Application/Bootstrap/Bootstrap.php

Show:

inherited

Classes
- \Zend_Application_Bootstrap_Bootstrap

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_Application
Subpackage: Bootstrap
Version: $Id: Bootstrap.php 25073 2012-11-06 19:31:53Z rob $

\Zend_Application_Bootstrap_Bootstrap
jump to top

Package: Zend\Application\Bootstrap

Concrete base class for bootstrap classes

Registers and utilizes Zend_Controller_Front by default.

Parent(s): \Zend_Application_Bootstrap_BootstrapAbstract
Children: \Zend_Application_Module_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_Bootstrap

Properties

false|string $_appNamespace = false

Application resource namespace

Default valuefalseDetails

Type: false | string

\Zend_Application|\Zend_Application_Bootstrap_Bootstrapper $_application

inherited

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_application

Details

Type: \Zend_Application | \Zend_Application_Bootstrap_Bootstrapper
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_application

array $_classResources

inherited

Internal resource methods (resource/method pairs)

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_classResources

Details

Type: array
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_classResources

object $_container

inherited

Resource container

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_container

Details

Type: object
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_container

string $_environment

inherited

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_environment

Details

Type: string
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_environment

array $_optionKeys = array()

inherited

Flattened (lowercase) option keys used for lookups

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_optionKeys

Default valuearray()Details

Type: array
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_optionKeys

array $_options = array()

inherited

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_options

\Zend_Loader_PluginLoader_Interface $_pluginLoader

inherited

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_pluginLoader

Details

Type: \Zend_Loader_PluginLoader_Interface
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_pluginLoader

array $_pluginResources = array()

inherited

Class-based resource plugins

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_pluginResources

Default valuearray()Details

Type: array
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_pluginResources

\Zend_Loader_Autoloader_Resource $_resourceLoader

Application resource autoloader

Details

Type: \Zend_Loader_Autoloader_Resource

array $_run = array()

inherited

Initializers that have been run

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_run

Default valuearray()Details

Type: array
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_run

array $_started = array()

inherited

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

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_started

Default valuearray()Details

Type: array
Inherited_from: \Zend_Application_Bootstrap_BootstrapAbstract::$$_started

Methods

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

inherited

Overloading: intercept calls to bootstrap() methods

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::__call()

Parameters

Name	Type	Description
$method	string
$args	array

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	On invalid method name

__construct(\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper $application) : void

Constructor

Ensure FrontController resource is registered

Parameters

Name	Type	Description
$application	\Zend_Application \| \Zend_Application_Bootstrap_Bootstrapper

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	When invalid application is provided

__get(string $prop) : null | mixed

inherited

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

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::__get()

Parameters

Name	Type	Description
$prop	string

Returns

Type	Description
null \| mixed

__isset(string $prop) : bool

inherited

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

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::__isset()

Parameters

Name	Type	Description
$prop	string

Returns

Type	Description
bool

_bootstrap(null | string | array $resource = null) : void

inherited

Bootstrap implementation

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::_bootstrap()

This method may be overridden to provide custom bootstrapping logic. It is the sole method called by bootstrap().

Parameters

Name	Type	Description
$resource	null \| string \| array

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	When invalid argument was passed

_executeResource(string $resource) : void

inherited

Execute a resource

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::_executeResource()

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

Name	Type	Description
$resource	string

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	When resource not found

_loadPluginResource(string $resource, array | object | null $options) : string | false

inherited

Load a plugin resource

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::_loadPluginResource()

Parameters

Name	Type	Description
$resource	string
$options	array \| object \| null

Returns

Type	Description
string \| false

_markRun(string $resource) : void

inherited

Mark a resource as having run

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::_markRun()

Parameters

Name	Type	Description
$resource	string

_resolvePluginResourceName(\Zend_Application_Resource_Resource $resource) : string

inherited

Resolve a plugin resource name

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::_resolvePluginResourceName()

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

Name	Type	Description
$resource	\Zend_Application_Resource_Resource

Returns

Type	Description
string

bootstrap(null | string | array $resource = null) : \Zend_Application_Bootstrap_BootstrapAbstract

finalinherited

Bootstrap individual, all, or multiple resources

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::bootstrap()

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.

Parameters

Name	Type	Description
$resource	null \| string \| array

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	When invalid argument was passed

getAppNamespace() : string

Get application namespace (used for module autoloading)

Returns

Type	Description
string

getApplication() : \Zend_Application | \Zend_Application_Bootstrap_Bootstrapper

inherited

Retrieve parent application instance

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getApplication()

Returns

Type	Description
\Zend_Application \| \Zend_Application_Bootstrap_Bootstrapper

getClassResourceNames() : array

inherited

Get class resource names

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getClassResourceNames()

Returns

Type	Description
array

getClassResources() : array

inherited

