Zend_Loader Class Reference

Static Public Member Functions
static	loadClass ($class, $dirs=null)
static	loadFile ($filename, $dirs=null, $once=false)
static	isReadable ($filename)
static	explodeIncludePath ($path=null)
static	autoload ($class)
static	registerAutoload ($class='Zend_Loader', $enabled=true)
static	standardiseFile ($file)

Static Protected Member Functions
static	_securityCheck ($filename)
static	_includeFile ($filespec, $once=false)

Detailed Description

Definition at line 30 of file Loader.php.

Member Function Documentation

_includeFile()

static _includeFile (   $filespec,   $once = false  )

staticprotected

Attempt to include() the file.

include() is not prefixed with the @ operator because if the file is loaded and contains a parse error, execution will halt silently and this is difficult to debug.

Always set display_errors = Off on production servers!

Parameters

string	$filespec
boolean	$once

Returns

boolean

Deprecated:

Since 1.5.0; use loadFile() instead

Definition at line 309 of file Loader.php.

    {
        if ($once) {
            return include_once $filespec;
        } else {
            return include $filespec ;
        }
    }

_securityCheck()

static _securityCheck (   $filename )

staticprotected

Ensure that filename does not contain exploits

Parameters

string

$filename

Returns

void

Exceptions

Zend_Exception

Security check

Definition at line 284 of file Loader.php.

    {
        if (preg_match('/[^a-z0-9\\/\\\\_.:-]/i', $filename)) {
            #require_once 'Zend/Exception.php';
            throw new Zend_Exception('Security check: Illegal character in filename');
        }
    }

autoload()

static autoload (   $class )

static

spl_autoload() suitable implementation for supporting class autoloading.

Attach to spl_autoload() using the following: spl_autoload_register(array('Zend_Loader', 'autoload'));

Deprecated:

Since 1.8.0

Parameters

string

$class

Returns

string|false Class name on success; false on failure

Definition at line 231 of file Loader.php.

    {
        trigger_error(__CLASS__ . '::' . __METHOD__ . ' is deprecated as of 1.8.0 and will be removed with 2.0.0; use Zend_Loader_Autoloader instead', E_USER_NOTICE);
        try {
            @self::loadClass($class);
            return $class;
        } catch (Exception $e) {
            return false;
        }
    }

explodeIncludePath()

static explodeIncludePath (   $path = null )

static

Explode an include path into an array

If no path provided, uses current include_path. Works around issues that occur when the path includes stream schemas.

Parameters

string | null

$path

Returns

array

Definition at line 202 of file Loader.php.

    {
        if (null === $path) {
            $path = get_include_path();
        }

        if (PATH_SEPARATOR == ':') {
            // On *nix systems, include_paths which include paths with a stream
            // schema cannot be safely explode'd, so we have to be a bit more
            // intelligent in the approach.
            $paths = preg_split('#:(?!//)#', $path);
        } else {
            $paths = explode(PATH_SEPARATOR, $path);
        }
        return $paths;
    }

isReadable()

static isReadable (   $filename )

static

Returns TRUE if the $filename is readable, or FALSE otherwise. This function uses the PHP include_path, where PHP's is_readable() does not.

Note from ZF-2900: If you use custom error handler, please check whether return value from error_reporting() is zero or not. At mark of fopen() can not suppress warning if the handler is used.

Parameters

string

$filename

Returns

boolean

Definition at line 162 of file Loader.php.

    {
        if (is_readable($filename)) {
            // Return early if the filename is readable without needing the
            // include_path
            return true;
        }

        if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN'
            && preg_match('/^[a-z]:/i', $filename)
        ) {
            // If on windows, and path provided is clearly an absolute path,
            // return false immediately
            return false;
        }

        foreach (self::explodeIncludePath() as $path) {
            if ($path == '.') {
                if (is_readable($filename)) {
                    return true;
                }
                continue;
            }
            $file = $path . '/' . $filename;
            if (is_readable($file)) {
                return true;
            }
        }
        return false;
    }

loadClass()

static loadClass (   $class,   $dirs = null  )

static

Loads a class from a PHP file. The filename must be formatted as "$class.php".

If $dirs is a string or an array, it will search the directories in the order supplied, and attempt to load the first matching file.

If $dirs is null, it will split the class name at underscores to generate a path hierarchy (e.g., "Zend_Example_Class" will map to "Zend/Example/Class.php").

If the file was not found in the $dirs, or if no $dirs were specified, it will attempt to load it from PHP's include_path.

Parameters

string	$class	- The full class name of a Zend component.
string | array	$dirs	- OPTIONAL Either a path or an array of paths to search.

Returns

void

Exceptions

Zend_Exception

