Twig_SimpleFilter Class Reference

Represents a template filter. More...

Collaboration diagram for Twig_SimpleFilter:

Public Member Functions
	__construct ($name, $callable, array $options=array())
	getName ()
	getCallable ()
	getNodeClass ()
	setArguments ($arguments)
	getArguments ()
	needsEnvironment ()
	needsContext ()
	getSafe (Twig_Node $filterArgs)
	getPreservesSafety ()
	getPreEscape ()
	isVariadic ()
	isDeprecated ()
	getDeprecatedVersion ()
	getAlternative ()

Protected Attributes
	$name
	$callable
	$options
	$arguments = array()

Detailed Description

Represents a template filter.

@final

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Definition at line 19 of file SimpleFilter.php.

Constructor & Destructor Documentation

__construct()

Twig_SimpleFilter::__construct	(		$name,
			$callable,
		array	$options = array()
	)

Definition at line 26 of file SimpleFilter.php.

    {
        $this->name = $name;
        $this->callable = $callable;
        $this->options = array_merge(array(
            'needs_environment' => false,
            'needs_context' => false,
            'is_variadic' => false,
            'is_safe' => null,
            'is_safe_callback' => null,
            'pre_escape' => null,
            'preserves_safety' => null,
            'node_class' => 'Twig_Node_Expression_Filter',
            'deprecated' => false,
            'alternative' => null,
        ), $options);
    }

References $callable, $name, and $options.

Member Function Documentation

getAlternative()

Twig_SimpleFilter::getAlternative

(

)

Definition at line 115 of file SimpleFilter.php.

    {
        return $this->options['alternative'];
    }

getArguments()

Twig_SimpleFilter::getArguments

(

)

Definition at line 64 of file SimpleFilter.php.

    {
        return $this->arguments;
    }

References $arguments.

getCallable()

Twig_SimpleFilter::getCallable

(

)

Definition at line 49 of file SimpleFilter.php.

    {
        return $this->callable;
    }

References $callable.

getDeprecatedVersion()

Twig_SimpleFilter::getDeprecatedVersion

(

)

Definition at line 110 of file SimpleFilter.php.

    {
        return $this->options['deprecated'];
    }

getName()

Twig_SimpleFilter::getName

(

)

Definition at line 44 of file SimpleFilter.php.

    {
        return $this->name;
    }

References $name.

getNodeClass()

Twig_SimpleFilter::getNodeClass

(

)

Definition at line 54 of file SimpleFilter.php.

    {
        return $this->options['node_class'];
    }

getPreEscape()

Twig_SimpleFilter::getPreEscape

(

)

Definition at line 95 of file SimpleFilter.php.

    {
        return $this->options['pre_escape'];
    }

getPreservesSafety()

Twig_SimpleFilter::getPreservesSafety

(

)

Definition at line 90 of file SimpleFilter.php.

    {
        return $this->options['preserves_safety'];
    }

getSafe()

Twig_SimpleFilter::getSafe

(

Twig_Node

$filterArgs

)

Definition at line 79 of file SimpleFilter.php.

    {
        if (null !== $this->options['is_safe']) {
            return $this->options['is_safe'];
        }
 
        if (null !== $this->options['is_safe_callback']) {
            return call_user_func($this->options['is_safe_callback'], $filterArgs);
        }
    }

isDeprecated()

Twig_SimpleFilter::isDeprecated

(

)

Definition at line 105 of file SimpleFilter.php.

    {
        return (bool) $this->options['deprecated'];
    }

Referenced by Twig_ExpressionParser\getFilterNodeClass().

Here is the caller graph for this function:

isVariadic()

Twig_SimpleFilter::isVariadic

(

)

Definition at line 100 of file SimpleFilter.php.

    {
        return $this->options['is_variadic'];
    }

needsContext()

Twig_SimpleFilter::needsContext

(

)

Definition at line 74 of file SimpleFilter.php.

    {
        return $this->options['needs_context'];
    }

needsEnvironment()

Twig_SimpleFilter::needsEnvironment

(

)

Definition at line 69 of file SimpleFilter.php.

    {
        return $this->options['needs_environment'];
    }

setArguments()

Twig_SimpleFilter::setArguments

(

$arguments

)

Definition at line 59 of file SimpleFilter.php.

    {
        $this->arguments = $arguments;
    }

References $arguments.

Field Documentation

$arguments

Twig_SimpleFilter::$arguments = array()

protected

Definition at line 24 of file SimpleFilter.php.

Referenced by getArguments(), and setArguments().

$callable

Twig_SimpleFilter::$callable

protected

Definition at line 22 of file SimpleFilter.php.

Referenced by __construct(), and getCallable().

$name

Twig_SimpleFilter::$name

protected

Definition at line 21 of file SimpleFilter.php.

Referenced by __construct(), and getName().

$options

Twig_SimpleFilter::$options

protected

Definition at line 23 of file SimpleFilter.php.

Referenced by __construct().

---

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

• libs/composer/vendor/twig/twig/lib/Twig/SimpleFilter.php