Zend_Loader_StandardAutoloader Class Reference

Inheritance diagram for Zend_Loader_StandardAutoloader:

Public Member Functions
	__construct ($options=null)
	setOptions ($options)
	setFallbackAutoloader ($flag)
	isFallbackAutoloader ()
	registerNamespace ($namespace, $directory)
	registerNamespaces ($namespaces)
	registerPrefix ($prefix, $directory)
	registerPrefixes ($prefixes)
	autoload ($class)
	register ()
	handleError ($errno, $errstr)

Data Fields
const	NS_SEPARATOR = '\\'
const	PREFIX_SEPARATOR = '_'
const	LOAD_NS = 'namespaces'
const	LOAD_PREFIX = 'prefixes'
const	ACT_AS_FALLBACK = 'fallback_autoloader'
const	AUTOREGISTER_ZF = 'autoregister_zf'

Protected Member Functions
	transformClassNameToFilename ($class, $directory)
	loadClass ($class, $type)
	normalizeDirectory ($directory)

Protected Attributes
	$namespaces = array()
	$prefixes = array()
	$fallbackAutoloaderFlag = false
	$error

Detailed Description

Definition at line 35 of file StandardAutoloader.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Constructor

Parameters

null | array | Traversable

$options

Returns

void

Implements Zend_Loader_SplAutoloader.

Definition at line 70 of file StandardAutoloader.php.

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

Member Function Documentation

autoload()

autoload

(

$class

)

Defined by Autoloadable; autoload a class

Parameters

string

$class

Returns

false|string

Implements Zend_Loader_SplAutoloader.

Definition at line 226 of file StandardAutoloader.php.

    {
        $isFallback = $this->isFallbackAutoloader();
        if (false !== strpos($class, self::NS_SEPARATOR)) {
            if ($this->loadClass($class, self::LOAD_NS)) {
                return $class;
            } elseif ($isFallback) {
                return $this->loadClass($class, self::ACT_AS_FALLBACK);
            }
            return false;
        }
        if (false !== strpos($class, self::PREFIX_SEPARATOR)) {
            if ($this->loadClass($class, self::LOAD_PREFIX)) {
                return $class;
            } elseif ($isFallback) {
                return $this->loadClass($class, self::ACT_AS_FALLBACK);
            }
            return false;
        }
        if ($isFallback) {
            return $this->loadClass($class, self::ACT_AS_FALLBACK);
        }
        return false;
    }

handleError()

handleError	(		$errno,
			$errstr
	)

Error handler

Used by loadClass during fallback autoloading in PHP versions prior to 5.3.0.

Parameters

mixed	$errno
mixed	$errstr

Returns

void

Definition at line 271 of file StandardAutoloader.php.

    {
        $this->error = true;
    }

isFallbackAutoloader()

isFallbackAutoloader

(

)

Is this autoloader acting as a fallback autoloader?

Returns

bool

Definition at line 149 of file StandardAutoloader.php.

    {
        return $this->fallbackAutoloaderFlag;
    }

loadClass()

loadClass (   $class,   $type  )

protected

Load a class, based on its type (namespaced or prefixed)

Parameters

string	$class
string	$type

Returns

void

Definition at line 306 of file StandardAutoloader.php.

    {
        if (!in_array($type, array(self::LOAD_NS, self::LOAD_PREFIX, self::ACT_AS_FALLBACK))) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException();
        }

        // Fallback autoloading
        if ($type === self::ACT_AS_FALLBACK) {
            // create filename
            $filename = $this->transformClassNameToFilename($class, '');
            if (version_compare(PHP_VERSION, '5.3.2', '>=')) {
                $resolvedName = stream_resolve_include_path($filename);
                if ($resolvedName !== false) {
                    return include $resolvedName;
                }
                return false;
            }
            $this->error = false;
            set_error_handler(array($this, 'handleError'), E_WARNING);
            include $filename;
            restore_error_handler();
            if ($this->error) {
                return false;
            }
            return class_exists($class, false);
        }

        // Namespace and/or prefix autoloading
        foreach ($this->$type as $leader => $path) {
            if (0 === strpos($class, $leader)) {
                // Trim off leader (namespace or prefix)
                $trimmedClass = substr($class, strlen($leader));

                // create filename
                $filename = $this->transformClassNameToFilename($trimmedClass, $path);
                if (file_exists($filename)) {
                    return include $filename;
                }
                return false;
            }
        }
        return false;
    }

normalizeDirectory()

normalizeDirectory (   $directory )

protected

Normalize the directory to include a trailing directory separator

Parameters

string

$directory

Returns

string

Definition at line 357 of file StandardAutoloader.php.

    {
        $last = $directory[strlen($directory) - 1];
        if (in_array($last, array('/', '\\'))) {
            $directory[strlen($directory) - 1] = DIRECTORY_SEPARATOR;
            return $directory;
        }
        $directory .= DIRECTORY_SEPARATOR;
        return $directory;
    }

register()

register

(

)

Register the autoloader with spl_autoload

Returns

void

Implements Zend_Loader_SplAutoloader.

Definition at line 256 of file StandardAutoloader.php.

    {
        spl_autoload_register(array($this, 'autoload'));
    }

registerNamespace()

registerNamespace	(		$namespace,
			$directory
	)

Register a namespace/directory pair

Parameters

string	$namespace
string	$directory

Returns

Zend_Loader_StandardAutoloader

Definition at line 161 of file StandardAutoloader.php.

    {
        $namespace = rtrim($namespace, self::NS_SEPARATOR). self::NS_SEPARATOR;
        $this->namespaces[$namespace] = $this->normalizeDirectory($directory);
        return $this;
    }

