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 RoutableInterface

Defines an object as routable.

Routable objects are accessible via a URI. The interface provides a "slug" property to track the latest "pretty" URI path.

Available implementation as trait: - Charcoal\Object\RoutableTrait.

Namespace: Charcoal\Object
Located at Charcoal/Object/RoutableInterface.php
Methods summary
public Charcoal\Object\RoutableInterface
# setSlugPattern( mixed $pattern )

Set the object's URL slug pattern.

Set the object's URL slug pattern.

Parameters

$pattern
The slug pattern.

Returns

Charcoal\Object\RoutableInterface
Chainable
public string|null
# slugPattern( )

Retrieve the object's URL slug pattern.

Retrieve the object's URL slug pattern.

Returns

string|null
public Charcoal\Object\RoutableInterface
# setSlug( mixed $slug )

Set the object's URL slug.

Set the object's URL slug.

Parameters

$slug
The slug.

Returns

Charcoal\Object\RoutableInterface
Chainable
public string|null
# slug( )

Retrieve the object's URL slug.

Retrieve the object's URL slug.

Returns

string|null
public string|null
# generateSlug( )

Generate a URL slug from the object's URL slug pattern.

Generate a URL slug from the object's URL slug pattern.

Returns

string|null
public string|null
# url( )

Retrieve the object's URI.

Retrieve the object's URI.

Returns

string|null
public Charcoal\Object\ObjectRouteInterface
# createRouteObject( )

Create a route object.

Create a route object.

Returns

Charcoal\Object\ObjectRouteInterface
public string
# objectRouteClass( )

Retrieve the class name of the object route model.

Retrieve the class name of the object route model.

Returns

string
API documentation generated by ApiGen