Class CFriendlyUrlManager

Description

URL manager in replacement of CUrlManager with support of beauty URLs.

It generate and parse URLs in that maner:

Yii::app()->baseUrl./<path>/<action><itemSplitter><titem>.<actionSuffix>>

For use it change class name of urlManager in Yii configuration file (usually 'protected/config/main.php') to the class 'CFriendlyUrlManager'. Additionally, you cat specify next parameters:

  • $itemSplitter
  • $actionSuffix
  • $caseSensitive
  • $furlPageStorageClass
  • $furlPageStorageParams

Located in /CFriendlyUrlManager.php (line 27)

CUrlManager
   |
   --CFriendlyUrlManager
Variable Summary
Method Summary
string createUrl (string|integer $route, [ $params = array()], [integer $item = NULL], [string $action = NULL])
stdObject getLastParse ()
void init ()
array parseAction ( &$pathArray)
string parseUrl ( $request)
array splitUrl ([string $url = NULL])
Variables
string $actionSuffix = 'html' (line 40)

Action suffix.

Default - 'html'

boolean $caseSensitive = false (line 46)

Whether url may be case insensitive or not.

Default - false.

  • access: public
string $furlPageStorageClass = 'CFriendlyUrlPagePhpStorage' (line 58)

Class name for pages storage.

Now realized only two classes:

  • CFriendlyUrlPagePhpStorage for reading pages from PHP-file and
  • CFriendlyUrlPageDbStorage for reading pages from DB.
Default - CFriendlyUrlPgePhpStorage.

array $furlPageStorageParams = array() (line 64)

Additional parameters for initialization of storage class.

Default - empty array.

string $itemSplitter = '.' (line 34)

Action and item splitter character.

Default - dot.

stdObject $lastParse (line 77)

Contains last parsed URL data:

  • string $url - bautifurized current URL,
  • array $pathArray - path elements (web directories),
  • array $parentsArray - all parents pages,
  • CFriendlyUrlPage $page - current page,
  • string $action - requested action,
  • integer $item - requested item for action.

CFriendlyUrlPageControl $pageControl (line 83)

Representative of page control class.

Methods
createUrl (line 183)

Create an friendly URL.

string createUrl (string|integer $route, [ $params = array()], [integer $item = NULL], [string $action = NULL])
  • string|integer $route: URL or ID: uniqueID is negative, pageID is positive.
  • array $params: Additional query params.
  • integer $item: Item ID for action.
  • string $action: Action name.
getLastParse (line 280)

Make $lastParse read-only variable.

stdObject getLastParse ()
getPageControl (line 286)

Make $pageControl read-only variable.

CFriendlyUrlPage getPageControl ()
parseAction (line 255)

Find action and item, if presents.

array parseAction ( &$pathArray)
  • array &$pathArray: Array of path elements.
parseUrl (line 117)

Parse URL into a page, action and item, if that presents.

string parseUrl ( $request)
  • CHttpRequest $request: URL for parse.
splitUrl (line 241)

Split URL into array

array splitUrl ([string $url = NULL])
  • string $url: URL.

Documentation generated on Mon, 13 Apr 2009 16:55:47 +0400 by phpDocumentor 1.4.1