API Documentation
\
Helper

\AcidRouter

Classe de Routage : contrôleur de route

Summary

Methods
Properties
Constants
getInstance()
run()
runDefault()
proceed()
route()
before()
after()
runCallback()
addRoute()
addGet()
addPost()
addPut()
addDelete()
addHead()
addPatch()
addOption()
addDefaultRoute()
useGetParam()
setParam()
getParam()
setParams()
getParams()
getParamById()
setPartialParams()
getPartialParams()
getPartialParamById()
getPartitionalURIbyId()
clearParams()
getCurrentLang()
getDefaultRoute()
dispatcher()
accessTo()
getCurrentRouteName()
buildURL()
dispatch()
getKey()
getName()
searchKey()
directlyRun()
No public properties found
URI_DELIMITER
MODULES_PATH
DEFAULT_MODULE
DEFAULT_CONTROLLER
DEFAULT_ACTION
No protected methods found
$_routes
N/A
No private methods found
$_currentRoute
$_defaultRoute
$_currentLang
$_folder
$_site
$_before
$_after
$_use_get_param
$_globalParams
$instance
N/A

Constants

URI_DELIMITER

URI_DELIMITER

MODULES_PATH

MODULES_PATH

DEFAULT_MODULE

DEFAULT_MODULE

DEFAULT_CONTROLLER

DEFAULT_CONTROLLER

DEFAULT_ACTION

DEFAULT_ACTION

Properties

$_routes

$_routes : array

Type

array — Tableau des routes Défini

$_currentRoute

$_currentRoute : object

Type

object — Route courante

$_defaultRoute

$_defaultRoute : object

Type

object — Route par défaut

$_currentLang

$_currentLang : string

Type

string — Langue courante

$_folder

$_folder : string

Type

string — url folder

$_site

$_site : string

Type

string — url site

$_before

$_before : array

Type

array — liste des callbacks avant dispach

$_after

$_after : array

Type

array — liste des callbacks après dispach

$_use_get_param

$_use_get_param : string

Type

string — get_param_used_as_route

$_globalParams

$_globalParams : array

Type

array — Paramètres qui seront transmis à toutes les routes

$instance

$instance : \objet

Type

\objet — Instance

Methods

getInstance()

getInstance() : \AcidRouter

Retourne l'instance

Returns

\AcidRouter

run()

run()

Lance une détection d'URI

runDefault()

runDefault()

Lance la route par défaut

proceed()

proceed(  $request)

Renvoi vers le controller/action si match parmis les routes existantes Sinon Renvoi une erreur 404

Parameters

$request

route()

route(  $request)

Renvoi vers le controller/action si match Sinon Renvoi une erreur 404

Parameters

$request

before()

before(string  $routename, \function  $callback)

Ajoute un callback before

Parameters

string $routename
\function $callback

after()

after(string  $routename, \function  $callback)

Ajoute un callback before

Parameters

string $routename
\function $callback

runCallback()

runCallback(  $tab)

Execute un callback

Parameters

$tab

addRoute()

addRoute(string  $name, \AcidRoute  $route)

Ajoute une route

Parameters

string $name
\AcidRoute $route

addGet()

addGet(string  $name, \AcidRoute  $route)

Ajoute une route GET

Parameters

string $name
\AcidRoute $route

addPost()

addPost(string  $name, \AcidRoute  $route)

Ajoute une route POST

Parameters

string $name
\AcidRoute $route

addPut()

addPut(string  $name, \AcidRoute  $route)

Ajoute une route PUT

Parameters

string $name
\AcidRoute $route

addDelete()

addDelete(string  $name, \AcidRoute  $route)

Ajoute une route DELETE

Parameters

string $name
\AcidRoute $route

addHead()

addHead(string  $name, \AcidRoute  $route)

Ajoute une route Head

Parameters

string $name
\AcidRoute $route

addPatch()

addPatch(string  $name, \AcidRoute  $route)

Ajoute une route PATCH

