Loader/Autoloader.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: Autoloader
version: $Id: Autoloader.php 22480 2010-06-21 17:37:20Z matthew $
Classes: Zend_Loader_Autoloader

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_Autoloader
jump to top

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: Autoloader
uses: Zend_Loader_Autoloader
Properties: $_instance; $_autoloaders; $_defaultAutoloader; $_fallbackAutoloader; $_internalAutoloader; $_namespaces; $_namespaceAutoloaders; $_suppressNotFoundWarnings; $_zfPath
Methods: getInstance; resetInstance; autoload; setDefaultAutoloader; getDefaultAutoloader; setAutoloaders; getAutoloaders; getNamespaceAutoloaders; registerNamespace; unregisterNamespace; getRegisteredNamespaces; setZfPath; getZfPath; suppressNotFoundWarnings; setFallbackAutoloader; isFallbackAutoloader; getClassAutoloaders; unshiftAutoloader; pushAutoloader; removeAutoloader; __construct; _autoload; _setNamespaceAutoloaders; _getVersionPath; _getVersionType; _getAvailableVersions

Description

Autoloader stack and namespace autoloader

Properties

$_autoloaders
jump to class

array $_autoloaders = 'array'

Details

$_autoloaders: array
Concrete autoloader callback implementations
visibility: protected
default: array
final: false
static: false

$_defaultAutoloader
jump to class

array $_defaultAutoloader = 'array'

Details

$_defaultAutoloader: array
Default autoloader callback
visibility: protected
default: array
final: false
static: false

$_fallbackAutoloader
jump to class

bool $_fallbackAutoloader = 'false'

Details

$_fallbackAutoloader: bool
Whether or not to act as a fallback autoloader
visibility: protected
default: false
final: false
static: false

$_instance
jump to class

Zend_Loader_Autoloader $_instance = ''

Details

$_instance: Zend_Loader_Autoloader
Singleton instance
visibility: protected
default
final: false
static: true

$_internalAutoloader
jump to class

array $_internalAutoloader = ''

Details

$_internalAutoloader: array
Callback for internal autoloader implementation
visibility: protected
default
final: false
static: false

$_namespaceAutoloaders
jump to class

array $_namespaceAutoloaders = 'array'

Details

$_namespaceAutoloaders: array
Namespace-specific autoloaders
visibility: protected
default: array
final: false
static: false

$_namespaces
jump to class

array $_namespaces = 'array'

Details

$_namespaces: array
Supported namespaces 'Zend' and 'ZendX' by default.
visibility: protected
default: array
final: false
static: false

$_suppressNotFoundWarnings
jump to class

bool $_suppressNotFoundWarnings = 'false'

Details

$_suppressNotFoundWarnings: bool
Whether or not to suppress file not found warnings
visibility: protected
default: false
final: false
static: false

$_zfPath
jump to class

null|string $_zfPath = ''

Details

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

Methods

__construct
jump to class

__construct(
          
          )
        
        :
        void

Constructor

Registers instance with spl_autoload stack

Details

visibility: protected
final: false
static: false

_autoload
jump to class

_autoload(
          string $class
          )
        
        :
        bool

Internal autoloader implementation

Arguments

$class: string

Output

bool

Details

visibility: protected
final: false
static: false

_getAvailableVersions
jump to class

_getAvailableVersions(
          string $path, string $version
          )
        
        :
        array

Get available versions for the version type requested

Arguments

$path: string
$version: string

Output

array

Details

visibility: protected
final: false
static: false

_getVersionPath
jump to class

_getVersionPath(
          string $path, string $version
          )
        
        :
        void

Retrieve the filesystem path for the requested ZF version

Arguments

$path: string
$version: string

Details

visibility: protected
final: false
static: false

_getVersionType
jump to class

_getVersionType(
          string $version
          )
        
        :
        string

Retrieve the ZF version type

Arguments

$version: string

Output

string: "latest", "major", "minor", or "specific"

Details

visibility: protected
final: false
static: false
throws: if version string contains too many dots

_setNamespaceAutoloaders
jump to class

