Trait RouteMethods

Direct Known Users

MvcCore\Ext\Routers\Module, MvcCore\Ext\Routers\ModuleLocalization, MvcCore\Ext\Routers\ModuleMedia, MvcCore\Ext\Routers\ModuleMediaAndLocalization

Namespace: MvcCore\Ext\Routers\Module
Located at ext-router-module/src/MvcCore/Ext/Routers/Module/RouteMethods.php

Methods summary
`public MvcCore\Ext\Routers\Module`	# `SetDomainRoutes( MvcCore\Ext\Routers\Modules\Route[]\|array\|array[] $routes = [], boolean $autoInitialize = TRUE )` Clear all possible previously configured module domain routes and set new given routes again collection again. If there is no module property configured in given route item in array configuration, route module is set by given `$routes` array key, if key is not numeric. Clear all possible previously configured module domain routes and set new given routes again collection again. If there is no module property configured in given route item in array configuration, route module is set by given `$routes` array key, if key is not numeric. Routes could be defined in various forms: Example: `\MvcCore\Router::GetInstance()->SetDomainRoutes([ "blog" => [ "pattern" => "//blog.%sld%.%tld%", "namespace" => "Blog", "defaults" => ["page" => 1], "constraints" => ["page" => "\d+"], "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ], "main" => [ "pattern" => "//%domain%", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ] ]);` or: \MvcCore\Router::GetInstance()->SetDomainRoutes([ new \MvcCore\Ext\Routers\Modules\Route( "//blog.%sld%.%tld%", // pattern "blog", // module "Blog", // namespace ["page" => 1], // defaults ["page" => "\d+"], // constraints [ // advanced configuration "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ] ), new \MvcCore\Ext\Routers\Modules\Route([ "pattern" => "//%domain%", "module" => "main", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ]) ]); Parameters `$routes` `$autoInitialize` Returns `MvcCore\Ext\Routers\Module` Throws InvalidArgumentException
`public MvcCore\Ext\Routers\Module`	# `AddDomainRoutes( MvcCore\Ext\Routers\Modules\Route[]\|array\|array[] $routes, boolean $prepend = FALSE, boolean $throwExceptionForDuplication = TRUE )` Append or prepend new module domain routes. If there is no module property configured in given route item in array configuration, route module is set by given `$routes` array key, if key is not numeric. Append or prepend new module domain routes. If there is no module property configured in given route item in array configuration, route module is set by given `$routes` array key, if key is not numeric. Routes could be defined in various forms: Example: `\MvcCore\Router::GetInstance()->AddDomainRoutes([ "blog" => [ "pattern" => "//blog.%sld%.%tld%", "namespace" => "Blog", "defaults" => ["page" => 1], "constraints" => ["page" => "\d+"], "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ], "main" => [ "pattern" => "//%domain%", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ] ]);` or: \MvcCore\Router::GetInstance()->AddDomainRoutes([ new \MvcCore\Ext\Routers\Modules\Route( "//blog.%sld%.%tld%", // pattern "blog", // module "Blog", // namespace ["page" => 1], // defaults ["page" => "\d+"], // constraints [ // advanced configuration "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ] ), new \MvcCore\Ext\Routers\Modules\Route([ "pattern" => "//%domain%", "module" => "main", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ]) ]); Parameters `$routes` `$prepend` `$throwExceptionForDuplication` Returns `MvcCore\Ext\Routers\Module` Throws InvalidArgumentException
`public MvcCore\Ext\Routers\Module`	# `AddDomainRoute( MvcCore\Ext\Routers\Modules\Route\|array $routeCfgOrRoute, boolean $prepend = FALSE, boolean $throwExceptionForDuplication = TRUE )` Append or prepend new module domain route. Example: `\MvcCore\Router::GetInstance()->AddDomainRoute([ "blog" => [ "pattern" => "//blog.%sld%.%tld%", "namespace" => "Blog", "defaults" => ["page" => 1], "constraints" => ["page" => "\d+"], "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ], "main" => [ "pattern" => "//%domain%", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ] ]);` or: \MvcCore\Router::GetInstance()->AddDomainRoute([ new \MvcCore\Ext\Routers\Modules\Route( "//blog.%sld%.%tld%", // pattern "blog", // module "Blog", // namespace ["page" => 1], // defaults ["page" => "\d+"], // constraints [ // advanced configuration "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ] ), new \MvcCore\Ext\Routers\Modules\Route([ "pattern" => "//%domain%", "module" => "main", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ]) ]); Append or prepend new module domain route. Example: `\MvcCore\Router::GetInstance()->AddDomainRoute([ "blog" => [ "pattern" => "//blog.%sld%.%tld%", "namespace" => "Blog", "defaults" => ["page" => 1], "constraints" => ["page" => "\d+"], "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ], "main" => [ "pattern" => "//%domain%", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ] ]);` or: \MvcCore\Router::GetInstance()->AddDomainRoute([ new \MvcCore\Ext\Routers\Modules\Route( "//blog.%sld%.%tld%", // pattern "blog", // module "Blog", // namespace ["page" => 1], // defaults ["page" => "\d+"], // constraints [ // advanced configuration "allowedLocalizations" => ["en-US"], "allowedMediaVersions" => ["full" => ""] ] ), new \MvcCore\Ext\Routers\Modules\Route([ "pattern" => "//%domain%", "module" => "main", "allowedLocalizations" => ["en-US", "de-DE"], "allowedMediaVersions" => ["mobile" => "m", "full" => ""] ]) ]); Parameters `$routeCfgOrRoute` `$prepend` `$throwExceptionForDuplication` Returns `MvcCore\Ext\Routers\Module` Throws InvalidArgumentException
`protected MvcCore\Ext\Routers\Modules\Route`	# `getRouteDomainInstance( MvcCore\Ext\Routers\Modules\Route\|array & $routeCfgOrRoute )` Get always route instance from given route configuration data or return already created given instance. Get always route instance from given route configuration data or return already created given instance. Parameters `$routeCfgOrRoute` Route instance or route config array. Returns `MvcCore\Ext\Routers\Modules\Route`