Twig_Extension_Sandbox Class Reference

@final More...

Inheritance diagram for Twig_Extension_Sandbox:

Collaboration diagram for Twig_Extension_Sandbox:

Public Member Functions
	__construct (Twig_Sandbox_SecurityPolicyInterface $policy, $sandboxed=false)
	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...
	enableSandbox ()
	disableSandbox ()
	isSandboxed ()
	isSandboxedGlobally ()
	setSecurityPolicy (Twig_Sandbox_SecurityPolicyInterface $policy)
	getSecurityPolicy ()
	checkSecurity ($tags, $filters, $functions)
	checkMethodAllowed ($obj, $method)
	checkPropertyAllowed ($obj, $method)
	ensureToStringAllowed ($obj)
	getName ()
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 ()
	initRuntime (Twig_Environment $environment)
	Initializes the runtime environment. More...
	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 ()
	Returns a list of global variables to add to the existing list. More...
	getName ()
	Returns the name of the extension. More...

Protected Attributes
	$sandboxedGlobally
	$sandboxed
	$policy

Detailed Description

@final

Definition at line 15 of file Sandbox.php.

Constructor & Destructor Documentation

__construct()

Twig_Extension_Sandbox::__construct	(	Twig_Sandbox_SecurityPolicyInterface	$policy,
			$sandboxed = false
	)

Definition at line 21 of file Sandbox.php.

    {
        $this->policy = $policy;
        $this->sandboxedGlobally = $sandboxed;
    }

References $policy, and $sandboxed.

Member Function Documentation

checkMethodAllowed()

Twig_Extension_Sandbox::checkMethodAllowed	(		$obj,
			$method
	)

Definition at line 74 of file Sandbox.php.

    {
        if ($this->isSandboxed()) {
            $this->policy->checkMethodAllowed($obj, $method);
        }
    }

References isSandboxed().

Here is the call graph for this function:

checkPropertyAllowed()

Twig_Extension_Sandbox::checkPropertyAllowed	(		$obj,
			$method
	)

Definition at line 81 of file Sandbox.php.

    {
        if ($this->isSandboxed()) {
            $this->policy->checkPropertyAllowed($obj, $method);
        }
    }

References isSandboxed().

Here is the call graph for this function:

checkSecurity()

Twig_Extension_Sandbox::checkSecurity	(		$tags,
			$filters,
			$functions
	)

Definition at line 67 of file Sandbox.php.

    {
        if ($this->isSandboxed()) {
            $this->policy->checkSecurity($tags, $filters, $functions);
        }
    }

References $tags, and isSandboxed().

Here is the call graph for this function:

disableSandbox()

Twig_Extension_Sandbox::disableSandbox

(

)

Definition at line 42 of file Sandbox.php.

    {
        $this->sandboxed = false;
    }

enableSandbox()

Twig_Extension_Sandbox::enableSandbox

(

)

Definition at line 37 of file Sandbox.php.

    {
        $this->sandboxed = true;
    }

ensureToStringAllowed()

Twig_Extension_Sandbox::ensureToStringAllowed

(

$obj

)

Definition at line 88 of file Sandbox.php.

    {
        if ($this->isSandboxed() && is_object($obj)) {
            $this->policy->checkMethodAllowed($obj, '__toString');
        }
 
        return $obj;
    }

References isSandboxed().

Here is the call graph for this function:

getName()

Twig_Extension_Sandbox::getName

(

)

Deprecated:

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

Reimplemented from Twig_Extension.

Definition at line 97 of file Sandbox.php.

    {
        return 'sandbox';
    }

getNodeVisitors()

Twig_Extension_Sandbox::getNodeVisitors

(

)

Returns the node visitor instances to add to the existing list.

Returns

Twig_NodeVisitorInterface[]

Reimplemented from Twig_Extension.

Definition at line 32 of file Sandbox.php.

    {
        return array(new Twig_NodeVisitor_Sandbox());
    }

getSecurityPolicy()

Twig_Extension_Sandbox::getSecurityPolicy

(

)

Definition at line 62 of file Sandbox.php.

    {
        return $this->policy;
    }

References $policy.

getTokenParsers()

Twig_Extension_Sandbox::getTokenParsers

(

)

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

Returns

Twig_TokenParserInterface[]

Reimplemented from Twig_Extension.

Definition at line 27 of file Sandbox.php.

    {
        return array(new Twig_TokenParser_Sandbox());
    }

isSandboxed()

Twig_Extension_Sandbox::isSandboxed

(

)

Definition at line 47 of file Sandbox.php.

    {
        return $this->sandboxedGlobally || $this->sandboxed;
    }

References $sandboxed.

Referenced by checkMethodAllowed(), checkPropertyAllowed(), checkSecurity(), and ensureToStringAllowed().

Here is the caller graph for this function:

isSandboxedGlobally()

Twig_Extension_Sandbox::isSandboxedGlobally

(

)

Definition at line 52 of file Sandbox.php.

    {
        return $this->sandboxedGlobally;
    }

References $sandboxedGlobally.

setSecurityPolicy()

Twig_Extension_Sandbox::setSecurityPolicy

(

Twig_Sandbox_SecurityPolicyInterface

$policy

)

Definition at line 57 of file Sandbox.php.

    {
        $this->policy = $policy;
    }

References $policy.

Field Documentation

$policy

Twig_Extension_Sandbox::$policy

protected

Definition at line 19 of file Sandbox.php.

Referenced by __construct(), getSecurityPolicy(), and setSecurityPolicy().

$sandboxed

Twig_Extension_Sandbox::$sandboxed

protected

Definition at line 18 of file Sandbox.php.

Referenced by __construct(), and isSandboxed().

$sandboxedGlobally

Twig_Extension_Sandbox::$sandboxedGlobally

protected

Definition at line 17 of file Sandbox.php.

Referenced by isSandboxedGlobally().

---

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

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