Application/Bootstrap/BootstrapAbstract.php
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 [email protected] 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_Application
- Subpackage
- Bootstrap
- Version
- $Id: BootstrapAbstract.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Application_Bootstrap_BootstrapAbstract
Package: Zend\Application\BootstrapAbstract base class for bootstrap classes
- Implements
- \Zend_Application_Bootstrap_Bootstrapper
- \Zend_Application_Bootstrap_ResourceBootstrapper
- Children
- \Zend_Application_Bootstrap_Bootstrap
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
-
New BSD License
- Uses
- \global\Zend_Application_Bootstrap_Bootstrapper
- Uses
- \global\Zend_Application_Bootstrap_ResourceBootstrapper
Properties
array $_classResources =
<p>Internal resource methods (resource/method pairs)</p>
object $_container =
<p>Resource container</p>
array $_optionKeys = array()
Flattened (lowercase) option keys used for lookups
Default valuearray()Details
- Type
- array
array $_pluginResources = array()
<p>Class-based resource plugins</p>
Default valuearray()Details
- Type
- array
array $_run = array()
<p>Initializers that have been run</p>
Default valuearray()Details
- Type
- array
array $_started = array()
<p>Initializers that have been started but not yet completed (circular dependency detection)</p>
Default valuearray()Details
- Type
- array
Methods
__call(string $method, array $args) : voidOverloading: intercept calls to bootstrap() methods
Parameters
| Name |
Type |
Description |
| $method |
string |
|
| $args |
array |
|
Throws
__get(string $prop) : null | mixedImplement PHP's magic to retrieve a ressource
in the bootstrap
Parameters
| Name |
Type |
Description |
| $prop |
string |
|
Returns
| Type |
Description |
| null | mixed |
|
__isset(string $prop) : boolImplement PHP's magic to ask for the
existence of a ressource in the bootstrap
Parameters
| Name |
Type |
Description |
| $prop |
string |
|
Returns
_executeResource(string $resource) : void
Checks to see if the resource has already been run. If not, it searches
first to see if a local method matches the resource, and executes that.
If not, it checks to see if a plugin resource matches, and executes that
if found.
Finally, if not found, it throws an exception.
| Name |
Type |
Description |
| $resource |
string |
|
Throws
_markRun(string $resource) : voidMark a resource as having run
Parameters
| Name |
Type |
Description |
| $resource |
string |
|
_resolvePluginResourceName(\Zend_Application_Resource_Resource $resource) : stringResolve a plugin resource name
Uses, in order of preference
- $_explicitType property of resource
- Short name of resource (if a matching prefix path is found)
- class name (if none of the above are true)
The name is then cast to lowercase.
bootstrap(null | string | array $resource = null) : \Zend_Application_Bootstrap_BootstrapAbstract
finalBootstrap individual, all, or multiple resources
Marked as final to prevent issues when subclassing and naming the
child class 'Bootstrap' (in which case, overriding this method
would result in it being treated as a constructor).
If you need to override this functionality, override the
_bootstrap() method.
| Name |
Type |
Description |
| $resource |
null | string | array |
|
Returns
Throws
getClassResources() : arrayGet class resources (as resource/method pairs)
Uses get_class_methods() by default, reflection on prior to 5.2.6,
as a bug prevents the usage of get_class_methods() there.
getResource(string $name) : null | mixedRetrieve a resource from the container
During bootstrap resource initialization, you may return a value. If
you do, it will be stored in the container.
You can use this method to retrieve that value.
If no value was returned, this will return a null value.
| Name |
Type |
Description |
| $name |
string |
|
Returns
| Type |
Description |
| null | mixed |
|
hasPluginResource(string $resource) : boolIs the requested plugin resource registered?
Parameters
| Name |
Type |
Description |
| $resource |
string |
|
Returns
hasResource(string $name) : boolDetermine if a resource has been stored in the container
During bootstrap resource initialization, you may return a value. If
you do, it will be stored in the container.
You can use this method to determine if a value was stored.
| Name |
Type |
Description |
| $name |
string |
|
Returns
mergeOptions(array $array1, mixed $array2 = null) : arrayMerge options recursively
Parameters
| Name |
Type |
Description |
| $array1 |
array |
|
| $array2 |
mixed |
|
Returns
setContainer(object $container) : \Zend_Application_Bootstrap_BootstrapAbstract
By default, if a resource callback has a non-null return value, this
value will be stored in a container using the resource name as the
key.
Containers must be objects, and must allow setting public properties.
| Name |
Type |
Description |
| $container |
object |
|
Returns
inherited
Classes