Zend_Loader_PluginLoader Class Reference

Inheritance diagram for Zend_Loader_PluginLoader:

Collaboration diagram for Zend_Loader_PluginLoader:

Public Member Functions
	__construct (Array $prefixToPaths=array(), $staticRegistryName=null)
	addPrefixPath ($prefix, $path)
	getPaths ($prefix=null)
	clearPaths ($prefix=null)
	removePrefixPath ($prefix, $path=null)
	isLoaded ($name)
	getClassName ($name)
	getClassPath ($name)
	load ($name, $throwExceptions=true)
Static Public Member Functions
static	setIncludeFileCache ($file)
static	getIncludeFileCache ()
Protected Member Functions
	_formatPrefix ($prefix)
	_formatName ($name)
Static Protected Member Functions
static	_appendIncFile ($incFile)
Protected Attributes
	$_loadedPluginPaths = array()
	$_loadedPlugins = array()
	$_prefixToPaths = array()
	$_useStaticRegistry = null
Static Protected Attributes
static	$_includeFileCache
static	$_staticLoadedPluginPaths = array()
static	$_staticLoadedPlugins = array()
static	$_staticPrefixToPaths = array()

---

Detailed Description

Definition at line 38 of file PluginLoader.php.

---

Constructor & Destructor Documentation

__construct	(	Array $	prefixToPaths = array(),
		$	staticRegistryName = null
	)

Constructor

Parameters:

array	$prefixToPaths
string	$staticRegistryName	OPTIONAL

Definition at line 101 of file PluginLoader.php.

Here is the call graph for this function:

---

Member Function Documentation

static _appendIncFile

(

$

incFile

)

[static, protected]

Append an include_once statement to the class file cache

Parameters:

string

$incFile

Returns:

void

Definition at line 472 of file PluginLoader.php.

Here is the caller graph for this function:

_formatName

(

$

name

)

[protected]

Normalize plugin name

Parameters:

string

$name

Returns:

string

Definition at line 277 of file PluginLoader.php.

Here is the caller graph for this function:

_formatPrefix

(

$

prefix

)

[protected]

Format prefix for internal use

Parameters:

string

$prefix

Returns:

string

Definition at line 124 of file PluginLoader.php.

Here is the caller graph for this function:

addPrefixPath	(	$	prefix,
		$	path
	)

Add prefixed paths to the registry of paths

Parameters:

string	$prefix
string	$path

Returns:

Zend_Loader_PluginLoader

Implements Zend_Loader_PluginLoader_Interface.

Definition at line 145 of file PluginLoader.php.

Here is the call graph for this function:

Here is the caller graph for this function:

clearPaths

(

$

prefix = null

)

Clear path stack

Parameters:

string

$prefix

Returns:

bool False only if $prefix does not exist

Definition at line 206 of file PluginLoader.php.

Here is the call graph for this function:

getClassName

(

$

name

)

Return full class name for a named plugin

Parameters:

string

$name

Returns:

string|false False if class not found, class name otherwise

Implements Zend_Loader_PluginLoader_Interface.

Definition at line 304 of file PluginLoader.php.

Here is the call graph for this function:

Here is the caller graph for this function:

getClassPath

(

$

name

)

Get path to plugin class

Parameters:

mixed

$name

Returns:

string|false False if not found

Definition at line 324 of file PluginLoader.php.

Here is the call graph for this function:

static getIncludeFileCache

(

)

[static]

Retrieve class file cache path

Returns:

string|null

Definition at line 461 of file PluginLoader.php.

Here is the caller graph for this function:

getPaths

(

$

prefix = null

)

Get path stack

Parameters:

string

$prefix

Returns:

false|array False if prefix does not exist, array otherwise

Definition at line 174 of file PluginLoader.php.

Here is the call graph for this function:

isLoaded

(

$

name

)

Whether or not a Plugin by a specific name is loaded

Parameters:

string

$name

Returns:

Zend_Loader_PluginLoader

Implements Zend_Loader_PluginLoader_Interface.

Definition at line 288 of file PluginLoader.php.

Here is the call graph for this function:

Here is the caller graph for this function:

load	(	$	name,
		$	throwExceptions = true
	)

Load a plugin via the name provided

Parameters:

string	$name
bool	$throwExceptions	Whether or not to throw exceptions if the class is not resolved

Returns:

string|false Class name of loaded class; false if $throwExceptions if false and no class found

Exceptions:

Zend_Loader_Exception

if class not found

Definition at line 360 of file PluginLoader.php.

Here is the call graph for this function:

removePrefixPath	(	$	prefix,
		$	path = null
	)

Remove a prefix (or prefixed-path) from the registry

Parameters:

string	$prefix
string	$path	OPTIONAL

Returns:

Zend_Loader_PluginLoader

Implements Zend_Loader_PluginLoader_Interface.

Definition at line 243 of file PluginLoader.php.

Here is the call graph for this function:

static setIncludeFileCache

(

$

file

)

[static]

Set path to class file cache

Specify a path to a file that will add include_once statements for each plugin class loaded. This is an opt-in feature for performance purposes.

Parameters:

string

$file

Returns:

void

Exceptions:

Zend_Loader_PluginLoader_Exception

if file is not writeable or path does not exist

Definition at line 433 of file PluginLoader.php.

---

Field Documentation

$_includeFileCache [static, protected]

Definition at line 44 of file PluginLoader.php.

$_loadedPluginPaths = array() [protected]

Definition at line 51 of file PluginLoader.php.

$_loadedPlugins = array() [protected]

Definition at line 58 of file PluginLoader.php.

$_prefixToPaths = array() [protected]

Definition at line 65 of file PluginLoader.php.

$_staticLoadedPluginPaths = array() [static, protected]

Definition at line 72 of file PluginLoader.php.

$_staticLoadedPlugins = array() [static, protected]

Definition at line 79 of file PluginLoader.php.

$_staticPrefixToPaths = array() [static, protected]

Definition at line 86 of file PluginLoader.php.

$_useStaticRegistry = null [protected]

Definition at line 93 of file PluginLoader.php.

---

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

• C:/xampp/htdocs/moodle/lib/zend/Zend/Loader/PluginLoader.php