Methods summary
public
string|null
|
#
GetModule( )
Get application module name. Any custom string to define part of
application under specific domain, routed by this object.
Get application module name. Any custom string to define part of
application under specific domain, routed by this object.
Returns
string|null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetModule( string|null $module )
Set application module name. Any custom string to define part of
application under specific domain, routed by this object.
Set application module name. Any custom string to define part of
application under specific domain, routed by this object.
Parameters
Returns
|
public
string|null
|
#
GetNamespace( )
Get target controller namespace - used if routed controller defined by
standard route is not defined absolutely. This namespace is necessary to
define relatively from standard application controller namespace to
target controllers directory (namespace).
Get target controller namespace - used if routed controller defined by
standard route is not defined absolutely. This namespace is necessary to
define relatively from standard application controller namespace to
target controllers directory (namespace).
Returns
string|null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetNamespace( string|null $namespace )
Set target controller namespace - used if routed controller defined by
standard route is not defined absolutely. This namespace is necessary to
define relatively from standard application controller namespace to
target controllers directory (namespace).
Set target controller namespace - used if routed controller defined by
standard route is not defined absolutely. This namespace is necessary to
define relatively from standard application controller namespace to
target controllers directory (namespace).
Parameters
Returns
|
public
string[]
|
#
GetAllowedLocalizations( )
Get allowed localizations for the routed module if there is used
any variant of module router with localization.
Get allowed localizations for the routed module if there is used
any variant of module router with localization.
Returns
string[]
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetAllowedLocalizations( )
Set allowed localizations for the routed module if there is used
any variant of module router with localization.
Set allowed localizations for the routed module if there is used
any variant of module router with localization.
Returns
Var
\string[] $allowedLocalizations..., International lower case language
code(s) (+ optionally dash character
+ upper case international locale code(s))
|
public
array
&
|
#
GetAllowedMediaVersions( )
Get allowed localizations for the routed module if there is used
any variant of module router with media (device) definition.
Get allowed localizations for the routed module if there is used
any variant of module router with media (device) definition.
Returns
array
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetAllowedMediaVersions( array $allowedMediaVersionsAndUrlValues = [] )
Set allowed localizations for the routed module if there is used
any variant of module router with media (device) definition.
Set allowed localizations for the routed module if there is used
any variant of module router with media (device) definition.
Parameters
- $allowedMediaVersionsAndUrlValues
Returns
|
public
null
|
#
GetName( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Use method GetModule() instead.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Use method GetModule() instead.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetName( string $name )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Use method SetModule($module) instead.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Use method SetModule($module) instead.
Parameters
Returns
|
public
null
|
#
GetController( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetController( string $controller )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
public
null
|
#
GetAction( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetAction( string $action )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
public
null
|
#
GetControllerAction( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetControllerAction( string $controllerAction )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
public
null
|
#
GetMethod( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetMethod( string $method = NULL )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
public
null
|
#
GetRedirect( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetRedirect( string $redirectRouteName = NULL )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
public
boolean
|
#
GetAbsolute( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
boolean
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetAbsolute( boolean $absolute = TRUE )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
public
null
|
#
GetGroupName( )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Returns
null
|
public
MvcCore\Ext\Routers\Modules\Route
|
#
SetGroupName( string $groupName )
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
THIS METHOD IS NOT USED IN MODULE DOMAIN ROUTE CLASS.
Parameters
Returns
|
protected
MvcCore\Ext\Routers\Modules\Route
|
#
trriggerUnusedMethodError( string $method )
Trigger E_USER_WARNING user error about not used method in this
extended module domain route.
Trigger E_USER_WARNING user error about not used method in this
extended module domain route.
Parameters
Returns
|
Properties summary
protected
string|null
|
$module
Required, application module name. Any custom string to define part of
application under specific domain, routed by this object.
Required, application module name. Any custom string to define part of
application under specific domain, routed by this object.
Required
|
|
protected
string|null
|
$namespace
Optional, target controller namespace - used if routed controller defined
by standard route is not defined absolutely. This namespace is necessary
to define relatively from standard application controller namespace to
target controllers directory (namespace).
Optional, target controller namespace - used if routed controller defined
by standard route is not defined absolutely. This namespace is necessary
to define relatively from standard application controller namespace to
target controllers directory (namespace).
|
|
protected
array
|
$allowedLocalizations
Optional, allowed localizations for the routed module if there is used
any variant of module router with localization.
Optional, allowed localizations for the routed module if there is used
any variant of module router with localization.
|
|
protected
array
|
$mediaVersions
Optional, allowed localizations for the routed module if there is used
any variant of module router with media (device) definition.
Optional, allowed localizations for the routed module if there is used
any variant of module router with media (device) definition.
|
|