PHP Класс Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\Route

Автор: [email protected]
Наследование: extends Symfony\Cmf\Bundle\RoutingBundle\Model\Route, implements Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Phpcr\PrefixInterface, implements Doctrine\ODM\PHPCR\HierarchyInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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.

Открытые методы

Метод Описание
__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 )

Защищенные методы

Метод Описание
isBooleanOption ( $name )

Описание методов

__construct() публичный Метод

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 generateStaticPrefix ( string $id, string $idPrefix ) : string
$id string PHPCR id of this document
$idPrefix string part of the id that can be removed
Результат string the static part of the pattern of this route

getChildren() публичный Метод

Get all children of this route including non-routes.
public getChildren ( ) : Doctrine\Common\Collections\Collection
Результат Doctrine\Common\Collections\Collection

getName() публичный Метод

public getName ( )

getParentDocument() публичный Метод

The parent document, which might be another route or some other document.
public getParentDocument ( ) : object
Результат object The parent document

getPath() публичный Метод

Handle the trailing slash option.
public getPath ( )

getPrefix() публичный Метод

public getPrefix ( )

getRouteChildren() публичный Метод

Filters out children that do not implement the RouteObjectInterface.
public getRouteChildren ( ) : Symfony\Cmf\Component\Routing\RouteObjectInterface[]
Результат Symfony\Cmf\Component\Routing\RouteObjectInterface[]

getStaticPrefix() публичный Метод

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

isBooleanOption() защищенный Метод

protected isBooleanOption ( $name )

setId() публичный Метод

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

setName() публичный Метод

Note that this will change the URL this route matches.
public setName ( string $name ) : self
$name string the new name
Результат self

setParentDocument() публичный Метод

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

setPath() публичный Метод

public setPath ( $pattern )

setPosition() публичный Метод

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

setPrefix() публичный Метод

public setPrefix ( $idPrefix )

setStaticPrefix() публичный Метод

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

Описание свойств

$children защищенное свойство

Child route documents.
protected Collection,Doctrine\Common\Collections $children
Результат Doctrine\Common\Collections\Collection

$idPrefix защищенное свойство

This field is not persisted in storage.
protected string $idPrefix
Результат string

$name защищенное свойство

PHPCR node name.
protected string $name
Результат string

$parent защищенное свойство

parent document.
protected object $parent
Результат object