symfony API

sfOutputEscaperArrayDecorator 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.

Output escaping decorator class for arrays.

Inheritence

sfOutputEscaperArrayDecorator  <  sfOutputEscaperGetterDecorator < sfOutputEscaper

Method Summary

  • int count()
    Returns the size of the array (are required by the Countable interface).
  • mixed current()
    Escapes and return the current value (as required by the Iterator interface).
  • mixed getRaw($key)
    Returns the (unescaped) value from the array associated with the key supplied.
  • string key()
    Get the key associated with the current value (as required by the Iterator interface).
  • next()
    Moves to the next element (as required by the Iterator interface).
  • bool offsetExists($offset)
    Returns true if the supplied offset isset in the array (as required by the ArrayAccess interface).
  • mixed offsetGet($offset)
    Returns the element associated with the offset supplied (as required by the ArrayAccess interface).
  • offsetSet($offset, $value)
    Throws an exception saying that values cannot be set (this method is required for the ArrayAccess interface).
  • offsetUnset($offset)
    Throws an exception saying that values cannot be unset (this method is required for the ArrayAccess interface).
  • rewind()
    Reset the array to the beginning (as required for the Iterator interface).
  • bool valid()
    Returns true if the current element is valid (as required by the Iterator interface).

Methods inherited from sfOutputEscaperGetterDecorator

get , getRaw

Methods inherited from sfOutputEscaper

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

Method Details

  • (int) count () Browse code

    Returns the size of the array (are required by the Countable interface).

    returns The size of the array

  • (mixed) current () Browse code

    Escapes and return the current value (as required by the Iterator interface).


    This escapes the value using sfOutputEscaper::escape with whatever escaping method is set for this instance.

    returns The escaped value

  • (mixed) getRaw ($key) Browse code

    $key The key into the array to use

    Returns the (unescaped) value from the array associated with the key supplied.

    returns The value

  • (string) key () Browse code

    Get the key associated with the current value (as required by the Iterator interface).

    returns The key

  • next () Browse code

    Moves to the next element (as required by the Iterator interface).

  • (bool) offsetExists ($offset) Browse code

    $offset The offset of the value to check existance of

    Returns true if the supplied offset isset in the array (as required by the ArrayAccess interface).

    returns true if the offset isset; false otherwise

  • (mixed) offsetGet ($offset) Browse code

    $offset The offset of the value to get

    Returns the element associated with the offset supplied (as required by the ArrayAccess interface).

    returns The escaped value

  • offsetSet ($offset, $value) Browse code

    $offset (ignored)
    $value (ignored)

    Throws an exception saying that values cannot be set (this method is required for the ArrayAccess interface).


    This (and the other sfOutputEscaper classes) are designed to be read only so this is an illegal operation.

    throws sfException

  • offsetUnset ($offset) Browse code

    $offset (ignored)

    Throws an exception saying that values cannot be unset (this method is required for the ArrayAccess interface).


    This (and the other sfOutputEscaper classes) are designed to be read only so this is an illegal operation.

    throws sfException

  • rewind () Browse code

    Reset the array to the beginning (as required for the Iterator interface).

  • (bool) valid () Browse code

    Returns true if the current element is valid (as required by the Iterator interface).


    The current element will not be valid if next has fallen off the end of the array or if there are no elements in the array and rewind was called.

    returns The validity of the current element; true if it is valid