API Documentation
\
Helper

\AcidRoute

Classe de Routage : configuration de route

Summary

Methods
Properties
Constants
__construct()
setName()
getName()
setMethod()
getMethod()
getURI()
getPartitionalUri()
match()
proceedToTranslate()
getParams()
getPartials()
setParams()
setPartial()
callDispatch()
cleanParam()
cleanPartialParams()
build()
$unique_match
No constants found
No protected methods found
$URI
$_partitional_URI
$generatedURI
$module
$controller
$action
$method
$params
$partial
$partialParams
$name
N/A
No private methods found
No private properties found
N/A

Properties

$unique_match

$unique_match : boolean

Type

boolean — Empêche les autres routes d'être appelées si rencontré

$URI

$URI : string

Type

string — URI

$_partitional_URI

$_partitional_URI : string

Type

string — URI partielle

$generatedURI

$generatedURI : string

Type

string — URI générée

$module

$module : string

Type

string — Module associé à la route

$controller

$controller : string

Type

string — Controller associé à la route

$action

$action : string

Type

string — Méthode liée à la route

$method

$method : string

Type

string — HTTP Methods de liaison NULL / GET / POST / PUT / DELETE / HEAD / PATCH / OPTIONS

$params

$params : array

Type

array — Paramètres obligatoires

$partial

$partial : array

Type

array — Cette route contient des paramètres partiels

$partialParams

$partialParams : array

Type

array — Paramètres partiels

$name

$name : string

Type

string — Nom de la route

Methods

__construct()

__construct(  $URI, array  $controller = array(), null  $partial_start = null, null  $partial_stop = null, null  $params = null, null  $method = null)

Constructeur AcidRoute

Parameters

$URI

alias de la route
array $controller

configuration du controller
null $partial_start

si défini, index de la premère clé des paramètres partiels
null $partial_stop

si défini, index de la dernière clé des paramètres partiels
null $params

les paramètres
null $method

la méthode associée

setName()

setName(string  $val) : string

Définit le nom de la route

Parameters

string $val

Returns

string

getName()

getName() : string

Retourne le nom de la route

Returns

string

setMethod()

setMethod(mixed  $val) : string

Définit la méthode de la route

Parameters

mixed $val

: NULL / GET / POST / PUT / DELETE / HEAD / PATCH / OPTIONS / ARRAY(GET,POST,..)

Returns

string

getMethod()

getMethod() : string

Retourne le nom de la route

Returns

string

getURI()

getURI() : string

Retourn l'URI de la route

Returns

string

getPartitionalUri()

getPartitionalUri() : string

Retourne l'URI partielle de la route

Returns

string

match()

match(string  $path, \unknown_type  $partial_on_fail = null) : boolean

Retourne si le chemin en entré coïncide avec la route

Parameters

string $path
\unknown_type $partial_on_fail

Returns

boolean

proceedToTranslate()

proceedToTranslate(string  $key, string  $value) : boolean

Traduit une route

Parameters

string $key
string $value

Returns

boolean

getParams()

getParams() : array

Retourne les paramètres obligatoires

Returns

array

getPartials()

getPartials() : array

Retourne les paramètres partiels

Returns

array

setParams()

setParams(array  $new_params = null)

Definit les paramètres obligatoires

Parameters

array $new_params

setPartial()

setPartial(mixed  $value, boolean  $clear = false)

Definit les paramètres partiels

Parameters

mixed $value
boolean $clear

callDispatch()

callDispatch() : boolean

Traitement la route

Throws

\Exception

Returns

boolean

cleanParam()

cleanParam(string  $name = null)

Supprimes les paramètres associés à la route

Parameters

string $name

cleanPartialParams()

cleanPartialParams()

Supprimes les paramètres partiels associés à la route

build()

build() : boolean|\Ambigous

Builder

Returns

boolean|\Ambigous —

<string, unknown>