_setNamespaceAutoloaders(
          array $autoloaders, string $namespace
          )
        
        :
        Zend_Loader_Autoloader

Set autoloaders for a specific namespace

Arguments

$autoloaders: array
$namespace: string

Output

Zend_Loader_Autoloader

Details

visibility: protected
final: false
static: false

autoload
jump to class

autoload(
          string $class
          )
        
        :
        bool

Autoload a class

Arguments

$class: string

Output

bool

Details

visibility: public
final: false
static: true

getAutoloaders
jump to class

getAutoloaders(
          
          )
        
        :
        array

Get attached autoloader implementations

Output

array

Details

visibility: public
final: false
static: false

getClassAutoloaders
jump to class

getClassAutoloaders(
          string $class
          )
        
        :
        array

Get autoloaders to use when matching class

Determines if the class matches a registered namespace, and, if so, returns only the autoloaders for that namespace. Otherwise, it returns all non-namespaced autoloaders.

Arguments

$class: string

Output

array: Array of autoloaders to use

Details

visibility: public
final: false
static: false

getDefaultAutoloader
jump to class

getDefaultAutoloader(
          
          )
        
        :
        string|array

Retrieve the default autoloader callback

Output

string|array: PHP Callback

Details

visibility: public
final: false
static: false

getInstance
jump to class

getInstance(
          
          )
        
        :
        Zend_Loader_Autoloader

Retrieve singleton instance

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: true

getNamespaceAutoloaders
jump to class

getNamespaceAutoloaders(
          string $namespace
          )
        
        :
        array

Return all autoloaders for a given namespace

Arguments

$namespace: string

Output

array

Details

visibility: public
final: false
static: false

getRegisteredNamespaces
jump to class

getRegisteredNamespaces(
          
          )
        
        :
        array

Get a list of registered autoload namespaces

Output

array

Details

visibility: public
final: false
static: false

getZfPath
jump to class

getZfPath(
          
          )
        
        :

Details

visibility: public
final: false
static: false

isFallbackAutoloader
jump to class

isFallbackAutoloader(
          
          )
        
        :
        bool

Is this instance acting as a fallback autoloader?

Output

bool

Details

visibility: public
final: false
static: false

pushAutoloader
jump to class

pushAutoloader(
          object|array|string $callback, string|array $namespace
          )
        
        :
        Zend_Loader_Autoloader

Append an autoloader to the autoloader stack

Arguments

$callback: objectarraystring
PHP callback or Zend_Loader_Autoloader_Interface implementation
$namespace: stringarray
Specific namespace(s) under which to register callback

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

registerNamespace
jump to class

registerNamespace(
          string|array $namespace
          )
        
        :
        Zend_Loader_Autoloader

Arguments

$namespace: stringarray

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

removeAutoloader
jump to class

removeAutoloader(
          object|array|string $callback, null|string|array $namespace
              =
              null
          )
        
        :
        Zend_Loader_Autoloader

Remove an autoloader from the autoloader stack

Arguments

$callback: objectarraystring
PHP callback or Zend_Loader_Autoloader_Interface implementation
$namespace: nullstringarray
Specific namespace(s) from which to remove autoloader

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

resetInstance
jump to class

resetInstance(
          
          )
        
        :
        void

Reset the singleton instance

Details

visibility: public
final: false
static: true

setAutoloaders
jump to class

setAutoloaders(
          array $autoloaders
          )
        
        :
        Zend_Loader_Autoloader

Set several autoloader callbacks at once

Arguments

$autoloaders: array
Array of PHP callbacks (or Zend_Loader_Autoloader_Interface implementations) to act as autoloaders

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

setDefaultAutoloader
jump to class

setDefaultAutoloader(
          string|array $callback
          )
        
        :
        void

Set the default autoloader implementation

Arguments

$callback: stringarray
PHP callback

Details

visibility: public
final: false
static: false

setFallbackAutoloader
jump to class

setFallbackAutoloader(
          bool $flag
          )
        
        :
        Zend_Loader_Autoloader

