Twig_Function Class Reference

Represents a template function. More...

Inheritance diagram for Twig_Function:

Collaboration diagram for Twig_Function:

Public Member Functions
	__construct (array $options=array())
	setArguments ($arguments)
	getArguments ()
	needsEnvironment ()
	needsContext ()
	getSafe (Twig_Node $functionArgs)
	getCallable ()
Public Member Functions inherited from Twig_FunctionInterface
	compile ()
	Compiles a function. More...
	needsEnvironment ()
	needsContext ()
	getSafe (Twig_Node $filterArgs)
	setArguments ($arguments)
	getArguments ()
	getCallable ()

Protected Attributes
	$options
	$arguments = array()

Detailed Description

Represents a template function.

Use Twig_SimpleFunction 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 Function.php.

Constructor & Destructor Documentation

__construct()

Twig_Function::__construct

(

array

$options = array()

)

Definition at line 28 of file Function.php.

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

References $options.

Member Function Documentation

getArguments()

Twig_Function::getArguments

(

)

Implements Twig_FunctionInterface.

Definition at line 42 of file Function.php.

    {
        return $this->arguments;
    }

References $arguments.

getCallable()

Twig_Function::getCallable

(

)

Implements Twig_FunctionCallableInterface.

Definition at line 70 of file Function.php.

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

getSafe()

Twig_Function::getSafe

(

Twig_Node

$functionArgs

)

Implements Twig_FunctionInterface.

Definition at line 57 of file Function.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'], $functionArgs);
        }
 
        return array();
    }

needsContext()

Twig_Function::needsContext

(

)

Implements Twig_FunctionInterface.

Definition at line 52 of file Function.php.

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

needsEnvironment()

Twig_Function::needsEnvironment

(

)

Implements Twig_FunctionInterface.

Definition at line 47 of file Function.php.

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

setArguments()

Twig_Function::setArguments

(

$arguments

)

Implements Twig_FunctionInterface.

Definition at line 37 of file Function.php.

    {
        $this->arguments = $arguments;
    }

References $arguments.

Field Documentation

$arguments

Twig_Function::$arguments = array()

protected

Definition at line 26 of file Function.php.

Referenced by getArguments(), and setArguments().

$options

Twig_Function::$options

protected

Definition at line 25 of file Function.php.

Referenced by Twig_Function_Node\__construct(), Twig_Function_Function\__construct(), __construct(), and Twig_Function_Method\__construct().

---

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

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