CLDR Plural Rule Parser
Parses CLDR plural rules
Loading...
Searching...
No Matches
CLDRPluralRuleParser\Range Class Reference

Evaluator helper class representing a range list. More...

Public Member Functions

 __construct ( $start, $end=false)
 Initialize a new instance of Range.
 
 isNumberIn ( $number, $integerConstraint=true)
 Determine if the given number is inside the range.
 
 isNumberWithin ( $number)
 Readable alias for isNumberIn( $number, false ), and the implementation of the "within" operator.
 
 add ( $other)
 Add another part to this range.
 
 __toString ()
 Returns the string representation of the rule evaluator range.
 

Public Attributes

 $parts = []
 

Detailed Description

Evaluator helper class representing a range list.

Constructor & Destructor Documentation

◆ __construct()

CLDRPluralRuleParser\Range::__construct (   $start,
  $end = false 
)

Initialize a new instance of Range.

Parameters
int$startThe start of the range
int | bool$endThe end of the range, or false if the range is not bounded.

Member Function Documentation

◆ __toString()

CLDRPluralRuleParser\Range::__toString ( )

Returns the string representation of the rule evaluator range.

The purpose of this method is to help debugging.

Returns
string The string representation of the rule evaluator range

◆ add()

CLDRPluralRuleParser\Range::add (   $other)

Add another part to this range.

Parameters
Range | int$otherThe part to add, either a range object itself or a single number.

◆ isNumberIn()

CLDRPluralRuleParser\Range::isNumberIn (   $number,
  $integerConstraint = true 
)

Determine if the given number is inside the range.

Parameters
int$numberThe number to check
bool$integerConstraintIf true, also asserts the number is an integer; otherwise, number simply has to be inside the range.
Returns
bool True if the number is inside the range; otherwise, false.

◆ isNumberWithin()

CLDRPluralRuleParser\Range::isNumberWithin (   $number)

Readable alias for isNumberIn( $number, false ), and the implementation of the "within" operator.

Parameters
int$numberThe number to check
Returns
bool True if the number is inside the range; otherwise, false.

The documentation for this class was generated from the following file: