Class Localization

Responsibility - recognize localization from URL or from http header or session and set up request object, complete automatically rewritten URL with remembered localization version. Redirect to proper localization by configuration. Than route request like parent class does. Generate URL addresses with prefixed localization for localized routes or add only localization into query string where necessary.

MvcCore\Router implements MvcCore\IRouter uses MvcCore\Router\Props, MvcCore\Router\GettersSetters, MvcCore\Router\Instancing, MvcCore\Router\RouteMethods, MvcCore\Router\Routing, MvcCore\Router\RewriteRouting, MvcCore\Router\Canonical, MvcCore\Router\Redirecting, MvcCore\Router\UrlBuilding, MvcCore\Router\UrlByQuery, MvcCore\Router\UrlByRoutes

Namespace: MvcCore\Ext\Routers
Located at ext-router-localization/src/MvcCore/Ext/Routers/Localization.php

Methods inherited from MvcCore\IRouter
AddRoute(), AddRoutes(), GetAutoCanonizeRequests(), GetCurrentRoute(), GetDefaultParams(), GetInstance(), GetPreRouteMatchingHandler(), GetPreRouteUrlBuildingHandler(), GetRequest(), GetRequestedParams(), GetRoute(), GetRouteByQueryString(), GetRouteToDefaultIfNotMatch(), GetRoutes(), GetTrailingSlashBehaviour(), HasRoute(), RedefineRoutedTarget(), RemoveRoute(), Route(), SetAutoCanonizeRequests(), SetCurrentRoute(), SetOrCreateDefaultRouteAsCurrent(), SetPreRouteMatchingHandler(), SetPreRouteUrlBuildingHandler(), SetRequest(), SetRouteByQueryString(), SetRouteToDefaultIfNotMatch(), SetRoutes(), SetTrailingSlashBehaviour(), Url(), UrlByQueryString(), UrlByRoute()

Methods inherited from MvcCore\Ext\Routers\ILocalization
AddAllowedLocalizations(), AddLocalizationEquivalents(), GetAllowNonLocalizedRoutes(), GetAllowedLocalizations(), GetDefaultLocalization(), GetDetectLocalizationOnlyByLang(), GetLocalization(), GetLocalizationEquivalents(), GetRedirectFirstRequestToDefault(), GetRouteRecordsByLanguageAndLocale(), SetAllowNonLocalizedRoutes(), SetAllowedLocalizations(), SetDefaultLocalization(), SetDetectLocalizationOnlyByLang(), SetLocalization(), SetLocalizationEquivalents(), SetRedirectFirstRequestToDefault(), SetRouteRecordsByLanguageAndLocale()

Methods inherited from MvcCore\Ext\Routers\IExtended
`GetRouteGetRequestsOnly(), GetSessionExpirationSeconds(), GetStricModeBySession(), SetRouteGetRequestsOnly(), SetSessionExpirationSeconds(), SetStricModeBySession()`

Methods used from MvcCore\Ext\Routers\Localization\Preparing
`prepareLocalization(), prepareRequestLocalizationFromUrl(), prepareRequestLocalizationFromUrlPath(), prepareRequestLocalizationFromUrlQueryString(), prepareSetUpRequestLocalizationIfValid()`

Methods used from MvcCore\Ext\Routers\Localization\PreRouting
`checkLocalizationWithUrlAndRedirectIfNecessary(), manageLocalizationDetectionAndStoreInSession(), manageLocalizationSwitchingAndRedirect(), preRouteLocalization(), setUpLocalizationToContextAndSession()`

Methods used from MvcCore\Ext\Routers\Localization\PropsGettersSetters
AddAllowedLocalizations(), AddLocalizationEquivalents(), AddRoutes(), GetAllowNonLocalizedRoutes(), GetAllowedLocalizations(), GetDefaultLocalization(), GetDetectLocalizationOnlyByLang(), GetLocalization(), GetLocalizationEquivalents(), GetRedirectFirstRequestToDefault(), GetRouteRecordsByLanguageAndLocale(), SetAllowNonLocalizedRoutes(), SetAllowedLocalizations(), SetDefaultLocalization(), SetDetectLocalizationOnlyByLang(), SetLocalization(), SetLocalizationEquivalents(), SetRedirectFirstRequestToDefault(), SetRouteRecordsByLanguageAndLocale(), SetRoutes(), addRouteToGroup(), getRouteInstance(), isRouteCfgDataLocalized(), redirectLocalizationGetUrlValueAndUnsetGet(), removeRouteFromGroup()

Methods used from MvcCore\Ext\Routers\Localization\RedirectSections
`redirectToVersionSections()`

Methods used from MvcCore\Ext\Routers\Localization\RewriteRouting
`rewriteRouting(), rewriteRoutingGetRoutesToMatch()`

Methods used from MvcCore\Ext\Routers\Localization\RewriteRoutingChecks
`rewriteRoutingCheckRoute()`

Methods used from MvcCore\Ext\Routers\Localization\Routing
`Route()`

Methods used from MvcCore\Ext\Routers\Localization\UrlByRoute
`UrlByRoute()`

