Overview

Namespaces

  • Charcoal
    • Object
    • User
      • Acl

Classes

  • Content
  • ObjectRevision
  • ObjectRoute
  • ObjectSchedule
  • UserData

Interfaces

  • ArchivableInterface
  • CategorizableInterface
  • CategorizableMultipleInterface
  • CategoryInterface
  • ContentInterface
  • HierarchicalInterface
  • ObjectRevisionInterface
  • ObjectRouteInterface
  • ObjectScheduleInterface
  • PublishableInterface
  • RevisionableInterface
  • RoutableInterface
  • UserDataInterface

Traits

  • ArchivableTrait
  • CategorizableMultipleTrait
  • CategorizableTrait
  • CategoryTrait
  • HierarchicalTrait
  • PublishableTrait
  • RevisionableTrait
  • RoutableTrait
  • Overview
  • Namespace
  • Class

Interface ObjectRouteInterface

Defines a route to an object implementing Charcoal\Object\RoutableInterface.

Charcoal\Object\ObjectRoute for a basic implementation.

Direct known implementers

Charcoal\Object\ObjectRoute
Namespace: Charcoal\Object
Located at Charcoal/Object/ObjectRouteInterface.php
Methods summary
public boolean
# isSlugUnique( )

Determine if the current slug is unique.

Determine if the current slug is unique.

Returns

boolean
public Charcoal\Object\ObjectRouteInterface
# generateUniqueSlug( )

Generate a unique URL slug for routable object.

Generate a unique URL slug for routable object.

Returns

Charcoal\Object\ObjectRouteInterface
Chainable
public string
# slug( )

Retrieve the object route URI.

Retrieve the object route URI.

Returns

string
public string
# lang( )

Retrieve the locale of the object route.

Retrieve the locale of the object route.

Returns

string
public string
# routeObjType( )

Retrieve the foreign object type related to this route.

Retrieve the foreign object type related to this route.

Returns

string
public string
# routeObjId( )

Retrieve the foreign object ID related to this route.

Retrieve the foreign object ID related to this route.

Returns

string
public string
# routeTemplate( )

Retrieve the foreign object's template identifier.

Retrieve the foreign object's template identifier.

Returns

string
API documentation generated by ApiGen