Zend_Loader_Autoloader Class Reference

Public Member Functions
	setDefaultAutoloader ($callback)
	getDefaultAutoloader ()
	setAutoloaders (array $autoloaders)
	getAutoloaders ()
	getNamespaceAutoloaders ($namespace)
	registerNamespace ($namespace)
	unregisterNamespace ($namespace)
	getRegisteredNamespaces ()
	setZfPath ($spec, $version='latest')
	getZfPath ()
	suppressNotFoundWarnings ($flag=null)
	setFallbackAutoloader ($flag)
	isFallbackAutoloader ()
	getClassAutoloaders ($class)
	unshiftAutoloader ($callback, $namespace='')
	pushAutoloader ($callback, $namespace='')
	removeAutoloader ($callback, $namespace=null)

Static Public Member Functions
static	getInstance ()
static	resetInstance ()
static	autoload ($class)

Protected Member Functions
	__construct ()
	_autoload ($class)
	_setNamespaceAutoloaders (array $autoloaders, $namespace='')
	_getVersionPath ($path, $version)
	_getVersionType ($version)
	_getAvailableVersions ($path, $version)

Protected Attributes
	$_autoloaders = array()
	$_defaultAutoloader = array('Zend_Loader', 'loadClass')
	$_fallbackAutoloader = false
	$_internalAutoloader
	$_namespaces
	$_namespaceAutoloaders = array()
	$_suppressNotFoundWarnings = false
	$_zfPath

Static Protected Attributes
static	$_instance

Detailed Description

Definition at line 35 of file Autoloader.php.

Constructor & Destructor Documentation

__construct()

__construct ( )

protected

Constructor

Registers instance with spl_autoload stack

Returns

void

Definition at line 460 of file Autoloader.php.

    {
        spl_autoload_register(array(__CLASS__, 'autoload'));
        $this->_internalAutoloader = array($this, '_autoload');
    }

Member Function Documentation

_autoload()

_autoload (   $class )

protected

Internal autoloader implementation

Parameters

string

$class

Returns

bool

Definition at line 472 of file Autoloader.php.

    {
        $callback = $this->getDefaultAutoloader();
        try {
            if ($this->suppressNotFoundWarnings()) {
                @call_user_func($callback, $class);
            } else {
                call_user_func($callback, $class);
            }
            return $class;
        } catch (Zend_Exception $e) {
            return false;
        }
    }

_getAvailableVersions()

_getAvailableVersions (   $path,   $version  )

protected

Get available versions for the version type requested

Parameters

string	$path
string	$version

Returns

array

Definition at line 559 of file Autoloader.php.

    {
        if (!is_dir($path)) {
            throw new Zend_Loader_Exception('Invalid ZF path provided');
        }

        $path       = rtrim($path, '/');
        $path       = rtrim($path, '\\');
        $versionLen = strlen($version);
        $versions   = array();
        $dirs       = glob("$path/*", GLOB_ONLYDIR);
        foreach ((array) $dirs as $dir) {
            $dirName = substr($dir, strlen($path) + 1);
            if (!preg_match('/^(?:ZendFramework-)?(\d+\.\d+\.\d+((a|b|pl|pr|p|rc)\d+)?)(?:-minimal)?$/i', $dirName, $matches)) {
                continue;
            }

            $matchedVersion = $matches[1];

            if (('latest' == $version)
                || ((strlen($matchedVersion) >= $versionLen)
                    && (0 === strpos($matchedVersion, $version)))
            ) {
                $versions[$matchedVersion] = $dir . '/library';
            }
        }

        uksort($versions, 'version_compare');
        return $versions;
    }

_getVersionPath()

_getVersionPath (   $path,   $version  )

protected

Retrieve the filesystem path for the requested ZF version

Parameters

string	$path
string	$version

Returns

void

Definition at line 508 of file Autoloader.php.

    {
        $type = $this->_getVersionType($version);

        if ($type == 'latest') {
            $version = 'latest';
        }

        $availableVersions = $this->_getAvailableVersions($path, $version);
        if (empty($availableVersions)) {
            throw new Zend_Loader_Exception('No valid ZF installations discovered');
        }

        $matchedVersion = array_pop($availableVersions);
        return $matchedVersion;
    }