Methods used from MvcCore\Ext\Routers\Localization\UrlByRouteSections
`urlByRouteSections()`

Methods used from MvcCore\Ext\Routers\Localization\UrlByRouteSectionsLocalization
`urlByRouteSectionsLocalization()`

Methods used from MvcCore\Router\GettersSetters
`GetAutoCanonizeRequests(), GetDefaultParams(), GetPreRouteMatchingHandler(), GetPreRouteUrlBuildingHandler(), GetRequest(), GetRequestedParams(), GetRouteByQueryString(), GetRouteToDefaultIfNotMatch(), GetTrailingSlashBehaviour(), SetAutoCanonizeRequests(), SetPreRouteMatchingHandler(), SetPreRouteUrlBuildingHandler(), SetRequest(), SetRouteByQueryString(), SetRouteToDefaultIfNotMatch(), SetTrailingSlashBehaviour()`

Methods used from MvcCore\Router\Instancing
`GetInstance(), __construct()`

Methods used from MvcCore\Router\RouteMethods
`AddRoute(), GetCurrentRoute(), GetRoute(), GetRoutes(), HasRoute(), RemoveRoute(), SetCurrentRoute()`

Methods used from MvcCore\Router\Routing
`RedefineRoutedTarget(), SetOrCreateDefaultRouteAsCurrent(), queryStringRouting(), routeDetectStrategy(), routeProcessRouteRedirectionIfAny(), routeSetUpDefaultForHomeIfNoMatch(), routeSetUpSelfRouteNameIfAny()`

Methods used from MvcCore\Router\RewriteRouting
`rewriteRoutingGetReqPathFirstWord(), rewriteRoutingProcessPreHandler(), rewriteRoutingSetRequestParams(), rewriteRoutingSetRequestedAndDefaultParams(), rewriteRoutingSetUpCurrentRouteByRequest()`

Methods used from MvcCore\Router\Canonical
`canonicalRedirectIfAny(), canonicalRedirectQueryStringStrategy(), canonicalRedirectRewriteRoutesStrategy()`

Methods used from MvcCore\Router\Redirecting
`redirect(), redirectToProperTrailingSlashIfNecessary()`

Methods used from MvcCore\Router\UrlBuilding
`Url(), urlGetCompletedCtrlActionKey()`

Methods used from MvcCore\Router\UrlByQuery
`UrlByQueryString(), urlByQueryStringCompleteCtrlAction(), urlByQueryStringCompleteResult(), urlGetAbsoluteParam()`

Methods used from MvcCore\Router\UrlByRoutes
`getQueryStringParamsSepatator()`

Constants summary
`string`	`VERSION` MvcCore Extension - Router - Localization - version: Comparison by PHP function version_compare(); MvcCore Extension - Router - Localization - version: Comparison by PHP function version_compare(); See http://php.net/manual/en/function.version-compare.php	# `'5.0.0'`

Constants inherited from MvcCore\Router\IConstants
`DEFAULT_ROUTE_NAME, DEFAULT_ROUTE_NAME_ERROR, DEFAULT_ROUTE_NAME_NOT_FOUND, TRAILING_SLASH_ALWAYS, TRAILING_SLASH_BENEVOLENT, TRAILING_SLASH_REMOVE, URL_PARAM_ABSOLUTE, URL_PARAM_ACTION, URL_PARAM_BASEPATH, URL_PARAM_CONTROLLER, URL_PARAM_DOMAIN, URL_PARAM_HOST, URL_PARAM_PATH, URL_PARAM_SLD, URL_PARAM_TLD`

Constants inherited from MvcCore\Ext\Routers\ILocalization
`LANG_AND_LOCALE_SEPARATOR, URL_PARAM_LOCALIZATION, URL_PARAM_REDIRECTED_SOURCE, URL_PARAM_SWITCH_LOCALIZATION`

Properties used from MvcCore\Router\Props
`$anyRoutesConfigured, $application, $autoCanonizeRequests, $currentRoute, $defaultParams, $instance, $internalRequest, $noUrlRoutes, $preRouteMatchingHandler, $preRouteUrlBuildingHandler, $queryParamsSepatator, $request, $requestedParams, $routeByQueryString, $routeClass, $routeToDefaultIfNotMatch, $routerClass, $routes, $routesGroups, $selfRouteName, $toolClass, $trailingSlashBehaviour, $urlRoutes`

Properties used from MvcCore\Ext\Routers\Localization\PropsGettersSetters
`$allowNonLocalizedRoutes, $allowedLocalizations, $defaultLocalization, $defaultLocalizationStr, $detectLocalizationOnlyByLang, $firstRequestLocalizationDetection, $localization, $localizationEquivalents, $originalRequestPath, $redirectFirstRequestToDefault, $requestLocalization, $requestLocalizationEquivalent, $routeClassLocalized, $routeRecordsByLanguageAndLocale, $sessionLocalization, $switchUriParamLocalization`

Classes

Interfaces

Traits

Exceptions

Functions

Class Localization

See