/**
* Parses a localized number representation and returns the number (or null if $string is not a valid number representation).
* @param string $string The number representation to parse.
* @param bool $trim [default: true] Remove spaces and new lines at the start/end of $string?
* @param int|null $precision [default: null] The wanted precision; if null or not specified the complete number will be returned.
* @return null|number
* @example http://www.concrete5.org/documentation/how-tos/developers/formatting-numbers/ See the Formatting numbers how-to for more details
*/
public function unformat($string, $trim = true, $precision = null)
{
$result = null;
$number = \Punic\Number::unformat($string);
if (!is_null($number)) {
if (is_numeric($precision)) {
$number = round($number, $precision);
}
$result = $number;
}
return $result;
}
/**
* Format a unit string
* @param int|float|string $number The unit amount
* @param string $unit The unit identifier (eg 'duration/millisecond' or 'millisecond')
* @param string $width = 'short' The format name; it can be 'long' (eg '3 milliseconds'), 'short' (eg '3 ms') or 'narrow' (eg '3ms'). You can also add a precision specifier ('long,2' or just '2')
* @param string $locale = '' The locale to use. If empty we'll use the default locale set in \Punic\Data
*/
public static function format($number, $unit, $width = 'short', $locale = '')
{
$data = \Punic\Data::get('units', $locale);
$precision = null;
if (is_int($width)) {
$precision = $width;
$width = 'short';
} elseif (is_string($width) && preg_match('/^(?:(.*),)?([+\\-]?\\d+)$/', $width, $m)) {
$precision = intval($m[2]);
$width = $m[1];
if (!strlen($width)) {
$width = 'short';
}
}
if (strpos($width, '_') === 0 || !array_key_exists($width, $data)) {
$widths = array();
foreach (array_keys($data) as $w) {
if (strpos($w, '_') !== 0) {
$widths[] = $w;
}
}
throw new Exception\ValueNotInList($width, $widths);
}
$data = $data[$width];
if (strpos($unit, '/') === false) {
$unitCategory = null;
$unitID = null;
foreach (array_keys($data) as $c) {
if (strpos($c, '_') === false) {
if (array_key_exists($unit, $data[$c])) {
if (is_null($unitCategory)) {
$unitCategory = $c;
$unitID = $unit;
} else {
$unitCategory = null;
break;
}
}
}
}
} else {
list($unitCategory, $unitID) = explode('/', $unit, 2);
}
$rules = null;
if (strpos($unit, '_') === false && !is_null($unitCategory) && !is_null($unitID) && array_key_exists($unitCategory, $data) && array_key_exists($unitID, $data[$unitCategory])) {
$rules = $data[$unitCategory][$unitID];
}
if (is_null($rules)) {
$units = array();
foreach ($data as $c => $us) {
if (strpos($c, '_') === false) {
foreach (array_keys($us) as $u) {
if (strpos($c, '_') === false) {
$units[] = "{$c}/{$u}";
}
}
}
}
throw new \Punic\Exception\ValueNotInList($unit, $units);
}
$pluralRule = \Punic\Plural::getRule($number, $locale);
//@codeCoverageIgnoreStart
// These checks aren't necessary since $pluralRule should always be in $rules, but they don't hurt ;)
if (!array_key_exists($pluralRule, $rules)) {
if (array_key_exists('other', $rules)) {
$pluralRule = 'other';
} else {
$availableRules = array_keys($rules);
$pluralRule = $availableRules[0];
}
}
//@codeCoverageIgnoreEnd
return sprintf($rules[$pluralRule], \Punic\Number::format($number, $precision, $locale));
}
