interface/modules/zend_modules/library/Zend/I18n/View/Helper/Plural.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\I18n\View\Helper;
  11
  12 use Zend\I18n\Exception;
  13 use Zend\I18n\Translator\Plural\Rule as PluralRule;
  14 use Zend\View\Helper\AbstractHelper;
  15
  16 /**
  17  * Helper for rendering text based on a count number (like the I18n plural translation helper, but when translation
  18  * is not needed).
  19  *
  20  * Please note that we did not write any hard-coded rules for languages, as languages can evolve, we prefered to
  21  * let the developer define the rules himself, instead of potentially break applications if we change rules in the
  22  * future.
  23  *
  24  * However, you can find most of the up-to-date plural rules for most languages in those links:
  25  *      - http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
  26  *      - https://developer.mozilla.org/en-US/docs/Localization_and_Plurals
  27  */
  28 class Plural extends AbstractHelper
  29 {
  30     /**
  31      * Plural rule to use
  32      *
  33      * @var PluralRule
  34      */
  35     protected $rule;
  36
  37     /**
  38      * @throws Exception\ExtensionNotLoadedException if ext/intl is not present
  39      */
  40     public function __construct()
  41     {
  42         if (!extension_loaded('intl')) {
  43             throw new Exception\ExtensionNotLoadedException(sprintf(
  44                 '%s component requires the intl PHP extension',
  45                 __NAMESPACE__
  46             ));
  47         }
  48     }
  49
  50     /**
  51      * Given an array of strings, a number and, if wanted, an optional locale (the default one is used
  52      * otherwise), this picks the right string according to plural rules of the locale
  53      *
  54      * @param  array|string $strings
  55      * @param  int          $number
  56      * @throws Exception\InvalidArgumentException
  57      * @return string
  58      */
  59     public function __invoke($strings, $number)
  60     {
  61         if (null === $this->getPluralRule()) {
  62             throw new Exception\InvalidArgumentException(sprintf(
  63                 'No plural rule was set'
  64             ));
  65         }
  66
  67         if (!is_array($strings)) {
  68             $strings = (array) $strings;
  69         }
  70
  71         $pluralIndex = $this->getPluralRule()->evaluate($number);
  72
  73         return $strings[$pluralIndex];
  74     }
  75
  76     /**
  77      * Set the plural rule to use
  78      *
  79      * @param  PluralRule|string $pluralRule
  80      * @return Plural
  81      */
  82     public function setPluralRule($pluralRule)
  83     {
  84         if (!$pluralRule instanceof PluralRule) {
  85             $pluralRule = PluralRule::fromString($pluralRule);
  86         }
  87
  88         $this->rule = $pluralRule;
  89
  90         return $this;
  91     }
  92
  93     /**
  94      * Get the plural rule to  use
  95      *
  96      * @return PluralRule
  97      */
  98     public function getPluralRule()
  99     {
 100         return $this->rule;
 101     }
 102 }