_getVersionType()

_getVersionType (   $version )

protected

Retrieve the ZF version type

Parameters

string

$version

Returns

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

Exceptions

Zend_Loader_Exception

if version string contains too many dots

Definition at line 532 of file Autoloader.php.

    {
        if (strtolower($version) == 'latest') {
            return 'latest';
        }

        $parts = explode('.', $version);
        $count = count($parts);
        if (1 == $count) {
            return 'major';
        }
        if (2 == $count) {
            return 'minor';
        }
        if (3 < $count) {
            throw new Zend_Loader_Exception('Invalid version string provided');
        }
        return 'specific';
    }

_setNamespaceAutoloaders()

_setNamespaceAutoloaders ( array  $autoloaders,   $namespace = ''  )

protected

Set autoloaders for a specific namespace

Parameters

array	$autoloaders
string	$namespace

Returns

Zend_Loader_Autoloader

Definition at line 494 of file Autoloader.php.

    {
        $namespace = (string) $namespace;
        $this->_namespaceAutoloaders[$namespace] = $autoloaders;
        return $this;
    }

autoload()

static autoload (   $class )

static

Autoload a class

Parameters

string

$class

Returns

bool

Definition at line 114 of file Autoloader.php.

    {
        $self = self::getInstance();

        foreach ($self->getClassAutoloaders($class) as $autoloader) {
            if ($autoloader instanceof Zend_Loader_Autoloader_Interface) {
                if ($autoloader->autoload($class)) {
                    return true;
                }
            } elseif (is_array($autoloader)) {
                if (call_user_func($autoloader, $class)) {
                    return true;
                }
            } elseif (is_string($autoloader) || is_callable($autoloader)) {
                if ($autoloader($class)) {
                    return true;
                }
            }
        }

        return false;
    }

getAutoloaders()

getAutoloaders

(

)

Get attached autoloader implementations

Returns

array

Definition at line 180 of file Autoloader.php.

    {
        return $this->_autoloaders;
    }

getClassAutoloaders()

getClassAutoloaders

(

$class

)

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.

Parameters

string

$class

Returns

array Array of autoloaders to use

Definition at line 327 of file Autoloader.php.

    {
        $namespace   = false;
        $autoloaders = array();

        // Add concrete namespaced autoloaders
        foreach (array_keys($this->_namespaceAutoloaders) as $ns) {
            if ('' == $ns) {
                continue;
            }
            if (0 === strpos($class, $ns)) {
                if ((false === $namespace) || (strlen($ns) > strlen($namespace))) {
                    $namespace = $ns;
                    $autoloaders = $this->getNamespaceAutoloaders($ns);
                }
            }
        }

        // Add internal namespaced autoloader
        foreach ($this->getRegisteredNamespaces() as $ns) {
            if (0 === strpos($class, $ns)) {
                $namespace     = $ns;
                $autoloaders[] = $this->_internalAutoloader;
                break;
            }
        }

        // Add non-namespaced autoloaders
        $autoloadersNonNamespace = $this->getNamespaceAutoloaders('');
        if (count($autoloadersNonNamespace)) {
            foreach ($autoloadersNonNamespace as $ns) {
                $autoloaders[] = $ns;
            }
            unset($autoloadersNonNamespace);
        }

        // Add fallback autoloader
        if (!$namespace && $this->isFallbackAutoloader()) {
            $autoloaders[] = $this->_internalAutoloader;
        }

        return $autoloaders;
    }

getDefaultAutoloader()

getDefaultAutoloader

(

)

Retrieve the default autoloader callback

Returns

string|array PHP Callback

Definition at line 158 of file Autoloader.php.

    {
        return $this->_defaultAutoloader;
    }

getInstance()

static getInstance ( )

static

Retrieve singleton instance

Returns

Zend_Loader_Autoloader

Definition at line 90 of file Autoloader.php.

    {
        if (null === self::$_instance) {
            self::$_instance = new self();
        }
        return self::$_instance;
    }

getNamespaceAutoloaders()

getNamespaceAutoloaders

(

$namespace

)

Return all autoloaders for a given namespace

Parameters

string

$namespace

Returns

array

