DirectoriesAutoloader Class Reference

Collaboration diagram for DirectoriesAutoloader:

Public Member Functions
	register ()
	forceRegenerate ($className)
	dryRun ($dryRun=true)
	setCachePath ($pTmp)
	setCacheFileName ($ptmpFileName)
	getCacheFilePath ()
	addCustomFilter ($pCustomFilterClass)
	autoload ($pClassName)
	getClassFile ($className)
	classExists ($pClassName)
	addDirectory ($pDirectory, $pRecursive=true)
	addFamilies ($genDirectory)

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

Detailed Description

Definition at line 170 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

Definition at line 307 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

Definition at line 611 of file classAutoloader.php.

addFamilies

(

$genDirectory

)

add Family classes in cache

Parameters

string

$genDirectory

generate family directory

Returns

bool|DirectoriesAutoloader

Exceptions

DirectoriesAutoloaderException

Definition at line 629 of file classAutoloader.php.

Here is the call graph for this function:

autoload

(

$pClassName

)

autoloader

Parameters

string

$pClassName

name of the class to load

Returns

boolean

Definition at line 411 of file classAutoloader.php.

classExists

(

$pClassName

)

Check if a class exists in the autoloader's cache

Parameters

$pClassName

Returns

bool

Definition at line 589 of file classAutoloader.php.

dryRun

(

$dryRun = true

)

Definition at line 242 of file classAutoloader.php.

forceRegenerate

(

$className

)

force autoloader to regenerate cache now!

Returns

Definition at line 229 of file classAutoloader.php.

getCacheFilePath

(

)

get the fully qualified tmp file path

Returns

string

Definition at line 282 of file classAutoloader.php.

getClassFile

(

$className

)

get file path where className is defined

Parameters

string

$className

Returns

string|null

Definition at line 508 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

Definition at line 200 of file classAutoloader.php.

register

(

)

register autoloader against SPL

Returns

boolean

Definition at line 217 of file classAutoloader.php.

setCacheFileName

(

$ptmpFileName

)

define the name of tmp file

Parameters

string

$ptmpFileName

tmp file name

Returns

void

Definition at line 273 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 259 of file classAutoloader.php.

---

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

• classAutoloader.php