Formato de strings en PHP

La mayoría de las veces para mostrar un string en PHP se utiliza echo(), que devuelve el string mostrándolo en HTML. Con echo incluso se pueden concatenar varios strings juntos (siempre sin el uso de paréntesis).

Una opción para mostrar múltiples opciones en una caja de selección con echo es la siguiente:

$opciones = array(
    'opcion1' => 'titulo1',
    'opcion2' => 'titulo2',
    'opcion3' => 'titulo3'
);

echo '<select>';

foreach ($opciones as $key => $value)
{
    echo 'option value="'.$key.'">'.$value.'</option>';
}

echo '</select>';

El código anterior resulta legible y fácil de construir, pero si por ejemplo se tiene que mostrar un array de imágenes con sus correspondientes etiquetas, la cosa se complica:

$imagenes = array(
    'imagen1' => array('class'=> 'style', 'alt'=>'imagen1', 'title'=> 'imagen1','src'=>'http://www.example.com/imagen1.jpg'),
    'imagen2' => array('class'=> 'style', 'alt'=>'imagen2', 'title'=> 'imagen2','src'=>'http://www.example.com/imagen2.jpg'),
    'imagen3' => array('class'=> 'style', 'alt'=>'imagen3', 'title'=> 'imagen3','src'=>'http://www.example.com/imagen3.jpg')
);

echo '<select>';

foreach ($imagenes as $key => $value)
{
    echo '<img class="'.$value["class"].'" alt="'.$value["alt"].'" title="'.$value["title"].'" src="'.$value["src"].'" />';
}

echo '</select>';

Ahora no es tan fácil de leer con tanto abrir y cerrar comillas simples y dobles.

La solución la proporcionan las funciones incorporadas de formateo de strings.

​1. sprintf

string sprintf (string $format [, mixed $args [, mixed $... ]] )

Devuelve un string formateado según $format.

El string de formateo está compuesto de cero o más caracteres (excluyendo %), que se copian al resultado, junto con especificaciones de conversión que permiten concretar la salida de los argumentos. Esto se aplica para sprintf() y printf().

Cada especificación de conversión se constituye por un signo de porcentaje % seguido de un elemento (los 5 primeros puntos son opcionales):

