Class: RewriteUrlGenerator

Source Location: /modules/rewrite/classes/RewriteUrlGenerator.class

Class RewriteUrlGenerator

Class Overview

Generic rewrite URL generator.

Located in /modules/rewrite/classes/RewriteUrlGenerator.class [line 35]

GalleryUrlGenerator
   |
   --RewriteUrlGenerator

Properties

Methods

[ Top ]

Direct descendents

Child Class	Description
ModRewriteUrlGenerator	URL Generator for Apache mod_rewrite parser.
IsapiRewriteUrlGenerator	URL Generator for IIS ISAPI_Rewrite parser.
PathInfoUrlGenerator	PHP path info URL generator.

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From GalleryUrlGenerator

GalleryUrlGenerator::$_currentBaseHost

GalleryUrlGenerator::$_currentUrl

GalleryUrlGenerator::$_currentUrlBaseDir

GalleryUrlGenerator::$_embedSessionString

GalleryUrlGenerator::$_file

GalleryUrlGenerator::$_host

GalleryUrlGenerator::$_isCookiePathConfigured

GalleryUrlGenerator::$_path

GalleryUrlGenerator::$_protocol

Inherited From GalleryUrlGenerator

GalleryUrlGenerator::appendParamsToUrl()

Append parameters to a URL using the Gallery prefix and URL encoding keys and values.

GalleryUrlGenerator::assertIsInternalUrl()

Assert that the given URL is internal to the application

GalleryUrlGenerator::embedForceSessionId()

Decide whether to include session id in the URL.

GalleryUrlGenerator::generateUrl()

Generate a Gallery URL.

GalleryUrlGenerator::getCacheableUrl()

Return a URL that is stripped of all parameters that don't directly affect the output of the page, like navigation parameters. This URL can be used as the cache key for this page.

GalleryUrlGenerator::getCookiePath()

Get the cookie path that will encompass Gallery (and CMS app if embedded).

GalleryUrlGenerator::getCurrentRequestUri()

Return the current request URI.

GalleryUrlGenerator::getCurrentUrl()

Return the complete URL of the current request.

GalleryUrlGenerator::getCurrentUrlDir()

Return the base directory of all generated URLs. Eg, if the URL is:

GalleryUrlGenerator::getGalleryId()

Old multisite system used a galleryId based on the current URL. Return a value here so sites won't break before they can upgrade.

GalleryUrlGenerator::getHostName()

Return the host name for the current request.

GalleryUrlGenerator::getNavigationId()

Get the current navigation id.

GalleryUrlGenerator::getNavigationLinks()

Get a list of navigation links to go back to where we came from.

GalleryUrlGenerator::getNavigationReturnUrl()

Get an URL to return to the currently loaded view, stripping all parameters that are of navigational nature.

GalleryUrlGenerator::init()

Configure the GalleryUrlGenerator with all the data it needs.

GalleryUrlGenerator::initNavigation()

Initialize the navigation.

GalleryUrlGenerator::isNavigationBackPossible()

Check if we currently have a back link to where we came from.

GalleryUrlGenerator::makeAbsoluteUrl()

Make a given URL an absolute Gallery URL. The specified URL can be relative (e.g. main.php), server-relative (e.g. /gallery2/main.php) or already absolute.

GalleryUrlGenerator::makeRelativeUrl()

Translate the given absolute URL to a relative URL.

GalleryUrlGenerator::makeUrl()

Add given path to current protocol/server/port to create full URL.

GalleryUrlGenerator::_flattenParamsArray()

Convert a structure of nested URL parameters into a flat array of parameters.

GalleryUrlGenerator::_getLocalPath()

Check for a local override of an href path (to override a css or js file, for example).

GalleryUrlGenerator::_parseUri()

Split a URI string into file, path, host and protocol substrings and normalize them.

GalleryUrlGenerator::_saveLocalUrlMap()

Save changes to the local URL map.

GalleryUrlGenerator::_saveLocalUrlMapPhp5()

Compatibility function for PHP 5.3. See comment in GalleryUrlGenerator::_getLocalPath.

[ Top ]

Property Summary

