PHP Trait Bolt\Storage\Entity\ContentRouteTrait

This is a breakout of the old Bolt\Content class and serves two main purposes: * Maintain backward compatibility for Bolt\Content through the remainder of the 2.x development/release life-cycle * Attempt to break up former functionality into sections of code that more resembles Single Responsibility Principles These traits should be considered transitional, the functionality in the process of refactor, and not representative of a valid approach.
Author: Gawain Lynch ([email protected])
Show file Open project: bolt/bolt

Public Methods

Method Description
editlink ( ) : string Creates a link to EDIT this record, if the user is logged in.
getRouteNameAndParams ( ) : array | null Returns [route name, route params] for url generation, or null for various reasons.
isHome ( ) : boolean Checks if the current record is set as the homepage.
link ( integer $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH ) : string | null Creates a URL for the content record.

Protected Methods

Method Description
getReference ( ) : string Get the reference to this record, to uniquely identify this specific record.
getRouteConfig ( ) : array | null Retrieves the first route applicable to the content as a two-element array consisting of the binding and the route array. Returns null if there is no applicable route.
getRouteRequirementParams ( array $route ) : array Build a ContentType's route parameters
isApplicableRoute ( array $route ) : boolean Check if a route is applicable to this record.

Private Methods

Method Description
getLinkSlug ( ) : string | integer Get a record's slug depending on the type of object used.

Method Details

getReference() protected method

Get the reference to this record, to uniquely identify this specific record.
protected getReference ( ) : string
return string

getRouteConfig() protected method

Retrieves the first route applicable to the content as a two-element array consisting of the binding and the route array. Returns null if there is no applicable route.
protected getRouteConfig ( ) : array | null
return array | null

getRouteNameAndParams() public method

Returns [route name, route params] for url generation, or null for various reasons.
public getRouteNameAndParams ( ) : array | null
return array | null

getRouteRequirementParams() protected method

Build a ContentType's route parameters
protected getRouteRequirementParams ( array $route ) : array
$route array
return array

isApplicableRoute() protected method

Check if a route is applicable to this record.
protected isApplicableRoute ( array $route ) : boolean
$route array
return boolean

isHome() public method

Checks if the current record is set as the homepage.
public isHome ( ) : boolean
return boolean