symfony API

sfOutputEscaperIteratorDecorator Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.1 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.1 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 iterator decorator.

Inheritence

sfOutputEscaperIteratorDecorator  <  sfOutputEscaperObjectDecorator < sfOutputEscaperGetterDecorator < sfOutputEscaper

Method Summary

  • int count()
    Returns the size of the array (are required by the Countable interface).
  • mixed current()
    Escapes and gets the current element (as required by the Iterator interface).
  • string key()
    Gets the current key (as required by the Iterator interface).
  • next()
    Moves to the next element in the iterator (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
  • offsetUnset($offset)
    Throws an exception saying that values cannot be unset (this method is
  • bool rewind()
    Resets the iterator (as required by the Iterator interface).
  • bool valid()
    Returns whether the current element is valid or not (as required by the
  • __construct($escapingMethod, $value)
    Constructs a new escaping iteratoror using the escaping method and value supplied.

Methods inherited from sfOutputEscaperObjectDecorator

getRaw , __call , __toString

Methods inherited from sfOutputEscaperGetterDecorator

get , getRaw

Methods inherited from sfOutputEscaper

escape , getRawValue , isClassMarkedAsSafe , markClassAsSafe , markClassesAsSafe , __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 gets the current element (as required by the Iterator interface).

    returns The escaped value

  • (string) key () Browse code

    Gets the current key (as required by the Iterator interface).

    returns Iterator key

  • next () Browse code

    Moves to the next element in the iterator (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

  • (bool) rewind () Browse code

    Resets the iterator (as required by the Iterator interface).

    returns true, if the iterator rewinds successfully otherwise false

  • (bool) valid () Browse code

    Returns whether the current element is valid or not (as required by the

    Iterator interface).

    returns true if the current element is valid; false otherwise

  • __construct ($escapingMethod, $value) Browse code

    $escapingMethod The escaping method to use
    $value The iterator to escape

    Constructs a new escaping iteratoror using the escaping method and value supplied.