interface/modules/zend_modules/library/Zend/I18n/Translator/Plural/Symbol.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\Translator\Plural;
  11
  12 use Closure;
  13 use Zend\I18n\Exception;
  14
  15 /**
  16  * Parser symbol.
  17  *
  18  * All properties in the symbol are defined as public for easier and faster
  19  * access from the applied closures. An exception are the closure properties
  20  * themselves, as they have to be accessed via the appropriate getter and
  21  * setter methods.
  22  */
  23 class Symbol
  24 {
  25     /**
  26      * Parser instance.
  27      *
  28      * @var Parser
  29      */
  30     public $parser;
  31
  32     /**
  33      * Node or token type name.
  34      *
  35      * @var string
  36      */
  37     public $id;
  38
  39     /**
  40      * Left binding power (precedence).
  41      *
  42      * @var int
  43      */
  44     public $leftBindingPower;
  45
  46     /**
  47      * Getter for null denotation.
  48      *
  49      * @var callable
  50      */
  51     protected $nullDenotationGetter;
  52
  53     /**
  54      * Getter for left denotation.
  55      *
  56      * @var callable
  57      */
  58     protected $leftDenotationGetter;
  59
  60     /**
  61      * Value used by literals.
  62      *
  63      * @var mixed
  64      */
  65     public $value;
  66
  67     /**
  68      * First node value.
  69      *
  70      * @var Symbol
  71      */
  72     public $first;
  73
  74     /**
  75      * Second node value.
  76      *
  77      * @var Symbol
  78      */
  79     public $second;
  80
  81     /**
  82      * Third node value.
  83      *
  84      * @var Symbol
  85      */
  86     public $third;
  87
  88     /**
  89      * Create a new symbol.
  90      *
  91      * @param  Parser  $parser
  92      * @param  string  $id
  93      * @param  int $leftBindingPower
  94      */
  95     public function __construct(Parser $parser, $id, $leftBindingPower)
  96     {
  97         $this->parser               = $parser;
  98         $this->id                   = $id;
  99         $this->leftBindingPower     = $leftBindingPower;
 100     }
 101
 102     /**
 103      * Set the null denotation getter.
 104      *
 105      * @param  Closure $getter
 106      * @return Symbol
 107      */
 108     public function setNullDenotationGetter(Closure $getter)
 109     {
 110         $this->nullDenotationGetter = $getter;
 111         return $this;
 112     }
 113
 114     /**
 115      * Set the left denotation getter.
 116      *
 117      * @param  Closure $getter
 118      * @return Symbol
 119      */
 120     public function setLeftDenotationGetter(Closure $getter)
 121     {
 122         $this->leftDenotationGetter = $getter;
 123         return $this;
 124     }
 125
 126     /**
 127      * Get null denotation.
 128      *
 129      * @throws Exception\ParseException
 130      * @return Symbol
 131      */
 132     public function getNullDenotation()
 133     {
 134         if ($this->nullDenotationGetter === null) {
 135             throw new Exception\ParseException(sprintf(
 136                 'Syntax error: %s', $this->id
 137             ));
 138         }
 139
 140         /** @var callable $function  */
 141         $function = $this->nullDenotationGetter;
 142         return $function($this);
 143     }
 144
 145     /**
 146      * Get left denotation.
 147      *
 148      * @param  Symbol $left
 149      * @throws Exception\ParseException
 150      * @return Symbol
 151      */
 152     public function getLeftDenotation($left)
 153     {
 154         if ($this->leftDenotationGetter === null) {
 155             throw new Exception\ParseException(sprintf(
 156                 'Unknown operator: %s', $this->id
 157             ));
 158         }
 159
 160         /** @var callable $function  */
 161         $function = $this->leftDenotationGetter;
 162         return $function($this, $left);
 163     }
 164 }