Elgg  Version 3.0
Public Member Functions | Protected Attributes | List of all members
Elgg\ClassMap Class Reference

A map of class names to absolute file paths. More...

Public Member Functions

 getPath ($class)
 Get the path for a class/interface/trait. More...
 
 setPath ($class, $path)
 Set the path for a class/interface/trait, and mark map as altered. More...
 
 getAltered ()
 Was this map altered by the class loader? More...
 
 setAltered ($altered)
 Set the altered flag. More...
 
 getMap ()
 Get the full map. More...
 
 setMap (array $map)
 Set the full map. More...
 
 mergeMap (array $map)
 Merge a class map with the current map. More...
 

Protected Attributes

 $map = []
 
 $altered = false
 

Detailed Description

A map of class names to absolute file paths.

Definition at line 13 of file ClassMap.php.

Member Function Documentation

Elgg\ClassMap::getAltered ( )

Was this map altered by the class loader?

Returns
bool

Definition at line 61 of file ClassMap.php.

Elgg\ClassMap::getMap ( )

Get the full map.

Returns
array

Definition at line 81 of file ClassMap.php.

Elgg\ClassMap::getPath (   $class)

Get the path for a class/interface/trait.

Parameters
string$classa class/interface/trait name
Returns
string the file path or empty string

Definition at line 31 of file ClassMap.php.

Elgg\ClassMap::mergeMap ( array  $map)

Merge a class map with the current map.

Parameters
array$maparray with keys being class/interface/trait names and values the absolute file paths that define them
Returns

Definition at line 104 of file ClassMap.php.

Elgg\ClassMap::setAltered (   $altered)

Set the altered flag.

Parameters
bool$alteredWhether the class map has been altered
Returns

Definition at line 71 of file ClassMap.php.

Elgg\ClassMap::setMap ( array  $map)

Set the full map.

Parameters
array$maparray with keys being class/interface/trait names and values the absolute file paths that define them
Returns

Definition at line 92 of file ClassMap.php.

Elgg\ClassMap::setPath (   $class,
  $path 
)

Set the path for a class/interface/trait, and mark map as altered.

Parameters
string$classa class/interface/trait name
string$pathabsolute file path
Returns

Definition at line 45 of file ClassMap.php.

Member Data Documentation

Elgg\ClassMap::$altered = false
protected

Definition at line 23 of file ClassMap.php.

Elgg\ClassMap::$map = []
protected

Definition at line 18 of file ClassMap.php.


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