Class: RewriteApi

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

Class RewriteApi

Class Overview

A helper class for the URL Rewrite module

Located in /modules/rewrite/classes/RewriteApi.class [line 33]

Properties

Methods

[ Top ]

Property Summary

GalleryStatus	$_error	If this is set an error has occured where we couldn't report it.
RewriteParser	$_parser	Holds the active parser.

[ Top ]

Method Summary

RewriteApi	RewriteApi()
array	activateRewriteRulesForModule()	Activate the rewrite rules for a specific module which can be inactive at the time of this call. Does not update active rules by default, only changes the list of active rules for the given module.
array	fetchActiveRulesForModule()	Fetch the active rewrite rules for a specific module which can be inactive at the time of this call.
array	fetchEmbedConfig()	Returns the current active configuration values.
array	getApiVersion()
string	getParserId()
string	getParserType()
array	isCompatibleWithApi()	When using this API you should first make sure that your code is compatible with it.
array	needsEmbedConfig()	Checks if the parser needs configuration.
array	saveEmbedConfig()	Saves the configuration.

[ Top ]

Properties

GalleryStatus $_error [line 40]

If this is set an error has occured where we couldn't report it.

[ Top ]

RewriteParser $_parser [line 47]

Holds the active parser.

[ Top ]

Methods

Constructor RewriteApi [line 49]

RewriteApi RewriteApi(
)

[ Top ]

activateRewriteRulesForModule [line 193]

array activateRewriteRulesForModule(
string
$moduleId, [array
$ruleIds = null], [bool
$replacePatterns = false] 
)

Activate the rewrite rules for a specific module which can be inactive at the time of this call. Does not update active rules by default, only changes the list of active rules for the given module.

Parameters:

string	$moduleId:	id of the module
array	$ruleIds:	(optional) list of rule ids to activate. If omitted, all rules get activated
bool	$replacePatterns:	(optional) whether to replace active rules and patterns from the pattern history or to replace them. Defaults to false.

API Tags:

Return:

GalleryStatus a status code boolean true if the operation was successful, false if not (e.g. if the .htaccess could not be written or if the rules are invalid)

[ Top ]

fetchActiveRulesForModule [line 159]

array fetchActiveRulesForModule(
string
$moduleId 
)

Fetch the active rewrite rules for a specific module which can be inactive at the time of this call.

Parameters:

string

$moduleId:

id of the module

API Tags:

Return:

GalleryStatus a status code array $ruleIds list of the active rewrite rule ids

[ Top ]

fetchEmbedConfig [line 108]

array fetchEmbedConfig(
)

Returns the current active configuration values.

API Tags:

Return:

GalleryStatus a status code array configuration settings (key => value)

[ Top ]

getApiVersion [line 252]

array getApiVersion(
)

API Tags:

Return:

api version

[ Top ]

getParserId [line 259]

string getParserId(
)

API Tags:

Return:

parser id

[ Top ]

getParserType [line 266]

string getParserType(
)

API Tags:

Return:

parser type

[ Top ]

isCompatibleWithApi [line 64]

array isCompatibleWithApi(
array
$version 
)

When using this API you should first make sure that your code is compatible with it.

Parameters:

array

$version:

major, minor version

API Tags:

Return:

GalleryStatus a status code boolean true if compatible with given version

[ Top ]

needsEmbedConfig [line 84]

array needsEmbedConfig(
)

Checks if the parser needs configuration.

API Tags:

Return:

GalleryStatus a status code boolean true if configuration is needed

[ Top ]

saveEmbedConfig [line 134]

array saveEmbedConfig(
array
$params 
)

Saves the configuration.

Parameters:

array

$params:

settings to save (key => value)

API Tags:

Return:

GalleryStatus a status code int Rewrite Status code string translated error message

[ Top ]

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

	Rewrite Classes

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