class Twig_Extension_Escaper in Translation template extractor 6.3

Hierarchy

• class \Twig_Extension implements Twig_ExtensionInterface
  • class \Twig_Extension_Escaper

File

vendor/Twig/Extension/Escaper.php, line 11

class Twig_Extension_Escaper extends Twig_Extension {
  protected $defaultStrategy;
  public function __construct($defaultStrategy = 'html') {
    $this
      ->setDefaultStrategy($defaultStrategy);
  }

  /**
   * Returns the token parser instances to add to the existing list.
   *
   * @return array An array of Twig_TokenParserInterface or Twig_TokenParserBrokerInterface instances
   */
  public function getTokenParsers() {
    return array(
      new Twig_TokenParser_AutoEscape(),
    );
  }

  /**
   * Returns the node visitor instances to add to the existing list.
   *
   * @return Twig_NodeVisitorInterface[] An array of Twig_NodeVisitorInterface instances
   */
  public function getNodeVisitors() {
    return array(
      new Twig_NodeVisitor_Escaper(),
    );
  }

  /**
   * Returns a list of filters to add to the existing list.
   *
   * @return array An array of filters
   */
  public function getFilters() {
    return array(
      new Twig_SimpleFilter('raw', 'twig_raw_filter', array(
        'is_safe' => array(
          'all',
        ),
      )),
    );
  }

  /**
   * Sets the default strategy to use when not defined by the user.
   *
   * The strategy can be a valid PHP callback that takes the template
   * "filename" as an argument and returns the strategy to use.
   *
   * @param mixed $defaultStrategy An escaping strategy
   */
  public function setDefaultStrategy($defaultStrategy) {

    // for BC
    if (true === $defaultStrategy) {
      $defaultStrategy = 'html';
    }
    $this->defaultStrategy = $defaultStrategy;
  }

  /**
   * Gets the default strategy to use when not defined by the user.
   *
   * @param string $filename The template "filename"
   *
   * @return string The default strategy to use for the template
   */
  public function getDefaultStrategy($filename) {

    // disable string callables to avoid calling a function named html or js,
    // or any other upcoming escaping strategy
    if (!is_string($this->defaultStrategy) && is_callable($this->defaultStrategy)) {
      return call_user_func($this->defaultStrategy, $filename);
    }
    return $this->defaultStrategy;
  }

  /**
   * Returns the name of the extension.
   *
   * @return string The extension name
   */
  public function getName() {
    return 'escaper';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Twig_Extension::getFunctions	public	function	Returns a list of functions to add to the existing list. Overrides Twig_ExtensionInterface::getFunctions	4
Twig_Extension::getGlobals	public	function	Returns a list of global variables to add to the existing list. Overrides Twig_ExtensionInterface::getGlobals	1
Twig_Extension::getOperators	public	function	Returns a list of operators to add to the existing list. Overrides Twig_ExtensionInterface::getOperators	1
Twig_Extension::getTests	public	function	Returns a list of tests to add to the existing list. Overrides Twig_ExtensionInterface::getTests	2
Twig_Extension::initRuntime	public	function	Initializes the runtime environment. Overrides Twig_ExtensionInterface::initRuntime
Twig_Extension_Escaper::$defaultStrategy	protected	property
Twig_Extension_Escaper::getDefaultStrategy	public	function	Gets the default strategy to use when not defined by the user.
Twig_Extension_Escaper::getFilters	public	function	Returns a list of filters to add to the existing list. Overrides Twig_Extension::getFilters
Twig_Extension_Escaper::getName	public	function	Returns the name of the extension. Overrides Twig_ExtensionInterface::getName
Twig_Extension_Escaper::getNodeVisitors	public	function	Returns the node visitor instances to add to the existing list. Overrides Twig_Extension::getNodeVisitors
Twig_Extension_Escaper::getTokenParsers	public	function	Returns the token parser instances to add to the existing list. Overrides Twig_Extension::getTokenParsers
Twig_Extension_Escaper::setDefaultStrategy	public	function	Sets the default strategy to use when not defined by the user.
Twig_Extension_Escaper::__construct	public	function