Parameters

string $name
\AcidRoute $route

addOption()

addOption(string  $name, \AcidRoute  $route)

Ajoute une route OPTION

Parameters

string $name
\AcidRoute $route

addDefaultRoute()

addDefaultRoute(string  $name, \AcidRoute  $route)

Définit la route par défaut

Parameters

string $name
\AcidRoute $route

useGetParam()

useGetParam(  $name)

Definit si la route est enregistrée dans un paramêtre GET

Parameters

$name

Nom de l'attribut GET

setParam()

setParam(string  $name,   $value)

Definit des paramètres

Parameters

string $name

= nom du parametre
$value

= valeur du parametre

getParam()

getParam(string  $name)

Récupère la valeur d'un paramètre

Parameters

string $name

= nom du parametre

setParams()

setParams(array  $params = array())

Défini les parametres à injecté lors de l'appel

Parameters

array $params

Array(name=>value)

getParams()

getParams()

Renvoi un tableau des parametres URI array(key=>value)

getParamById()

getParamById(  $id)

Retourne la valeur sinon une Exception

Parameters

$id

= position du parametre voulu

setPartialParams()

setPartialParams(string  $value, boolean  $clear = false) : mixed

Définit les paramètres partiels

Parameters

string $value
boolean $clear

Returns

mixed

getPartialParams()

getPartialParams()

All partial

getPartialParamById()

getPartialParamById(\srting  $id)

Partial

Parameters

\srting $id

ident

getPartitionalURIbyId()

getPartitionalURIbyId(mixed  $id) : mixed

Retourne une url partielle au moyen de l'identifiant en entrée

Parameters

mixed $id

Returns

mixed

clearParams()

clearParams(  $name = null)

Si un name est entré, suppression et clear du parametre URI Sinon Clear de tous les parametres

Parameters

$name

getCurrentLang()

getCurrentLang() : string

Retourne la langue courante

Returns

string

getDefaultRoute()

getDefaultRoute() : string

Retourne la route par défaut

Returns

string

dispatcher()

dispatcher()

Distribution de la route

accessTo()

accessTo(string  $routeName, boolean  $clean = true) : \Ambigous

Accède à la route

Parameters

string $routeName
boolean $clean

si true, supprime les paramètres liés à la route avant de la retourner

Returns

\Ambigous —

<AcidRouter, objet>

getCurrentRouteName()

getCurrentRouteName()

Retourne la route courante

buildURL()

buildURL(string  $routename, array  $params = null, array  $partial_params = null, boolean  $no_slash = false, boolean  $no_lang = false, boolean  $no_param = false, boolean  $http = false) : mixed

Génère une URL en fonction de la route désignée par les paramètres en entrée

Parameters

string $routename
array $params

paramètres obligatoires
array $partial_params

paramètres partiels
boolean $no_slash

si true, enlève le dernier slash
boolean $no_lang

si true, ne prend pas en compte la langue
boolean $no_param

DEPRECATED/TODO
boolean $http

si true, retourne l'url absolue, sinon retourne l'url relative

Returns

mixed

dispatch()

dispatch()

Dispatch current URL

getKey()

getKey(string  $key, string  $lang = null) : mixed

Retourne la traduction de la clé de routage pour la langue soumise en entrée, retourne false si non trouvée

Parameters

string $key
string $lang

Returns

mixed

getName()

getName(string  $key, string  $lang = null) : mixed

Retourne le nom associé à la clé de routage pour la langue soumise en entrée, retourne false si non trouvé

Parameters

string $key
string $lang

Returns

mixed

searchKey()

searchKey(string  $value, string  $current = null) : mixed

Cherche la clé de routage correspondant à $value

Parameters

string $value
string $current

langue

Returns

mixed

directlyRun()

directlyRun(string  $name, \AcidRoute  $route, array  $params = array(), array  $partials = array())

Definit une route à la volée et y accès directement

Parameters

string $name
\AcidRoute $route
array $params
array $partials