Class: PathInfoUrlGenerator

Source Location: /modules/rewrite/classes/parsers/pathinfo/PathInfoUrlGenerator.class

Class PathInfoUrlGenerator

Class Overview

PHP path info URL generator.

Located in /modules/rewrite/classes/parsers/pathinfo/PathInfoUrlGenerator.class [line 35]

GalleryUrlGenerator
   |
   --RewriteUrlGenerator
      |
      --PathInfoUrlGenerator

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From RewriteUrlGenerator

RewriteUrlGenerator::$_error

RewriteUrlGenerator::$_shortUrls

Inherited From GalleryUrlGenerator

GalleryUrlGenerator::$_currentBaseHost

GalleryUrlGenerator::$_currentUrl

GalleryUrlGenerator::$_currentUrlBaseDir

GalleryUrlGenerator::$_embedSessionString

GalleryUrlGenerator::$_file

GalleryUrlGenerator::$_host

GalleryUrlGenerator::$_isCookiePathConfigured

GalleryUrlGenerator::$_path

GalleryUrlGenerator::$_protocol

Inherited From RewriteUrlGenerator

RewriteUrlGenerator::generateUrl()

RewriteUrlGenerator::init()

RewriteUrlGenerator::loadEntity()

Load entity.

RewriteUrlGenerator::_getBaseParamString()

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

RewriteUrlGenerator::_getBaseUrl()

Return the base URL for all generated short URLs.

RewriteUrlGenerator::_getShortUrl()

Return first short URL to match URL params.

RewriteUrlGenerator::_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).

RewriteUrlGenerator::_parseShortUrl()

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

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

array	$_baseParamString	Base parameter string for all generated URLs, e.g. 'module=gallery'. Index of array = $forceDirect (true/false) only relevant for embedded Gallery.
array	$_piFile	URL base filename of Gallery. Doesn't include URL parameters (unlike GalleryUrlGenerator::_file). Index of array = $forceDirect (true/false) only relevant for embedded Gallery.

[ Top ]

Method Summary

void	generateUrl()
string	getCurrentUrlDir()	Return the base directory of all generated URLs, e.g. if the URL is:
void	init()
void	initNavigation()
void	_getBaseParamString()
void	_getBaseUrl()

[ Top ]

Properties

array $_baseParamString [line 43]

Base parameter string for all generated URLs, e.g. 'module=gallery'. Index of array = $forceDirect (true/false) only relevant for embedded Gallery.

API Tags:

Access:

private

[ Top ]

array $_piFile [line 52]

URL base filename of Gallery. Doesn't include URL parameters (unlike GalleryUrlGenerator::_file). Index of array = $forceDirect (true/false) only relevant for embedded Gallery.

API Tags:

Access:

private

[ Top ]

Methods

generateUrl [line 155]

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

Parameters:

	$params:
	$options:

API Tags:

See:

GalleryUrlGenerator::generateUrl

Redefinition of:

RewriteUrlGenerator::generateUrl()

[ Top ]

getCurrentUrlDir [line 202]

string getCurrentUrlDir(
[boolean
$forceDirect = false] 
)

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

http://example.com/gallery2/main.php/Travels/Somewhere/IMG001.jpg.htm Then we return: http://example.com/gallery2/

Note that the URL parts can all be overridden.

Parameters:

boolean

$forceDirect:

(optional) ensure Gallery base URL is returned (different when embedded)

API Tags:

Return:

the base URL directory

Redefinition of:

GalleryUrlGenerator::getCurrentUrlDir(): Return the base directory of all generated URLs. Eg, if the URL is:

[ Top ]

init [line 57]

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

Parameters:

	$baseUri:
	$g2Uri:
	$embedSessionString:

API Tags:

See:

GalleryUrlGenerator::init

Redefinition of:

RewriteUrlGenerator::init()

[ Top ]

initNavigation [line 138]

void initNavigation(
)

API Tags:

See:

GalleryUrlGenerator::initNavigation

Redefinition of:

GalleryUrlGenerator::initNavigation(): Initialize the navigation.

[ Top ]

_getBaseParamString [line 186]

void _getBaseParamString(
[
$forceDirect = false] 
)

Parameters:

$forceDirect:

API Tags:

See:

RewriteUrlGenerator::_getBaseParamString

Redefinition of:

RewriteUrlGenerator::_getBaseParamString(): Return the base URL parameters for all generated short URLs, e.g. '?module=gallery'.

[ Top ]

_getBaseUrl [line 173]

void _getBaseUrl(
[
$forceDirect = false] 
)

Parameters:

$forceDirect:

API Tags:

See:

RewriteUrlGenerator::_getBaseUrl

Redefinition of:

RewriteUrlGenerator::_getBaseUrl(): Return the base URL for all generated short URLs.

[ Top ]

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

	Rewrite Parsers

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