Class: GLOptimizerModule

Source Location: /engine/lib/common/optimizer.php

Class GLOptimizerModule

Class Overview

Optimizer Module This abstract class is the base class of an optimizing module.

Optimizer Module This abstract class is the base class of an optimizing module. Each optimizer should extend this.

Located in /engine/lib/common/optimizer.php [line 150]

Author(s):

Information Tags:

Version:

1.0

Methods

[ Top ]

Descendants

Child Class	Description
opt_compatibility	Compatibility file optimizer This class is used in order to provide compatibility with every PHP system.
opt_xmlconfig	XML Configuration file optimizer This optimizer provides faster access to XML configs, by caching the XML file into a PHP-Array-Encoded format.

[ Top ]

Method Summary

string	allocate_cache()	Allocate a new file in cache
void	is_valid()
void	optimize_file()
void	optimize_string()
bool	should_update()	Check whether we should update or not the cached file

[ Top ]

Methods

allocate_cache [line 171]

string allocate_cache(
string
$prefix, [string
$uid = false] 
)

Allocate a new file in cache

Allocate a new file in cache

Parameters:

string	$prefix:	A group name that will be prefixed on the cache file
string	$uid:	[Optiona] A unique identifier for the file being optimized. If not specified, a new will be generated

API Tags:

Return:

Returns the new cache file path

[ Top ]

is_valid [line 152]

void is_valid(

$categories, 
$string 
)

Parameters:

	$categories:
	$string:

API Tags:

Access:

public

Redefined in descendants as:

[ Top ]

optimize_file [line 160]

void optimize_file(

$file, 
$options 
)

Parameters:

	$file:
	$options:

API Tags:

Access:

public

Redefined in descendants as:

[ Top ]

optimize_string [line 156]

void optimize_string(

$string, 
$options 
)

Parameters:

	$string:
	$options:

API Tags:

Access:

public

Redefined in descendants as:

opt_compatibility::optimize_string()

[ Top ]

should_update [line 188]

bool should_update(
string
$file, [mixed
$check = false] 
)

Check whether we should update or not the cached file

Check whether we should update or not the cached file

Parameters:

string	$file:	The path to the cache file
mixed	$check:	If this variable is FALSE, no previously existing file check will be performed; it will be replaced immediately. If this variable is an MD5 string, the file contents will be matched with the string provided. If this variable is a timestamp, the file's last modification date will be required to be newer than the provided.

API Tags:

Return:

Returns TRUE if FALSE, depedning on when you should or should not update this cache file

[ Top ]

Documentation generated on Tue, 13 Oct 2009 23:49:14 +0300 by phpDocumentor 1.4.1

	GloryLands Common

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