Class \Prado\Web\TUrlManager

TUrlManager class

TUrlManager is the base class for managing URLs that can be recognized by PRADO applications. It provides the default implementation for parsing and constructing URLs.

Derived classes may override constructUrl and parseUrl to provide customized URL schemes.

By default, THttpRequest uses TUrlManager as its URL manager. If you want to use your customized URL manager, load your manager class as an application module and set \Prado\Web\THttpRequest::setUrlManager with the ID of your URL manager module.

Class hierarchy

\Prado\Web\TUrlManager

\Prado\TModule implements IModule

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0.6

Methods summary
`public`	`constructUrl(string $serviceID, string $serviceParam, array<string\|int, mixed> $getItems, bool $encodeAmpersand, bool $encodeGetItems) : string` Constructs a URL that can be recognized by PRADO. This method provides the actual implementation used by THttpRequest::constructUrl. Override this method if you want to provide your own way of URL formatting. If you do so, you may also need to override parseUrl so that the URL can be properly parsed. The URL is constructed as the following format: `/entryscript.php?serviceID=serviceParameter&get1=value1&...` If \Prado\Web\THttpRequest::setUrlFormat is 'Path', the following format is used instead: `/entryscript.php/serviceID/serviceParameter/get1,value1/get2,value2...` If \Prado\Web\THttpRequest::setUrlFormat is 'HiddenPath', then entryscript.php will be hidden and the following format is used instead: `/serviceID/serviceParameter/get1,value1/get2,value2...` In order to use the 'HiddenPath' format you need proper url rewrite configuration; here's an example for Apache's .htaccess: `Options +FollowSymLinks RewriteEngine On RewriteCond %{REQUEST_FILENAME} !-d RewriteCond %{REQUEST_FILENAME} !-f RewriteRule ^(.*)$ index.php/$1 [L]`
`public`	`parseUrl() : array<string\|int, mixed>` Parses the request URL and returns an array of input parameters. This method is automatically invoked by THttpRequest when handling a user request. In general, this method should parse the path info part of the requesting URL and generate an array of name-value pairs according to some scheme. The current implementation deals with both 'Get' and 'Path' URL formats. You may override this method to support customized URL format.

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getApplication, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getID, getListeningToGlobalEvents, getRequest, getResponse, getService, getSession, getSubProperty, getUser, hasEvent, hasEventHandler, hasMethod, hasProperty, init, isa, listen, publishAsset, publishFilePath, raiseEvent, setID, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`