Methods summary
public static
MvcCore\Route
|
#
CreateInstance( string|array $patternOrConfig = NULL, string $controllerAction = NULL, array $defaults = [], array $constraints = [], array $method = NULL )
Create every time new route instance, no singleton managing.
Called usually from core methods:
- \MvcCore\Router::AddRoutes();
- \MvcCore\Router::AddRoute();
- \MvcCore\Router::SetOrCreateDefaultRouteAsCurrent();
This method is the best place where to implement custom route init for
configured core class. First argument could be configuration array with
all necessary constructor values or all separated arguments - first is
route pattern value to parse into match and reverse values, then
controller with action, params default values and constraints.
Example:
new Route([
"pattern" => "/products-list/<name>/<color>",
"controllerAction" => "Products:List",
"defaults" => ["name" => "default-name", "color" => "red"],
"constraints" => ["name" => "[^/]*", "color" => "[a-z]*"]
]);
or:
new Route(
"/products-list/<name>/<color>",
"Products:List",
["name" => "default-name", "color" => "red"],
["name" => "[^/]*", "color" => "[a-z]*"]
);
or:
new Route([
"name" => "products_list",
"match" => "#^/products\-list/(?<name>[^/]*)/(?<color>[a-z]*)(?=/$|$)#",
"reverse" => "/products-list/<name>/<color>",
"controller" => "Products",
"action" => "List",
"defaults" => ["name" => "default-name", "color" => "red"],
]);
Create every time new route instance, no singleton managing.
Called usually from core methods:
- \MvcCore\Router::AddRoutes();
- \MvcCore\Router::AddRoute();
- \MvcCore\Router::SetOrCreateDefaultRouteAsCurrent();
This method is the best place where to implement custom route init for
configured core class. First argument could be configuration array with
all necessary constructor values or all separated arguments - first is
route pattern value to parse into match and reverse values, then
controller with action, params default values and constraints.
Example:
new Route([ "pattern" => "/products-list/<name>/<color>", "controllerAction" => "Products:List", "defaults" => ["name" => "default-name", "color" => "red"], "constraints" => ["name" => "[^/]*", "color" => "[a-z]*"]
]);
or:
new Route( "/products-list/<name>/<color>", "Products:List", ["name" => "default-name", "color" => "red"], ["name" => "[^/]*", "color" => "[a-z]*"]
);
or:
new Route([ "name" => "products_list", "match" => "#^/products\-list/(?<name>[^/]*)/(?<color>[a-z]*)(?=/$|$)#", "reverse" => "/products-list/<name>/<color>", "controller" => "Products", "action" => "List", "defaults" => ["name" => "default-name", "color" => "red"],
]);
Parameters
- $patternOrConfig
Required, configuration array or route pattern value
to parse into match and reverse patterns. - $controllerAction
Optional, controller and action name in pascal case
like: "Products:List". - $defaults
Optional, default param values like:
["name" => "default-name", "page" => 1]. - $constraints
Optional, params regular expression constraints for
regular expression match function if no "match"
property in config array as first argument defined. - $method
$advancedConfiguration
Optional, http method to only match requests by this
method. If NULL (by default), request with any http
method could be matched by this route. Given value is
automatically converted to upper case. Returns
|
public
string|array|null
|
#
GetPattern( )
Get route base pattern to complete match pattern string to match requested
URL and to complete reverse pattern string to build back an URL address.
Get route base pattern to complete match pattern string to match requested
URL and to complete reverse pattern string to build back an URL address.
To define route by this form is the most comfortable way, but a way
slower, because there is necessary every request to convert this value
into match and into reverse properties correctly. But you can specify
those both properties directly, if you can write regular expressions.
This match and reverse definition has to be in very basic form without
regular expression escaping or advanced rules:
- No regular expression border # characters, it's used in match only.
- No start ^ or end $ regular expression chars, also used in match.
- No escaping of regular expression characters: [](){}<>|=+*.!?-/, those characters will be escaped in route match property.
- Star character inside param name (<color*>) means greedy param matching all to the end of the URL address. It has to be the last one.
Example: "/products-list/<name>[/<color*>]".
Returns
string|array|null
|
public
MvcCore\Route
|
#
SetPattern( string|array $pattern )
Set route base pattern to complete match pattern string to match requested
URL and to complete reverse pattern string to build back an URL address.
Set route base pattern to complete match pattern string to match requested
URL and to complete reverse pattern string to build back an URL address.
To define route by this form is the most comfortable way, but a way
slower, because there is necessary every request to convert this value
into match and into reverse properties correctly. But you can specify
those both properties directly, if you can write regular expressions.
This match and reverse definition has to be in very basic form without
regular expression escaping or advanced rules:
- No regular expression border # characters, it's used in match only.
- No start ^ or end $ regular expression chars, also used in match.
- No escaping of regular expression characters: [](){}<>|=+*.!?-/, those characters will be escaped in route match property.
- Star character inside param name (<color*>) means greedy param matching all to the end of the URL address. It has to be the last one.
Example: "/products-list/<name>[/<color*>]".
Parameters
Returns
|
public
string|array|null
|
#
GetMatch( )
Get route match pattern in raw form (to use it as it is) to match requested
URL. This match pattern must have the very same structure and content
as reverse pattern, because there is necessary to complete route flags
from reverse pattern string - to prepare proper regular expression
subject for this match, not just only the request path. Because those
flags is not possible to detect from raw regular expression string.
Get route match pattern in raw form (to use it as it is) to match requested
URL. This match pattern must have the very same structure and content
as reverse pattern, because there is necessary to complete route flags
from reverse pattern string - to prepare proper regular expression
subject for this match, not just only the request path. Because those
flags is not possible to detect from raw regular expression string.
This is required together with route reverse property, if you have not
configured route pattern property instead.
To define the route by assigning properties route match and route
reverse together is little bit more annoying way to define it (because
you have to write almost the same information twice), but it's the best
speed solution, because there is no route internal metadata completion
and pattern parsing into match and reverse properties.
Example: "#^/products\-list/(?<name>[^/]+)(/(?<id>\d+))?/?$#"
Returns
string|array|null
|
public
MvcCore\Route
|
#
SetMatch( string|array $match )
Set route match pattern in raw form (to use it as it is) to match requested
URL. This match pattern must have the very same structure and content
as reverse pattern, because there is necessary to complete route flags
from reverse pattern string - to prepare proper regular expression
subject for this match, not just only the request path. Because those
flags is not possible to detect from raw regular expression string.
Set route match pattern in raw form (to use it as it is) to match requested
URL. This match pattern must have the very same structure and content
as reverse pattern, because there is necessary to complete route flags
from reverse pattern string - to prepare proper regular expression
subject for this match, not just only the request path. Because those
flags is not possible to detect from raw regular expression string.
This is required together with route reverse property, if you have not
configured route pattern property instead.
To define the route by assigning properties route match and route
reverse together is little bit more annoying way to define it (because
you have to write almost the same information twice), but it's the best
speed solution, because there is no route internal metadata completion
and pattern parsing into match and reverse properties.
Example: "#^/products\-list/(?<name>[^/]+)(/(?<id>\d+))?/?$#"
Parameters
Returns
|
public
string|array|null
|
#
GetReverse( )
Get route reverse address replacements pattern to build url.
- No regular expression border # characters.
- No regular expression characters escaping ([](){}<>|=+*.!?-/).
- No start ^ or end $ regular expression characters.
Get route reverse address replacements pattern to build url.
- No regular expression border # characters.
- No regular expression characters escaping ([](){}<>|=+*.!?-/).
- No start ^ or end $ regular expression characters.
Required together with route match property, if you have not configured
route pattern property instead. This is only very simple string with
variable section definitions defined by brackets [] and with parameters
replacement places (like <name> or <page>) for given values by
\MvcCore\Router::Url($name, $params); method.
To define the route by assigning properties route match and route
reverse together is little bit more annoying way to define it (because
you have to write almost the same information twice), but it's the best
speed solution, because there is no route internal metadata completion
and pattern parsing into match and reverse properties.
Example: "/products-list/<name>[/<color>]"
Returns
string|array|null
|
public
MvcCore\Route
|
#
SetReverse( string|array $reverse )
Set route reverse address replacements pattern to build url.
- No regular expression border # characters.
- No regular expression characters escaping ([](){}<>|=+*.!?-/).
- No start ^ or end $ regular expression characters.
Set route reverse address replacements pattern to build url.
- No regular expression border # characters.
- No regular expression characters escaping ([](){}<>|=+*.!?-/).
- No start ^ or end $ regular expression characters.
Required together with route match property, if you have not configured
route pattern property instead. This is only very simple string with
variable section definitions defined by brackets [] and with parameters
replacement places (like <name> or <page>) for given values by
\MvcCore\Router::Url($name, $params); method.
To define the route by assigning properties route match and route
reverse together is little bit more annoying way to define it (because
you have to write almost the same information twice), but it's the best
speed solution, because there is no route internal metadata completion
and pattern parsing into match and reverse properties.
Example: "/products-list/<name>[/<color>]"
Parameters
Returns
|
public
string|null
|
#
GetName( )
Get route name is your custom keyword/term or pascal case combination of
controller and action describing "Controller:Action" target to be
dispatched. Route name is not required route property.
Get route name is your custom keyword/term or pascal case combination of
controller and action describing "Controller:Action" target to be
dispatched. Route name is not required route property.
By this name there is selected proper route object to complete URL string
by given params in router method: \MvcCore\Router:Url($name, $params);.
Example: "products_list" | "Products:Gallery"
Returns
string|null
|
public
MvcCore\Route
|
#
SetName( string|null $name )
Set route name is your custom keyword/term or pascal case combination of
controller and action describing "Controller:Action" target to be
dispatched. Route name is not required route property.
Set route name is your custom keyword/term or pascal case combination of
controller and action describing "Controller:Action" target to be
dispatched. Route name is not required route property.
By this name there is selected proper route object to complete URL string
by given params in router method: \MvcCore\Router:Url($name, $params);.
Example: "products_list" | "Products:Gallery"
Parameters
Returns
|
public
string
|
#
GetController( )
Get controller name/path to dispatch, in pascal case. This property is not
required. If there is controller param inside route pattern or inside
route match pattern property, it's used to define this record to dispatch
specific requested controller.
Get controller name/path to dispatch, in pascal case. This property is not
required. If there is controller param inside route pattern or inside
route match pattern property, it's used to define this record to dispatch
specific requested controller.
It should contain controller class namespaces defined in standard PHP
notation. If there is backslash at the beginning - controller class will
be loaded directly from base standard controllers directory
/App/Controllers, not by any relative place defined by possible domain
route from extended router. If there are two standard slashes in the
beginning, controller class will be loaded without those two slashes
from base PHP place without any automatic MvcCore namespace prepending.
Example: "Products" - normally placed in /App/Controllers/Products.php(but it could be also in some sub-directory if there is used extended route with namespace)"\Front\Business\Products"- placed in/App/Controllers/Front/Business/Products.php/Anywhere/Else/Controllers/Products.php
Returns
string
|
public
MvcCore\Route
|
#
SetController( string|null $controller )
Set controller name/path to dispatch, in pascal case. This property is not
required. If there is controller param inside route pattern or inside
route match pattern property, it's used to define this record to dispatch
specific requested controller.
Set controller name/path to dispatch, in pascal case. This property is not
required. If there is controller param inside route pattern or inside
route match pattern property, it's used to define this record to dispatch
specific requested controller.
It should contain controller class namespaces defined in standard PHP
notation. If there is backslash at the beginning - controller class will
be loaded directly from base standard controllers directory
/App/Controllers, not by any relative place defined by possible domain
route from extended router. If there are two standard slashes in the
beginning, controller class will be loaded without those two slashes
from base PHP place without any automatic MvcCore namespace prepending.
Example: "Products" - normally placed in /App/Controllers/Products.php(but it could be also in some sub-directory if there is used extended route with namespace)"\Front\Business\Products"- placed in/App/Controllers/Front/Business/Products.php/Anywhere/Else/Controllers/Products.php
Parameters
Returns
|
public
string
|
#
GetAction( )
Get action name to call in dispatched controller, in pascal case. This
property is not required. If controller instance has default method
IndexAction(), its called. If there is no such method, no method is
called. If there is action param inside route pattern or inside route
match pattern property, it's used to overwrite this record to dispatch
specific requested action.
Get action name to call in dispatched controller, in pascal case. This
property is not required. If controller instance has default method
IndexAction(), its called. If there is no such method, no method is
called. If there is action param inside route pattern or inside route
match pattern property, it's used to overwrite this record to dispatch
specific requested action.
If this property has value "List", then public method in target
controller has to be named as: public function ListAction () {...}.
Example: "List"
Returns
string
|
public
MvcCore\Route
|
#
SetAction( string|null $action )
Set action name to call in dispatched controller, in pascal case. This
property is not required. If controller instance has default method
IndexAction(), its called. If there is no such method, no method is
called. If there is action param inside route pattern or inside route
match pattern property, it's used to overwrite this record to dispatch
specific requested action.
Set action name to call in dispatched controller, in pascal case. This
property is not required. If controller instance has default method
IndexAction(), its called. If there is no such method, no method is
called. If there is action param inside route pattern or inside route
match pattern property, it's used to overwrite this record to dispatch
specific requested action.
If this property has value "List", then public method in target
controller has to be named as: public function ListAction () {...}.
Example: "List"
Parameters
Returns
|
public
string
|
#
GetControllerAction( )
Get target controller name/path and controller action name together in
one getter, in pascal case, separated by colon. There are also contained
controller namespace. Read more about controller name/path definition
possibilities in \MvcCore\Route::GetController(); getter method.
Get target controller name/path and controller action name together in
one getter, in pascal case, separated by colon. There are also contained
controller namespace. Read more about controller name/path definition
possibilities in \MvcCore\Route::GetController(); getter method.
Example: "Products:List" | "\Front\Business\Products:Gallery"
Returns
string
|
public
MvcCore\Route
|
#
SetControllerAction( $controllerAction )
Set target controller name/path and controller action name together in
one setter, in pascal case, separated by colon. There are also contained
controller namespace. Read more about controller name/path definition
possibilities in \MvcCore\Route::SetController(); setter method.
Set target controller name/path and controller action name together in
one setter, in pascal case, separated by colon. There are also contained
controller namespace. Read more about controller name/path definition
possibilities in \MvcCore\Route::SetController(); setter method.
Example: "Products:List" | "\Front\Business\Products:Gallery"
Returns
|
public
array|array[]
&
|
#
GetDefaults( )
Get route rewrite params default values and also any other query string
params default values. It could be used for any application request
param from those application inputs - $_GET, $_POST or php://input.
Get route rewrite params default values and also any other query string
params default values. It could be used for any application request
param from those application inputs - $_GET, $_POST or php://input.
Example: ["name" => "default-name", "color" => "red",].
Returns
array|array[]
|
public
MvcCore\Route
|
#
SetDefaults( array|array[] $defaults = [] )
Set route rewrite params default values and also any other query string
params default values. It could be used for any application request
param from those application inputs - $_GET, $_POST or php://input.
Set route rewrite params default values and also any other query string
params default values. It could be used for any application request
param from those application inputs - $_GET, $_POST or php://input.
Example: ["name" => "default-name", "color" => "red",].
Parameters
Returns
|
public
array|array[]
|
#
GetConstraints( )
Get array with param names and their custom regular expression matching
rules. Not required, for all rewrite params there is used default
matching rules from route static properties defaultDomainConstraint or
defaultPathConstraint. It should be changed to any value. Default value
is "[^.]+" for domain part and "[^/]+" for path part.
Get array with param names and their custom regular expression matching
rules. Not required, for all rewrite params there is used default
matching rules from route static properties defaultDomainConstraint or
defaultPathConstraint. It should be changed to any value. Default value
is "[^.]+" for domain part and "[^/]+" for path part.
Example: ["name" => "[^/]+", "color" => "[a-z]+",]
Returns
array|array[]
|
public
MvcCore\Route
|
#
SetConstraints( array|array[] $constraints = [] )
Set array with param names and their custom regular expression matching
rules. Not required, for all rewrite params there is used default
matching rules from route static properties defaultDomainConstraint or
defaultPathConstraint. It should be changed to any value. Default value
is "[^.]+" for domain part and "[^/]+" for path part.
Set array with param names and their custom regular expression matching
rules. Not required, for all rewrite params there is used default
matching rules from route static properties defaultDomainConstraint or
defaultPathConstraint. It should be changed to any value. Default value
is "[^.]+" for domain part and "[^/]+" for path part.
Example: ["name" => "[^/]+", "color" => "[a-z]+",]
Parameters
Returns
|
public
array|callable[]
&
|
#
GetFilters( )
Get URL address params filters to filter URL params in and out. By route
filters you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Get URL address params filters to filter URL params in and out. By route
filters you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Filters are callables and always in this array under keys "in" and
"out" accepting arguments:
- $params associative array with params from requested URL address for in filter and associative array with params to build URL address for out filter.
- $defaultParams associative array with default params to store any custom value necessary to filter effectively.
- $request current request instance implements \MvcCore\IRequest.
Callable filter must return associative array with filtered params.
There is possible to call any callable as closure function in variable
except forms like 'ClassName::methodName' and ['childClassName',
'parent::methodName'] and [$childInstance, 'parent::methodName'].
Returns
array|callable[]
|
public
MvcCore\Route
|
#
SetFilters( array $filters = [] )
Set URL address params filters to filter URL params in and out. By route
filters you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Set URL address params filters to filter URL params in and out. By route
filters you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Filters are callables and always in this array under keys "in" and
"out" accepting arguments:
- $params associative array with params from requested URL address for in filter and associative array with params to build URL address for out filter.
- $defaultParams associative array with default params to store any custom value necessary to filter effectively.
- $request current request instance implements \MvcCore\IRequest.
Callable filter must return associative array with filtered params.
There is possible to call any callable as closure function in variable
except forms like 'ClassName::methodName' and ['childClassName',
'parent::methodName'] and [$childInstance, 'parent::methodName'].
Parameters
Returns
|
public
callable|null
|
#
GetFilter( $direction = \MvcCore\IRoute::CONFIG_FILTER_IN )
Get URL address params filter to filter URL params in and out. By route
filter you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Get URL address params filter to filter URL params in and out. By route
filter you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Filter is callable accepting arguments:
- $params associative array with params from requested URL address for in filter and associative array with params to build URL address for out filter.
- $defaultParams associative array with default params to store any custom value necessary to filter effectively.
- $request current request instance implements \MvcCore\IRequest.
Callable filter must return associative array with filtered params.
There is possible to call any callable as closure function in variable
except forms like 'ClassName::methodName' and ['childClassName',
'parent::methodName'] and [$childInstance, 'parent::methodName'].
Returns
callable|null
|
public
MvcCore\Route
|
#
SetFilter( callable $handler, string $direction = \MvcCore\IRoute::CONFIG_FILTER_IN )
Set URL address params filter to filter URL params in and out. By route
filter you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Set URL address params filter to filter URL params in and out. By route
filter you can change incoming request params into application and out
from application. For example to translate the values or anything else.
Filter is callable accepting arguments:
- $params associative array with params from requested URL address for in filter and associative array with params to build URL address for out filter.
- $defaultParams associative array with default params to store any custom value necessary to filter effectively.
- $request current request instance implements \MvcCore\IRequest.
Callable filter must return associative array with filtered params.
There is possible to call any callable as closure function in variable
except forms like 'ClassName::methodName' and ['childClassName',
'parent::methodName'] and [$childInstance, 'parent::methodName'].
Parameters
Returns
|
public
string|null
|
#
GetMethod( )
Get http method to only match requests with this defined method. If NULL,
request with any http method could be matched by this route. Value has to
be in upper case.
Example: "POST" | \MvcCore\IRequest::METHOD_POST
Get http method to only match requests with this defined method. If NULL,
request with any http method could be matched by this route. Value has to
be in upper case.
Example: "POST" | \MvcCore\IRequest::METHOD_POST
Returns
string|null
|
public
MvcCore\Route
|
#
SetMethod( string|null $method = NULL )
Set http method to only match requests with this defined method. If NULL,
request with any http method could be matched by this route. Value has to
be in upper case.
Example: "POST" | \MvcCore\IRequest::METHOD_POST
Set http method to only match requests with this defined method. If NULL,
request with any http method could be matched by this route. Value has to
be in upper case.
Example: "POST" | \MvcCore\IRequest::METHOD_POST
Parameters
Returns
|
public
string|null
|
#
GetRedirect( )
Get other route unique name to redirect request to. To this target route are
passed params parsed from this matched route. This property is used for
routes handling old pages or old request forms, redirecting those request
to new form.
Example: "new_route_name"
Get other route unique name to redirect request to. To this target route are
passed params parsed from this matched route. This property is used for
routes handling old pages or old request forms, redirecting those request
to new form.
Example: "new_route_name"
Returns
string|null
|
public
MvcCore\Route
|
#
SetRedirect( string|null $redirectRouteName = NULL )
Set other route unique name to redirect request to. To this target route are
passed params parsed from this matched route. This property is used for
routes handling old pages or old request forms, redirecting those request
to new form.
Example: "new_route_name"
Set other route unique name to redirect request to. To this target route are
passed params parsed from this matched route. This property is used for
routes handling old pages or old request forms, redirecting those request
to new form.
Example: "new_route_name"
Parameters
Returns
|
public
boolean
|
#
GetAbsolute( )
Return TRUE if route pattern (or reverse) contains domain part with
two slashes at the beginning or if route is defined with absolute
boolean flag by advanced configuration in constructor or by setter.
Return TRUE if route pattern (or reverse) contains domain part with
two slashes at the beginning or if route is defined with absolute
boolean flag by advanced configuration in constructor or by setter.
Returns
boolean
|
public
MvcCore\Route
|
#
SetAbsolute( boolean $absolute = TRUE )
Set boolean about to generate absolute URL addresses. If TRUE, there is
always generated absolute URL form. If FALSE, absolute URL address is
generated only if pattern (or reverse) property contains absolute
matching form.
Set boolean about to generate absolute URL addresses. If TRUE, there is
always generated absolute URL form. If FALSE, absolute URL address is
generated only if pattern (or reverse) property contains absolute
matching form.
Parameters
Returns
|
public
string|null
|
#
GetGroupName( )
Get route group name to belongs to. Group name is always first word parsed
from request path. First word is content between two first slashes in
request path. If group name is NULL, route belongs to default group
and that group is used when no other group matching the request path.
Get route group name to belongs to. Group name is always first word parsed
from request path. First word is content between two first slashes in
request path. If group name is NULL, route belongs to default group
and that group is used when no other group matching the request path.
Returns
string|null
|
public
MvcCore\Route
|
#
SetGroupName( string|null $groupName )
Set route group name to belongs to. Group name is always first word parsed
from request path. First word is content between two first slashes in
request path. If group name is NULL, route belongs to default group
and that group is used when no other group matching the request path.
Set route group name to belongs to. Group name is always first word parsed
from request path. First word is content between two first slashes in
request path. If group name is NULL, route belongs to default group
and that group is used when no other group matching the request path.
Parameters
Returns
|
public
string[]|null
|
#
GetReverseParams( )
Return only reverse params names as strings array. Reverse params array
is array with all rewrite params founded in patter (or reverse) string.
Example: ["name", "color"];
Return only reverse params names as strings array. Reverse params array
is array with all rewrite params founded in patter (or reverse) string.
Example: ["name", "color"];
Returns
string[]|null
|
public
MvcCore\Route
|
#
SetMatchedParams( array $matchedParams = [] )
Set manually matched params from rewrite route matching process into
current route object. Use this method only on currently matched route!
Passed array must have keys as param names and values as matched values
and it must contain all only matched rewrite params and route controller
and route action if any.
Set manually matched params from rewrite route matching process into
current route object. Use this method only on currently matched route!
Passed array must have keys as param names and values as matched values
and it must contain all only matched rewrite params and route controller
and route action if any.
Parameters
Returns
|
public
array|null
&
|
#
GetMatchedParams( )
Get matched params from rewrite route matching process into current route
object. Use this method only on currently matched route! Passed array
must have keys as param names and values as matched values and it must
contain all only matched rewrite params and route controller and route
action if any.
Get matched params from rewrite route matching process into current route
object. Use this method only on currently matched route! Passed array
must have keys as param names and values as matched values and it must
contain all only matched rewrite params and route controller and route
action if any.
Returns
array|null
|
public
MvcCore\Router
|
#
GetRouter( )
Get router instance reference, used mostly in route URL building process.
Get router instance reference, used mostly in route URL building process.
Returns
|
public
MvcCore\Route
|
#
SetRouter( MvcCore\IRouter $router )
Set router instance reference, used mostly in route URL building process.
Set router instance reference, used mostly in route URL building process.
Parameters
Returns
|
public
mixed
|
#
GetAdvancedConfigProperty( string $propertyName )
Get any special advanced configuration property from route constructor.
configuration array contains data from route constructor. If route is
initialized with all params (not only by single array), the configuration
array used in this method contains the fourth param with advanced route
configuration. If route is initialized only with one single array
argument, the configuration array used in this method contains that whole
configuration single array argument. Data in described are without no
change against initialization moment. You can specify key to the array to
get any initialization value.
Get any special advanced configuration property from route constructor.
configuration array contains data from route constructor. If route is
initialized with all params (not only by single array), the configuration
array used in this method contains the fourth param with advanced route
configuration. If route is initialized only with one single array
argument, the configuration array used in this method contains that whole
configuration single array argument. Data in described are without no
change against initialization moment. You can specify key to the array to
get any initialization value.
Parameters
Returns
mixed
|
public
array
&
|
#
Matches( MvcCore\IRequest $request )
Return array of matched params if incoming request match this route
or NULL if doesn't. Returned array must contain all matched reverse
params with matched controller and action names by route and by matched
params. Route is matched usually if request property path matches by
PHP preg_match_all() route match pattern. Sometimes, matching subject
could be different if route specifies it - if route pattern (or match)
property contains domain (or base path part) - it means if it is absolute
or if pattern (or match) property contains a query string part.
This method is usually called in core request routing process
from \MvcCore\Router::Route(); method and it's sub-methods.
Return array of matched params if incoming request match this route
or NULL if doesn't. Returned array must contain all matched reverse
params with matched controller and action names by route and by matched
params. Route is matched usually if request property path matches by
PHP preg_match_all() route match pattern. Sometimes, matching subject
could be different if route specifies it - if route pattern (or match)
property contains domain (or base path part) - it means if it is absolute
or if pattern (or match) property contains a query string part.
This method is usually called in core request routing process
from \MvcCore\Router::Route(); method and it's sub-methods.
Parameters
- $request
- The request object instance.
Returns
array Matched and params array, keys are matched
params or controller and action params.
Throws
LogicException
Route configuration property is missing.
InvalidArgumentException
Wrong route pattern format.
|
public
array
|
#
Filter( array & $params = [], array & $defaultParams = [], string $direction = \MvcCore\IRoute::CONFIG_FILTER_IN )
Filter given array $params by configured "in" | "out" filter callable.
This function return array with first item as bool about successful
filter processing in try/catch and second item as filtered params array.
Filter given array $params by configured "in" | "out" filter callable.
This function return array with first item as bool about successful
filter processing in try/catch and second item as filtered params array.
Parameters
- $params
- $defaultParams
- $direction
Returns
array
Filtered params array.
|
public
string[]
|
#
Url( MvcCore\IRequest $request, array & $params = [], array & $defaultUrlParams = [], string $queryStringParamsSepatator = '&', boolean $splitUrl = FALSE )
Complete route URL by given params array and route internal reverse
replacements pattern string. If there are more given params in first
argument than total count of replacement places in reverse pattern,
then create URL with query string params after reverse pattern,
containing that extra record(s) value(s). Returned is an array with only
one string as result URL or it could be returned for extended classes
an array with two strings - result URL in two parts - first part as scheme,
domain and base path and second as path and query string.
Example:
Input ($params):
[
"name" => "cool-product-name",
"color" => "blue",
"variants" => ["L", "XL"],
];
Input (\MvcCore\Route::$reverse):
"/products-list/<name>/<color*>"
Output:
["/any/app/base/path/products-list/cool-product-name/blue?variant[]=L&variant[]=XL"]
or:
[
"/any/app/base/path",
"/products-list/cool-product-name/blue?variant[]=L&variant[]=XL"
]
Complete route URL by given params array and route internal reverse
replacements pattern string. If there are more given params in first
argument than total count of replacement places in reverse pattern,
then create URL with query string params after reverse pattern,
containing that extra record(s) value(s). Returned is an array with only
one string as result URL or it could be returned for extended classes
an array with two strings - result URL in two parts - first part as scheme,
domain and base path and second as path and query string.
Example:
Input ($params): [ "name" => "cool-product-name", "color" => "blue", "variants" => ["L", "XL"], ];
Input (\MvcCore\Route::$reverse): "/products-list/<name>/<color*>"
Output: ["/any/app/base/path/products-list/cool-product-name/blue?variant[]=L&variant[]=XL"] or: [ "/any/app/base/path", "/products-list/cool-product-name/blue?variant[]=L&variant[]=XL" ]
Parameters
- $request
- Currently requested request object.
- $params
URL params from application point completed
by developer. - $defaultUrlParams
Requested URL route params and query string
params without escaped HTML special chars:
< > & " ' &. - $queryStringParamsSepatator
Query params separator, & by default. Always
automatically completed by router instance. - $splitUrl
Boolean value about to split completed result URL
into two parts or not. Default is FALSE to return
a string array with only one record - the result
URL. If TRUE, result url is split into two
parts and function return array with two items. Returns
string[] Result URL address in array. If last argument is
FALSE by default, this function returns only
single item array with result URL. If last
argument is TRUE, function returns result URL
in two parts - domain part with base path and
path part with query string.
|
public
MvcCore\Route
|
#
InitAll( )
Initialize all possible protected values (match, reverse etc...). This
method is not recommended to use in production mode, it's designed mostly
for development purposes, to see what could be inside route object.
Initialize all possible protected values (match, reverse etc...). This
method is not recommended to use in production mode, it's designed mostly
for development purposes, to see what could be inside route object.
Returns
|
public
string[]
|
#
__sleep( )
Collect all properties names to serialize them by serialize() method.
Collect all instance properties declared as private, protected and public
and if there is not configured in static::$protectedProperties anything
under property name, return those properties in result array.
Collect all properties names to serialize them by serialize() method.
Collect all instance properties declared as private, protected and public
and if there is not configured in static::$protectedProperties anything
under property name, return those properties in result array.
Returns
string[]
|
public
|
#
__wakeup( )
Assign router instance to local property $this->router;.
Assign router instance to local property $this->router;.
|