Application/Bootstrap/BootstrapAbstract.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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Application  
Subpackage
Bootstrap  
Version
$Id$  

\Zend_Application_Bootstrap_BootstrapAbstract
jump to top

Package: Zend_Application\Bootstrap
Abstract base class for bootstrap classes
Implements
Children
\Zend_Application_Bootstrap_Bootstrap
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Uses
 
Uses
 

Properties

>VPropertyprotected\Zend_Application|\Zend_Application_Bootstrap_Bootstrapper $_application
Details
Type
\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper
>VPropertyprotectedarray $_classResources

Internal resource methods (resource/method pairs)

Details
Type
array
>VPropertyprotectedobject $_container

Resource container

Details
Type
object
>VPropertyprotectedstring $_environment
Details
Type
string
>VPropertyprotectedarray $_optionKeys = array()
Flattened (lowercase) option keys used for lookups
Default valuearray()Details
Type
array
>VPropertyprotectedarray $_options = array()
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Loader_PluginLoader_Interface $_pluginLoader
Details
Type
\Zend_Loader_PluginLoader_Interface
>VPropertyprotectedarray $_pluginResources = array()

Class-based resource plugins

Default valuearray()Details
Type
array
>VPropertyprotectedarray $_run = array()

Initializers that have been run

Default valuearray()Details
Type
array
>VPropertyprotectedarray $_started = array()

Initializers that have been started but not yet completed (circular dependency detection)

Default valuearray()Details
Type
array

Methods

methodpublic__call(string $method, array $args) : void

Overloading: intercept calls to bootstrap() methods

Parameters
NameTypeDescription
$methodstring
$argsarray
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionOn invalid method name
methodpublic__construct(\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper $application) : void

Constructor

Sets application object, initializes options, and prepares list of initializer methods.
Parameters
NameTypeDescription
$application\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionWhen invalid application is provided
methodpublic__get(string $prop) : null | mixed

Implement PHP's magic to retrieve a ressource in the bootstrap

Parameters
NameTypeDescription
$propstring
Returns
TypeDescription
null | mixed
methodpublic__isset(string $prop) : bool

Implement PHP's magic to ask for the existence of a ressource in the bootstrap

Parameters
NameTypeDescription
$propstring
Returns
TypeDescription
bool
methodprotected_bootstrap(null | string | array $resource = null) : void

Bootstrap implementation

This method may be overridden to provide custom bootstrapping logic. It is the sole method called by {@link bootstrap()}.
Parameters
NameTypeDescription
$resourcenull | string | array
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionWhen invalid argument was passed
methodprotected_executeResource(string $resource) : void

Execute a resource

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.
Parameters
NameTypeDescription
$resourcestring
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionWhen resource not found
methodprotected_loadPluginResource(string $resource, array | object | null $options) : string | false

Load a plugin resource

Parameters
NameTypeDescription
$resourcestring
$optionsarray | object | null
Returns
TypeDescription
string | false
methodprotected_markRun(string $resource) : void

Mark a resource as having run

Parameters
NameTypeDescription
$resourcestring
methodprotected_resolvePluginResourceName(\Zend_Application_Resource_Resource $resource) : string

Resolve 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.
Parameters
NameTypeDescription
$resource\Zend_Application_Resource_Resource
Returns
TypeDescription
string
methodpublicbootstrap(null | string | array $resource = null) : \Zend_Application_Bootstrap_BootstrapAbstract
final

Bootstrap 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 {@link _bootstrap()} method.
Parameters
NameTypeDescription
$resourcenull | string | array
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionWhen invalid argument was passed
methodpublicgetApplication() : \Zend_Application | \Zend_Application_Bootstrap_Bootstrapper

Retrieve parent application instance

Returns
TypeDescription
\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper
methodpublicgetClassResourceNames() : array

Get class resource names

Returns
TypeDescription
array
methodpublicgetClassResources() : array

Get 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.
Returns
TypeDescription
array
methodpublicgetContainer() : object

Retrieve resource container

Returns
TypeDescription
object
methodpublicgetEnvironment() : string

Retrieve application environment

Returns
TypeDescription
string
methodpublicgetOption(string $key) : mixed

Retrieve a single option

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
mixed
methodpublicgetOptions() : array

Get current options from bootstrap

Returns
TypeDescription
array
methodpublicgetPluginLoader() : \Zend_Loader_PluginLoader_Interface

Get the plugin loader for resources

Returns
TypeDescription
\Zend_Loader_PluginLoader_Interface
methodpublicgetPluginResource( $resource) : \Zend_Application_Resource_Resource

Get a registered plugin resource

Parameters
NameTypeDescription
$resource
Returns
TypeDescription
\Zend_Application_Resource_Resource
methodpublicgetPluginResourceNames() : array

Retrieve plugin resource names

Returns
TypeDescription
array
methodpublicgetPluginResources() : array

Retrieve all plugin resources

Returns
TypeDescription
array
methodpublicgetResource(string $name) : null | mixed

Retrieve a resource from the container

During bootstrap resource initialization, you may return a value. If you do, it will be stored in the {@link setContainer() container}. You can use this method to retrieve that value. If no value was returned, this will return a null value.
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
null | mixed
methodpublichasOption(string $key) : bool

Is an option present?

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
bool
methodpublichasPluginResource(string $resource) : bool

Is the requested plugin resource registered?

Parameters
NameTypeDescription
$resourcestring
Returns
TypeDescription
bool
methodpublichasResource(string $name) : bool

Determine 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 {@link setContainer() container}. You can use this method to determine if a value was stored.
Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
bool
methodpublicmergeOptions(array $array1, mixed $array2 = null) : array

Merge options recursively

Parameters
NameTypeDescription
$array1array
$array2mixed
Returns
TypeDescription
array
methodpublicregisterPluginResource(string | \Zend_Application_Resource_Resource $resource, mixed $options = null) : \Zend_Application_Bootstrap_BootstrapAbstract

Register a new resource plugin

Parameters
NameTypeDescription
$resourcestring | \Zend_Application_Resource_Resource
$optionsmixed
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionWhen invalid resource is provided
methodpublicsetApplication(\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper $application) : \Zend_Application_Bootstrap_BootstrapAbstract

Set application/parent bootstrap

Parameters
NameTypeDescription
$application\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
methodpublicsetContainer(object $container) : \Zend_Application_Bootstrap_BootstrapAbstract

Set resource container

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.
Parameters
NameTypeDescription
$containerobject
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
methodpublicsetOptions(array $options) : \Zend_Application_Bootstrap_BootstrapAbstract

Set class state

Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
methodpublicsetPluginLoader(\Zend_Loader_PluginLoader_Interface $loader) : \Zend_Application_Bootstrap_BootstrapAbstract

Set plugin loader for loading resources

Parameters
NameTypeDescription
$loader\Zend_Loader_PluginLoader_Interface
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
methodpublicunregisterPluginResource(string | \Zend_Application_Resource_Resource $resource) : \Zend_Application_Bootstrap_BootstrapAbstract

Unregister a resource from the bootstrap

Parameters
NameTypeDescription
$resourcestring | \Zend_Application_Resource_Resource
Returns
TypeDescription
\Zend_Application_Bootstrap_BootstrapAbstract
Throws
ExceptionDescription
\Zend_Application_Bootstrap_ExceptionWhen unknown resource type is provided
Documentation was generated by phpDocumentor 2.2.0 .