Application/Bootstrap/BootstrapAbstract.php

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_Application
subpackage: Bootstrap
version: $Id: BootstrapAbstract.php 22665 2010-07-25 00:40:37Z ramon $
Classes: Zend_Application_Bootstrap_BootstrapAbstract

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_Application_Bootstrap_BootstrapAbstract
jump to top

Implements: Zend_Application_Bootstrap_Bootstrapper; Zend_Application_Bootstrap_ResourceBootstrapper
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_Application
subpackage: Bootstrap
uses: Zend_Application_Bootstrap_Bootstrapper
uses: Zend_Application_Bootstrap_ResourceBootstrapper
Properties: $_application; $_classResources; $_container; $_environment; $_optionKeys; $_options; $_pluginLoader; $_pluginResources; $_run; $_started
Methods: __construct; setOptions; getOptions; hasOption; getOption; mergeOptions; getClassResources; getClassResourceNames; registerPluginResource; unregisterPluginResource; hasPluginResource; getPluginResource; getPluginResources; getPluginResourceNames; setPluginLoader; getPluginLoader; setApplication; getApplication; getEnvironment; setContainer; getContainer; hasResource; getResource; __get; __isset; bootstrap; __call; _bootstrap; _executeResource; _loadPluginResource; _markRun; _resolvePluginResourceName

Description

Abstract base class for bootstrap classes

Properties

$_application
jump to class

Zend_Application|Zend_Application_Bootstrap_Bootstrapper $_application = ''

Details

$_application: Zend_Application|Zend_Application_Bootstrap_Bootstrapper
visibility: protected
default
final: false
static: false

$_classResources
jump to class

array $_classResources = ''

Details

$_classResources: array
Internal resource methods (resource/method pairs)
visibility: protected
default
final: false
static: false

$_container
jump to class

object $_container = ''

Details

$_container: object
Resource container
visibility: protected
default
final: false
static: false

$_environment
jump to class

string $_environment = ''

Details

$_environment: string
visibility: protected
default
final: false
static: false

$_optionKeys
jump to class

array $_optionKeys = 'array'

Flattened (lowercase) option keys used for lookups

Details

$_optionKeys: array
visibility: protected
default: array
final: false
static: false

$_options
jump to class

array $_options = 'array'

Details

$_options: array
visibility: protected
default: array
final: false
static: false

$_pluginLoader
jump to class

Zend_Loader_PluginLoader_Interface $_pluginLoader = ''

Details

$_pluginLoader: Zend_Loader_PluginLoader_Interface
visibility: protected
default
final: false
static: false

$_pluginResources
jump to class

array $_pluginResources = 'array'

Details

$_pluginResources: array
Class-based resource plugins
visibility: protected
default: array
final: false
static: false

$_run
jump to class

array $_run = 'array'

Details

$_run: array
Initializers that have been run
visibility: protected
default: array
final: false
static: false

$_started
jump to class

array $_started = 'array'

Details

$_started: array
Initializers that have been started but not yet completed (circular dependency detection)
visibility: protected
default: array
final: false
static: false

Methods

__call
jump to class

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

Overloading: intercept calls to bootstrap<resourcename>() methods

Arguments

$method: string
$args: array

Details

visibility: public
final: false
static: false
throws: On invalid method name

__construct
jump to class

__construct(
          Zend_Application|Zend_Application_Bootstrap_Bootstrapper $application
          )
        
        :
        void

Constructor

Sets application object, initializes options, and prepares list of initializer methods.

Arguments

$application: Zend_ApplicationZend_Application_Bootstrap_Bootstrapper

Details

visibility: public
final: false
static: false
throws: When invalid applicaiton is provided

__get
jump to class

__get(
          string $prop
          )
        
        :
        null|mixed

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

Arguments

$prop: string

Output

null|mixed

Details

visibility: public
final: false
static: false

__isset
jump to class

__isset(
          string $prop
          )
        
        :
        bool

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

