languages/utils/CLDRPluralRuleEvaluatorRange.php

   1 <?php
   2 /**
   3  * @author Niklas Laxström, Tim Starling
   4  *
   5  * @copyright Copyright © 2010-2012, Niklas Laxström
   6  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
   7  *
   8  * @file
   9  * @since 1.20
  10  */
  11
  12 /**
  13  * Evaluator helper class representing a range list.
  14  */
  15 class CLDRPluralRuleEvaluatorRange {
  16         /**
  17          * The parts
  18          *
  19          * @var array
  20          */
  21         public $parts = array();
  22
  23         /**
  24          * Initialize a new instance of CLDRPluralRuleEvaluatorRange
  25          *
  26          * @param int $start The start of the range
  27          * @param int|bool $end The end of the range, or false if the range is not bounded.
  28          */
  29         function __construct( $start, $end = false ) {
  30                 if ( $end === false ) {
  31                         $this->parts[] = $start;
  32                 } else {
  33                         $this->parts[] = array( $start, $end );
  34                 }
  35         }
  36
  37         /**
  38          * Determine if the given number is inside the range.
  39          *
  40          * @param int $number The number to check
  41          * @param bool $integerConstraint If true, also asserts the number is an integer; otherwise, number simply has to be inside the range.
  42          * @return bool True if the number is inside the range; otherwise, false.
  43          */
  44         function isNumberIn( $number, $integerConstraint = true ) {
  45                 foreach ( $this->parts as $part ) {
  46                         if ( is_array( $part ) ) {
  47                                 if ( ( !$integerConstraint || floor( $number ) === (float)$number )
  48                                         && $number >= $part[0] && $number <= $part[1]
  49                                 ) {
  50                                         return true;
  51                                 }
  52                         } else {
  53                                 if ( $number == $part ) {
  54                                         return true;
  55                                 }
  56                         }
  57                 }
  58
  59                 return false;
  60         }
  61
  62         /**
  63          * Readable alias for isNumberIn( $number, false ), and the implementation
  64          * of the "within" operator.
  65          *
  66          * @param int $number The number to check
  67          * @return bool True if the number is inside the range; otherwise, false.
  68          */
  69         function isNumberWithin( $number ) {
  70                 return $this->isNumberIn( $number, false );
  71         }
  72
  73         /**
  74          * Add another part to this range.
  75          *
  76          * @param CLDRPluralRuleEvaluatorRange|int $other The part to add, either
  77          *   a range object itself or a single number.
  78          */
  79         function add( $other ) {
  80                 if ( $other instanceof self ) {
  81                         $this->parts = array_merge( $this->parts, $other->parts );
  82                 } else {
  83                         $this->parts[] = $other;
  84                 }
  85         }
  86
  87         /**
  88          * Returns the string representation of the rule evaluator range.
  89          * The purpose of this method is to help debugging.
  90          *
  91          * @return string The string representation of the rule evaluator range
  92          */
  93         function __toString() {
  94                 $s = 'Range(';
  95                 foreach ( $this->parts as $i => $part ) {
  96                         if ( $i ) {
  97                                 $s .= ', ';
  98                         }
  99                         if ( is_array( $part ) ) {
 100                                 $s .= $part[0] . '..' . $part[1];
 101                         } else {
 102                                 $s .= $part;
 103                         }
 104                 }
 105                 $s .= ')';
 106
 107                 return $s;
 108         }
 109 }