Docs For Class ModRewriteHelper

Class ModRewriteHelper

Method Summary

array	checkFile()	Check if the .htaccess file is writeable.
array	checkModRewrite()	Returns one of the following codes:
array	getHtaccessContent()	Return the .htaccess content given a set or rewrite rules.
array	getHtaccessPath()	Return the absolute path to the .htaccess file.
void	loadAdminRewriteTemplate()
void	loadTestResultsTemplate()
void	needsConfiguration()
void	saveAccessList()
void	saveActiveRules()
void	saveEmbedConfig()
array	writeFile()	Write Gallery data to the .htaccess file.

[ Top ]

Methods

checkFile [line 349]

array checkFile(
[boolean
$embedded = false] 
)

Check if the .htaccess file is writeable.

Parameters:

boolean

$embedded:

(optional) if true then the embedded .htaccess is checked

API Tags:

Return:

GalleryStatus a status code int rewrite status code (REWRITE_STATUS_OK on success)

[ Top ]

checkModRewrite [line 451]

array checkModRewrite(
)

Returns one of the following codes:

REWRITE_STATUS_OK everything is fine REWRITE_STATUS_APACHE_NO_MOD_REWRITE no mod rewrite support REWRITE_STATUS_APACHE_UNABLE_TO_TEST unable to properly test mod_rewrite REWRITE_STATUS_MULTISITE can't test mod_rewrite in multisite

API Tags:

Return:

GalleryStatus a status code int rewrite status code int rewrite true status code

[ Top ]

getHtaccessContent [line 219]

array getHtaccessContent(
array
$regexRules, [boolean
$embedded = false] 
)

Return the .htaccess content given a set or rewrite rules.

Parameters:

array	$regexRules:	regular expression rules with settings
boolean	$embedded:	(optional) true if the embedded .htaccess is wanted

API Tags:

Return:

GalleryStatus a status code string the Gallery .htaccess section

[ Top ]

getHtaccessPath [line 329]

array getHtaccessPath(
[boolean
$embedded = false] 
)

Return the absolute path to the .htaccess file.

Parameters:

boolean

$embedded:

(optional) true if embedded .htaccess is wanted

API Tags:

Return:

GalleryStatus a status code string .htaccess file path

[ Top ]

loadAdminRewriteTemplate [line 627]

void loadAdminRewriteTemplate(

&$template, 
&$form 
)

Parameters:

	&$template:
	&$form:

API Tags:

See:

RewriteParser::loadAdminParserTemplate

[ Top ]

loadTestResultsTemplate [line 535]

void loadTestResultsTemplate(

&$template, 
&$form 
)

Parameters:

	&$template:
	&$form:

API Tags:

See:

RewriteParser::loadTestResultsTemplate

[ Top ]

needsConfiguration [line 162]

void needsConfiguration(
)

API Tags:

See:

RewriteParser::needsConfiguration

[ Top ]

saveAccessList [line 120]

void saveAccessList(

$accessList, 
$allowEmptyReferer 
)

Parameters:

	$accessList:
	$allowEmptyReferer:

API Tags:

See:

RewriteParser::saveAccessList

[ Top ]

saveActiveRules [line 38]

void saveActiveRules(

$parser, [
$activeRules = null], [
$upgradeModule = null] 
)

Parameters:

	$parser:
	$activeRules:
	$upgradeModule:

API Tags:

See:

RewriteParser::saveActiveRules

[ Top ]

saveEmbedConfig [line 662]

void saveEmbedConfig(
array
$param, ModRewriteParser
$parser, boolean
$saveActiveRules 
)

Parameters:

array	$param:	config values
ModRewriteParser	$parser:
boolean	$saveActiveRules:	true if we want to write the .htaccess

API Tags:

See:

RewriteParser::fetchEmbedConfig

[ Top ]

writeFile [line 391]

array writeFile(
array
$regexRules, [boolean
$embedded = false] 
)

Write Gallery data to the .htaccess file.

Parameters:

array	$regexRules:	regular expression rules with settings
boolean	$embedded:	(optional) if true then the embedded .htaccess is written

API Tags:

Return:

GalleryStatus a status code int rewrite status code

[ Top ]

Documentation generated on Wed, 16 Dec 2009 05:08:29 -0800 by phpDocumentor 1.3.0RC6

	Rewrite Parsers

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

Class: ModRewriteHelper

Class ModRewriteHelper