Definition at line 191 of file Autoloader.php.

    {
        $namespace = (string) $namespace;
        if (!array_key_exists($namespace, $this->_namespaceAutoloaders)) {
            return array();
        }
        return $this->_namespaceAutoloaders[$namespace];
    }

getRegisteredNamespaces()

getRegisteredNamespaces

(

)

Get a list of registered autoload namespaces

Returns

array

Definition at line 249 of file Autoloader.php.

    {
        return array_keys($this->_namespaces);
    }

getZfPath()

getZfPath

(

)

Definition at line 275 of file Autoloader.php.

    {
        return $this->_zfPath;
    }

isFallbackAutoloader()

isFallbackAutoloader

(

)

Is this instance acting as a fallback autoloader?

Returns

bool

Definition at line 312 of file Autoloader.php.

    {
        return $this->_fallbackAutoloader;
    }

pushAutoloader()

pushAutoloader	(		$callback,
			$namespace = ''
	)

Append an autoloader to the autoloader stack

Parameters

object | array | string	$callback	PHP callback or Zend_Loader_Autoloader_Interface implementation
string | array	$namespace	Specific namespace(s) under which to register callback

Returns

Zend_Loader_Autoloader

Definition at line 401 of file Autoloader.php.

    {
        $autoloaders = $this->getAutoloaders();
        array_push($autoloaders, $callback);
        $this->setAutoloaders($autoloaders);

        $namespace = (array) $namespace;
        foreach ($namespace as $ns) {
            $autoloaders = $this->getNamespaceAutoloaders($ns);
            array_push($autoloaders, $callback);
            $this->_setNamespaceAutoloaders($autoloaders, $ns);
        }

        return $this;
    }

registerNamespace()

registerNamespace

(

$namespace

)

Register a namespace to autoload

Parameters

string | array

$namespace

Returns

Zend_Loader_Autoloader

Definition at line 206 of file Autoloader.php.

    {
        if (is_string($namespace)) {
            $namespace = (array) $namespace;
        } elseif (!is_array($namespace)) {
            throw new Zend_Loader_Exception('Invalid namespace provided');
        }

        foreach ($namespace as $ns) {
            if (!isset($this->_namespaces[$ns])) {
                $this->_namespaces[$ns] = true;
            }
        }
        return $this;
    }

removeAutoloader()

removeAutoloader	(		$callback,
			$namespace = null
	)

Remove an autoloader from the autoloader stack

Parameters

object | array | string	$callback	PHP callback or Zend_Loader_Autoloader_Interface implementation
null | string | array	$namespace	Specific namespace(s) from which to remove autoloader

Returns

Zend_Loader_Autoloader

Definition at line 424 of file Autoloader.php.

    {
        if (null === $namespace) {
            $autoloaders = $this->getAutoloaders();
            if (false !== ($index = array_search($callback, $autoloaders, true))) {
                unset($autoloaders[$index]);
                $this->setAutoloaders($autoloaders);
            }

            foreach ($this->_namespaceAutoloaders as $ns => $autoloaders) {
                if (false !== ($index = array_search($callback, $autoloaders, true))) {
                    unset($autoloaders[$index]);
                    $this->_setNamespaceAutoloaders($autoloaders, $ns);
                }
            }
        } else {
            $namespace = (array) $namespace;
            foreach ($namespace as $ns) {
                $autoloaders = $this->getNamespaceAutoloaders($ns);
                if (false !== ($index = array_search($callback, $autoloaders, true))) {
                    unset($autoloaders[$index]);
                    $this->_setNamespaceAutoloaders($autoloaders, $ns);
                }
            }
        }

        return $this;
    }

resetInstance()

static resetInstance ( )

static

Reset the singleton instance

Returns

void

Definition at line 103 of file Autoloader.php.

    {
        self::$_instance = null;
    }

setAutoloaders()

setAutoloaders

(

array

$autoloaders

)

Set several autoloader callbacks at once

Parameters

array

$autoloaders

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

Returns

Zend_Loader_Autoloader

Definition at line 169 of file Autoloader.php.

    {
        $this->_autoloaders = $autoloaders;
        return $this;
    }

setDefaultAutoloader()

setDefaultAutoloader

(

$callback

)

Set the default autoloader implementation

Parameters

string | array

$callback

PHP callback

Returns

void

