API Documentation

Zend/Loader.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Loader  
Version
$Id: Loader.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Loader

Package: Zend\Loader

Static methods for loading classes and files.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Methods

methodprotected_includeFile( string $filespec, boolean $once = false ) : boolean
static

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
Name Type Description
$filespec string
$once boolean
Returns
Type Description
boolean
Details
Deprecated
Since 1.5.0; use loadFile() instead  
methodprotected_securityCheck( string $filename ) : void
static

Ensure that filename does not contain exploits

Parameters
Name Type Description
$filename string
Throws
Exception Description
\Zend_Exception
methodpublicautoload( string $class ) : string|false
static

spl_autoload() suitable implementation for supporting class autoloading.

Attach to spl_autoload() using the following:

spl_autoload_register(array('Zend_Loader', 'autoload'));
Parameters
Name Type Description
$class string
Returns
Type Description
string|false Class name on success; false on failure
Details
Deprecated
Since 1.8.0  
methodpublicexplodeIncludePath( string|null $path = null ) : array
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
Name Type Description
$path string|null
Returns
Type Description
array
methodpublicisReadable( string $filename ) : boolean
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
Name Type Description
$filename string
Returns
Type Description
boolean
methodpublicloadClass( string $class, string|array $dirs = null ) : void
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
Name Type Description
$class string
  • The full class name of a Zend component.
$dirs string|array
  • OPTIONAL Either a path or an array of paths to search.
Throws
Exception Description
\Zend_Exception
methodpublicloadFile( string $filename, string|array $dirs = null, boolean $once = false ) : boolean
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
Name Type Description
$filename string
$dirs string|array
  • OPTIONAL either a path or array of paths to search.
$once boolean
Returns
Type Description
boolean
Throws
Exception Description
\Zend_Exception
methodpublicregisterAutoload( string $class = 'Zend_Loader', boolean $enabled = true ) : void
static

Register {@link autoload()} with spl_autoload()

Parameters
Name Type Description
$class string

(optional)

$enabled boolean

(optional)

Throws
Exception Description
\Zend_Exception if spl_autoload() is not found or if the specified class does not have an autoload() method.
Details
Deprecated
Since 1.8.0  
Documentation was generated by DocBlox 0.15.1.