symfony API

sfFilter Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.0 API OpenSearch

Packages

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

sfFilter provides a way for you to intercept incoming requests or outgoing responses.

Inheritence

sfFakeRenderingFilter, sfExecutionFilter, sfWebDebugFilter, sfCommonFilter, sfSecurityFilter, sfCacheFilter, sfRenderingFilter, sfFlashFilter, sfFillInFormFilter  <  sfFilter

Method Summary

  • sfContext getContext()
    Retrieves the current application context.
  • string getParameter(, , )
    Gets the parameter associated with the given key.
  • sfParameterHolder getParameterHolder()
    Gets the parameter holder for this object.
  • boolean hasParameter(, )
    Returns true if the given key exists in the parameter holder.
  • boolean initialize(, )
    Initializes this Filter.
  • boolean isFirstCall()
    Returns true if this is the first call to the sfFilter instance.
  • setParameter(, , )
    Sets the value for the given key.

Method Details

  • (sfContext) getContext () Browse code

    Retrieves the current application context.

    returns The current sfContext instance

  • (string) getParameter (, , ) Browse code

    Gets the parameter associated with the given key.


    This is a shortcut for:

    $this->getParameterHolder()->get()

    returns The value associated with the key

  • (sfParameterHolder) getParameterHolder () Browse code

    Gets the parameter holder for this object.

    returns A sfParameterHolder instance

  • (boolean) hasParameter (, ) Browse code

    Returns true if the given key exists in the parameter holder.


    This is a shortcut for:

    $this->getParameterHolder()->has()

    returns true if the given key exists, false otherwise

  • (boolean) initialize (, ) Browse code

    Initializes this Filter.

    returns true, if initialization completes successfully, otherwise false

    throws sfInitializationException If an error occurs while initializing this Filter

  • (boolean) isFirstCall () Browse code

    Returns true if this is the first call to the sfFilter instance.

    returns true if this is the first call to the sfFilter instance, false otherwise

  • setParameter (, , ) Browse code

    Sets the value for the given key.


    This is a shortcut for:

    $this->getParameterHolder()->set()