Overview

Packages

  • PHP
  • Router

Classes

  • Route
  • Router
  • RouterForIncludes
  • SimpleRoute
  • Overview
  • Package
  • Class
  • Tree

Class Route

Představuje jednu routu. Zadané reguláry pro jednotlivé části routy implicitně rozlišují velikost písmen.

Direct known subclasses

SimpleRoute
Package: Router
Author: Jakub Kulhan (původní verze routeru), http://bukaj.netuje.cz/blog/jednoduchy-routing-v-php
Author: Viktorie Halasu (rozšíření), http://projekty.vize.name/router/
Version: 1.3
Located at Route.php
Methods summary
public
# __construct( string $route, array $defaults = array(), integer $flags = 0, mixed $redir = null )

Parsuje zadání routy.

Parsuje zadání routy.

Parameters

$route
string
$defaults
array
Pole výchozích hodnot.
$flags
integer
Modifikátory routy (bitmask). FIXED | CI | REDIR
$redir
mixed
Pokud se přesměrovávají nepoužívané URL na nové (flag REDIR), musí obsahovat buď pole hodnot pro vytvoření nové URL, anebo callback, který toto pole vrací. Callback funkce dostane jediný parametr - parsovanou routu (ze starého URL). Pokud je použité pole a některý prvek má hodnotu Router::COPY_OLD_VALUE, zkopíruje se do něj hodnota ze stejnojmenného prvku ve staré URL (např. "controller").
public boolean
# matchUrl( string $url )

Pokusí se rozebrat zadanou URL podle této routy.

Pokusí se rozebrat zadanou URL podle této routy.

Parameters

$url
string

Returns

boolean
public boolean
# createUrlFromParams( array $params )

Podle této routy zkusí ze zadaných parametrů vytvořit URL. Parametry mohou být v libovolném pořadí, nezávisle na pořadí v routě.

Podle této routy zkusí ze zadaných parametrů vytvořit URL. Parametry mohou být v libovolném pořadí, nezávisle na pořadí v routě.

Parameters

$params
array
Parametry. Musí být uvedeny i výchozí hodnoty (2.param konstruktoru). Nepovinné části routy nebo výchozí parametry pro celý router (1.param Router::__construct) lze vynechat.

Returns

boolean
public
# addVariableUrlParts( array $variables )

Změní hodnotu některých částí u poslední vytvořené URL a vrátí novou URL (pro šablony URL).

Změní hodnotu některých částí u poslední vytvořené URL a vrátí novou URL (pro šablony URL).

Parameters

$variables
array
Proměnné části.

Throws

LogicException
final public boolean
# hasFlag( integer $flag )

Zjistí, jestli má routa nastaven zadaný modifikátor

Zjistí, jestli má routa nastaven zadaný modifikátor

Parameters

$flag
integer

Returns

boolean
final public array
# getRedirParams( )

Vrací pole parametrů pro vytvoření URL (u přesměrovávané routy)

Vrací pole parametrů pro vytvoření URL (u přesměrovávané routy)

Returns

array
final public array
# getParsedUrl( )

Vrací rozebranou URL.

Vrací rozebranou URL.

Returns

array
final public string
# getLastCreatedUrl( )

Vrací naposled vytvořenou URL.

Vrací naposled vytvořenou URL.

Returns

string
final public boolean
# isRedirected( )

Zjistí, jestli se tato routa má přesměrovávat.

Zjistí, jestli se tato routa má přesměrovávat.

Returns

boolean
protected array
# parse( string $route )

Parsuje zadanou routu.

Parsuje zadanou routu.

Parameters

$route
string

Returns

array
final protected array
# kmerge( array $arr1, array $arr2 )

Sloučí dvě asoc. pole. Podobné jako array_merge, ale nepřepisuje hodnotu v prvním poli prázdným řetězcem ani NULL.

Sloučí dvě asoc. pole. Podobné jako array_merge, ale nepřepisuje hodnotu v prvním poli prázdným řetězcem ani NULL.

Parameters

$arr1
array
$arr2
array

Returns

array
protected
# resolveRedirection( mixed $redir = null )

Nastaví přesměrování

Nastaví přesměrování

Parameters

$redir
mixed
(Pole nebo callback).

Throws

InvalidArgumentException
Pokud chybí cíl, nebo je špatného dat.typu
protected array
# invokeRedirCallback( )

Volá callback pro přesměrovávanou routu a vrací jeho výsledek.

Volá callback pro přesměrovávanou routu a vrací jeho výsledek.

Returns

array

Throws

RuntimeException
Pokud je callback neplatný
LogicException
UnexpectedValueException
Pokud callback nevrací pole.
public string
# toSource( )

Vrací textové zadání této routy.

Vrací textové zadání této routy.

Returns

string
Constants summary
integer FIXED 1
#

Modifikátor. Určuje, že z této routy se nebude dělat polotovar.

Modifikátor. Určuje, že z této routy se nebude dělat polotovar.

integer CI 2
#

Modifikátor. Určuje, že tato routa nerozlišuje velká a malá písmena.

Modifikátor. Určuje, že tato routa nerozlišuje velká a malá písmena.

integer REDIR 4
#

Modifikátor. Požadavek odpovídající této routě se má ihned přesměrovat na novou URL.

Modifikátor. Požadavek odpovídající této routě se má ihned přesměrovat na novou URL.

integer SIMPLE 8
#

Modifikátor. Zadaná routa je pro URL z parametrů (a má se zpracovat třídou SimpleRoute).

Modifikátor. Zadaná routa je pro URL z parametrů (a má se zpracovat třídou SimpleRoute).

string DEFAULT_REGEX '[A-Za-z0-9_.-]+'
#

Výchozí regulár pro jednotlivé části routy (písmena bez diakritiky, číslice, podtržítko, tečka, pomlčka).

Výchozí regulár pro jednotlivé části routy (písmena bez diakritiky, číslice, podtržítko, tečka, pomlčka).

string DEFAULT_VALUE 'a'
#

Hodnota, kterou zachytí výchozí regulár.

Hodnota, kterou zachytí výchozí regulár.

Properties summary
protected string $source ''
#

Textová podoba této routy tak, jak byla zadaná.

Textová podoba této routy tak, jak byla zadaná.

protected boolean $isRedirected false
#

Má se tato routa přesměrovávat?

Má se tato routa přesměrovávat?

protected integer $flags 0
#

Modifikátory použité pro tuto routu (bitmask).

Modifikátory použité pro tuto routu (bitmask).

protected array $params
#

Parametry z rozebrané routy.

Parametry z rozebrané routy.

protected array $parsedUrl array()
#

URL rozebraná podle této routy.

URL rozebraná podle této routy.

protected string $regex
#

Regulár pro tuto routu.

Regulár pro tuto routu.

protected array $redirParams
#

Přesměrování (pole parametrů pro vytvoření URL.)

Přesměrování (pole parametrů pro vytvoření URL.)

protected callback $redirCallback
#

Callback pro přesměrování.

Callback pro přesměrování.

protected string $urlFormat
#

Formátovací řetězec pro URL.

Formátovací řetězec pro URL.

protected array $lastUrlParams
#

Parametry, ze kterých byla naposled vytvořena URL.

Parametry, ze kterých byla naposled vytvořena URL.

protected string $lastCreatedUrl ''
#

Poslední vytvořená URL.

Poslední vytvořená URL.

PHP Router ver.1.3, r02 API documentation generated by ApiGen 2.6.1