ToWebs

Descripción

string money_format ( string formato, float numero )

money_format() devuelve una versión con formato de numero. Esta función envuelve la función de la biblioteca de C strfmon(), con la diferencia de que ésta implementación convierte solo un número a la vez.

Nota: La función money_format() está definida solo si el sistema tiene la capacidad de llamar a strfmon. Por ejemplo, Windows no tiene soporte para esta función, así que money_format() no se encuentra definida en Windows.

La especificación de formato consiste de la siguiente secuencia:

un caracter %
banderas opcionales
un ancho de campo opcional
precisión de izquierda opcional
precisión de derecha opcional
un caracter de conversión, requerido

Banderas. Una o más de las siguientes banderas opcionales pueden ser usadas:

=f: El caracter = seguido de un caracter (byte sencillo) f que será usado como el caracter de relleno numérico. Es caracter de relleno predeterminado es el espacio.
^: Deshabilitar el uso de caracteres de agrupamiento (tal y como estén definidos según la localidad actual).
+ o (: Especifica el estilo de formato para números positivos y negativos. Si se usa +, los equivalentes de + y - en la localidad actual serán usados. Si se usa (, las cantidades negativas estarán ubicadas entre paréntesis. Si no se da especificación alguna, el valor por defecto es +.
!: Elimina el símbolo de moneda de la cadena de salida.
-: Si se encuentra presente, hará que todos los campos estén justificados a izquierda (con relleno a la derecha), en contraste al comportamiento predeterminado que hace que los campos estén justificados a derecha (con relleno a la izquierda).

Ancho de campo.

w: Una cadena de dígito decimal que especifica un ancho de campo mínimo. El campo será justificado a derecha a menos que la bandera - sea usada. El valor predeterminado es 0 (cero).

Precisión de izquierda.

#n

El número máximo de dígitos (n) a esperar a la izquerda del caracter decimal (p. ej. el punto decimal). Usualmente se usa para mantener la salida con formato alineada en las mismas columnas, usando el caracter de relleno si el número de dígitos es menor que n. Si el número de dígitos real es mayor que n, entonces ésta especificación es ignorada.

Si no se ha suprimido el agrupamiento usando la bandera ^, los separadores de agrupamiento serán insertados antes de que los caracteres de relleno (si los hay) sean agregados. Los separadores de agrupamiento no serán aplicados sobre los caracteres de relleno, aun si el caracter de relleno es un dígito.

Para asegurar el alineamiento, cualquier caracter que aparezca antes o después del número en la salida con formato, tales como los símbolos de moneda o de signo, son rellenados en tanto sea necesario con caracteres de espacio para hacer que sus formatos positivo y negativo tengan una misma longitud.

Precisión de derecha .

.p: Un punto seguido del número de dígitos (p) después del caracter decimal. Si el valor de p es 0 (cero), el caracter decimal y los dígitos a su derecha serán omitidos. Si no se incluye ninguna precisión de derecha, el valor predeterminado será determinado por la localidad en uso. La cantidad a la cual se está dando formato es redondeada al número de dígitos especificado antes del formato.

Caracteres de conversión .

i: El número recibe formato de acuerdo al formato de moneda internacional de la localidad (p.ej. para la localidad de USA: USD 1,234.56).
n: El número recibe formato de acuerdo al formato de moneda nacional de la localidad (p.ej. para la localidad de_DE: DM1.234,56).
%: Devuelve el caracter %.

Nota: La categoría LC_MONETARY de los parámetros de la localidad, afecta el comportamiento de esta función. Use setlocale() para establecer la localidad por defecto apropiada antes de usar esta función.
Los caracteres antes y después de la cadena de formato serán devueltos sin modificaciones.

Ejemplo 1. Ejemplo de money_format()

Usaremos diferentes localidades y especificaciones de formato para ilustrar el uso de esta función.


<?php

$numero = 1234.56;

// imprimamos el formato internacional para la localidad en_US
setlocale(LC_MONETARY, 'en_US');
echo money_format('%i', $numero) . "\n";  
// USD 1,234.56

// Formato nacional italiano con 2 decimales
setlocale(LC_MONETARY, 'it_IT');
echo money_format('%.2n', $numero) . "\n";
// L. 1.234,56

// Uso de un numero negativo
$numero = -1234.5672;

// Formato nacional de US, usando () para numeros negativos
// y 10 digitos para la precision de derecha
setlocale(LC_MONETARY, 'en_US');
echo money_format('%(#10n', $numero) . "\n";
// ($        1,234.57)

// Un formato similar al anterior, agregando el uso de 2 digitos de
// precision de derecha y '*' como caracter de relleno
echo money_format('%=*(#10.2n', $numero) . "\n";
// ($********1,234.57)
    
// Justifiquemos a izquierda, con 14 posiciones de ancho, 8 digitos de
// precision de izquierda, 2 de precision de derecha, sin caracter de
// agrupamiento y usando el formato internacional de la localidad
// de_DE.
setlocale(LC_MONETARY, 'de_DE');
echo money_format('%=*^-14#8.2i', 1234.56) . "\n";
// DEM 1234,56****

// Agreguemos un poco de informacion antes y despues de la especificacion
// de conversion
setlocale(LC_MONETARY, 'en_GB');
$fmt = 'El valor final es %i (despues de un descuento de 10%%)';
echo money_format($fmt, 1234.56) . "\n";
// El valor final es GBP 1,234.56 (despues de un descuento de 10%)

?>

Vea también: setlocale(), number_format(),sprintf(), printf() y sscanf().