nochso\Omni\Format\Quantity

Complexity

Total Complexity

6

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	format()	0	21	6

<?php
namespace nochso\Omni\Format;

use nochso\Omni\Dot;
use nochso\Omni\Numeric;

/**
 * Quantity formats a string depending on quantity (many, one or zero).
 * 
 * The plural, singular and empty formats of the string can be defined like this:
 *
 * `(plural|singular|zero)`
 * 
 * The singular and zero formats are optional:
 * 
 * ```php
 * Quantity::format('day(s)', 1); // day
 * Quantity::format('day(s)', 0); // days
 * ```
 *
 * If the `zero` format is not defined, the plural form will be used instead.
 * Alternatively you can use an empty string:
 * 
 * ```php
 * Quantity::format('(many|one|)', 0); // empty string
 * ```
 * 
 * Example with all three formats:
 * 
 * ```php
 * Quantity::format('(bugs|bug|no bugs at all)', 5) // bugs
 * Quantity::format('(bugs|bug|no bugs at all)', 1) // bug
 * Quantity::format('(bugs|bug|no bugs at all)', 0) // no bugs at all
 * ```
 */
class Quantity
{
    /**
     * Format a string depending on a quantity.
     * 
     * See the class documentation for defining `$format`.
     * 
     * @param string $format
     * @param string $quantity
     *
     * @return mixed
     */
    public static function format($format, $quantity)
    {
        $quantity = Numeric::ensure($quantity);
        $callback = function ($matches) use ($quantity) {
            // Get available choices
            $choices = preg_split('/\|/', $matches[2]);
            // Assume plural
            $choice = 0;
            // Choose singular
            if ($quantity === 1.0 || $quantity === 1) {
                $choice = 1;
            }
            // Choose zero if it's defined, otherwise keep using plural format
            if (($quantity === 0 || $quantity === 0.0) && isset($choices[2])) {
                $choice = 2;
            }
            return Dot::get($choices, $choice, '');
        };
        $pattern = '/(?<!\\\\)(\\((.+?(?<!\\\\))\\))/';
        return preg_replace_callback($pattern, $callback, $format);
    }
}