Loader/PluginLoader.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Loader
subpackage: PluginLoader
version: $Id: PluginLoader.php 22604 2010-07-17 00:14:06Z ramon $
Classes: Zend_Loader_PluginLoader

Description

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.

Zend_Loader_PluginLoader
jump to top

Implements: Zend_Loader_PluginLoader_Interface
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Loader
subpackage: PluginLoader
Properties: $_includeFileCache; $_loadedPluginPaths; $_loadedPlugins; $_prefixToPaths; $_staticLoadedPluginPaths; $_staticLoadedPlugins; $_staticPrefixToPaths; $_useStaticRegistry
Methods: __construct; _formatPrefix; addPrefixPath; getPaths; clearPaths; removePrefixPath; _formatName; isLoaded; getClassName; getClassPath; load; setIncludeFileCache; getIncludeFileCache; _appendIncFile

Description

Generic plugin class loader

Properties

$_includeFileCache
jump to class

string $_includeFileCache = ''

Class map cache file

Details

$_includeFileCache: string
visibility: protected
default
final: false
static: true

$_loadedPluginPaths
jump to class

array $_loadedPluginPaths = 'array'

Instance loaded plugin paths

Details

$_loadedPluginPaths: array
visibility: protected
default: array
final: false
static: false

$_loadedPlugins
jump to class

array $_loadedPlugins = 'array'

Instance loaded plugins

Details

$_loadedPlugins: array
visibility: protected
default: array
final: false
static: false

$_prefixToPaths
jump to class

array $_prefixToPaths = 'array'

Instance registry property

Details

$_prefixToPaths: array
visibility: protected
default: array
final: false
static: false

$_staticLoadedPluginPaths
jump to class

array $_staticLoadedPluginPaths = 'array'

Statically loaded plugin path mappings

Details

$_staticLoadedPluginPaths: array
visibility: protected
default: array
final: false
static: true

$_staticLoadedPlugins
jump to class

array $_staticLoadedPlugins = 'array'

Statically loaded plugins

Details

$_staticLoadedPlugins: array
visibility: protected
default: array
final: false
static: true

$_staticPrefixToPaths
jump to class

array $_staticPrefixToPaths = 'array'

Static registry property

Details

$_staticPrefixToPaths: array
visibility: protected
default: array
final: false
static: true

$_useStaticRegistry
jump to class

string|null $_useStaticRegistry = 'null'

Whether to use a statically named registry for loading plugins

Details

$_useStaticRegistry: string|null
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$prefixToPaths: array
$staticRegistryName: string
OPTIONAL

Details

visibility: public
final: false
static: false

_appendIncFile
jump to class

_appendIncFile(
          string $incFile
          )
        
        :
        void

Append an include_once statement to the class file cache

Arguments

$incFile: string

Details

visibility: protected
final: false
static: true

_formatName
jump to class

_formatName(
          string $name
          )
        
        :
        string

Normalize plugin name

Arguments

$name: string

Output

string

Details

visibility: protected
final: false
static: false

_formatPrefix
jump to class

_formatPrefix(
          string $prefix
          )
        
        :
        string

Format prefix for internal use

Arguments

$prefix: string

Output

string

Details

visibility: protected
final: false
static: false

addPrefixPath
jump to class

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

Add prefixed paths to the registry of paths

Arguments

$prefix: string
$path: string

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false

clearPaths
jump to class

clearPaths(
          string $prefix
              =
              null
          )
        
        :
        bool

Clear path stack

Arguments

$prefix: string

Output

bool: False only if $prefix does not exist

Details

visibility: public
final: false
static: false

getClassName
jump to class

getClassName(
          string $name
          )
        
        :
        string|false

Return full class name for a named plugin

Arguments

$name: string

Output

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

Details

visibility: public
final: false
static: false

getClassPath
jump to class

getClassPath(
          mixed $name
          )
        
        :
        string|false

Get path to plugin class

Arguments

$name: mixed

Output

string|false: False if not found

Details

visibility: public
final: false
static: false

getIncludeFileCache
jump to class

getIncludeFileCache(
          
          )
        
        :
        string|null

Retrieve class file cache path

Output

string|null

Details

visibility: public
final: false
static: true

getPaths
jump to class

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

Get path stack

Arguments

$prefix: string

Output

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

Details

visibility: public
final: false
static: false

isLoaded
jump to class

isLoaded(
          string $name
          )
        
        :
        Zend_Loader_PluginLoader

Whether or not a Plugin by a specific name is loaded

Arguments

$name: string

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false

load
jump to class

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

Load a plugin via the name provided

Arguments

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

Output

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

Details

visibility: public
final: false
static: false
throws: if class not found

removePrefixPath
jump to class

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

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

Arguments

$prefix: string
$path: string
OPTIONAL

Output

Zend_Loader_PluginLoader

Details

visibility: public
final: false
static: false

setIncludeFileCache
jump to class

setIncludeFileCache(
          string $file
          )
        
        :
        void

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.

Arguments

$file: string

Details

visibility: public
final: false
static: true
throws: if file is not writeable or path does not exist

API Documentation

Loader/PluginLoader.php

Description

Zend_Loader_PluginLoaderjump to top

Description

Properties

$_includeFileCachejump to class

Details

$_loadedPluginPathsjump to class

Details

$_loadedPluginsjump to class

Details

$_prefixToPathsjump to class

Details

$_staticLoadedPluginPathsjump to class

Details

$_staticLoadedPluginsjump to class

Details

$_staticPrefixToPathsjump to class

Details

$_useStaticRegistryjump to class

Details

Methods

__constructjump to class

Arguments

Details

_appendIncFilejump to class

Arguments

Details

_formatNamejump to class

Arguments

Output

Details

_formatPrefixjump to class

Arguments

Output

Details

addPrefixPathjump to class

Arguments

Output

Details

clearPathsjump to class

Arguments

Output

Details

getClassNamejump to class

Arguments

Output

Details

getClassPathjump to class

Arguments

Output

Details

getIncludeFileCachejump to class

Output

Details

getPathsjump to class

Arguments

Output

Details

isLoadedjump to class

Arguments

Output

Details

loadjump to class

Arguments

Output

Details

removePrefixPathjump to class

Arguments

Output

Details

setIncludeFileCachejump to class

Arguments

Details

Zend_Loader_PluginLoader
jump to top

$_includeFileCache
jump to class

$_loadedPluginPaths
jump to class

$_loadedPlugins
jump to class

$_prefixToPaths
jump to class

$_staticLoadedPluginPaths
jump to class

$_staticLoadedPlugins
jump to class

$_staticPrefixToPaths
jump to class

$_useStaticRegistry
jump to class

__construct
jump to class

_appendIncFile
jump to class

_formatName
jump to class

_formatPrefix
jump to class

addPrefixPath
jump to class

clearPaths
jump to class

getClassName
jump to class

getClassPath
jump to class

getIncludeFileCache
jump to class

getPaths
jump to class

isLoaded
jump to class

load
jump to class

removePrefixPath
jump to class

setIncludeFileCache
jump to class