PHP Class Themosis\Route\Route

Inheritance: extends Illuminate\Routing\Route
Afficher le fichier Open project: themosis/framework Class Usage Examples

Protected Properties

Свойство Type Description
$condition string The WordPress template condition.
$conditionalParameters array | void The additional parameters for the WordPress template conditions
$conditions array WordPress conditional tags.
$rewrite_tag_prefix string The prefix used to name the custom route tag.

Méthodes publiques

Méthode Description
__construct ( array | string $methods, string $uri, mixed $action ) Build a Route instance.
addConditions ( array $conditions ) Allow developers to add route WordPress conditions.
condition ( ) : string Get the WordPress condition.
conditionalParameters ( ) : array Return the conditional parameters
createRewriteRule ( ) Create a WordPress rewrite rule for the route if the route is not using a WordPress conditional tag.
getRewriteRuleRegex ( ) : mixed | string Returns the regex to be registered as a rewrite rule to let WordPress know the existence of this route
getWpValidators ( ) : array Get matching validators.
matches ( Illuminate\Http\Request $request, boolean $includingMethod = true ) : boolean Determine if the route matches given request.
parameters ( ) : array Get the key / value list of parameters for the route.

Méthodes protégées

Méthode Description
getConditions ( ) : array Retrieve the list of registered WordPress conditions.
parseCondition ( string $uri ) : string Return the real WordPress conditional tag.
parseConditionalParameters ( array $action ) : array Parses the conditional parameter out of the action parameter. This is the parameter given to WordPress conditional functions later.

Method Details

__construct() public méthode

Build a Route instance.
public __construct ( array | string $methods, string $uri, mixed $action )
$methods array | string
$uri string
$action mixed

addConditions() public méthode

Allow developers to add route WordPress conditions.
public addConditions ( array $conditions )
$conditions array

condition() public méthode

Get the WordPress condition.
public condition ( ) : string
Résultat string

conditionalParameters() public méthode

Return the conditional parameters
public conditionalParameters ( ) : array
Résultat array

createRewriteRule() public méthode

By registering a rewrite rule using the route's regex we force WordPress not to change the url to one Wordpress knows.
public createRewriteRule ( )

getConditions() protected méthode

Retrieve the list of registered WordPress conditions.
protected getConditions ( ) : array
Résultat array

getRewriteRuleRegex() public méthode

Returns the regex to be registered as a rewrite rule to let WordPress know the existence of this route
public getRewriteRuleRegex ( ) : mixed | string
Résultat mixed | string

getWpValidators() public méthode

Get matching validators.
public getWpValidators ( ) : array
Résultat array

matches() public méthode

Determine if the route matches given request.
public matches ( Illuminate\Http\Request $request, boolean $includingMethod = true ) : boolean
$request Illuminate\Http\Request
$includingMethod boolean
Résultat boolean

parameters() public méthode

Get the key / value list of parameters for the route.
public parameters ( ) : array
Résultat array

parseCondition() protected méthode

Return the real WordPress conditional tag.
protected parseCondition ( string $uri ) : string
$uri string
Résultat string

parseConditionalParameters() protected méthode

Parses the conditional parameter out of the action parameter. This is the parameter given to WordPress conditional functions later.
protected parseConditionalParameters ( array $action ) : array
$action array The action parameter where the conditional parameters are in
Résultat array An array with the conditional parameters or null

Property Details

$condition protected_oe property

The WordPress template condition.
protected string $condition
Résultat string

$conditionalParameters protected_oe property

The additional parameters for the WordPress template conditions
protected array|void $conditionalParameters
Résultat array | void

$conditions protected_oe property

WordPress conditional tags.
protected array $conditions
Résultat array

$rewrite_tag_prefix protected_oe property

The prefix used to name the custom route tag.
protected string $rewrite_tag_prefix
Résultat string