symfony API

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

sfObjectRoute represents a route that is bound to PHP object(s).

Inheritence

sfDoctrineRoute, sfPropelRoute  <  sfObjectRoute  <  sfRequestRoute < sfRoute

Method Summary

Methods inherited from sfRequestRoute

generate , matchesParameters , matchesUrl , __construct

Methods inherited from sfRoute

bind , compile , compileForSeparator , compileForText , compileForVariable , fixDefaults , fixRequirements , fixSuffix , generate , generateStarParameter , generateWithTokens , getDefaultOptions , getDefaultParameters , getDefaults , getOptions , getPattern , getRegex , getRequirements , getTokens , getVariables , hasStarParameter , initializeOptions , isBound , matchesParameters , matchesUrl , mergeArrays , parseStarParameter , postCompile , preCompile , serialize , setDefaultOptions , setDefaultParameters , tokenize , tokenizeBufferAfter , tokenizeBufferBefore , unserialize , __construct

Method Details

  • convertObjectToArray ($object) Browse code

    $object

  • doConvertObjectToArray ($object) Browse code

    $object

  • filterParameters ($parameters) Browse code

    $parameters

  • (string) generate ($params, $context = array(), (Boolean) $absolute = false) Browse code

    $params The parameter values
    $context The context
    $absolute Whether to generate an absolute URL

    Generates a URL from the given parameters.

    returns The generated URL

  • (Object) getObject () Browse code

    Gets the object related to the current route and parameters.


    This method is only accessible if the route is bound and of type "object".

    returns The related object

  • getObjectForParameters ($parameters) Browse code

    $parameters

  • (array) getObjects () Browse code

    Gets the list of objects related to the current route and parameters.


    This method is only accessible if the route is bound and of type "list".

    returns And array of related objects

  • getObjectsForParameters ($parameters) Browse code

    $parameters

  • getRealVariables () Browse code

  • (Boolean) matchesParameters ($params, $context = array()) Browse code

    $params The parameters
    $context The context

    Returns true if the parameters matches this route, false otherwise.

    returns true if the parameters matches this route, false otherwise.

  • __construct ($pattern, $defaults = array(), $requirements = array(), $options = array()) Browse code

    $pattern The pattern to match
    $defaults An array of default parameter values
    $requirements An array of requirements for parameters (regexes)
    $options An array of options

    Constructor.