ClassMap Class Reference

Public Member Functions
	addClasses (array $classes)
	Adds class mapping definitions.
	getClassName ($originalClass, $tagName= '', array $params=null, $default=true, $useGlobal=true)
	Returns the proper class name, or default value if no mapping exists.
	enableAutoLoader ($enable=true)
	handleAutoLoading ($className)
Static Public Member Functions
static	instance ()
Data Fields
	$fileDiscovery = 'class'
	$useSplAutoload = false
	$classesAsked = array()
	$classesUsed = array()
Static Public Attributes
static	$inst
static	$defaultClass = __CLASS__
	Name of the class used by the first call to instance()
Protected Member Functions
	__construct ()
Protected Attributes
	$classes = array()
	$autoLoaderEnabled = false

---

Constructor & Destructor Documentation

ClassMap::__construct

(

)

[protected]

---

Member Function Documentation

ClassMap::addClasses

(

array $

classes

)

Adds class mapping definitions.

Every class can be overriden by extending class name, or by callback function. Classes can have default overrides, as well as specific overrides for specific tags passed to getClassName().

Callback should look like this:

 function callback($className, $tagName, array $params, $default) {
  return 'ClassName';
 }

Parameters:

array

$classes

Map in the form: ['Class1'] => 'Override1', ['Class2'] => [''] => 'Override2', ['Tag1'] => 'OverrideTag1', ['Class3'] => callback

ClassMap::enableAutoLoader

(

$

enable = true

)

ClassMap::getClassName	(	$	originalClass,
		$	tagName = '',
		array $	params = null,
		$	default = true,
		$	useGlobal = true
	)

Returns the proper class name, or default value if no mapping exists.

Parameters:

string	$originalClass
string	$tagName	- additional tag
array	$params	- additional parameters that can be used by callbacks
string	$default	- default class to return. If true - return $originalClass
string	$useGlobal	- if TRUE, global classes will be used if tagName doesn't exist.

ClassMap::handleAutoLoading

(

$

className

)

static ClassMap::instance

(

)

[static]

Returns:

ClassMap

---

Field Documentation

ClassMap::$autoLoaderEnabled = false [protected]

ClassMap::$classes = array() [protected]

ClassMap::$classesAsked = array()

ClassMap::$classesUsed = array()

ClassMap::$defaultClass = __CLASS__ [static]

Name of the class used by the first call to instance()

ClassMap::$fileDiscovery = 'class'

ClassMap::$inst [static]

ClassMap::$useSplAutoload = false

---

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

• include/core/ClassMap.php