PHP Class Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route

Author: [email protected]
Inheritance: extends Symfony\Cmf\Bundle\RoutingBundle\Model\Route, implements Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\PrefixInterface, implements Doctrine\ODM\PHPCR\HierarchyInterface
Show file Open project: symfony-cmf/routing-bundle Class Usage Examples

Protected Properties

Property Type Description
$children Doctrine\Common\Collections\Collection Child route documents.
$idPrefix string This field is not persisted in storage.
$name string PHPCR node name.
$parent object parent document.

Public Methods

Method Description
__construct ( array $options = [] ) PHPCR id can not end on '/', so we need an additional option for a trailing slash.
generateStaticPrefix ( string $id, string $idPrefix ) : string
getChildren ( ) : Doctrine\Common\Collections\Collection Get all children of this route including non-routes.
getName ( )
getParentDocument ( ) : object The parent document, which might be another route or some other document.
getPath ( )
getPrefix ( )
getRouteChildren ( ) : Symfony\Cmf\Component\Routing\RouteObjectInterface[] Get all route children of this route.
getStaticPrefix ( )
setId ( string $id ) PHPCR documents can be moved by setting the id to a new path.
setName ( string $name ) : self Rename a route by setting its new name.
setParentDocument ( object $parent ) Move the route by setting a parent.
setPath ( $pattern )
setPosition ( $parent, $name ) Convenience method to set parent and name at the same time.
setPrefix ( $idPrefix )
setStaticPrefix ( $prefix )

Protected Methods

Method Description
isBooleanOption ( $name )

Method Details

__construct() public method

Additional supported option is: * add_trailing_slash: When set, a trailing slash is appended to the route
public __construct ( array $options = [] )
$options array

generateStaticPrefix() public method

public generateStaticPrefix ( string $id, string $idPrefix ) : string
$id string PHPCR id of this document
$idPrefix string part of the id that can be removed
return string the static part of the pattern of this route

getChildren() public method

Get all children of this route including non-routes.
public getChildren ( ) : Doctrine\Common\Collections\Collection
return Doctrine\Common\Collections\Collection

getName() public method

public getName ( )

getParentDocument() public method

The parent document, which might be another route or some other document.
public getParentDocument ( ) : object
return object The parent document

getPath() public method

Handle the trailing slash option.
public getPath ( )

getPrefix() public method

public getPrefix ( )

getRouteChildren() public method

Filters out children that do not implement the RouteObjectInterface.
public getRouteChildren ( ) : Symfony\Cmf\Component\Routing\RouteObjectInterface[]
return Symfony\Cmf\Component\Routing\RouteObjectInterface[]

getStaticPrefix() public method

Overwrite model method as we need to build this
public getStaticPrefix ( )

isBooleanOption() protected method

protected isBooleanOption ( $name )

setId() public method

PHPCR documents can be moved by setting the id to a new path.
public setId ( string $id )
$id string

setName() public method

Note that this will change the URL this route matches.
public setName ( string $name ) : self
$name string the new name
return self

setParentDocument() public method

Note that this will change the URL this route matches.
public setParentDocument ( object $parent )
$parent object the new parent document

setPath() public method

public setPath ( $pattern )

setPosition() public method

The url will be the url of the parent plus the supplied name.
public setPosition ( $parent, $name )

setPrefix() public method

public setPrefix ( $idPrefix )

setStaticPrefix() public method

Overwritten to translate into a move operation.
public setStaticPrefix ( $prefix )

Property Details

$children protected property

Child route documents.
protected Collection,Doctrine\Common\Collections $children
return Doctrine\Common\Collections\Collection

$idPrefix protected property

This field is not persisted in storage.
protected string $idPrefix
return string

$name protected property

PHPCR node name.
protected string $name
return string

$parent protected property

parent document.
protected object $parent
return object