bool	$_error	If there's an error, use parent GalleryUrlGenerator functions.
array	$_shortUrls	Short URL map.

[ Top ]

Method Summary

void	generateUrl()
void	init()
GalleryEntity	loadEntity()	Load entity.
string	_getBaseParamString()	Return the base URL parameters for all generated short URLs, e.g. '?module=gallery'.
string	_getBaseUrl()	Return the base URL for all generated short URLs.
array	_getShortUrl()	Return first short URL to match URL params.
GalleryStatus	_onLoad()	This function is called at the end of URL generator initialization. If an onLoad function is specified for the current view it loads the needed file and calls the function which should parse any request params that wasn't parsed by the rewrite parser (e.g. %path% to itemId).
boolean	_parseShortUrl()	Substitute all keywords with values from URL params or custom functions.

[ Top ]

Properties

bool $_error = false [line 42]

If there's an error, use parent GalleryUrlGenerator functions.

API Tags:

Access:

private

[ Top ]

array $_shortUrls = array() [line 49]

Short URL map.

API Tags:

Access:

private

[ Top ]

Methods

generateUrl [line 120]

void generateUrl(
[
$params = array()], [
$options = array()] 
)

Parameters:

	$params:
	$options:

API Tags:

See:

GalleryUrlGenerator::generateUrl

Redefinition of:

GalleryUrlGenerator::generateUrl(): Generate a Gallery URL.

Redefined in descendants as:

[ Top ]

init [line 72]

void init(
[
$baseUri = null], [
$g2Uri = null], [
$embedSessionString = null] 
)

Parameters:

	$baseUri:
	$g2Uri:
	$embedSessionString:

API Tags:

See:

GalleryUrlGenerator::init

Redefinition of:

GalleryUrlGenerator::init(): Configure the GalleryUrlGenerator with all the data it needs.

Redefined in descendants as:

[ Top ]

loadEntity [line 221]

GalleryEntity loadEntity(

&$itemId, int
$itemId 
)

Load entity.

Parameters:

int	$itemId:	itemId of the entity to load
	&$itemId:

API Tags:

Return:

or null on failure

[ Top ]

_getBaseParamString [line 256]

string _getBaseParamString(
[boolean
$forceDirect = false] 
)

Return the base URL parameters for all generated short URLs, e.g. '?module=gallery'.

Parameters:

boolean

$forceDirect:

(optional) if true, return Gallery base URL (different when embedded)

API Tags:

Return:	the base URL parameters
Access:	private

Redefined in descendants as:

PathInfoUrlGenerator::_getBaseParamString()

[ Top ]

_getBaseUrl [line 245]

string _getBaseUrl(
[boolean
$forceDirect = false] 
)

Return the base URL for all generated short URLs.

Parameters:

boolean

$forceDirect:

(optional) if true, return Gallery base URL (different when embedded)

API Tags:

Return:	the base URL
Access:	private

Redefined in descendants as:

PathInfoUrlGenerator::_getBaseUrl()

[ Top ]

_getShortUrl [line 56]

array _getShortUrl(
array
$params 
)

Return first short URL to match URL params.

Parameters:

array

$params:

URL params

API Tags:

Return:

first short URL to match URL params

[ Top ]

_onLoad [line 95]

GalleryStatus _onLoad(
)

This function is called at the end of URL generator initialization. If an onLoad function is specified for the current view it loads the needed file and calls the function which should parse any request params that wasn't parsed by the rewrite parser (e.g. %path% to itemId).

API Tags:

Return:

a status code

Information Tags:

Private:

[ Top ]

_parseShortUrl [line 175]

boolean _parseShortUrl(

&$url, 
&$params, array
$options, array
$functions, string
$url, array
$params 
)

Substitute all keywords with values from URL params or custom functions.

Parameters:

string	$url:	URL to be parsed
array	$params:	of URL parameters
array	$options:	of generation options
array	$functions:	of custom functions
	&$url:
	&$params:

API Tags:

Return:	true on success
Access:	private

[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:52:09 -0700 by phpDocumentor 1.3.0RC6

	Rewrite Classes

[ class tree: Rewrite ] [ index: Rewrite ] [ all elements ]