Indicate whether or not this autoloader should be a fallback autoloader

Arguments

$flag: bool

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

setZfPath
jump to class

setZfPath(
           $spec,  $version
              =
              latest
          )
        
        :

Arguments

$spec
$version

Details

visibility: public
final: false
static: false

suppressNotFoundWarnings
jump to class

suppressNotFoundWarnings(
          null|bool $flag
              =
              null
          )
        
        :
        bool|Zend_Loader_Autoloader

Get or set the value of the "suppress not found warnings" flag

Arguments

$flag: nullbool

Output

bool|Zend_Loader_Autoloader: Returns boolean if no argument is passed, object instance otherwise

Details

visibility: public
final: false
static: false

unregisterNamespace
jump to class

unregisterNamespace(
          string|array $namespace
          )
        
        :
        Zend_Loader_Autoloader

Unload a registered autoload namespace

Arguments

$namespace: stringarray

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

unshiftAutoloader
jump to class

unshiftAutoloader(
          object|array|string $callback, string|array $namespace
          )
        
        :
        Zend_Loader_Autoloader

Add an autoloader to the beginning of the stack

Arguments

$callback: objectarraystring
PHP callback or Zend_Loader_Autoloader_Interface implementation
$namespace: stringarray
Specific namespace(s) under which to register callback

Output

Zend_Loader_Autoloader

Details

visibility: public
final: false
static: false

API Documentation

Loader/Autoloader.php

Description

Zend_Loader_Autoloaderjump to top

Description

Properties

$_autoloadersjump to class

Details

$_defaultAutoloaderjump to class

Details

$_fallbackAutoloaderjump to class

Details

$_instancejump to class

Details

$_internalAutoloaderjump to class

Details

$_namespaceAutoloadersjump to class

Details

$_namespacesjump to class

Details

$_suppressNotFoundWarningsjump to class

Details

$_zfPathjump to class

Details

Methods

__constructjump to class

Details

_autoloadjump to class

Arguments

Output

Details

_getAvailableVersionsjump to class

Arguments

Output

Details

_getVersionPathjump to class

Arguments

Details

_getVersionTypejump to class

Arguments

Output

Details

_setNamespaceAutoloadersjump to class

Arguments

Output

Details

autoloadjump to class

Arguments

Output

Details

getAutoloadersjump to class

Output

Details

getClassAutoloadersjump to class

Arguments

Output

Details

getDefaultAutoloaderjump to class

Output

Details

getInstancejump to class

Output

Details

getNamespaceAutoloadersjump to class

Arguments

Output

Details

getRegisteredNamespacesjump to class

Output

Details

getZfPathjump to class

Details

isFallbackAutoloaderjump to class

Output

Details

pushAutoloaderjump to class

Arguments

Output

Details

registerNamespacejump to class

Zend_Loader_Autoloader
jump to top

$_autoloaders
jump to class

$_defaultAutoloader
jump to class

$_fallbackAutoloader
jump to class

$_instance
jump to class

$_internalAutoloader
jump to class

$_namespaceAutoloaders
jump to class

$_namespaces
jump to class

$_suppressNotFoundWarnings
jump to class

$_zfPath
jump to class

__construct
jump to class

_autoload
jump to class

_getAvailableVersions
jump to class

_getVersionPath
jump to class

_getVersionType
jump to class

_setNamespaceAutoloaders
jump to class

autoload
jump to class

getAutoloaders
jump to class

getClassAutoloaders
jump to class

getDefaultAutoloader
jump to class

getInstance
jump to class

getNamespaceAutoloaders
jump to class

getRegisteredNamespaces
jump to class

getZfPath
jump to class

isFallbackAutoloader
jump to class

pushAutoloader
jump to class

registerNamespace
jump to class

removeAutoloader
jump to class

resetInstance
jump to class

setAutoloaders
jump to class

setDefaultAutoloader
jump to class

setFallbackAutoloader
jump to class

setZfPath
jump to class

suppressNotFoundWarnings
jump to class

unregisterNamespace
jump to class

unshiftAutoloader
jump to class