The format function can be used to format data. Some common examples include formatting currencies, decimal numbers, or dates.<\/p>\n\n\n\n
string format(number|string|datetime $data, string $format, string $culture)<\/code><\/pre>\n\n\n\nThis function takes a numerical-, string- or date value as $data, and formats this input based on $format and $culture. Output is a string value.<\/p>\n\n\n\n
Parameters<\/h3>\n\n\n\n
$data:<\/strong> Can be a number, string, or date-time object.
$format<\/strong>: A string defining how the $data should be formatted. Should follow Microsoft standard format specifiers<\/a> (e.g., “C2”, “N1”).
$culture<\/strong>: A string defining the culture the $data formatting should follow. Should follow iana values (e.g. “en-US”, “es-ES”).<\/p>\n\n\n\nExample<\/h3>\n\n\n\n
Below, “FirstValue” is formatted in four different ways showcasing various options.<\/p>\n\n\n\n
{\n \"FirstValue\": 1000\n}<\/code><\/pre>\n\n\n\nThe names of the values below indicate what the transformation is achieving.<\/p>\n\n\n\n
{\n AmericanCurrencyTwoDecimals: format(FirstValue, 'C2', 'en-US'),\n SpanishCurrencyNoDecimals: format(FirstValue, 'C0', 'es-ES'),\n AmericanNumberTwoDecimals: format(FirstValue, 'N2', 'en-US'),\n SpanishNumberTwoDecimals: format(FirstValue, 'N2', 'es-ES')\n}<\/code><\/pre>\n\n\n\nThus, currencies based on culture, number of decimals, thousands separator, and decimal points are controlled.<\/p>\n\n\n\n
{\n \"AmericanCurrencyTwoDecimals\": \"$1,000.00\",\n \"SpanishCurrencyNoDecimals\": \"1.000 \u20ac\",\n \"AmericanNumberTwoDecimals\": \"1,000.00\",\n \"SpanishNumberTwoDecimals\": \"1.000,00\"\n}<\/code><\/pre>\n\n\n\n