Loader/PluginLoader.php

Show:

inherited

Classes
- \Zend_Loader_PluginLoader

Table of Contents

Zend Framework

LICENSE This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Loader
Subpackage: PluginLoader
Version: $Id$

\Zend_Loader_PluginLoader
jump to top

Package: Zend_Loader\PluginLoader

Generic plugin class loader

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_includeFileCache

static

Class map cache file

Details

Type: string

array $_loadedPluginPaths = array()

Instance loaded plugin paths

Default valuearray()Details

Type: array

array $_loadedPlugins = array()

Instance loaded plugins

Default valuearray()Details

Type: array

array $_prefixToPaths = array()

Instance registry property

Default valuearray()Details

Type: array

array $_staticLoadedPluginPaths = array()

static

Statically loaded plugin path mappings

Default valuearray()Details

Type: array

array $_staticLoadedPlugins = array()

static

Statically loaded plugins

Default valuearray()Details

Type: array

array $_staticPrefixToPaths = array()

static

Static registry property

Default valuearray()Details

Type: array

string|null $_useStaticRegistry = null

Whether to use a statically named registry for loading plugins

Default valuenullDetails

Type: string | null

Methods

__construct(array $prefixToPaths = array(), string $staticRegistryName = null) : void

Constructor

Parameters

Name	Type	Description
$prefixToPaths	array
$staticRegistryName	string	OPTIONAL

_appendIncFile(string $incFile) : void

static

Append an include_once statement to the class file cache

Parameters

Name	Type	Description
$incFile	string

_formatName(string $name) : string

Normalize plugin name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

_formatPrefix(string $prefix) : string

Format prefix for internal use

Parameters

Name	Type	Description
$prefix	string

Returns

Type	Description
string

addPrefixPath(string $prefix, string $path) : \Zend_Loader_PluginLoader

Add prefixed paths to the registry of paths

Parameters

Name	Type	Description
$prefix	string
$path	string

Returns

Type	Description
\Zend_Loader_PluginLoader

clearPaths(string $prefix = null) : bool

Clear path stack

Parameters

Name	Type	Description
$prefix	string

Returns

Type	Description
bool	False only if $prefix does not exist

getClassName(string $name) : string | false

Return full class name for a named plugin

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string \| false	False if class not found, class name otherwise

getClassPath(mixed $name) : string | false

Get path to plugin class

Parameters

Name	Type	Description
$name	mixed

Returns

Type	Description
string \| false	False if not found

getIncludeFileCache() : string | null

static

Retrieve class file cache path

Returns

Type	Description
string \| null

getPaths(string $prefix = null) : false | array

Get path stack

Parameters

Name	Type	Description
$prefix	string

Returns

Type	Description
false \| array	False if prefix does not exist, array otherwise

isLoaded(string $name) : \Zend_Loader_PluginLoader

Whether or not a Plugin by a specific name is loaded

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Loader_PluginLoader

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

Load a plugin via the name provided

Parameters

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

Returns

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

Throws

Exception	Description
\Zend_Loader_Exception	if class not found

removePrefixPath(string $prefix, string $path = null) : \Zend_Loader_PluginLoader

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

Parameters

Name	Type	Description
$prefix	string
$path	string	OPTIONAL

Returns

Type	Description
\Zend_Loader_PluginLoader

setIncludeFileCache(string $file) : void

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

Name	Type	Description
$file	string

Throws

Exception	Description
\Zend_Loader_PluginLoader_Exception	if file is not writeable or path does not exist