symfony API

sfOutputEscaperGetterDecorator Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.2 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.2 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

Abstract output escaping decorator class for "getter" objects.

Inheritence

sfOutputEscaperArrayDecorator, sfOutputEscaperObjectDecorator  <  sfOutputEscaperGetterDecorator  <  sfOutputEscaper

Method Summary

  • mixed get($key, $escapingMethod = null)
    Returns the escaped value associated with the key supplied.
  • mixed getRaw($key)
    Returns the raw, unescaped value associated with the key supplied.

Methods inherited from sfOutputEscaper

escape , getRawValue , isClassMarkedAsSafe , markClassAsSafe , markClassesAsSafe , unescape , __construct , __get

Method Details

  • (mixed) get ($key, $escapingMethod = null) Browse code

    $key The key to retieve
    $escapingMethod The escaping method (a PHP function) to use

    Returns the escaped value associated with the key supplied.


    Typically (using this implementation) the raw value is obtained using the getRaw method, escaped and the result returned.

    returns The escaped value

  • (mixed) getRaw ($key) Browse code

    $key The key to retrieve

    Returns the raw, unescaped value associated with the key supplied.


    The key might be an index into an array or a value to be passed to the decorated object's get() method.

    returns The value