symfony API

sfEvent Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.3 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.3 version. Switch to:

sfEvent.

Method Summary

  • string getName()
    Returns the event name.
  • array getParameters()
    Returns the event parameters.
  • mixed getReturnValue()
    Returns the return value.
  • mixed getSubject()
    Returns the subject.
  • Boolean isProcessed()
    Returns whether the event has been processed by a listener or not.
  • Boolean offsetExists($name)
    Returns true if the parameter exists (implements the ArrayAccess interface).
  • mixed offsetGet($name)
    Returns a parameter value (implements the ArrayAccess interface).
  • offsetSet($name, $value)
    Sets a parameter (implements the ArrayAccess interface).
  • offsetUnset($name)
    Removes a parameter (implements the ArrayAccess interface).
  • setProcessed($processed)
    Sets the processed flag.
  • setReturnValue($value)
    Sets the return value for this event.
  • __construct($subject, $name, $parameters)
    Constructs a new sfEvent.

Method Details

  • (string) getName () Browse code

    Returns the event name.

    returns The event name

  • (array) getParameters () Browse code

    Returns the event parameters.

    returns The event parameters

  • (mixed) getReturnValue () Browse code

    Returns the return value.

    returns The return value

  • (mixed) getSubject () Browse code

    Returns the subject.

    returns The subject

  • (Boolean) isProcessed () Browse code

    Returns whether the event has been processed by a listener or not.

    returns true if the event has been processed, false otherwise

  • (Boolean) offsetExists ($name) Browse code

    $name The parameter name

    Returns true if the parameter exists (implements the ArrayAccess interface).

    returns true if the parameter exists, false otherwise

  • (mixed) offsetGet ($name) Browse code

    $name The parameter name

    Returns a parameter value (implements the ArrayAccess interface).

    returns The parameter value

  • offsetSet ($name, $value) Browse code

    $name The parameter name
    $value The parameter value

    Sets a parameter (implements the ArrayAccess interface).

  • offsetUnset ($name) Browse code

    $name The parameter name

    Removes a parameter (implements the ArrayAccess interface).

  • setProcessed ($processed) Browse code

    $processed The processed flag value

    Sets the processed flag.

  • setReturnValue ($value) Browse code

    $value The return value

    Sets the return value for this event.

  • __construct ($subject, $name, $parameters) Browse code

    $subject The subject
    $name The event name
    $parameters An array of parameters

    Constructs a new sfEvent.