Twig_Extension_Core Class Reference

More...

Inheritance diagram for Twig_Extension_Core:

Collaboration diagram for Twig_Extension_Core:

Public Member Functions
	setEscaper ($strategy, $callable)
	Defines a new escaper to be used via the escape filter. More...
	getEscapers ()
	Gets all defined escapers. More...
	setDateFormat ($format=null, $dateIntervalFormat=null)
	Sets the default format to be used by the date filter. More...
	getDateFormat ()
	Gets the default format to be used by the date filter. More...
	setTimezone ($timezone)
	Sets the default timezone to be used by the date filter. More...
	getTimezone ()
	Gets the default timezone to be used by the date filter. More...
	setNumberFormat ($decimal, $decimalPoint, $thousandSep)
	Sets the default format to be used by the number_format filter. More...
	getNumberFormat ()
	Get the default format used by the number_format filter. More...
	getTokenParsers ()
	Returns the token parser instances to add to the existing list. More...
	getFilters ()
	Returns a list of filters to add to the existing list. More...
	getFunctions ()
	Returns a list of functions to add to the existing list. More...
	getTests ()
	Returns a list of tests to add to the existing list. More...
	getOperators ()
	Returns a list of operators to add to the existing list. More...
	getName ()
	Returns the name of the extension. More...
Public Member Functions inherited from Twig_Extension
	initRuntime (Twig_Environment $environment)
	getTokenParsers ()
	Returns the token parser instances to add to the existing list. More...
	getNodeVisitors ()
	Returns the node visitor instances to add to the existing list. More...
	getFilters ()
	Returns a list of filters to add to the existing list. More...
	getTests ()
	Returns a list of tests to add to the existing list. More...
	getFunctions ()
	Returns a list of functions to add to the existing list. More...
	getOperators ()
	Returns a list of operators to add to the existing list. More...
	getGlobals ()
	getName ()

Protected Attributes
	$dateFormats = array('F j, Y H:i', '%d days')
	$numberFormat = array(0, '.', ',')
	$timezone = null
	$escapers = array()

Detailed Description

Definition at line 19 of file Core.php.

Member Function Documentation

getDateFormat()

Twig_Extension_Core::getDateFormat

(

)

Gets the default format to be used by the date filter.

Returns

array The default date format string and the default date interval format string

Definition at line 69 of file Core.php.

References $dateFormats.

    {
        return $this->dateFormats;
    }

getEscapers()

Twig_Extension_Core::getEscapers

(

)

Gets all defined escapers.

Returns

array An array of escapers

Definition at line 42 of file Core.php.

References $escapers.

    {
        return $this->escapers;
    }

getFilters()

Twig_Extension_Core::getFilters

(

)

Returns a list of filters to add to the existing list.

Returns

Twig_SimpleFilter[]

Implements Twig_ExtensionInterface.

Definition at line 142 of file Core.php.

