PHP Class Pimcore\Model\Staticroute

Inheritance: extends AbstractModel
Mostra file Open project: pimcore/pimcore Class Usage Examples

Public Properties

Property Type Description
$_values array Associative array filled on match() that holds matched path values for given variable names.
$action string
$controller string
$creationDate integer
$defaults string
$id integer
$modificationDate integer
$module string
$name string
$pattern string
$priority integer
$reverse string
$siteId integer
$variables string

Protected Properties

Property Type Description
$_currentRoute Staticroute contains the static route which the current request matches (it he does), this is used in the view to get the current route
$nameIdMappingCache array this is a small per request cache to know which route is which is, this info is used in self::getByName()

Public Methods

Method Description
assemble ( array $urlOptions = [], boolean $reset = false, boolean $encode = true ) : mixed | string
create ( ) : Staticroute
getAction ( ) : string
getById ( integer $id ) : Staticroute
getByName ( string $name, $siteId = null ) : Staticroute
getController ( ) : string
getCreationDate ( ) : integer
getCurrentRoute ( ) : Staticroute
getDefaults ( ) : string
getDefaultsArray ( ) : array Get the defaults defined in a string as array
getId ( ) : integer
getModificationDate ( ) : integer
getModule ( ) : string
getName ( ) : string
getPattern ( ) : string
getPriority ( ) : integer
getReverse ( ) : string
getSiteId ( ) : integer
getVariables ( ) : string
match ( string $path, array $params = [] ) : array | boolean
setAction ( string $action ) : void
setController ( string $controller ) : void
setCreationDate ( $creationDate )
setCurrentRoute ( $route ) : void
setDefaults ( string $defaults ) : void
setId ( integer $id )
setModificationDate ( $modificationDate )
setModule ( string $module )
setName ( string $name ) : void
setPattern ( string $pattern )
setPriority ( integer $priority ) : void
setReverse ( string $reverse ) : void
setSiteId ( integer $siteId )
setVariables ( string $variables ) : void

Method Details

assemble() public method

public assemble ( array $urlOptions = [], boolean $reset = false, boolean $encode = true ) : mixed | string
$urlOptions array
$reset boolean
$encode boolean
return mixed | string

create() public static method

public static create ( ) : Staticroute
return Staticroute

getAction() public method

public getAction ( ) : string
return string

getById() public static method

public static getById ( integer $id ) : Staticroute
$id integer
return Staticroute

getByName() public static method

public static getByName ( string $name, $siteId = null ) : Staticroute
$name string
return Staticroute

getController() public method

public getController ( ) : string
return string

getCreationDate() public method

public getCreationDate ( ) : integer
return integer

getCurrentRoute() public static method

public static getCurrentRoute ( ) : Staticroute
return Staticroute

getDefaults() public method

public getDefaults ( ) : string
return string

getDefaultsArray() public method

Get the defaults defined in a string as array
public getDefaultsArray ( ) : array
return array

getId() public method

public getId ( ) : integer
return integer

getModificationDate() public method

public getModificationDate ( ) : integer
return integer

getModule() public method

public getModule ( ) : string
return string

getName() public method

public getName ( ) : string
return string

getPattern() public method

public getPattern ( ) : string
return string

getPriority() public method

public getPriority ( ) : integer
return integer

getReverse() public method

public getReverse ( ) : string
return string

getSiteId() public method

public getSiteId ( ) : integer
return integer

getVariables() public method

public getVariables ( ) : string
return string

match() public method

public match ( string $path, array $params = [] ) : array | boolean
$path string
$params array
return array | boolean

setAction() public method

public setAction ( string $action ) : void
$action string
return void

setController() public method

public setController ( string $controller ) : void
$controller string
return void

setCreationDate() public method

public setCreationDate ( $creationDate )
$creationDate

setCurrentRoute() public static method

public static setCurrentRoute ( $route ) : void
$route
return void

setDefaults() public method

public setDefaults ( string $defaults ) : void
$defaults string
return void

setId() public method

public setId ( integer $id )
$id integer

setModificationDate() public method

public setModificationDate ( $modificationDate )
$modificationDate

setModule() public method

public setModule ( string $module )
$module string

setName() public method

public setName ( string $name ) : void
$name string
return void

setPattern() public method

public setPattern ( string $pattern )
$pattern string

setPriority() public method

public setPriority ( integer $priority ) : void
$priority integer
return void

setReverse() public method

public setReverse ( string $reverse ) : void
$reverse string
return void

setSiteId() public method

public setSiteId ( integer $siteId )
$siteId integer

setVariables() public method

public setVariables ( string $variables ) : void
$variables string
return void

Property Details

$_currentRoute protected_oe static_oe property

contains the static route which the current request matches (it he does), this is used in the view to get the current route
protected static Staticroute,Pimcore\Model $_currentRoute
return Staticroute

$_values public_oe property

Associative array filled on match() that holds matched path values for given variable names.
public array $_values
return array

$action public_oe property

public string $action
return string

$controller public_oe property

public string $controller
return string

$creationDate public_oe property

public int $creationDate
return integer

$defaults public_oe property

public string $defaults
return string

$id public_oe property

public int $id
return integer

$modificationDate public_oe property

public int $modificationDate
return integer

$module public_oe property

public string $module
return string

$name public_oe property

public string $name
return string

$nameIdMappingCache protected_oe static_oe property

this is a small per request cache to know which route is which is, this info is used in self::getByName()
protected static array $nameIdMappingCache
return array

$pattern public_oe property

public string $pattern
return string

$priority public_oe property

public int $priority
return integer

$reverse public_oe property

public string $reverse
return string

$siteId public_oe property

public int $siteId
return integer

$variables public_oe property

public string $variables
return string