Arguments

$prop: string

Output

bool

Details

visibility: public
final: false
static: false

_bootstrap
jump to class

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

Arguments

$resource: nullstringarray

Details

visibility: protected
final: false
static: false
throws: When invalid argument was passed

_executeResource
jump to class

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

Arguments

$resource: string

Details

visibility: protected
final: false
static: false
throws: When resource not found

_loadPluginResource
jump to class

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

Load a plugin resource

Arguments

$resource: string
$options: arrayobjectnull

Output

string|false

Details

visibility: protected
final: false
static: false

_markRun
jump to class

_markRun(
          string $resource
          )
        
        :
        void

Mark a resource as having run

Arguments

$resource: string

Details

visibility: protected
final: false
static: false

_resolvePluginResourceName
jump to class

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

Arguments

$resource: Zend_Application_Resource_Resource

Output

string

Details

visibility: protected
final: false
static: false

bootstrap
jump to class

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

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.

Arguments

$resource: nullstringarray

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: true
static: false
throws: When invalid argument was passed

getApplication
jump to class

getApplication(
          
          )
        
        :
        Zend_Application|Zend_Application_Bootstrap_Bootstrapper

Retrieve parent application instance

Output

Zend_Application|Zend_Application_Bootstrap_Bootstrapper

Details

visibility: public
final: false
static: false

getClassResourceNames
jump to class

getClassResourceNames(
          
          )
        
        :
        array

Get class resource names

Output

array

Details

visibility: public
final: false
static: false

getClassResources
jump to class

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

Output

array

Details

visibility: public
final: false
static: false

getContainer
jump to class

getContainer(
          
          )
        
        :
        object

Retrieve resource container

Output

object

Details

visibility: public
final: false
static: false

getEnvironment
jump to class

getEnvironment(
          
          )
        
        :
        string

Retrieve application environment

Output

string

Details

visibility: public
final: false
static: false

getOption
jump to class

getOption(
          string $key
          )
        
        :
        mixed

Retrieve a single option

Arguments

$key: string

Output

mixed

Details

visibility: public
final: false
static: false

getOptions
jump to class

getOptions(
          
          )
        
        :
        array

Get current options from bootstrap

Output

array

Details

visibility: public
final: false
static: false

getPluginLoader
jump to class

getPluginLoader(
          
          )
        
        :
        Zend_Loader_PluginLoader_Interface

Get the plugin loader for resources

Output

Zend_Loader_PluginLoader_Interface

Details

visibility: public
final: false
static: false

getPluginResource
jump to class

getPluginResource(
           $resource
          )
        
        :
        Zend_Application_Resource_Resource

Get a registered plugin resource

Arguments

$resource

Output

Zend_Application_Resource_Resource

Details

visibility: public
final: false
static: false

getPluginResourceNames
jump to class

getPluginResourceNames(
          
          )
        
        :
        array

Retrieve plugin resource names

Output

array

Details

visibility: public
final: false
static: false

getPluginResources
jump to class

getPluginResources(
          
          )
        
        :
        array

Retrieve all plugin resources

Output

array

Details

visibility: public
final: false
static: false

getResource
jump to class

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

Arguments

$name: string

Output

null|mixed

Details

visibility: public
final: false
static: false

hasOption
jump to class

hasOption(
          string $key
          )
        
        :
        bool

Is an option present?

Arguments

$key: string

Output

bool

Details

visibility: public
final: false
static: false

hasPluginResource
jump to class

hasPluginResource(
          string $resource
          )
        
        :
        bool

Is the requested plugin resource registered?

Arguments

$resource: string

Output

bool

Details

visibility: public
final: false
static: false

hasResource
jump to class

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

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

mergeOptions
jump to class

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

Merge options recursively

Arguments

$array1: array
$array2: mixed

Output

array

Details

visibility: public
final: false
static: false

registerPluginResource
jump to class

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

Arguments

