Class Zend_Loader_PluginLoader

Generic plugin class loader

Zend_Loader_PluginLoader implements Zend_Loader_PluginLoader_Interface

Package: Zend\Loader\PluginLoader
Category: Zend
Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Located at Zend/Loader/PluginLoader.php

Methods summary
`public`	# `__construct( array $prefixToPaths = array(), string $staticRegistryName = null )` Constructor Constructor Parameters `$prefixToPaths` `array` `$staticRegistryName` `string` OPTIONAL
`protected string`	# `_formatPrefix( string $prefix )` Format prefix for internal use Format prefix for internal use Parameters `$prefix` `string` Returns `string`
`public Zend_Loader_PluginLoader`	# `addPrefixPath( string $prefix, string $path )` Add prefixed paths to the registry of paths Add prefixed paths to the registry of paths Parameters `$prefix` `string` `$path` `string` Returns `Zend_Loader_PluginLoader` Implementation of `Zend_Loader_PluginLoader_Interface::addPrefixPath`
`public false\|array`	# `getPaths( string $prefix = null )` Get path stack Get path stack Parameters `$prefix` `string` Returns `false\|array` False if prefix does not exist, array otherwise
`public boolean`	# `clearPaths( string $prefix = null )` Clear path stack Clear path stack Parameters `$prefix` `string` Returns `boolean` False only if $prefix does not exist
`public Zend_Loader_PluginLoader`	# `removePrefixPath( string $prefix, string $path = null )` Remove a prefix (or prefixed-path) from the registry Remove a prefix (or prefixed-path) from the registry Parameters `$prefix` `string` `$path` `string` OPTIONAL Returns `Zend_Loader_PluginLoader` Implementation of `Zend_Loader_PluginLoader_Interface::removePrefixPath`
`protected string`	# `_formatName( string $name )` Normalize plugin name Normalize plugin name Parameters `$name` `string` Returns `string`
`public Zend_Loader_PluginLoader`	# `isLoaded( string $name )` Whether or not a Plugin by a specific name is loaded Whether or not a Plugin by a specific name is loaded Parameters `$name` `string` Returns `Zend_Loader_PluginLoader` Implementation of `Zend_Loader_PluginLoader_Interface::isLoaded`
`public string\|false`	# `getClassName( string $name )` Return full class name for a named plugin Return full class name for a named plugin Parameters `$name` `string` Returns `string\|false` False if class not found, class name otherwise Implementation of `Zend_Loader_PluginLoader_Interface::getClassName`
`public string\|false`	# `getClassPath( mixed $name )` Get path to plugin class Get path to plugin class Parameters `$name` `mixed` Returns `string\|false` False if not found
`public string\|false`	# `load( string $name, boolean $throwExceptions = true )` Load a plugin via the name provided Load a plugin via the name provided Parameters `$name` `string` `$throwExceptions` `boolean` 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 Throws `Zend_Loader_Exception` if class not found Implementation of `Zend_Loader_PluginLoader_Interface::load`
`public static`	# `setIncludeFileCache( string $file )` Set path to class file cache 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 `$file` `string` Throws `Zend_Loader_PluginLoader_Exception` if file is not writeable or path does not exist
`public static string\|null`	# `getIncludeFileCache( )` Retrieve class file cache path Retrieve class file cache path Returns `string\|null`
`protected static`	# `_appendIncFile( string $incFile )` Append an include_once statement to the class file cache Append an include_once statement to the class file cache Parameters `$incFile` `string`

Properties summary
`protected static string`	`$_includeFileCache`		# Class map cache file Class map cache file
`protected array`	`$_loadedPluginPaths`	`array()`	# Instance loaded plugin paths Instance loaded plugin paths
`protected array`	`$_loadedPlugins`	`array()`	# Instance loaded plugins Instance loaded plugins
`protected array`	`$_prefixToPaths`	`array()`	# Instance registry property Instance registry property
`protected static array`	`$_staticLoadedPluginPaths`	`array()`	# Statically loaded plugin path mappings Statically loaded plugin path mappings
`protected static array`	`$_staticLoadedPlugins`	`array()`	# Statically loaded plugins Statically loaded plugins
`protected static array`	`$_staticPrefixToPaths`	`array()`	# Static registry property Static registry property
`protected string\|null`	`$_useStaticRegistry`	`null`	# Whether to use a statically named registry for loading plugins Whether to use a statically named registry for loading plugins

Packages

Classes

Interfaces

Exceptions

Class Zend_Loader_PluginLoader

Parameters

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Parameters

Returns

Throws

Implementation of

Parameters

Throws

Returns

Parameters