From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- zend/documentation/api/core/files/Loader.html | 101 ++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 zend/documentation/api/core/files/Loader.html (limited to 'zend/documentation/api/core/files/Loader.html') diff --git a/zend/documentation/api/core/files/Loader.html b/zend/documentation/api/core/files/Loader.html new file mode 100644 index 0000000..4b428b2 --- /dev/null +++ b/zend/documentation/api/core/files/Loader.html @@ -0,0 +1,101 @@ + +Zend Gdata API Documentation

Loader.php

+ Show: + PublicProtectedPrivateinherited
+ 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 24593 2012-01-05 20:35:02Z matthew $ +   +

\Zend_Loader
jump to top

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
NameTypeDescription
$filespecstring
$onceboolean
Returns
TypeDescription
boolean
Details
Deprecated
Since 1.5.0; use loadFile() instead +   +
methodprotected_securityCheck(string $filename) : void
static

Ensure that filename does not contain exploits

Parameters
NameTypeDescription
$filenamestring
Throws
ExceptionDescription
\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
NameTypeDescription
$classstring
Returns
TypeDescription
string | falseClass 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
NameTypeDescription
$pathstring | null
Returns
TypeDescription
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
NameTypeDescription
$filenamestring
Returns
TypeDescription
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
NameTypeDescription
$classstring
    +
  • The full class name of a Zend component.
    • +
+
$dirsstring | array
    +
  • OPTIONAL Either a path or an array of paths + to search.
    • +
+
Throws
ExceptionDescription
\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
NameTypeDescription
$filenamestring
$dirsstring | array
    +
  • OPTIONAL either a path or array of paths + to search.
    • +
+
$onceboolean
Returns
TypeDescription
boolean
Throws
ExceptionDescription
\Zend_Exception
methodpublicregisterAutoload(string $class = 'Zend_Loader', boolean $enabled = true) : void
static

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

Parameters
NameTypeDescription
$classstring

(optional)

+
$enabledboolean

(optional)

+
Throws
ExceptionDescription
\Zend_Exceptionif spl_autoload() is not found +or if the specified class does not have an autoload() method.
Details
Deprecated
Since 1.8.0 +   +
methodpublicstandardiseFile(string $file) : string
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
NameTypeDescription
$filestring
    +
  • The file name to be loaded.
    • +
+
Returns
TypeDescription
string
+ Documentation was generated by + phpDocumentor + 2.0.0a12. + -- cgit v1.2.3