Definition at line 52 of file Loader.php.

    {
        if (class_exists($class, false) || interface_exists($class, false)) {
            return;
        }

        if ((null !== $dirs) && !is_string($dirs) && !is_array($dirs)) {
            #require_once 'Zend/Exception.php';
            throw new Zend_Exception('Directory argument must be a string or an array');
        }

        $file = self::standardiseFile($class);

        if (!empty($dirs)) {
            // use the autodiscovered path
            $dirPath = dirname($file);
            if (is_string($dirs)) {
                $dirs = explode(PATH_SEPARATOR, $dirs);
            }
            foreach ($dirs as $key => $dir) {
                if ($dir == '.') {
                    $dirs[$key] = $dirPath;
                } else {
                    $dir = rtrim($dir, '\\/');
                    $dirs[$key] = $dir . DIRECTORY_SEPARATOR . $dirPath;
                }
            }
            $file = basename($file);
            self::loadFile($file, $dirs, true);
        } else {
            self::loadFile($file, null, true);
        }

        if (!class_exists($class, false) && !interface_exists($class, false)) {
            #require_once 'Zend/Exception.php';
            throw new Zend_Exception("File \"$file\" does not exist or class \"$class\" was not found in the file");
        }
    }

loadFile()

static loadFile (   $filename,   $dirs = null,   $once = false  )

static

Loads a PHP file. This is a wrapper for PHP's include() function.

$filename must be the complete filename, including any extension such as ".php". Note that a security check is performed that does not permit extended characters in the filename. This method is intended for loading Zend Framework files.

If $dirs is a string or an array, it will search the directories in the order supplied, and attempt to load the first matching file.

If the file was not found in the $dirs, or if no $dirs were specified, it will attempt to load it from PHP's include_path.

If $once is TRUE, it will use include_once() instead of include().

Parameters

string	$filename
string | array	$dirs	- OPTIONAL either a path or array of paths to search.
boolean	$once

Returns

boolean

Exceptions

Zend_Exception

Search in provided directories, as well as include_path

Try finding for the plain filename in the include_path.

If searching in directories, reset include_path

Definition at line 114 of file Loader.php.

    {
        self::_securityCheck($filename);

        $incPath = false;
        if (!empty($dirs) && (is_array($dirs) || is_string($dirs))) {
            if (is_array($dirs)) {
                $dirs = implode(PATH_SEPARATOR, $dirs);
            }
            $incPath = get_include_path();
            set_include_path($dirs . PATH_SEPARATOR . $incPath);
        }

        if ($once) {
            include_once $filename;
        } else {
            include $filename;
        }

        if ($incPath) {
            set_include_path($incPath);
        }

        return true;
    }

registerAutoload()

static registerAutoload (   $class = 'Zend_Loader',   $enabled = true  )

static

Register autoload() with spl_autoload()

Deprecated:

Since 1.8.0

Parameters

string	$class	(optional)
boolean	$enabled	(optional)

Returns

void

Exceptions

Zend_Exception

if spl_autoload() is not found or if the specified class does not have an autoload() method.

Definition at line 252 of file Loader.php.

    {
        trigger_error(__CLASS__ . '::' . __METHOD__ . ' is deprecated as of 1.8.0 and will be removed with 2.0.0; use Zend_Loader_Autoloader instead', E_USER_NOTICE);
        #require_once 'Zend/Loader/Autoloader.php';
        $autoloader = Zend_Loader_Autoloader::getInstance();
        $autoloader->setFallbackAutoloader(true);

        if ('Zend_Loader' != $class) {
            self::loadClass($class);
            $methods = get_class_methods($class);
            if (!in_array('autoload', (array) $methods)) {
                #require_once 'Zend/Exception.php';
                throw new Zend_Exception("The class \"$class\" does not have an autoload() method");
            }

            $callback = array($class, 'autoload');

            if ($enabled) {
                $autoloader->pushAutoloader($callback);
            } else {
                $autoloader->removeAutoloader($callback);
            }
        }
    }

standardiseFile()

static standardiseFile (   $file )

static

Standardise the filename.

Convert the supplied filename into the namespace-aware standard, based on the Framework Interop Group reference implementation: http://groups.google.com/group/php-standards/web/psr-0-final-proposal

The filename must be formatted as "$file.php".

Parameters

string

$file

- The file name to be loaded.

Returns

string

Definition at line 330 of file Loader.php.

    {
        $fileName = ltrim($file, '\\');
        $file      = '';
        $namespace = '';
        if ($lastNsPos = strripos($fileName, '\\')) {
            $namespace = substr($fileName, 0, $lastNsPos);
            $fileName = substr($fileName, $lastNsPos + 1);
            $file      = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
        }
        $file .= str_replace('_', DIRECTORY_SEPARATOR, $fileName) . '.php';
        return $file;
    }

---

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

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