<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* A gettext Plural-Forms parser.

[3] Fix | Delete

*

[4] Fix | Delete

* @since 4.9.0

[5] Fix | Delete

*/

[6] Fix | Delete

if ( ! class_exists( 'Plural_Forms', false ) ) :

[7] Fix | Delete

#[AllowDynamicProperties]

[8] Fix | Delete

class Plural_Forms {

[9] Fix | Delete

/**

[10] Fix | Delete

* Operator characters.

[11] Fix | Delete

*

[12] Fix | Delete

* @since 4.9.0

[13] Fix | Delete

* @var string OP_CHARS Operator characters.

[14] Fix | Delete

*/

[15] Fix | Delete

const OP_CHARS = '|&><!=%?:';

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Valid number characters.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 4.9.0

[21] Fix | Delete

* @var string NUM_CHARS Valid number characters.

[22] Fix | Delete

*/

[23] Fix | Delete

const NUM_CHARS = '0123456789';

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Operator precedence.

[27] Fix | Delete

*

[28] Fix | Delete

* Operator precedence from highest to lowest. Higher numbers indicate

[29] Fix | Delete

* higher precedence, and are executed first.

[30] Fix | Delete

*

[31] Fix | Delete

* @see https://en.wikipedia.org/wiki/Operators_in_C_and_C%2B%2B#Operator_precedence

[32] Fix | Delete

*

[33] Fix | Delete

* @since 4.9.0

[34] Fix | Delete

* @var array $op_precedence Operator precedence from highest to lowest.

[35] Fix | Delete

*/

[36] Fix | Delete

protected static $op_precedence = array(

[37] Fix | Delete

'%' => 6,

[38] Fix | Delete

[39] Fix | Delete

'<' => 5,

[40] Fix | Delete

'<=' => 5,

[41] Fix | Delete

'>' => 5,

[42] Fix | Delete

'>=' => 5,

[43] Fix | Delete

[44] Fix | Delete

'==' => 4,

[45] Fix | Delete

'!=' => 4,

[46] Fix | Delete

[47] Fix | Delete

'&&' => 3,

[48] Fix | Delete

[49] Fix | Delete

'||' => 2,

[50] Fix | Delete

[51] Fix | Delete

'?:' => 1,

[52] Fix | Delete

'?' => 1,

[53] Fix | Delete

[54] Fix | Delete

'(' => 0,

[55] Fix | Delete

')' => 0,

[56] Fix | Delete

);

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Tokens generated from the string.

[60] Fix | Delete

*

[61] Fix | Delete

* @since 4.9.0

[62] Fix | Delete

* @var array $tokens List of tokens.

[63] Fix | Delete

*/

[64] Fix | Delete

protected $tokens = array();

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Cache for repeated calls to the function.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 4.9.0

[70] Fix | Delete

* @var array $cache Map of $n => $result

[71] Fix | Delete

*/

[72] Fix | Delete

protected $cache = array();

[73] Fix | Delete

[74] Fix | Delete

/**

[75] Fix | Delete

* Constructor.

[76] Fix | Delete

*

[77] Fix | Delete

* @since 4.9.0

[78] Fix | Delete

*

[79] Fix | Delete

* @param string $str Plural function (just the bit after `plural=` from Plural-Forms)

[80] Fix | Delete

*/

[81] Fix | Delete

public function __construct( $str ) {

[82] Fix | Delete

$this->parse( $str );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Parse a Plural-Forms string into tokens.

[87] Fix | Delete

*

[88] Fix | Delete

* Uses the shunting-yard algorithm to convert the string to Reverse Polish

[89] Fix | Delete

* Notation tokens.

[90] Fix | Delete

*

[91] Fix | Delete

* @since 4.9.0

[92] Fix | Delete

*

[93] Fix | Delete

* @throws Exception If there is a syntax or parsing error with the string.

[94] Fix | Delete

*

[95] Fix | Delete

* @param string $str String to parse.

[96] Fix | Delete

*/

[97] Fix | Delete

protected function parse( $str ) {

[98] Fix | Delete

$pos = 0;

[99] Fix | Delete

$len = strlen( $str );

[100] Fix | Delete

[101] Fix | Delete

// Convert infix operators to postfix using the shunting-yard algorithm.

[102] Fix | Delete

$output = array();

[103] Fix | Delete

$stack = array();

[104] Fix | Delete

while ( $pos < $len ) {

[105] Fix | Delete

$next = substr( $str, $pos, 1 );

[106] Fix | Delete

[107] Fix | Delete

switch ( $next ) {

[108] Fix | Delete

// Ignore whitespace.

[109] Fix | Delete

case ' ':

[110] Fix | Delete

case "\t":

[111] Fix | Delete

++$pos;

[112] Fix | Delete

break;

[113] Fix | Delete

[114] Fix | Delete

// Variable (n).

[115] Fix | Delete

case 'n':

[116] Fix | Delete

$output[] = array( 'var' );

[117] Fix | Delete

++$pos;

[118] Fix | Delete

break;

[119] Fix | Delete

[120] Fix | Delete

// Parentheses.

[121] Fix | Delete

case '(':

[122] Fix | Delete

$stack[] = $next;

[123] Fix | Delete

++$pos;

[124] Fix | Delete

break;

[125] Fix | Delete

[126] Fix | Delete

case ')':

[127] Fix | Delete

$found = false;

[128] Fix | Delete

while ( ! empty( $stack ) ) {

[129] Fix | Delete

$o2 = $stack[ count( $stack ) - 1 ];

[130] Fix | Delete

if ( '(' !== $o2 ) {

[131] Fix | Delete

$output[] = array( 'op', array_pop( $stack ) );

[132] Fix | Delete

continue;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

// Discard open paren.

[136] Fix | Delete

array_pop( $stack );

[137] Fix | Delete

$found = true;

[138] Fix | Delete

break;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

if ( ! $found ) {

[142] Fix | Delete

throw new Exception( 'Mismatched parentheses' );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

++$pos;

[146] Fix | Delete

break;

[147] Fix | Delete

[148] Fix | Delete

// Operators.

[149] Fix | Delete

case '|':

[150] Fix | Delete

case '&':

[151] Fix | Delete

case '>':

[152] Fix | Delete

case '<':

[153] Fix | Delete

case '!':

[154] Fix | Delete

case '=':

[155] Fix | Delete

case '%':

[156] Fix | Delete

case '?':

[157] Fix | Delete

$end_operator = strspn( $str, self::OP_CHARS, $pos );

[158] Fix | Delete

$operator = substr( $str, $pos, $end_operator );

[159] Fix | Delete

if ( ! array_key_exists( $operator, self::$op_precedence ) ) {

[160] Fix | Delete

throw new Exception( sprintf( 'Unknown operator "%s"', $operator ) );

[161] Fix | Delete

}

[162] Fix | Delete

[163] Fix | Delete

while ( ! empty( $stack ) ) {

[164] Fix | Delete

$o2 = $stack[ count( $stack ) - 1 ];

[165] Fix | Delete

[166] Fix | Delete

// Ternary is right-associative in C.

[167] Fix | Delete

if ( '?:' === $operator || '?' === $operator ) {

[168] Fix | Delete

if ( self::$op_precedence[ $operator ] >= self::$op_precedence[ $o2 ] ) {

[169] Fix | Delete

break;

[170] Fix | Delete

}

[171] Fix | Delete

} elseif ( self::$op_precedence[ $operator ] > self::$op_precedence[ $o2 ] ) {

[172] Fix | Delete

break;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

$output[] = array( 'op', array_pop( $stack ) );

[176] Fix | Delete

}

[177] Fix | Delete

$stack[] = $operator;

[178] Fix | Delete

[179] Fix | Delete

$pos += $end_operator;

[180] Fix | Delete

break;

[181] Fix | Delete

[182] Fix | Delete

// Ternary "else".

[183] Fix | Delete

case ':':

[184] Fix | Delete

$found = false;

[185] Fix | Delete

$s_pos = count( $stack ) - 1;

[186] Fix | Delete

while ( $s_pos >= 0 ) {

[187] Fix | Delete

$o2 = $stack[ $s_pos ];

[188] Fix | Delete

if ( '?' !== $o2 ) {

[189] Fix | Delete

$output[] = array( 'op', array_pop( $stack ) );

[190] Fix | Delete

--$s_pos;

[191] Fix | Delete

continue;

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

// Replace.

[195] Fix | Delete

$stack[ $s_pos ] = '?:';

[196] Fix | Delete

$found = true;

[197] Fix | Delete

break;

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

if ( ! $found ) {

[201] Fix | Delete

throw new Exception( 'Missing starting "?" ternary operator' );

[202] Fix | Delete

}

[203] Fix | Delete

++$pos;

[204] Fix | Delete

break;

[205] Fix | Delete

[206] Fix | Delete

// Default - number or invalid.

[207] Fix | Delete

default:

[208] Fix | Delete

if ( $next >= '0' && $next <= '9' ) {

[209] Fix | Delete

$span = strspn( $str, self::NUM_CHARS, $pos );

[210] Fix | Delete

$output[] = array( 'value', intval( substr( $str, $pos, $span ) ) );

[211] Fix | Delete

$pos += $span;

[212] Fix | Delete

break;

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

throw new Exception( sprintf( 'Unknown symbol "%s"', $next ) );

[216] Fix | Delete

}

[217] Fix | Delete

}

[218] Fix | Delete

[219] Fix | Delete

while ( ! empty( $stack ) ) {

[220] Fix | Delete

$o2 = array_pop( $stack );

[221] Fix | Delete

if ( '(' === $o2 || ')' === $o2 ) {

[222] Fix | Delete

throw new Exception( 'Mismatched parentheses' );

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

$output[] = array( 'op', $o2 );

[226] Fix | Delete

}

[227] Fix | Delete

[228] Fix | Delete

$this->tokens = $output;

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* Get the plural form for a number.

[233] Fix | Delete

*

[234] Fix | Delete

* Caches the value for repeated calls.

[235] Fix | Delete

*

[236] Fix | Delete

* @since 4.9.0

[237] Fix | Delete

*

[238] Fix | Delete

* @param int $num Number to get plural form for.

[239] Fix | Delete

* @return int Plural form value.

[240] Fix | Delete

*/

[241] Fix | Delete

public function get( $num ) {

[242] Fix | Delete

if ( isset( $this->cache[ $num ] ) ) {

[243] Fix | Delete

return $this->cache[ $num ];

[244] Fix | Delete

}

[245] Fix | Delete

$this->cache[ $num ] = $this->execute( $num );

[246] Fix | Delete

return $this->cache[ $num ];

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Execute the plural form function.

[251] Fix | Delete

*

[252] Fix | Delete

* @since 4.9.0

[253] Fix | Delete

*

[254] Fix | Delete

* @throws Exception If the plural form value cannot be calculated.

[255] Fix | Delete

*

[256] Fix | Delete

* @param int $n Variable "n" to substitute.

[257] Fix | Delete

* @return int Plural form value.

[258] Fix | Delete

*/

[259] Fix | Delete

public function execute( $n ) {

[260] Fix | Delete

$stack = array();

[261] Fix | Delete

$i = 0;

[262] Fix | Delete

$total = count( $this->tokens );

[263] Fix | Delete

while ( $i < $total ) {

[264] Fix | Delete

$next = $this->tokens[ $i ];

[265] Fix | Delete

++$i;

[266] Fix | Delete

if ( 'var' === $next[0] ) {

[267] Fix | Delete

$stack[] = $n;

[268] Fix | Delete

continue;

[269] Fix | Delete

} elseif ( 'value' === $next[0] ) {

[270] Fix | Delete

$stack[] = $next[1];

[271] Fix | Delete

continue;

[272] Fix | Delete

}

[273] Fix | Delete

[274] Fix | Delete

// Only operators left.

[275] Fix | Delete

switch ( $next[1] ) {

[276] Fix | Delete

case '%':

[277] Fix | Delete

$v2 = array_pop( $stack );

[278] Fix | Delete

$v1 = array_pop( $stack );

[279] Fix | Delete

$stack[] = $v1 % $v2;

[280] Fix | Delete

break;

[281] Fix | Delete

[282] Fix | Delete

case '||':

[283] Fix | Delete

$v2 = array_pop( $stack );

[284] Fix | Delete

$v1 = array_pop( $stack );

[285] Fix | Delete

$stack[] = $v1 || $v2;

[286] Fix | Delete

break;

[287] Fix | Delete

[288] Fix | Delete

case '&&':

[289] Fix | Delete

$v2 = array_pop( $stack );

[290] Fix | Delete

$v1 = array_pop( $stack );

[291] Fix | Delete

$stack[] = $v1 && $v2;

[292] Fix | Delete

break;

[293] Fix | Delete

[294] Fix | Delete

case '<':

[295] Fix | Delete

$v2 = array_pop( $stack );

[296] Fix | Delete

$v1 = array_pop( $stack );

[297] Fix | Delete

$stack[] = $v1 < $v2;

[298] Fix | Delete

break;

[299] Fix | Delete

[300] Fix | Delete

case '<=':

[301] Fix | Delete

$v2 = array_pop( $stack );

[302] Fix | Delete

$v1 = array_pop( $stack );

[303] Fix | Delete

$stack[] = $v1 <= $v2;

[304] Fix | Delete

break;

[305] Fix | Delete

[306] Fix | Delete

case '>':

[307] Fix | Delete

$v2 = array_pop( $stack );

[308] Fix | Delete

$v1 = array_pop( $stack );

[309] Fix | Delete

$stack[] = $v1 > $v2;

[310] Fix | Delete

break;

[311] Fix | Delete

[312] Fix | Delete

case '>=':

[313] Fix | Delete

$v2 = array_pop( $stack );

[314] Fix | Delete

$v1 = array_pop( $stack );

[315] Fix | Delete

$stack[] = $v1 >= $v2;

[316] Fix | Delete

break;

[317] Fix | Delete

[318] Fix | Delete

case '!=':

[319] Fix | Delete

$v2 = array_pop( $stack );

[320] Fix | Delete

$v1 = array_pop( $stack );

[321] Fix | Delete

$stack[] = $v1 !== $v2;

[322] Fix | Delete

break;

[323] Fix | Delete

[324] Fix | Delete

case '==':

[325] Fix | Delete

$v2 = array_pop( $stack );

[326] Fix | Delete

$v1 = array_pop( $stack );

[327] Fix | Delete

$stack[] = $v1 === $v2;

[328] Fix | Delete

break;

[329] Fix | Delete

[330] Fix | Delete

case '?:':

[331] Fix | Delete

$v3 = array_pop( $stack );

[332] Fix | Delete

$v2 = array_pop( $stack );

[333] Fix | Delete

$v1 = array_pop( $stack );

[334] Fix | Delete

$stack[] = $v1 ? $v2 : $v3;

[335] Fix | Delete

break;

[336] Fix | Delete

[337] Fix | Delete

default:

[338] Fix | Delete

throw new Exception( sprintf( 'Unknown operator "%s"', $next[1] ) );

[339] Fix | Delete

}

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

if ( count( $stack ) !== 1 ) {

[343] Fix | Delete

throw new Exception( 'Too many values remaining on the stack' );

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

return (int) $stack[0];

[347] Fix | Delete

}

[348] Fix | Delete

}

[349] Fix | Delete

endif;

[350] Fix | Delete

[351] Fix | Delete