References array.

    {
        $filters = array(
            // formatting filters
            new Twig_SimpleFilter('date', 'twig_date_format_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('date_modify', 'twig_date_modify_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('format', 'sprintf'),
            new Twig_SimpleFilter('replace', 'twig_replace_filter'),
            new Twig_SimpleFilter('number_format', 'twig_number_format_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('abs', 'abs'),
            new Twig_SimpleFilter('round', 'twig_round'),

            // encoding
            new Twig_SimpleFilter('url_encode', 'twig_urlencode_filter'),
            new Twig_SimpleFilter('json_encode', 'twig_jsonencode_filter'),
            new Twig_SimpleFilter('convert_encoding', 'twig_convert_encoding'),

            // string filters
            new Twig_SimpleFilter('title', 'twig_title_string_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('capitalize', 'twig_capitalize_string_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('upper', 'strtoupper'),
            new Twig_SimpleFilter('lower', 'strtolower'),
            new Twig_SimpleFilter('striptags', 'strip_tags'),
            new Twig_SimpleFilter('trim', 'twig_trim_filter'),
            new Twig_SimpleFilter('nl2br', 'nl2br', array('pre_escape' => 'html', 'is_safe' => array('html'))),

            // array helpers
            new Twig_SimpleFilter('join', 'twig_join_filter'),
            new Twig_SimpleFilter('split', 'twig_split_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('sort', 'twig_sort_filter'),
            new Twig_SimpleFilter('merge', 'twig_array_merge'),
            new Twig_SimpleFilter('batch', 'twig_array_batch'),

            // string/array filters
            new Twig_SimpleFilter('reverse', 'twig_reverse_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('length', 'twig_length_filter', array('needs_environment' => true)),
            new Twig_SimpleFilter('slice', 'twig_slice', array('needs_environment' => true)),
            new Twig_SimpleFilter('first', 'twig_first', array('needs_environment' => true)),
            new Twig_SimpleFilter('last', 'twig_last', array('needs_environment' => true)),

            // iteration and runtime
            new Twig_SimpleFilter('default', '_twig_default_filter', array('node_class' => 'Twig_Node_Expression_Filter_Default')),
            new Twig_SimpleFilter('keys', 'twig_get_array_keys_filter'),

            // escaping
            new Twig_SimpleFilter('escape', 'twig_escape_filter', array('needs_environment' => true, 'is_safe_callback' => 'twig_escape_filter_is_safe')),
            new Twig_SimpleFilter('e', 'twig_escape_filter', array('needs_environment' => true, 'is_safe_callback' => 'twig_escape_filter_is_safe')),
        );

        if (function_exists('mb_get_info')) {
            $filters[] = new Twig_SimpleFilter('upper', 'twig_upper_filter', array('needs_environment' => true));
            $filters[] = new Twig_SimpleFilter('lower', 'twig_lower_filter', array('needs_environment' => true));
        }

        return $filters;
    }

getFunctions()

Twig_Extension_Core::getFunctions

(

)

Returns a list of functions to add to the existing list.

Returns

Twig_SimpleFunction[]

Implements Twig_ExtensionInterface.

Definition at line 199 of file Core.php.

References array.

    {
        return array(
            new Twig_SimpleFunction('max', 'max'),
            new Twig_SimpleFunction('min', 'min'),
            new Twig_SimpleFunction('range', 'range'),
            new Twig_SimpleFunction('constant', 'twig_constant'),
            new Twig_SimpleFunction('cycle', 'twig_cycle'),
            new Twig_SimpleFunction('random', 'twig_random', array('needs_environment' => true)),
            new Twig_SimpleFunction('date', 'twig_date_converter', array('needs_environment' => true)),
            new Twig_SimpleFunction('include', 'twig_include', array('needs_environment' => true, 'needs_context' => true, 'is_safe' => array('all'))),
            new Twig_SimpleFunction('source', 'twig_source', array('needs_environment' => true, 'is_safe' => array('all'))),
        );
    }

getName()

Twig_Extension_Core::getName

(

)

Returns the name of the extension.

Returns

string The extension name

Deprecated:

since 1.26 (to be removed in 2.0), not used anymore internally

Implements Twig_ExtensionInterface.

Definition at line 273 of file Core.php.

    {
        return 'core';
    }

getNumberFormat()

Twig_Extension_Core::getNumberFormat

(

)

Get the default format used by the number_format filter.

Returns

array The arguments for number_format()

Definition at line 115 of file Core.php.

References $numberFormat.

    {
        return $this->numberFormat;
    }

getOperators()

Twig_Extension_Core::getOperators

(

)

Returns a list of operators to add to the existing list.

Returns

array<array> First array of unary operators, second array of binary operators

Implements Twig_ExtensionInterface.

Definition at line 232 of file Core.php.

References array, Twig_ExpressionParser\OPERATOR_LEFT, and Twig_ExpressionParser\OPERATOR_RIGHT.

    {
        return array(
            array(
                'not' => array('precedence' => 50, 'class' => 'Twig_Node_Expression_Unary_Not'),
                '-' => array('precedence' => 500, 'class' => 'Twig_Node_Expression_Unary_Neg'),
                '+' => array('precedence' => 500, 'class' => 'Twig_Node_Expression_Unary_Pos'),
            ),
            array(
                'or' => array('precedence' => 10, 'class' => 'Twig_Node_Expression_Binary_Or', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'and' => array('precedence' => 15, 'class' => 'Twig_Node_Expression_Binary_And', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'b-or' => array('precedence' => 16, 'class' => 'Twig_Node_Expression_Binary_BitwiseOr', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'b-xor' => array('precedence' => 17, 'class' => 'Twig_Node_Expression_Binary_BitwiseXor', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'b-and' => array('precedence' => 18, 'class' => 'Twig_Node_Expression_Binary_BitwiseAnd', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '==' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Equal', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '!=' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_NotEqual', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '<' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Less', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '>' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Greater', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '>=' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_GreaterEqual', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '<=' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_LessEqual', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'not in' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_NotIn', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'in' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_In', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'matches' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_Matches', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'starts with' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_StartsWith', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'ends with' => array('precedence' => 20, 'class' => 'Twig_Node_Expression_Binary_EndsWith', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '..' => array('precedence' => 25, 'class' => 'Twig_Node_Expression_Binary_Range', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '+' => array('precedence' => 30, 'class' => 'Twig_Node_Expression_Binary_Add', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '-' => array('precedence' => 30, 'class' => 'Twig_Node_Expression_Binary_Sub', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '~' => array('precedence' => 40, 'class' => 'Twig_Node_Expression_Binary_Concat', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '*' => array('precedence' => 60, 'class' => 'Twig_Node_Expression_Binary_Mul', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '/' => array('precedence' => 60, 'class' => 'Twig_Node_Expression_Binary_Div', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '//' => array('precedence' => 60, 'class' => 'Twig_Node_Expression_Binary_FloorDiv', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '%' => array('precedence' => 60, 'class' => 'Twig_Node_Expression_Binary_Mod', 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'is' => array('precedence' => 100, 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                'is not' => array('precedence' => 100, 'associativity' => Twig_ExpressionParser::OPERATOR_LEFT),
                '**' => array('precedence' => 200, 'class' => 'Twig_Node_Expression_Binary_Power', 'associativity' => Twig_ExpressionParser::OPERATOR_RIGHT),
                '??' => array('precedence' => 300, 'class' => 'Twig_Node_Expression_NullCoalesce', 'associativity' => Twig_ExpressionParser::OPERATOR_RIGHT),
            ),
        );
    }

getTests()

Twig_Extension_Core::getTests

(

)

Returns a list of tests to add to the existing list.

Returns

Twig_SimpleTest[]

Implements Twig_ExtensionInterface.

Definition at line 214 of file Core.php.

References array.

    {
        return array(
            new Twig_SimpleTest('even', null, array('node_class' => 'Twig_Node_Expression_Test_Even')),
            new Twig_SimpleTest('odd', null, array('node_class' => 'Twig_Node_Expression_Test_Odd')),
            new Twig_SimpleTest('defined', null, array('node_class' => 'Twig_Node_Expression_Test_Defined')),
            new Twig_SimpleTest('sameas', null, array('node_class' => 'Twig_Node_Expression_Test_Sameas', 'deprecated' => '1.21', 'alternative' => 'same as')),
            new Twig_SimpleTest('same as', null, array('node_class' => 'Twig_Node_Expression_Test_Sameas')),
            new Twig_SimpleTest('none', null, array('node_class' => 'Twig_Node_Expression_Test_Null')),
            new Twig_SimpleTest('null', null, array('node_class' => 'Twig_Node_Expression_Test_Null')),
            new Twig_SimpleTest('divisibleby', null, array('node_class' => 'Twig_Node_Expression_Test_Divisibleby', 'deprecated' => '1.21', 'alternative' => 'divisible by')),
            new Twig_SimpleTest('divisible by', null, array('node_class' => 'Twig_Node_Expression_Test_Divisibleby')),
            new Twig_SimpleTest('constant', null, array('node_class' => 'Twig_Node_Expression_Test_Constant')),
            new Twig_SimpleTest('empty', 'twig_test_empty'),
            new Twig_SimpleTest('iterable', 'twig_test_iterable'),
        );
    }

getTimezone()

Twig_Extension_Core::getTimezone

(

)

Gets the default timezone to be used by the date filter.

Returns

DateTimeZone The default timezone currently in use

Definition at line 89 of file Core.php.

References $timezone, and timezone.

    {
        if (null === $this->timezone) {
            $this->timezone = new DateTimeZone(date_default_timezone_get());
        }

        return $this->timezone;
    }

getTokenParsers()

Twig_Extension_Core::getTokenParsers

(

)

Returns the token parser instances to add to the existing list.

Returns

Twig_TokenParserInterface[]

Implements Twig_ExtensionInterface.

Definition at line 120 of file Core.php.

References array.

    {
        return array(
            new Twig_TokenParser_For(),
            new Twig_TokenParser_If(),
            new Twig_TokenParser_Extends(),
            new Twig_TokenParser_Include(),
            new Twig_TokenParser_Block(),
            new Twig_TokenParser_Use(),
            new Twig_TokenParser_Filter(),
            new Twig_TokenParser_Macro(),
            new Twig_TokenParser_Import(),
            new Twig_TokenParser_From(),
            new Twig_TokenParser_Set(),
            new Twig_TokenParser_Spaceless(),
            new Twig_TokenParser_Flush(),
            new Twig_TokenParser_Do(),
            new Twig_TokenParser_Embed(),
            new Twig_TokenParser_With(),
        );
    }

setDateFormat()

Twig_Extension_Core::setDateFormat	(		$format = null,
			$dateIntervalFormat = null
	)

Sets the default format to be used by the date filter.

Parameters

string	$format	The default date format string
string	$dateIntervalFormat	The default date interval format string

Definition at line 53 of file Core.php.

References $format.

    {
        if (null !== $format) {
            $this->dateFormats[0] = $format;
        }

        if (null !== $dateIntervalFormat) {
            $this->dateFormats[1] = $dateIntervalFormat;
        }
    }

setEscaper()

Twig_Extension_Core::setEscaper	(		$strategy,
			$callable
	)

Defines a new escaper to be used via the escape filter.

Parameters

string	$strategy	The strategy name that should be used as a strategy in the escape call
callable	$callable	A valid PHP callable

Definition at line 32 of file Core.php.

    {
        $this->escapers[$strategy] = $callable;
    }

setNumberFormat()

Twig_Extension_Core::setNumberFormat	(		$decimal,
			$decimalPoint,
			$thousandSep
	)

Sets the default format to be used by the number_format filter.

Parameters

int	$decimal	the number of decimal places to use
string	$decimalPoint	the character(s) to use for the decimal point
string	$thousandSep	the character(s) to use for the thousands separator

Definition at line 105 of file Core.php.

References array.

    {
        $this->numberFormat = array($decimal, $decimalPoint, $thousandSep);
    }

setTimezone()

Twig_Extension_Core::setTimezone

(

$timezone

)

Sets the default timezone to be used by the date filter.

Parameters

DateTimeZone | string

$timezone

The default timezone string or a DateTimeZone object

Definition at line 79 of file Core.php.

References $timezone, and timezone.

    {
        $this->timezone = $timezone instanceof DateTimeZone ? $timezone : new DateTimeZone($timezone);
    }

Field Documentation

$dateFormats

Twig_Extension_Core::$dateFormats = array('F j, Y H:i', '%d days')

protected

Definition at line 21 of file Core.php.

Referenced by getDateFormat().

$escapers

Twig_Extension_Core::$escapers = array()

protected

Definition at line 24 of file Core.php.

Referenced by getEscapers().

$numberFormat

Twig_Extension_Core::$numberFormat = array(0, '.', ',')

protected

Definition at line 22 of file Core.php.

Referenced by getNumberFormat().

$timezone

Twig_Extension_Core::$timezone = null

protected

Definition at line 23 of file Core.php.

Referenced by getTimezone(), setTimezone(), twig_date_converter(), and twig_date_format_filter().

---

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

• libs/composer/vendor/twig/twig/lib/Twig/Extension/Core.php