Class: ModRewriteParser

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

Class ModRewriteParser

Class Overview

This URL rewrite parser provides Apache mod_rewrite support for short URLs.

http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html

Located in /modules/rewrite/classes/parsers/modrewrite/parser.inc [line 51]

RewriteParser
   |
   --ModRewriteParser

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

ModRewriteParser	ModRewriteParser()
void	fetchEmbedConfig()
void	getErrorMessage()
void	handleAdminParserRequest()
void	handleTestResultsRequest()
void	loadAdminParserTemplate()
void	loadTestResultsTemplate()
void	needsConfiguration()
void	needsEmbedConfig()
void	saveAccessList()
void	saveActiveRules()
void	saveEmbedConfig()

[ Top ]

Properties

Methods

Constructor ModRewriteParser [line 53]

ModRewriteParser ModRewriteParser(
)

[ Top ]

fetchEmbedConfig [line 246]

void fetchEmbedConfig(
)

API Tags:

See:

RewriteParser::fetchEmbedConfig

Redefinition of:

RewriteParser::fetchEmbedConfig()

[ Top ]

getErrorMessage [line 89]

void getErrorMessage(

$code, [
$rewriteModule = null] 
)

Parameters:

	$code:
	$rewriteModule:

API Tags:

See:

RewriteParser::getErrorMessage

Redefinition of:

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.

[ Top ]

handleAdminParserRequest [line 184]

void handleAdminParserRequest(

$form 
)

Parameters:

$form:

API Tags:

See:

RewriteParser::handleAdminParserRequest

Redefinition of:

RewriteParser::handleAdminParserRequest(): Handles the submitted form and should save the settings.

[ Top ]

handleTestResultsRequest [line 144]

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 ]

loadAdminParserTemplate [line 175]

void loadAdminParserTemplate(

&$template, 
&$form 
)

Parameters:

	&$template:
	&$form:

API Tags:

See:

RewriteParser::loadAdminParserTemplate

Redefinition of:

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

[ Top ]

loadTestResultsTemplate [line 135]

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 80]

void needsConfiguration(
)

API Tags:

See:

RewriteParser::needsConfiguration

Redefinition of:

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

[ Top ]

needsEmbedConfig [line 227]

void needsEmbedConfig(
)

API Tags:

See:

RewriteParser::needsEmbedConfig

Redefinition of:

RewriteParser::needsEmbedConfig()

[ Top ]

saveAccessList [line 71]

void saveAccessList(

$accessList, 
$allowEmptyReferer 
)

Parameters:

	$accessList:
	$allowEmptyReferer:

API Tags:

See:

RewriteParser::saveAccessList

Redefinition of:

RewriteParser::saveAccessList(): Saves list of hosts Gallery allows as referrer and if Gallery should allow an empty referrer.

[ Top ]

saveActiveRules [line 62]

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 ]

saveEmbedConfig [line 264]

void saveEmbedConfig(

$param 
)

Parameters:

$param:

API Tags:

See:

RewriteParser::fetchEmbedConfig

Redefinition of:

RewriteParser::saveEmbedConfig()

[ Top ]

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

	Rewrite Parsers

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