Elgg\AutoloadManager Class Reference

Manages core autoloading and caching of class maps. More...

Public Member Functions
	__construct (protected ClassLoader $loader, protected AutoloadCache $cache)
	Constructor. More...
	addClasses (string $dir)
	Add classes found in this directory to the class map and allow classes in subdirectories to be found by PSR-0 rules. More...
	saveCache ()
	If necessary, save necessary state details. More...
	loadCache ()
	Set the state of the manager from the cache. More...
	deleteCache ()
	Delete the cache file. More...

Public Attributes
const	FILENAME = 'autoload_data.php'
const	KEY_CLASSES = 'classes'
const	KEY_SCANNED_DIRS = 'scannedDirs'

Protected Member Functions
	scanClassesDir (string $dir)
	Scan (non-recursively) a /classes directory for PHP files to map directly to classes. More...
	getCacheFileContents ()
	Tries to read the contents of the cache file and if valid returns the content. More...

Protected Attributes
array	$scannedDirs = []
bool	$altered = false

Detailed Description

Manages core autoloading and caching of class maps.

Definition at line 12 of file AutoloadManager.php.

Constructor & Destructor Documentation

__construct()

Elgg\AutoloadManager::__construct	(	protected ClassLoader	$loader,
		protected AutoloadCache	$cache
	)

Constructor.

Parameters

ClassLoader	$loader	Class loader object
AutoloadCache	$cache	Autoload cache

Definition at line 34 of file AutoloadManager.php.

Member Function Documentation

addClasses()

Elgg\AutoloadManager::addClasses

(

string

$dir

)

Add classes found in this directory to the class map and allow classes in subdirectories to be found by PSR-0 rules.

We keep track of which dirs were scanned on previous requests so we don't need to rescan unless the cache is emptied.

Parameters

string

$dir

Directory of classes

Returns

AutoloadManager

Definition at line 49 of file AutoloadManager.php.

deleteCache()

Elgg\AutoloadManager::deleteCache

(

)

Delete the cache file.

Returns

AutoloadManager

Definition at line 164 of file AutoloadManager.php.

getCacheFileContents()

Elgg\AutoloadManager::getCacheFileContents ( )

protected

Tries to read the contents of the cache file and if valid returns the content.

Returns

null|array

Definition at line 153 of file AutoloadManager.php.

loadCache()

Elgg\AutoloadManager::loadCache

(

)

Set the state of the manager from the cache.

Returns

bool was the cache loaded?

Definition at line 130 of file AutoloadManager.php.

saveCache()

Elgg\AutoloadManager::saveCache

(

)

If necessary, save necessary state details.

Returns

AutoloadManager

Definition at line 104 of file AutoloadManager.php.

scanClassesDir()

Elgg\AutoloadManager::scanClassesDir ( string  $dir )

protected

Scan (non-recursively) a /classes directory for PHP files to map directly to classes.

For BC with Elgg 1.8's autoloader we map these files directly, but besides this the autoloader is PSR-0 compatible.

Parameters

string

$dir

Directory of classes

Returns

array

Definition at line 72 of file AutoloadManager.php.

Member Data Documentation

$altered

bool Elgg\AutoloadManager::$altered = false

protected

Definition at line 26 of file AutoloadManager.php.

$scannedDirs

array Elgg\AutoloadManager::$scannedDirs = []

protected

Definition at line 21 of file AutoloadManager.php.

FILENAME

const Elgg\AutoloadManager::FILENAME = 'autoload_data.php'

Definition at line 14 of file AutoloadManager.php.

KEY_CLASSES

const Elgg\AutoloadManager::KEY_CLASSES = 'classes'

Definition at line 15 of file AutoloadManager.php.

KEY_SCANNED_DIRS

const Elgg\AutoloadManager::KEY_SCANNED_DIRS = 'scannedDirs'

Definition at line 16 of file AutoloadManager.php.

---

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

• engine/classes/Elgg/AutoloadManager.php