Zend\Mvc\Router\Http\TranslatorAwareTreeRouteStack
Translator aware tree route stack.
Synopsis
class TranslatorAwareTreeRouteStack
extends TreeRouteStack
implements
TranslatorAwareInterface
{
- // members
- protected TranslatorInterface $translator;
- protected bool $translatorEnabled;
- protected string $translatorTextDomain;
- // Inherited members from TreeRouteStack
- protected string $baseUrl;
- protected Http $requestUri;
- protected ArrayObject $prototypes;
- // Inherited members from SimpleRouteStack
- protected PriorityList $routes;
- protected RoutePluginManager $routePluginManager;
- protected array $defaultParams;
- // methods
- public RouteMatch|null match()
- public mixed assemble()
- public TreeRouteStack setTranslator()
- public TranslatorInterface getTranslator()
- public bool hasTranslator()
- public TreeRouteStack setTranslatorEnabled()
- public bool isTranslatorEnabled()
- public self setTranslatorTextDomain()
- public string getTranslatorTextDomain()
- // Inherited methods from TreeRouteStack
- public static SimpleRouteStack factory()
- protected void init()
- public TreeRouteStack addRoute()
- protected RouteInterface routeFromArray()
- public TreeRouteStack addPrototypes()
- public TreeRouteStack addPrototype()
- public RouteInterface|null getPrototype()
- public RouteMatch|null match()
- public mixed assemble()
- public self setBaseUrl()
- public string getBaseUrl()
- public TreeRouteStack setRequestUri()
- public Http getRequestUri()
- // Inherited methods from SimpleRouteStack
- public void __construct()
- public static SimpleRouteStack factory()
- protected void init()
- public SimpleRouteStack setRoutePluginManager()
- public RoutePluginManager getRoutePluginManager()
- public SimpleRouteStack addRoutes()
- public SimpleRouteStack addRoute()
- public SimpleRouteStack removeRoute()
- public SimpleRouteStack setRoutes()
- public Traversable getRoutes()
- public bool hasRoute()
- public RouteInterface getRoute()
- public SimpleRouteStack setDefaultParams()
- public SimpleRouteStack setDefaultParam()
- protected RouteInterface routeFromArray()
- public RouteMatch|null match()
- public mixed assemble()
Hierarchy
Extends
Implements
Members
protected
- $baseUrl
—
string
Base URL. - $defaultParams
—
array
Default parameters. - $prototypes
—
ArrayObject
Prototype routes. - $requestUri
—
Zend\Uri\Http
Request URI. - $routePluginManager
—
Zend\Mvc\Router\RoutePluginManager
Route plugin manager - $routes
—
Zend\Mvc\Router\PriorityList
Stack containing all routes. - $translator
—
Zend\I18n\Translator\TranslatorInterface
Translator used for translatable segments. - $translatorEnabled
—
Zend\Mvc\Router\Http\bool
Whether the translator is enabled. - $translatorTextDomain
—
string
Translator text domain to use.
Methods
public
- assemble() — assemble(): defined by \Zend\Mvc\Router\RouteInterface interface.
- getTranslator() — getTranslator(): defined by TranslatorAwareInterface.
- getTranslatorTextDomain() — getTranslatorTextDomain(): defined by TranslatorAwareInterface.
- hasTranslator() — hasTranslator(): defined by TranslatorAwareInterface.
- isTranslatorEnabled() — isTranslatorEnabled(): defined by TranslatorAwareInterface.
- match() — match(): defined by \Zend\Mvc\Router\RouteInterface
- setTranslator() — setTranslator(): defined by TranslatorAwareInterface.
- setTranslatorEnabled() — setTranslatorEnabled(): defined by TranslatorAwareInterface.
- setTranslatorTextDomain() — setTranslatorTextDomain(): defined by TranslatorAwareInterface.
Inherited from Zend\Mvc\Router\Http\TreeRouteStack
protected
- init() — init(): defined by SimpleRouteStack.
- routeFromArray() — routeFromArray(): defined by SimpleRouteStack.
public
- addPrototype() — Add a prototype.
- addPrototypes() — Add multiple prototypes at once.
- addRoute() — addRoute(): defined by RouteStackInterface interface.
- assemble() — assemble(): defined by \Zend\Mvc\Router\RouteInterface interface.
- factory() — factory(): defined by RouteInterface interface.
- getBaseUrl() — Get the base URL.
- getPrototype() — Get a prototype.
- getRequestUri() — Get the request URI.
- match() — match(): defined by \Zend\Mvc\Router\RouteInterface
- setBaseUrl() — Set the base URL.
- setRequestUri() — Set the request URI.
Inherited from Zend\Mvc\Router\SimpleRouteStack
protected
- init() — Init method for extending classes.
- routeFromArray() — Create a route from array specifications.
public
- addRoute() — addRoute(): defined by RouteStackInterface interface.
- addRoutes() — addRoutes(): defined by RouteStackInterface interface.
- assemble() — assemble(): defined by RouteInterface interface.
- factory() — factory(): defined by RouteInterface interface.
- getRoute() — Get a route by name
- getRoutePluginManager() — Get the route plugin manager.
- getRoutes() — Get the added routes
- hasRoute() — Check if a route with a specific name exists
- match() — match(): defined by RouteInterface interface.
- removeRoute() — removeRoute(): defined by RouteStackInterface interface.
- setDefaultParam() — Set a default parameter.
- setDefaultParams() — Set a default parameters.
- setRoutePluginManager() — Set the route plugin manager.
- setRoutes() — setRoutes(): defined by RouteStackInterface interface.