symfony API

sfRouteCollection Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.4 API OpenSearch

Packages

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

sfRouteCollection represents a collection of routes.

Inheritence

sfObjectRouteCollection  <  sfRouteCollection

Method Summary

  • mixed current()
    Returns the current route (implements the Iterator interface).
  • array getOptions()
    Returns the options.
  • array getRoutes()
    Returns the routes.
  • string key()
    Get the name of the current route (implements the Iterator interface).
  • next()
    Moves to the next route (implements the Iterator interface).
  • rewind()
    Reset the error array to the beginning (implements the Iterator interface).
  • boolean valid()
    Returns true if the current route is valid (implements the Iterator interface).
  • __construct($options)
    Constructor.

Method Details

  • (mixed) current () Browse code

    Returns the current route (implements the Iterator interface).

    returns The escaped value

  • (array) getOptions () Browse code

    Returns the options.

    returns The options

  • (array) getRoutes () Browse code

    Returns the routes.

    returns The routes

  • (string) key () Browse code

    Get the name of the current route (implements the Iterator interface).

    returns The key

  • next () Browse code

    Moves to the next route (implements the Iterator interface).

  • rewind () Browse code

    Reset the error array to the beginning (implements the Iterator interface).

  • (boolean) valid () Browse code

    Returns true if the current route is valid (implements the Iterator interface).

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

  • __construct ($options) Browse code

    $options An array of options

    Constructor.