Zend_Loader_ClassMapAutoloader Class Reference

Inheritance diagram for Zend_Loader_ClassMapAutoloader:

Public Member Functions
	__construct ($options=null)
	setOptions ($options)
	registerAutoloadMap ($map)
	registerAutoloadMaps ($locations)
	getAutoloadMap ()
	autoload ($class)
	register ()

Static Public Member Functions
static	realPharPath ($path)
static	concatPharParts ($part)
static	resolvePharParentPath ($value, $key, &$parts)

Protected Member Functions
	loadMapFromFile ($location)

Protected Attributes
	$mapsLoaded = array()
	$map = array()

Detailed Description

Definition at line 33 of file ClassMapAutoloader.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Create a new instance, and optionally configure the autoloader.

Parameters

null | array | Traversable

$options

Returns

void

Implements Zend_Loader_SplAutoloader.

Definition at line 55 of file ClassMapAutoloader.php.

    {
        if (null !== $options) {
            $this->setOptions($options);
        }
    }

Member Function Documentation

autoload()

autoload

(

$class

)

Defined by Autoloadable

Parameters

string

$class

Returns

void

Implements Zend_Loader_SplAutoloader.

Definition at line 145 of file ClassMapAutoloader.php.

    {
        if (isset($this->map[$class])) {
            #require_once $this->map[$class];
        }
    }

concatPharParts()

static concatPharParts (   $part )

static

Helper callback for filtering phar paths

Parameters

string

$part

Returns

bool

Definition at line 227 of file ClassMapAutoloader.php.

    {
        return ($part !== '' && $part !== '.');
    }

getAutoloadMap()

getAutoloadMap

(

)

Retrieve current autoload map

Returns

array

Definition at line 134 of file ClassMapAutoloader.php.

    {
        return $this->map;
    }

loadMapFromFile()

loadMapFromFile (   $location )

protected

Load a map from a file

If the map has been previously loaded, returns the current instance; otherwise, returns whatever was returned by calling include() on the location.

Parameters

string

$location

Returns

Zend_Loader_ClassMapAutoloader|mixed

Exceptions

Zend_Loader_Exception_InvalidArgumentException

for nonexistent locations

Definition at line 177 of file ClassMapAutoloader.php.

    {
        if (!file_exists($location)) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException('Map file provided does not exist');
        }

        if (!$path = self::realPharPath($location)) {
            $path = realpath($location);
        }

        if (in_array($path, $this->mapsLoaded)) {
            // Already loaded this map
            return $this;
        }

        $map = include $path;

        return $map;
    }

realPharPath()

static realPharPath (   $path )

static

Resolve the real_path() to a file within a phar.

See also

https://bugs.php.net/bug.php?id=52769

Parameters

string

$path

Returns

string

Definition at line 205 of file ClassMapAutoloader.php.

    {
        if (strpos($path, 'phar:///') !== 0) {
            return;
        }

        $parts = explode('/', str_replace(array('/','\\'), '/', substr($path, 8)));
        $parts = array_values(array_filter($parts, array(__CLASS__, 'concatPharParts')));

        array_walk($parts, array(__CLASS__, 'resolvePharParentPath'), $parts);

        if (file_exists($realPath = 'phar:///' . implode('/', $parts))) {
            return $realPath;
        }
    }

register()

register

(

)

Register the autoloader with spl_autoload registry

Returns

void

Implements Zend_Loader_SplAutoloader.

Definition at line 157 of file ClassMapAutoloader.php.

    {
        if (version_compare(PHP_VERSION, '5.3.0', '>=')) {
            spl_autoload_register(array($this, 'autoload'), true, true);
        } else {
            spl_autoload_register(array($this, 'autoload'), true);
        }
    }

registerAutoloadMap()

registerAutoloadMap

(

$map

)

Register an autoload map

An autoload map may be either an associative array, or a file returning an associative array.

An autoload map should be an associative array containing classname/file pairs.

Parameters

string | array

$location

Returns

Zend_Loader_ClassMapAutoloader

Definition at line 88 of file ClassMapAutoloader.php.

    {
        if (is_string($map)) {
            $location = $map;
            if ($this === ($map = $this->loadMapFromFile($location))) {
                return $this;
            }
        }

        if (!is_array($map)) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException('Map file provided does not return a map');
        }

        $this->map = array_merge($this->map, $map);

        if (isset($location)) {
            $this->mapsLoaded[] = $location;
        }

        return $this;
    }

registerAutoloadMaps()

registerAutoloadMaps

(

$locations

)

Register many autoload maps at once

Parameters

array

$locations

Returns

Zend_Loader_ClassMapAutoloader

Definition at line 117 of file ClassMapAutoloader.php.

    {
        if (!is_array($locations) && !($locations instanceof Traversable)) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException('Map list must be an array or implement Traversable');
        }
        foreach ($locations as $location) {
            $this->registerAutoloadMap($location);
        }
        return $this;
    }

resolvePharParentPath()

static resolvePharParentPath (   $value,   $key, &  $parts  )

static

Helper callback to resolve a parent path in a Phar archive

Parameters

string	$value
int	$key
array	$parts

Returns

void

Definition at line 240 of file ClassMapAutoloader.php.

    {
        if ($value !== '...') {
            return;
        }
        unset($parts[$key], $parts[$key-1]);
        $parts = array_values($parts);
    }

setOptions()

setOptions

(

$options

)

Configure the autoloader

Proxies to registerAutoloadMaps().

Parameters

array | Traversable

$options

Returns

Zend_Loader_ClassMapAutoloader

Implements Zend_Loader_SplAutoloader.

Definition at line 70 of file ClassMapAutoloader.php.

    {
        $this->registerAutoloadMaps($options);
        return $this;
    }

Field Documentation

$map

$map = array()

protected

Definition at line 45 of file ClassMapAutoloader.php.

$mapsLoaded

$mapsLoaded = array()

protected

Definition at line 39 of file ClassMapAutoloader.php.

---

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

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