\Charcoal\ObjectObjectRouteInterface

Defines a route to an object implementing {@see \Charcoal\Object\RoutableInterface}.

\Charcoal\Object\ObjectRoute for a basic implementation.

Summary

Methods
Constants
isSlugUnique()
generateUniqueSlug()
slug()
lang()
routeObjType()
routeObjId()
routeTemplate()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

isSlugUnique()

isSlugUnique() : boolean

Determine if the current slug is unique.

Returns

boolean

generateUniqueSlug()

generateUniqueSlug() : \Charcoal\Object\ObjectRouteInterface

Generate a unique URL slug for routable object.

Returns

\Charcoal\Object\ObjectRouteInterface

Chainable

slug()

slug() : string

Retrieve the object route URI.

Returns

string

lang()

lang() : string

Retrieve the locale of the object route.

Returns

string

routeObjType()

routeObjType() : string

Retrieve the foreign object type related to this route.

Returns

string

routeObjId()

routeObjId() : string

Retrieve the foreign object ID related to this route.

Returns

string

routeTemplate()

routeTemplate() : string

Retrieve the foreign object's template identifier.

Returns

string