Twig_Filter Class Reference

Represents a template filter. More...

Inheritance diagram for Twig_Filter:

Collaboration diagram for Twig_Filter:

Public Member Functions
	__construct (array $options=array())
	setArguments ($arguments)
	getArguments ()
	needsEnvironment ()
	needsContext ()
	getSafe (Twig_Node $filterArgs)
	getPreservesSafety ()
	getPreEscape ()
	getCallable ()
Public Member Functions inherited from Twig_FilterInterface
	compile ()
	Compiles a filter. More...

Protected Attributes
	$options
	$arguments = array()

Detailed Description

Represents a template filter.

Use Twig_SimpleFilter instead.

Author

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

Deprecated:

since 1.12 (to be removed in 2.0)

Definition at line 23 of file Filter.php.

Constructor & Destructor Documentation

__construct()

Twig_Filter::__construct

(

array

$options = array()

)

Definition at line 28 of file Filter.php.

References $options, and array.

    {
        $this->options = array_merge(array(
            'needs_environment' => false,
            'needs_context' => false,
            'pre_escape' => null,
            'preserves_safety' => null,
            'callable' => null,
        ), $options);
    }

Member Function Documentation

getArguments()

Twig_Filter::getArguments

(

)

Implements Twig_FilterInterface.

Definition at line 44 of file Filter.php.

References $arguments.

    {
        return $this->arguments;
    }

getCallable()

Twig_Filter::getCallable

(

)

Implements Twig_FilterCallableInterface.

Definition at line 80 of file Filter.php.

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

getPreEscape()

Twig_Filter::getPreEscape

(

)

Implements Twig_FilterInterface.

Definition at line 75 of file Filter.php.

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

getPreservesSafety()

Twig_Filter::getPreservesSafety

(

)

Implements Twig_FilterInterface.

Definition at line 70 of file Filter.php.

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

getSafe()

Twig_Filter::getSafe

(

Twig_Node

$filterArgs

)

Implements Twig_FilterInterface.

Definition at line 59 of file Filter.php.

    {
        if (isset($this->options['is_safe'])) {
            return $this->options['is_safe'];
        }

        if (isset($this->options['is_safe_callback'])) {
            return call_user_func($this->options['is_safe_callback'], $filterArgs);
        }
    }

needsContext()

Twig_Filter::needsContext

(

)

Implements Twig_FilterInterface.

Definition at line 54 of file Filter.php.

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

needsEnvironment()

Twig_Filter::needsEnvironment

(

)

Implements Twig_FilterInterface.

Definition at line 49 of file Filter.php.

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

setArguments()

Twig_Filter::setArguments

(

$arguments

)

Implements Twig_FilterInterface.

Definition at line 39 of file Filter.php.

References $arguments.

    {
        $this->arguments = $arguments;
    }

Field Documentation

$arguments

Twig_Filter::$arguments = array()

protected

Definition at line 26 of file Filter.php.

Referenced by getArguments(), and setArguments().

$options

Twig_Filter::$options

protected

Definition at line 25 of file Filter.php.

Referenced by Twig_Filter_Node\__construct(), Twig_Filter_Function\__construct(), Twig_Filter_Method\__construct(), and __construct().

---

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

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