PHP Interface Sulu\Component\CustomUrl\Document\CustomUrlBehavior

Inheritance: extends Sulu\Component\DocumentManager\Behavior\Mapping\UuidBehavior, extends Sulu\Component\DocumentManager\Behavior\Mapping\PathBehavior, extends Sulu\Component\Content\Document\Behavior\RobotBehavior, extends Sulu\Component\Content\Document\Behavior\TargetBehavior
Exibir arquivo Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
addRoute ( string $route, RouteDocument $routeDocument ) Add a route to document.
getBaseDomain ( ) : string Returns base domain of custom-url.
getDomainParts ( ) : array Returns domain parts of custom-url.
getRoutes ( ) : RouteDocument[] Returns list of existing routes.
getTargetLocale ( ) : string Returns locale for target.
getTitle ( ) : string Returns title of custom-url.
isCanonical ( ) : boolean Returns true if canonical is enabled.
isPublished ( ) : string Returns state of custom-url.
isRedirect ( ) : boolean Returns true if redirect is enabled.
setRoutes ( array $routes ) Set list of routes.

Method Details

addRoute() public method

Add a route to document.
public addRoute ( string $route, RouteDocument $routeDocument )
$route string
$routeDocument RouteDocument

getBaseDomain() public method

Returns base domain of custom-url.
public getBaseDomain ( ) : string
return string

getDomainParts() public method

Returns domain parts of custom-url.
public getDomainParts ( ) : array
return array

getRoutes() public method

Returns list of existing routes.
public getRoutes ( ) : RouteDocument[]
return RouteDocument[]

getTargetLocale() public method

Returns locale for target.
public getTargetLocale ( ) : string
return string

getTitle() public method

Returns title of custom-url.
public getTitle ( ) : string
return string

isCanonical() public method

Returns true if canonical is enabled.
public isCanonical ( ) : boolean
return boolean

isPublished() public method

Returns state of custom-url.
public isPublished ( ) : string
return string

isRedirect() public method

Returns true if redirect is enabled.
public isRedirect ( ) : boolean
return boolean

setRoutes() public method

Set list of routes.
public setRoutes ( array $routes )
$routes array