Definition at line 143 of file Autoloader.php.

    {
        if (!is_callable($callback)) {
            throw new Zend_Loader_Exception('Invalid callback specified for default autoloader');
        }

        $this->_defaultAutoloader = $callback;
        return $this;
    }

setFallbackAutoloader()

setFallbackAutoloader

(

$flag

)

Indicate whether or not this autoloader should be a fallback autoloader

Parameters

bool

$flag

Returns

Zend_Loader_Autoloader

Definition at line 301 of file Autoloader.php.

    {
        $this->_fallbackAutoloader = (bool) $flag;
        return $this;
    }

setZfPath()

setZfPath	(		$spec,
			$version = 'latest'
	)

Definition at line 254 of file Autoloader.php.

    {
        $path = $spec;
        if (is_array($spec)) {
            if (!isset($spec['path'])) {
                throw new Zend_Loader_Exception('No path specified for ZF');
            }
            $path = $spec['path'];
            if (isset($spec['version'])) {
                $version = $spec['version'];
            }
        }

        $this->_zfPath = $this->_getVersionPath($path, $version);
        set_include_path(implode(PATH_SEPARATOR, array(
            $this->_zfPath,
            get_include_path(),
        )));
        return $this;
    }

suppressNotFoundWarnings()

suppressNotFoundWarnings

(

$flag = null

)

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

Parameters

null | bool

$flag

Returns

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

Definition at line 286 of file Autoloader.php.

    {
        if (null === $flag) {
            return $this->_suppressNotFoundWarnings;
        }
        $this->_suppressNotFoundWarnings = (bool) $flag;
        return $this;
    }

unregisterNamespace()

unregisterNamespace

(

$namespace

)

Unload a registered autoload namespace

Parameters

string | array

$namespace

Returns

Zend_Loader_Autoloader

Definition at line 228 of file Autoloader.php.

    {
        if (is_string($namespace)) {
            $namespace = (array) $namespace;
        } elseif (!is_array($namespace)) {
            throw new Zend_Loader_Exception('Invalid namespace provided');
        }

        foreach ($namespace as $ns) {
            if (isset($this->_namespaces[$ns])) {
                unset($this->_namespaces[$ns]);
            }
        }
        return $this;
    }

unshiftAutoloader()

unshiftAutoloader	(		$callback,
			$namespace = ''
	)

Add an autoloader to the beginning of the stack

Parameters

object | array | string	$callback	PHP callback or Zend_Loader_Autoloader_Interface implementation
string | array	$namespace	Specific namespace(s) under which to register callback

Returns

Zend_Loader_Autoloader

Definition at line 378 of file Autoloader.php.

    {
        $autoloaders = $this->getAutoloaders();
        array_unshift($autoloaders, $callback);
        $this->setAutoloaders($autoloaders);

        $namespace = (array) $namespace;
        foreach ($namespace as $ns) {
            $autoloaders = $this->getNamespaceAutoloaders($ns);
            array_unshift($autoloaders, $callback);
            $this->_setNamespaceAutoloaders($autoloaders, $ns);
        }

        return $this;
    }

Field Documentation

$_autoloaders

$_autoloaders = array()

protected

Definition at line 45 of file Autoloader.php.

$_defaultAutoloader

$_defaultAutoloader = array('Zend_Loader', 'loadClass')

protected

Definition at line 50 of file Autoloader.php.

$_fallbackAutoloader

$_fallbackAutoloader = false

protected

Definition at line 55 of file Autoloader.php.

$_instance

$_instance

staticprotected

Definition at line 40 of file Autoloader.php.

$_internalAutoloader

$_internalAutoloader

protected

Definition at line 60 of file Autoloader.php.

$_namespaceAutoloaders

$_namespaceAutoloaders = array()

protected

Definition at line 73 of file Autoloader.php.

$_namespaces

$_namespaces

protected

Initial value:

= array(
        'Zend_'  => true,
        'ZendX_' => true,
    )

Definition at line 65 of file Autoloader.php.

$_suppressNotFoundWarnings

$_suppressNotFoundWarnings = false

protected

Definition at line 78 of file Autoloader.php.

$_zfPath

$_zfPath

protected

Definition at line 83 of file Autoloader.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Loader/Autoloader.php