$resource: stringZend_Application_Resource_Resource
$options: mixed

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: false
static: false
throws: When invalid resource is provided

setApplication
jump to class

setApplication(
          Zend_Application|Zend_Application_Bootstrap_Bootstrapper $application
          )
        
        :
        Zend_Application_Bootstrap_BootstrapAbstract

Set application/parent bootstrap

Arguments

$application: Zend_ApplicationZend_Application_Bootstrap_Bootstrapper

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: false
static: false

setContainer
jump to class

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

Arguments

$container: object

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: false
static: false

setOptions
jump to class

setOptions(
          array $options
          )
        
        :
        Zend_Application_Bootstrap_BootstrapAbstract

Set class state

Arguments

$options: array

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: false
static: false

setPluginLoader
jump to class

setPluginLoader(
          Zend_Loader_PluginLoader_Interface $loader
          )
        
        :
        Zend_Application_Bootstrap_BootstrapAbstract

Set plugin loader for loading resources

Arguments

$loader: Zend_Loader_PluginLoader_Interface

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: false
static: false

unregisterPluginResource
jump to class

unregisterPluginResource(
          string|Zend_Application_Resource_Resource $resource
          )
        
        :
        Zend_Application_Bootstrap_BootstrapAbstract

Unregister a resource from the bootstrap

Arguments

$resource: stringZend_Application_Resource_Resource

Output

Zend_Application_Bootstrap_BootstrapAbstract

Details

visibility: public
final: false
static: false
throws: When unknown resource type is provided

API Documentation

Application/Bootstrap/BootstrapAbstract.php

Description

Zend_Application_Bootstrap_BootstrapAbstractjump to top

Description

Properties

$_applicationjump to class

Details

$_classResourcesjump to class

Details

$_containerjump to class

Details

$_environmentjump to class

Details

$_optionKeysjump to class

Details

$_optionsjump to class

Details

$_pluginLoaderjump to class

Details

$_pluginResourcesjump to class

Details

$_runjump to class

Details

$_startedjump to class

Details

Methods

__calljump to class

Arguments

Details

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__issetjump to class

Arguments

Output

Details

_bootstrapjump to class

Arguments

Details

_executeResourcejump to class

Arguments

Details

_loadPluginResourcejump to class

Arguments

Output

Details

_markRunjump to class

Arguments

Details

_resolvePluginResourceNamejump to class

Arguments

Output

Details

bootstrapjump to class

Arguments

Output

Details

getApplicationjump to class

Output

Details

getClassResourceNamesjump to class

Output

Details

getClassResourcesjump to class

Output

Details

getContainerjump to class

Output

Details

getEnvironmentjump to class

Output

Details

getOptionjump to class

Arguments

Output

Zend_Application_Bootstrap_BootstrapAbstract
jump to top

$_application
jump to class

$_classResources
jump to class

$_container
jump to class

$_environment
jump to class

$_optionKeys
jump to class

$_options
jump to class

$_pluginLoader
jump to class

$_pluginResources
jump to class

$_run
jump to class

$_started
jump to class

__call
jump to class

__construct
jump to class

__get
jump to class

__isset
jump to class

_bootstrap
jump to class

_executeResource
jump to class

_loadPluginResource
jump to class

_markRun
jump to class

_resolvePluginResourceName
jump to class

bootstrap
jump to class

getApplication
jump to class

getClassResourceNames
jump to class

getClassResources
jump to class

getContainer
jump to class

getEnvironment
jump to class

getOption
jump to class

getOptions
jump to class

getPluginLoader
jump to class

getPluginResource
jump to class

getPluginResourceNames
jump to class

getPluginResources
jump to class

getResource
jump to class

hasOption
jump to class

hasPluginResource
jump to class

hasResource
jump to class

mergeOptions
jump to class

registerPluginResource
jump to class

setApplication
jump to class

setContainer
jump to class

setOptions
jump to class

setPluginLoader
jump to class

unregisterPluginResource
jump to class