API Documentation

Loader.php

Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Loader
version
$Id: Loader.php 22020 2010-04-27 16:35:56Z matthew $
Classes
Zend_Loader

Description

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.

Zend_Loader
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Loader
Methods
loadClass
loadFile
isReadable
explodeIncludePath
autoload
registerAutoload
_securityCheck
_includeFile

Description

Static methods for loading classes and files.

Methods

_includeFile
jump to class

_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!

Arguments
$filespec
string
$once
boolean
Output
boolean
Details
visibility
protected
final
false
static
true
deprecated
Since 1.5.0; use loadFile() instead

_securityCheck
jump to class

_securityCheck( string $filename ) : void

Ensure that filename does not contain exploits

Arguments
$filename
string
Details
visibility
protected
final
false
static
true
throws

autoload
jump to class

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'));

Arguments
$class
string
Output
string|false
Class name on success; false on failure
Details
visibility
public
final
false
static
true
deprecated
Since 1.8.0

explodeIncludePath
jump to class

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.

Arguments
$path
stringnull
Output
array
Details
visibility
public
final
false
static
true

isReadable
jump to class

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.

Arguments
$filename
string
Output
boolean
Details
visibility
public
final
false
static
true

loadClass
jump to class

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.

Arguments
$class
string
- The full class name of a Zend component.
$dirs
stringarray
- OPTIONAL Either a path or an array of paths to search.
Details
visibility
public
final
false
static
true
throws

loadFile
jump to class

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().

Arguments
$filename
string
$dirs
stringarray
- OPTIONAL either a path or array of paths to search.
$once
boolean
Output
boolean
Details
visibility
public
final
false
static
true
throws

registerAutoload
jump to class

registerAutoload( string $class = Zend_Loader, boolean $enabled = true ) : void

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

Arguments
$class
string
(optional)
$enabled
boolean
(optional)
Details
visibility
public
final
false
static
true
deprecated
Since 1.8.0
throws
if spl_autoload() is not found or if the specified class does not have an autoload() method.
Documentation was generated by DocBlox.