symfony API

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

sfViewParameterHolder stores all variables that will be available to the template.

Inheritence

sfViewParameterHolder  <  sfParameterHolder

Method Summary

  • string getEscaping()
    Gets the default escaping strategy associated with this view.
  • string getEscapingMethod()
    Returns the name of the function that is to be used as the escaping method.
  • bool initialize($dispatcher, $parameters = array(), $options = array())
    Initializes this view parameter holder.
  • bool isEscaped()
    Returns true if the current object acts as an escaper.
  • array serialize()
    Serializes the current instance.
  • setEscaping($escaping)
    Sets the escape character strategy.
  • setEscapingMethod($method)
    Sets the escaping method for the current view.
  • array toArray()
    Returns an array representation of the view parameters.
  • unserialize($serialized)
    Unserializes a sfViewParameterHolder instance.
  • __construct($dispatcher, $parameters = array(), $options = array())
    Constructor.

Methods inherited from sfParameterHolder

add , addByRef , clear , get , getAll , getNames , has , remove , serialize , set , setByRef , unserialize , __construct

Method Details

  • (string) getEscaping () Browse code

    Gets the default escaping strategy associated with this view.


    The escaping strategy specifies how the variables get passed to the view.

    returns the escaping strategy

  • (string) getEscapingMethod () Browse code

    Returns the name of the function that is to be used as the escaping method.


    If the escaping method is empty, then that is returned. The default value specified by the sub-class will be used. If the method does not exist (in the sense there is no define associated with the method), an exception is thrown.

    returns The escaping method as the name of the function to use

    throws InvalidArgumentException If the method does not exist

  • (bool) initialize ($dispatcher, $parameters = array(), $options = array()) Browse code

    $dispatcher An sfEventDispatcher instance.
    $parameters An associative array of initialization parameters.
    $options

    An associative array of options.

    Options:

    • escaping_strategy - [off] - The escaping strategy (on or off)

    • escaping_method - [ESC_SPECIALCHARS] - The escaping method (ESC_RAW, ESC_ENTITIES, ESC_JS, ESC_JS_NO_ENTITIES, or ESC_SPECIALCHARS)

    Initializes this view parameter holder.

    returns true, if initialization completes successfully, otherwise false.

    throws sfInitializationException If an error occurs while initializing this view parameter holder.

  • (bool) isEscaped () Browse code

    Returns true if the current object acts as an escaper.

    returns true if the current object acts as an escaper, false otherwise

  • (array) serialize () Browse code

    Serializes the current instance.

    returns Objects instance

  • setEscaping ($escaping) Browse code

    $escaping Escape code

    Sets the escape character strategy.

  • setEscapingMethod ($method) Browse code

    $method Method for escaping

    Sets the escaping method for the current view.

  • (array) toArray () Browse code

    Returns an array representation of the view parameters.

    returns An array of view parameters

    throws InvalidArgumentException

  • unserialize ($serialized) Browse code

    $serialized The serialized instance data

    Unserializes a sfViewParameterHolder instance.

  • __construct ($dispatcher, $parameters = array(), $options = array()) Browse code

    $dispatcher
    $parameters
    $options

    Constructor.