/library/Zend/Application/Bootstrap/ResourceBootstrapper.php

 1<?php
 2/**
 3 * Zend Framework
 4 *
 5 * LICENSE
 6 *
 7 * This source file is subject to the new BSD license that is bundled
 8 * with this package in the file LICENSE.txt.
 9 * It is also available through the world-wide-web at this URL:
10 * http://framework.zend.com/license/new-bsd
11 * If you did not receive a copy of the license and are unable to
12 * obtain it through the world-wide-web, please send an email
13 * to license@zend.com so we can send you a copy immediately.
14 *
15 * @category   Zend
16 * @package    Zend_Application
17 * @subpackage Bootstrap
18 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
19 * @license    http://framework.zend.com/license/new-bsd     New BSD License
20 * @version    $Id: ResourceBootstrapper.php 24594 2012-01-05 21:27:01Z matthew $
21 */
22
23/**
24 * Interface for bootstrap classes that utilize resource plugins
25 *
26 * @category   Zend
27 * @package    Zend_Application
28 * @subpackage Bootstrap
29 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
30 * @license    http://framework.zend.com/license/new-bsd     New BSD License
31 */
32interface Zend_Application_Bootstrap_ResourceBootstrapper
33{
34    /**
35     * Register a resource with the bootstrap
36     *
37     * @param  string|Zend_Application_Resource_Resource $resource
38     * @param  null|array|Zend_Config                     $options
39     * @return Zend_Application_Bootstrap_ResourceBootstrapper
40     */
41    public function registerPluginResource($resource, $options = null);
42
43    /**
44     * Unregister a resource from the bootstrap
45     *
46     * @param  string|Zend_Application_Resource_Resource $resource
47     * @return Zend_Application_Bootstrap_ResourceBootstrapper
48     */
49    public function unregisterPluginResource($resource);
50
51    /**
52     * Is the requested resource registered?
53     *
54     * @param  string $resource
55     * @return bool
56     */
57    public function hasPluginResource($resource);
58
59    /**
60     * Retrieve resource
61     *
62     * @param  string $resource
63     * @return Zend_Application_Resource_Resource
64     */
65    public function getPluginResource($resource);
66
67    /**
68     * Get all resources
69     *
70     * @return array
71     */
72    public function getPluginResources();
73
74    /**
75     * Get just resource names
76     *
77     * @return array
78     */
79    public function getPluginResourceNames();
80
81    /**
82     * Set plugin loader to use to fetch resources
83     *
84     * @param  Zend_Loader_PluginLoader_Interface Zend_Loader_PluginLoader
85     * @return Zend_Application_Bootstrap_ResourceBootstrapper
86     */
87    public function setPluginLoader(Zend_Loader_PluginLoader_Interface $loader);
88
89    /**
90     * Retrieve plugin loader for resources
91     *
92     * @return Zend_Loader_PluginLoader
93     */
94    public function getPluginLoader();
95}