Get class resources (as resource/method pairs)

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getClassResources()

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

Type	Description
array

getContainer() : object

inherited

Retrieve resource container

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getContainer()

Returns

Type	Description
object

getEnvironment() : string

inherited

Retrieve application environment

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getEnvironment()

Returns

Type	Description
string

getOption(string $key) : mixed

inherited

Retrieve a single option

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getOption()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
mixed

getOptions() : array

inherited

Get current options from bootstrap

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getOptions()

Returns

Type	Description
array

getPluginLoader() : \Zend_Loader_PluginLoader_Interface

inherited

Get the plugin loader for resources

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getPluginLoader()

Returns

Type	Description
\Zend_Loader_PluginLoader_Interface

getPluginResource( $resource) : \Zend_Application_Resource_Resource

inherited

Get a registered plugin resource

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getPluginResource()

Parameters

Name	Type	Description
$resource

Returns

Type	Description
\Zend_Application_Resource_Resource

getPluginResourceNames() : array

inherited

Retrieve plugin resource names

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getPluginResourceNames()

Returns

Type	Description
array

getPluginResources() : array

inherited

Retrieve all plugin resources

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getPluginResources()

Returns

Type	Description
array

getResource(string $name) : null | mixed

inherited

Retrieve a resource from the container

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::getResource()

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.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
null \| mixed

getResourceLoader() : \Zend_Loader_Autoloader_Resource

Retrieve module resource loader

Returns

Type	Description
\Zend_Loader_Autoloader_Resource

hasOption(string $key) : bool

inherited

Is an option present?

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::hasOption()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
bool

hasPluginResource(string $resource) : bool

inherited

Is the requested plugin resource registered?

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::hasPluginResource()

Parameters

Name	Type	Description
$resource	string

Returns

Type	Description
bool

hasResource(string $name) : bool

inherited

Determine if a resource has been stored in the container

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::hasResource()

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.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool

mergeOptions(array $array1, mixed $array2 = null) : array

inherited

Merge options recursively

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::mergeOptions()

Parameters

Name	Type	Description
$array1	array
$array2	mixed

Returns

Type	Description
array

registerPluginResource(string | \Zend_Application_Resource_Resource $resource, mixed $options = null) : \Zend_Application_Bootstrap_BootstrapAbstract

inherited

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::registerPluginResource()

Parameters

Name	Type	Description
$resource	string \| \Zend_Application_Resource_Resource
$options	mixed

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	When invalid resource is provided

run() : mixed

Run the application

Checks to see that we have a default controller directory. If not, an exception is thrown.

If so, it registers the bootstrap with the 'bootstrap' parameter of the front controller, and dispatches the front controller.

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception

setAppNamespace(string $value) : \Zend_Application_Bootstrap_Bootstrap

Set application namespace (for module autoloading)

Parameters

Name	Type	Description
$value	string

Returns

Type	Description
\Zend_Application_Bootstrap_Bootstrap

setApplication(\Zend_Application | \Zend_Application_Bootstrap_Bootstrapper $application) : \Zend_Application_Bootstrap_BootstrapAbstract

inherited

Set application/parent bootstrap

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::setApplication()

Parameters

Name	Type	Description
$application	\Zend_Application \| \Zend_Application_Bootstrap_Bootstrapper

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

setContainer(object $container) : \Zend_Application_Bootstrap_BootstrapAbstract

inherited

Set resource container

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::setContainer()

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

Name	Type	Description
$container	object

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

setOptions(array $options) : \Zend_Application_Bootstrap_BootstrapAbstract

inherited

Set class state

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader) : \Zend_Application_Bootstrap_BootstrapAbstract

inherited

Set plugin loader for loading resources

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::setPluginLoader()

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader_Interface

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

setResourceLoader(\Zend_Loader_Autoloader_Resource $loader) : \Zend_Application_Module_Bootstrap

Set module resource loader

Parameters

Name	Type	Description
$loader	\Zend_Loader_Autoloader_Resource

Returns

Type	Description
\Zend_Application_Module_Bootstrap

unregisterPluginResource(string | \Zend_Application_Resource_Resource $resource) : \Zend_Application_Bootstrap_BootstrapAbstract

inherited

Unregister a resource from the bootstrap

Inherited from: \Zend_Application_Bootstrap_BootstrapAbstract::unregisterPluginResource()

Parameters

Name	Type	Description
$resource	string \| \Zend_Application_Resource_Resource

Returns

Type	Description
\Zend_Application_Bootstrap_BootstrapAbstract

Throws

Exception	Description
\Zend_Application_Bootstrap_Exception	When unknown resource type is provided

Application/Bootstrap/Bootstrap.php

\Zend_Application_Bootstrap_Bootstrapjump to top

Properties

Methods

\Zend_Application_Bootstrap_Bootstrap
jump to top