Loader.php
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 24593 2012-01-05 20:35:02Z matthew $
\Zend_Loader
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods


_includeFile(string $filespec, boolean $once = false) : boolean
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!
Name | Type | Description |
---|---|---|
$filespec | string | |
$once | boolean |
Type | Description |
---|---|
boolean |
- Deprecated
- Since 1.5.0; use loadFile() instead


_securityCheck(string $filename) : void
Ensure that filename does not contain exploits
Name | Type | Description |
---|---|---|
$filename | string |
Exception | Description |
---|---|
\Zend_Exception |


autoload(string $class) : string | false
spl_autoload() suitable implementation for supporting class autoloading.
Attach to spl_autoload() using the following:
spl_autoload_register(array('Zend_Loader', 'autoload'));
Name | Type | Description |
---|---|---|
$class | string |
Type | Description |
---|---|
string | false | Class name on success; false on failure |
- Deprecated
- Since 1.8.0


explodeIncludePath(string | null $path = null) : array
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.
Name | Type | Description |
---|---|---|
$path | string | null |
Type | Description |
---|---|
array |


isReadable(string $filename) : boolean
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.
Name | Type | Description |
---|---|---|
$filename | string |
Type | Description |
---|---|
boolean |


loadClass(string $class, string | array $dirs = null) : void
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.
Name | Type | Description |
---|---|---|
$class | string |
|
$dirs | string | array |
|
Exception | Description |
---|---|
\Zend_Exception |


loadFile(string $filename, string | array $dirs = null, boolean $once = false) : boolean
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().
Name | Type | Description |
---|---|---|
$filename | string | |
$dirs | string | array |
|
$once | boolean |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Exception |


registerAutoload(string $class = 'Zend_Loader', boolean $enabled = true) : void
Register {@link autoload()} with spl_autoload()
Name | Type | Description |
---|---|---|
$class | string | (optional) |
$enabled | boolean | (optional) |
Exception | Description |
---|---|
\Zend_Exception | if spl_autoload() is not found or if the specified class does not have an autoload() method. |
- Deprecated
- Since 1.8.0


standardiseFile(string $file) : string
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".
Name | Type | Description |
---|---|---|
$file | string |
|
Type | Description |
---|---|
string |