Docs For Class Zend_Loader

Description

Implements interfaces:

Zend_Loader_PluginLoader_Interface

Generic plugin class loader

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Located in /Loader/PluginLoader.php (line 38)

Variable Summary

static string $_includeFileCache

static array $_staticLoadedPluginPaths

static array $_staticLoadedPlugins

static array $_staticPrefixToPaths

array $_loadedPluginPaths

array $_loadedPlugins

array $_prefixToPaths

string|null $_useStaticRegistry

Method Summary

static string|null getIncludeFileCache ()

static void setIncludeFileCache (string $file)

static void _appendIncFile (string $incFile)

Zend_Loader_PluginLoader __construct ([ $prefixToPaths = array()], [string $staticRegistryName = null])

Zend_Loader_PluginLoader addPrefixPath (string $prefix, string $path)

bool clearPaths ([string $prefix = null])

string|false getClassName (string $name)

string|false getClassPath (mixed $name)

false|array getPaths ([string $prefix = null])

Zend_Loader_PluginLoader isLoaded (string $name)

string|false load (string $name, [bool $throwExceptions = true])

Zend_Loader_PluginLoader removePrefixPath (string $prefix, [string $path = null])

string _formatName (string $name)

string _formatPrefix (string $prefix)

Variables

static string $_includeFileCache (line 44)

Class map cache file

access: protected

static array $_staticLoadedPluginPaths = array() (line 72)

Statically loaded plugin path mappings

access: protected

static array $_staticLoadedPlugins = array() (line 79)

Statically loaded plugins

access: protected

static array $_staticPrefixToPaths = array() (line 86)

Static registry property

access: protected

array $_loadedPluginPaths = array() (line 51)

Instance loaded plugin paths

access: protected

array $_loadedPlugins = array() (line 58)

Instance loaded plugins

access: protected

array $_prefixToPaths = array() (line 65)

Instance registry property

access: protected

string|null $_useStaticRegistry = null (line 93)

Whether to use a statically named registry for loading plugins

access: protected

Methods

static getIncludeFileCache (line 461)

Retrieve class file cache path

access: public

static string|null getIncludeFileCache ()

static setIncludeFileCache (line 433)

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.

throws: Zend_Loader_PluginLoader_Exception if file is not writeable or path does not exist
access: public

static void setIncludeFileCache (string $file)

string $file

static _appendIncFile (line 472)

Append an include_once statement to the class file cache

access: protected

static void _appendIncFile (string $incFile)

string $incFile

Constructor __construct (line 101)

Constructor

access: public

Zend_Loader_PluginLoader __construct ([ $prefixToPaths = array()], [string $staticRegistryName = null])

array $prefixToPaths
string $staticRegistryName: OPTIONAL

addPrefixPath (line 145)

Add prefixed paths to the registry of paths

access: public

Zend_Loader_PluginLoader addPrefixPath (string $prefix, string $path)

string $prefix
string $path

Implementation of:

Zend_Loader_PluginLoader_Interface::addPrefixPath(): Add prefixed paths to the registry of paths

clearPaths (line 206)

Clear path stack

return: False only if $prefix does not exist
access: public

bool clearPaths ([string $prefix = null])

string $prefix

getClassName (line 304)

Return full class name for a named plugin

return: False if class not found, class name otherwise
access: public

string|false getClassName (string $name)

string $name

Implementation of:

Zend_Loader_PluginLoader_Interface::getClassName(): Return full class name for a named helper

getClassPath (line 324)

Get path to plugin class

return: False if not found
access: public

string|false getClassPath (mixed $name)

mixed $name

getPaths (line 174)

Get path stack

return: False if prefix does not exist, array otherwise
access: public

false|array getPaths ([string $prefix = null])

string $prefix

isLoaded (line 288)

Whether or not a Plugin by a specific name is loaded

access: public

Zend_Loader_PluginLoader isLoaded (string $name)

string $name

Implementation of:

Zend_Loader_PluginLoader_Interface::isLoaded(): Whether or not a Helper by a specific name

load (line 360)

Load a plugin via the name provided

return: Class name of loaded class; false if $throwExceptions if false and no class found
throws: Zend_Loader_Exception if class not found
access: public

string|false load (string $name, [bool $throwExceptions = true])

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

Implementation of:

Zend_Loader_PluginLoader_Interface::load(): Load a helper via the name provided

removePrefixPath (line 243)

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

access: public

Zend_Loader_PluginLoader removePrefixPath (string $prefix, [string $path = null])

string $prefix
string $path: OPTIONAL

Implementation of:

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

_formatName (line 277)

Normalize plugin name

access: protected

string _formatName (string $name)

string $name

_formatPrefix (line 124)

Format prefix for internal use

access: protected

string _formatPrefix (string $prefix)

string $prefix