Code Coverage
 
Classes and Traits
Functions and Methods
Lines
Total
0.00% covered (danger)
0.00%
0 / 1
70.00% covered (warning)
70.00%
7 / 10
 CRAP
94.00% covered (success)
94.00%
47 / 50
extension
0.00% covered (danger)
0.00%
0 / 1
70.00% covered (warning)
70.00%
7 / 10
 16.06
94.00% covered (success)
94.00%
47 / 50
 __construct
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
4 / 4
 getName
0.00% covered (danger)
0.00%
0 / 1
 2.00
0.00% covered (danger)
0.00%
0 / 1
 getTokenParsers
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
7 / 7
 getFilters
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
4 / 4
 getFunctions
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
4 / 4
 getOperators
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
16 / 16
 loop_subset
100.00% covered (success)
100.00%
1 / 1
 5
100.00% covered (success)
100.00%
5 / 5
 lang
0.00% covered (danger)
0.00%
0 / 1
 3.04
83.33% covered (warning)
83.33%
5 / 6
 lang_defined
0.00% covered (danger)
0.00%
0 / 1
 2.00
0.00% covered (danger)
0.00%
0 / 1
 lang_js
100.00% covered (success)
100.00%
1 / 1
 1
100.00% covered (success)
100.00%
2 / 2
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\template\twig;
use Twig\Error\RuntimeError;
class extension extends \Twig\Extension\AbstractExtension
{
    /** @var \phpbb\template\context */
    protected $context;
    /** @var \phpbb\template\twig\environment */
    protected $environment;
    /** @var \phpbb\language\language */
    protected $language;
    /**
    * Constructor
    *
    * @param \phpbb\template\context $context
    * @param \phpbb\template\twig\environment $environment
    * @param \phpbb\language\language $language
    */
    public function __construct(\phpbb\template\context $context, \phpbb\template\twig\environment $environment, $language)
    {
        $this->context = $context;
        $this->environment = $environment;
        $this->language = $language;
    }
    /**
    * Get the name of this extension
    *
    * @return string
    */
    public function getName()
    {
        return 'phpbb';
    }
    /**
    * Returns the token parser instance to add to the existing list.
    *
    * @return array An array of \Twig\TokenParser\AbstractTokenParser instances
    */
    public function getTokenParsers()
    {
        return array(
            new \phpbb\template\twig\tokenparser\defineparser,
            new \phpbb\template\twig\tokenparser\includeparser,
            new \phpbb\template\twig\tokenparser\includejs,
            new \phpbb\template\twig\tokenparser\includecss,
            new \phpbb\template\twig\tokenparser\event($this->environment),
            new \phpbb\template\twig\tokenparser\includephp($this->environment),
            new \phpbb\template\twig\tokenparser\php($this->environment),
        );
    }
    /**
    * Returns a list of filters to add to the existing list.
    *
    * @return array An array of filters
    */
    public function getFilters()
    {
        return array(
            new \Twig\TwigFilter('subset', array($this, 'loop_subset'), array('needs_environment' => true)),
            // @deprecated 3.2.0 Uses twig's JS escape method instead of addslashes
            new \Twig\TwigFilter('addslashes', 'addslashes'),
            new \Twig\TwigFilter('int', 'intval'),
            new \Twig\TwigFilter('float', 'floatval'),
        );
    }
    /**
    * Returns a list of global functions to add to the existing list.
    *
    * @return array An array of global functions
    */
    public function getFunctions()
    {
        return array(
            new \Twig\TwigFunction('lang', array($this, 'lang')),
            new \Twig\TwigFunction('lang_defined', array($this, 'lang_defined')),
            new \Twig\TwigFunction('lang_js', [$this, 'lang_js']),
            new \Twig\TwigFunction('get_class', 'get_class'),
        );
    }
    /**
    * Returns a list of operators to add to the existing list.
    *
    * @return array An array of operators
    */
    public function getOperators()
    {
        return array(
            array(
                '!' => array('precedence' => 50, 'class' => '\Twig\Node\Expression\Unary\NotUnary'),
            ),
            array(
                // precedence settings are copied from similar operators in Twig core extension
                '||' => array('precedence' => 10, 'class' => '\Twig\Node\Expression\Binary\OrBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                '&&' => array('precedence' => 15, 'class' => '\Twig\Node\Expression\Binary\AndBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'eq' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\EqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'ne' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\NotEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'neq' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\NotEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                '<>' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\NotEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                '===' => array('precedence' => 20, 'class' => '\phpbb\template\twig\node\expression\binary\equalequal', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                '!==' => array('precedence' => 20, 'class' => '\phpbb\template\twig\node\expression\binary\notequalequal', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'gt' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\GreaterBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'gte' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\GreaterEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'ge' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\GreaterEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'lt' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\LessBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'lte' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\LessEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'le' => array('precedence' => 20, 'class' => '\Twig\Node\Expression\Binary\LessEqualBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
                'mod' => array('precedence' => 60, 'class' => '\Twig\Node\Expression\Binary\ModBinary', 'associativity' => \Twig\ExpressionParser::OPERATOR_LEFT),
            ),
        );
    }
    /**
    * Grabs a subset of a loop
    *
    * @param \Twig\Environment $env          A Twig\Environment instance
    * @param mixed            $item         A variable
    * @param integer          $start        Start of the subset
    * @param integer          $end            End of the subset
    * @param boolean          $preserveKeys Whether to preserve key or not (when the input is an array)
    *
    * @return mixed The sliced variable
    */
    public function loop_subset(\Twig\Environment $env, $item, $start, $end = null, $preserveKeys = false)
    {
        // We do almost the same thing as Twig's slice (array_slice), except when $end is positive
        if ($end >= 1)
        {
            // When end is > 1, subset will end on the last item in an array with the specified $end
            // This is different from slice in that it is the number we end on rather than the number
            //  of items to grab (length)
            // Start must always be the actual starting number for this calculation (not negative)
            $start = ($start < 0) ? count($item) + $start : $start;
            $end = $end - $start;
        }
        // We always include the last element (this was the past design)
        $end = ($end == -1 || $end === null) ? null : $end + 1;
        return twig_slice($env, $item, $start, $end, $preserveKeys);
    }
    /**
    * Get output for a language variable (L_FOO, LA_FOO)
    *
    * This function checks to see if the language var was outputted to $context
    * (e.g. in the ACP, L_TITLE)
    * If not, we return the result of $user->lang()
    *
    * @return string
    */
    public function lang()
    {
        $args = func_get_args();
        $key = $args[0];
        $context_vars = $this->context->get_root_ref();
        if (is_string($key) && isset($context_vars['L_' . $key]))
        {
            return $context_vars['L_' . $key];
        }
        // LA_ is transformed into lang(\'$1\')|escape('js'), so we should not
        // need to check for it
        return call_user_func_array(array($this->language, 'lang'), $args);
    }
    /**
     * Check if a language variable exists
     *
     * @return bool
     */
    public function lang_defined($key)
    {
        return call_user_func_array([$this->language, 'is_set'], [$key]);
    }
    /**
     * Get output for language variable in JS code
     *
     * @throws RuntimeError When data passed to twig_escape_filter is not a UTF8 string
     */
    public function lang_js(): string
    {
        $args = func_get_args();
        return twig_escape_filter($this->environment, call_user_func_array([$this, 'lang'], $args), 'js');
    }
}