registerNamespaces()

registerNamespaces

(

$namespaces

)

Register many namespace/directory pairs at once

Parameters

array

$namespaces

Returns

Zend_Loader_StandardAutoloader

Definition at line 174 of file StandardAutoloader.php.

    {
        if (!is_array($namespaces) && !$namespaces instanceof Traversable) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException('Namespace pairs must be either an array or Traversable');
        }

        foreach ($namespaces as $namespace => $directory) {
            $this->registerNamespace($namespace, $directory);
        }
        return $this;
    }

registerPrefix()

registerPrefix	(		$prefix,
			$directory
	)

Register a prefix/directory pair

Parameters

string	$prefix
string	$directory

Returns

Zend_Loader_StandardAutoloader

Definition at line 194 of file StandardAutoloader.php.

    {
        $prefix = rtrim($prefix, self::PREFIX_SEPARATOR). self::PREFIX_SEPARATOR;
        $this->prefixes[$prefix] = $this->normalizeDirectory($directory);
        return $this;
    }

registerPrefixes()

registerPrefixes

(

$prefixes

)

Register many namespace/directory pairs at once

Parameters

array

$prefixes

Returns

Zend_Loader_StandardAutoloader

Definition at line 207 of file StandardAutoloader.php.

    {
        if (!is_array($prefixes) && !$prefixes instanceof Traversable) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException('Prefix pairs must be either an array or Traversable');
        }

        foreach ($prefixes as $prefix => $directory) {
            $this->registerPrefix($prefix, $directory);
        }
        return $this;
    }

setFallbackAutoloader()

setFallbackAutoloader

(

$flag

)

Set flag indicating fallback autoloader status

Parameters

bool

$flag

Returns

Zend_Loader_StandardAutoloader

Definition at line 138 of file StandardAutoloader.php.

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

setOptions()

setOptions

(

$options

)

Configure autoloader

Allows specifying both "namespace" and "prefix" pairs, using the following structure: array( 'namespaces' => array( 'Zend' => '/path/to/Zend/library', 'Doctrine' => '/path/to/Doctrine/library', ), 'prefixes' => array( 'Phly_' => '/path/to/Phly/library', ), 'fallback_autoloader' => true, )

Parameters

array | Traversable

$options

Returns

Zend_Loader_StandardAutoloader

Implements Zend_Loader_SplAutoloader.

Definition at line 98 of file StandardAutoloader.php.

    {
        if (!is_array($options) && !($options instanceof Traversable)) {
            #require_once dirname(__FILE__) . '/Exception/InvalidArgumentException.php';
            throw new Zend_Loader_Exception_InvalidArgumentException('Options must be either an array or Traversable');
        }

        foreach ($options as $type => $pairs) {
            switch ($type) {
                case self::AUTOREGISTER_ZF:
                    if ($pairs) {
                        $this->registerPrefix('Zend', dirname(dirname(__FILE__)));
                    }
                    break;
                case self::LOAD_NS:
                    if (is_array($pairs) || $pairs instanceof Traversable) {
                        $this->registerNamespaces($pairs);
                    }
                    break;
                case self::LOAD_PREFIX:
                    if (is_array($pairs) || $pairs instanceof Traversable) {
                        $this->registerPrefixes($pairs);
                    }
                    break;
                case self::ACT_AS_FALLBACK:
                    $this->setFallbackAutoloader($pairs);
                    break;
                default:
                    // ignore
            }
        }
        return $this;
    }

transformClassNameToFilename()

transformClassNameToFilename (   $class,   $directory  )

protected

Transform the class name to a filename

Parameters

string	$class
string	$directory

Returns

string

Definition at line 283 of file StandardAutoloader.php.

    {
        // $class may contain a namespace portion, in  which case we need
        // to preserve any underscores in that portion.
        $matches = array();
        preg_match('/(?P<namespace>.+\\\)?(?P<class>[^\\\]+$)/', $class, $matches);

        $class     = (isset($matches['class'])) ? $matches['class'] : '';
        $namespace = (isset($matches['namespace'])) ? $matches['namespace'] : '';

        return $directory
             . str_replace(self::NS_SEPARATOR, '/', $namespace)
             . str_replace(self::PREFIX_SEPARATOR, '/', $class)
             . '.php';
    }

Field Documentation

$error

$error

protected

Definition at line 62 of file StandardAutoloader.php.

$fallbackAutoloaderFlag

$fallbackAutoloaderFlag = false

protected

Definition at line 57 of file StandardAutoloader.php.

$namespaces

$namespaces = array()

protected

Definition at line 47 of file StandardAutoloader.php.

$prefixes

$prefixes = array()

protected

Definition at line 52 of file StandardAutoloader.php.

ACT_AS_FALLBACK

const ACT_AS_FALLBACK = 'fallback_autoloader'

Definition at line 41 of file StandardAutoloader.php.

AUTOREGISTER_ZF

const AUTOREGISTER_ZF = 'autoregister_zf'

Definition at line 42 of file StandardAutoloader.php.

LOAD_NS

const LOAD_NS = 'namespaces'

Definition at line 39 of file StandardAutoloader.php.

LOAD_PREFIX

const LOAD_PREFIX = 'prefixes'

Definition at line 40 of file StandardAutoloader.php.

NS_SEPARATOR

const NS_SEPARATOR = '\\'

Definition at line 37 of file StandardAutoloader.php.

PREFIX_SEPARATOR

const PREFIX_SEPARATOR = '_'

Definition at line 38 of file StandardAutoloader.php.

---

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

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