CBaseUrlRule
| Package | system.web |
|---|---|
| Inheritance | abstract class CBaseUrlRule » CComponent |
| Subclasses | CUrlRule |
| Since | 1.1.8 |
| Source Code | framework/web/CUrlManager.php |
CBaseUrlRule is the base class for a URL rule class.
Custom URL rule classes should extend from this class and implement two methods: createUrl and parseUrl.
Custom URL rule classes should extend from this class and implement two methods: createUrl and parseUrl.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| hasHostInfo | boolean | whether this rule will also parse the host info part. | CBaseUrlRule |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | CComponent |
| __get() | Returns a property value, an event handler list or a behavior based on its name. | CComponent |
| __isset() | Checks if a property value is null. | CComponent |
| __set() | Sets value of a component property. | CComponent |
| __unset() | Sets a component property to be null. | CComponent |
| asa() | Returns the named behavior object. | CComponent |
| attachBehavior() | Attaches a behavior to this component. | CComponent |
| attachBehaviors() | Attaches a list of behaviors to the component. | CComponent |
| attachEventHandler() | Attaches an event handler to an event. | CComponent |
| canGetProperty() | Determines whether a property can be read. | CComponent |
| canSetProperty() | Determines whether a property can be set. | CComponent |
| createUrl() | Creates a URL based on this rule. | CBaseUrlRule |
| detachBehavior() | Detaches a behavior from the component. | CComponent |
| detachBehaviors() | Detaches all behaviors from the component. | CComponent |
| detachEventHandler() | Detaches an existing event handler. | CComponent |
| disableBehavior() | Disables an attached behavior. | CComponent |
| disableBehaviors() | Disables all behaviors attached to this component. | CComponent |
| enableBehavior() | Enables an attached behavior. | CComponent |
| enableBehaviors() | Enables all behaviors attached to this component. | CComponent |
| evaluateExpression() | Evaluates a PHP expression or callback under the context of this component. | CComponent |
| getEventHandlers() | Returns the list of attached event handlers for an event. | CComponent |
| hasEvent() | Determines whether an event is defined. | CComponent |
| hasEventHandler() | Checks whether the named event has attached handlers. | CComponent |
| hasProperty() | Determines whether a property is defined. | CComponent |
| parseUrl() | Parses a URL based on this rule. | CBaseUrlRule |
| raiseEvent() | Raises an event. | CComponent |
Property Details
hasHostInfo property
public boolean $hasHostInfo;
whether this rule will also parse the host info part. Defaults to false.
Method Details
createUrl() method
abstract public mixed createUrl(CUrlManager $manager, string $route, array $params, string $ampersand) | ||
| $manager | CUrlManager | the manager |
| $route | string | the route |
| $params | array | list of parameters (name=>value) associated with the route |
| $ampersand | string | the token separating name-value pairs in the URL. |
| {return} | mixed | the constructed URL. False if this rule does not apply. |
Source Code: framework/web/CUrlManager.php#543 (show)
abstract public function createUrl($manager,$route,$params,$ampersand);
Creates a URL based on this rule.
parseUrl() method
abstract public mixed parseUrl(CUrlManager $manager, CHttpRequest $request, string $pathInfo, string $rawPathInfo) | ||
| $manager | CUrlManager | the URL manager |
| $request | CHttpRequest | the request object |
| $pathInfo | string | path info part of the URL (URL suffix is already removed based on CUrlManager::urlSuffix) |
| $rawPathInfo | string | path info that contains the potential URL suffix |
| {return} | mixed | the route that consists of the controller ID and action ID. False if this rule does not apply. |
Source Code: framework/web/CUrlManager.php#552 (show)
abstract public function parseUrl($manager,$request,$pathInfo,$rawPathInfo);
Parses a URL based on this rule.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CBaseUrlRule