DirectoriesAutoloader Class Reference

Collaboration diagram for DirectoriesAutoloader:

Public Member Functions
	register ()
	forceRegenerate ()
	setCachePath ($pTmp)
	setCacheFileName ($ptmpFileName)
	getCacheFilePath ()
	addCustomFilter ($pCustomFilterClass)
	autoload ($pClassName)
	addDirectory ($pDirectory, $pRecursive=true)

Static Public Member Functions
static	instance ($pTmpPath, $pTmpFileName= 'directoriesautoloader.cache.php')

Detailed Description

Definition at line 121 of file classAutoloader.php.

Member Function Documentation

addCustomFilter

(

$pCustomFilterClass

)

add an instance of FilterIterator as custom filter

Parameters

string

$pCustomFilterClass

className of customFilter to add

Exceptions

dcp\DirectoriesAutoloaderException

Returns

dcp

Definition at line 234 of file classAutoloader.php.

addDirectory	(		$pDirectory,
			$pRecursive = true
	)

add a directory to autoloaded directories

Parameters

string	$pDirectory	directory path
boolean	$pRecursive	should we recursively scan this directory

Exceptions

dcp\DirectoriesAutoloaderException

Returns

dcp

Definition at line 403 of file classAutoloader.php.

autoload

(

$pClassName

)

autoloader

Parameters

string

$pClassName

name of the class to load

Returns

boolean

Definition at line 262 of file classAutoloader.php.

forceRegenerate

(

)

force autoloader to regenerate cache now!

Returns

dcp

Definition at line 176 of file classAutoloader.php.

getCacheFilePath

(

)

get the fully qualified tmp file path

Returns

string

Definition at line 218 of file classAutoloader.php.

static instance (   $pTmpPath,   $pTmpFileName = 'directoriesautoloader.cache.php'  )

static

get singleton for DirectoriesAutoloader

Parameters

string	$pTmpPath	path to tmp dir
string	$pTmpFileName	tmp file name

Returns

dcp

Definition at line 147 of file classAutoloader.php.

register

(

)

register autoloader against SPL

Returns

boolean

Definition at line 164 of file classAutoloader.php.

setCacheFileName

(

$ptmpFileName

)

define the name of tmp file

Parameters

string

$ptmpFileName

tmp file name

Returns

void

Definition at line 209 of file classAutoloader.php.

setCachePath

(

$pTmp

)

define the path of tmp directory

Parameters

string

$pTmp

cache directory path

Exceptions

\dcp\DirectoriesAutoloaderException

Returns

void

Definition at line 195 of file classAutoloader.php.

---

The documentation for this class was generated from the following file:

• classAutoloader.php