1. Especificador de signo que fuerza a usar un signo en un número (+ ó -).
2. Especificador de relleno que indica que carácter se utiliza para rellenar el resultado hasta el tamaño justo del string, con ceros o con espacios. El valor por defecto es rellenar con espacios, si se pone un cero, se rellenará con ceros. Un carácter de relleno alternativo se puede especificar prefijándolo con una comilla simple (').
3. Especificador de alineación que indica si el resultado ha de alinearse a la izquierda o derecha. Por defecto es a la derecha, si incluye (-) se alineará a la izquierda.
4. Especificación de un número opcional de ancho mínimo de caracteres como resultado de la conversión.
5. Especificación de precisión en forma de punto (.) seguido de un número que indica cuántos dígitos decimales deben mostrarse para los números float. Si se utiliza con un string, actúa como punto de corte, estableciendo un número máximo de caracteres el string.
6. Especificador de tipo (obligatorio) que indica el tipo con el que han de ser tratados los datos del argumento:

Las variables se fuerzan con el especificador a un tipo adecuado:

Ejemplo:

$numero = 10;
$donde = "carretera";

$texto = 'Hay %d camiones en la %s';
echo sprintf($texto, $numero, $donde); // Devuelve: Hay 10 camiones en la carretera

Si cambiásemos el orden de los argumentos, no funcionaría como esperamos. Para ello podemos indicar con marcadores de posición el orden de los argumentos. Este marcador n$ debe ir inmediatamente después del signo de porcentaje %:

$numero = 10;
$donde = "carretera";

$texto = 'Hay %2$d camiones en la %1$s';
echo sprintf($texto, $donde, $numero);
//Si no se incluyera el orden devolvería: Hay 0 camiones en la 10

Se pueden repetir los marcadores de posición:

$numero = 10;
$donde = "carretera";

$texto = 'Hay %2$d camiones en la %1$s, y también hay %2$d coches';
echo sprintf($texto, $donde, $numero);

Si se empiezan a combinar especificadores se pueden obtener diferentes resultados:

echo sprintf("%'.9d", 123) ."<br>"; // ......123
echo sprintf("%09d", 123) ."<br>"; // 000000123
echo sprintf("%'.19d", 123) ."<br>"; // ...............123
echo sprintf("%'p9d", 123) ."<br>"; // pppppp123
echo sprintf("%9d", 123) ."<br>"; // '      123'
echo sprintf("%'*9d", 123) ."<br>"; // ******123

En el ejemplo anterior tenemos la comilla simple (') para indicar que se rellene el string con los valores indicados. El punto (.) se ha empleado como relleno. Si son strings o floats el punto tiene el significado de indicar el número de caracteres o decimales a devolver, respectivamente:

echo sprintf("%.1f", 123.4433) ."<br>"; // 123.4
echo sprintf("%.1s", "hola") ."<br>"; // h

Usar una combinación de especificadores con caracteres que requieren más de un byte puede tener resultados inesperados.

Otros ejemplos de combinaciones de números. Siempre devuelven un string:

$a =  19905;
$b = -19905;
$c = 68; // ASCII 68 es 'D'
echo "Binario: " . sprintf("%%b = '%b'\n", $a) . "<br>"; // Binario:%b = '100110111000001'
echo "ASCII: " . sprintf("%%c = '%c'\n", $c) . "<br>"; // ASCII:%c = 'D'
echo "Integer: " . sprintf("%%d = '%d'\n", $a) . "<br>"; // Integer:%d = '19905'
echo "Notación científica: " . sprintf("%%e = '%e'\n", $a) . "<br>"; // Notación científica: %e = '1.990500e+4'
echo "Integer positivo: " . sprintf("%%u = '%u'\n", $a) . "<br>"; // Integer positivo: %u = '19905'
echo "Integer negativo: " . sprintf("%%u = '%u'\n", $b) . "<br>"; // Integer negativo: %u = '18446744073709531711'
echo "Float: " . sprintf("%%f = '%f'\n", $a) . "<br>"; // Float: %f = '19905.000000'
echo "Octal: " . sprintf("%%o = '%o'\n", $a) . "<br>"; // Octal: %o = '46701'
echo "Cadena: " . sprintf("%%s = '%s'\n", $a) . "<br>"; // Cadena: %s = '19905'
echo "Hexadecimal(minúsculas): " . sprintf("%%x = '%x'\n", $a) . "<br>"; // Hexadecimal(minúsculas): %x = '4dc1'
echo "Hexadecimal(mayúsculas): " . sprintf("%%X = '%X'\n", $a) . "<br>"; // Hexadecimal(mayúsculas): %X = '4DC1'
echo "Signo sobre entero positivo: " . sprintf("%%+d = '%+d'\n", $a) . "<br>"; // Signo sobre entero positivo: %+d = '+19905'
echo "Signo sobre entero negativo: " . sprintf("%%+d = '%+d'\n", $b); // Signo sobre entero negativo: %+d = '-19905'

Ejemplos con strings (obsérvese que se utiliza printf(), no sprintf()):

$a = 'moto';
$b = 'muchas motos';

printf("[%s]\n",      $a); // salida estándar de string
printf("[%10s]\n",    $a); // justificación a la derecha con espacios
printf("[%-10s]\n",   $a); // justificación a la izquierda con espacios
printf("[%010s]\n",   $a); // rellenado con ceros también funciona con strings
printf("[%'#10s]\n",  $a); // utiliza el carácter de relleno personalizado '#'
printf("[%.10s]\n", $b); // corte a los 10 caracteres

Ejemplo de relleno de ceros para fechas:

$año = 1999;
$mes = 2;
$día = 9;
echo $fecha_iso = sprintf("%02d-%02d-%04d", $día, $mes, $año);

Ejemplo de relleno de ceros para dinero:

$dinero1 = 88.72;
$dinero2 = 14.38;
$dinero = $dinero1 + $dinero2;
// echo $dinero producirá "103.1";
echo $formateado = sprintf("%.2f", $dinero);
// echo $formateado producirá "103.10"