Class: PathInfoParser

Source Location: /modules/rewrite/classes/parsers/pathinfo/parser.inc

Class PathInfoParser

Class Overview

This URL Rewrite parser provides PHP Path Info support for short URLs.

Located in /modules/rewrite/classes/parsers/pathinfo/parser.inc [line 40]

RewriteParser
   |
   --PathInfoParser

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From RewriteParser

RewriteParser::$_parserId

RewriteParser::$_type

RewriteParser::$_urlGeneratorId

Inherited From RewriteParser

RewriteParser::fetchEmbedConfig()

RewriteParser::getErrorMessage()

Returns translated error message, called from AdminRewrite when an unsucsessful save has been made. A valid $code is anything that $this->saveActiveRules would return if an error occurs.

RewriteParser::getParserId()

RewriteParser::getParserType()

RewriteParser::getUrlGeneratorId()

RewriteParser::handleAdminParserRequest()

Handles the submitted form and should save the settings.

RewriteParser::handleTestResultsRequest()

Handles the submitted form and should save any settings (ie. forced tests).

RewriteParser::isValidRule()

This function is called when new rules are saved and by rewrite.AdminRewrite to know if this rule should be displayed. If the parser overrides this function it needs to call this (the parent). It also verifies that locked rules are saved with the original pattern. We perform a sanity check to minimize possible conflicts and bad regular expressions.

RewriteParser::loadAdminParserTemplate()

Displays the parser configuration if the template variable $AdminParser.body is set. It should be a Gallery base dir relative path.

RewriteParser::loadTestResultsTemplate()

Displays the test results if the template variable $TestResults.body is set. It should be a Gallery base dir relative path.

RewriteParser::needsConfiguration()

By default there's nothing to configure, so we return success.

RewriteParser::needsEmbedConfig()

RewriteParser::saveAccessList()

Saves list of hosts Gallery allows as referrer and if Gallery should allow an empty referrer.

RewriteParser::saveActiveRules()

Saves the active rewrite rules. This needs to be implemented by the specific plugin. It needs to save two rewrite params, activeRules and shortUrls. activeRules is just a serialized array of the given activeRules and shortUrls is returned by RewriteHelper::parseActiveRules(). It returns REWRITE_STATUS_OK on success.

RewriteParser::saveEmbedConfig()

RewriteParser::_setParserId()

RewriteParser::_setParserType()

RewriteParser::_setUrlGeneratorId()

[ Top ]

Method Summary

PathInfoParser	PathInfoParser()
void	handleTestResultsRequest()
void	loadTestResultsTemplate()
void	needsConfiguration()
void	saveActiveRules()

[ Top ]

Properties

Methods

Constructor PathInfoParser [line 42]

PathInfoParser PathInfoParser(
)

[ Top ]

handleTestResultsRequest [line 84]

void handleTestResultsRequest(

$form 
)

Parameters:

$form:

API Tags:

See:

RewriteParser::handleTestResultsRequest

Redefinition of:

RewriteParser::handleTestResultsRequest(): Handles the submitted form and should save any settings (ie. forced tests).

[ Top ]

loadTestResultsTemplate [line 75]

void loadTestResultsTemplate(

&$template, 
&$form 
)

Parameters:

	&$template:
	&$form:

API Tags:

See:

RewriteParser::loadTestResultsTemplate

Redefinition of:

RewriteParser::loadTestResultsTemplate(): Displays the test results if the template variable $TestResults.body is set. It should be a Gallery base dir relative path.

[ Top ]

needsConfiguration [line 60]

void needsConfiguration(
)

API Tags:

See:

RewriteParser::needsConfiguration

Redefinition of:

RewriteParser::needsConfiguration(): By default there's nothing to configure, so we return success.

[ Top ]

saveActiveRules [line 51]

void saveActiveRules(
[
$activeRules = null], [
$upgradeModule = null] 
)

Parameters:

	$activeRules:
	$upgradeModule:

API Tags:

See:

RewriteParser::saveActiveRules

Redefinition of:

RewriteParser::saveActiveRules(): Saves the active rewrite rules. This needs to be implemented by the specific plugin. It needs to save two rewrite params, activeRules and shortUrls. activeRules is just a serialized array of the given activeRules and shortUrls is returned by RewriteHelper::parseActiveRules(). It returns REWRITE_STATUS_OK on success.

[ Top ]

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

	Rewrite Parsers

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