Application/Resource/Resource.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Application
0017  * @subpackage Resource
0018  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0019  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0020  * @version    $Id$
0021  */
0022
0023 /**
0024  * Interface for bootstrap resources
0025  *
0026  * @category   Zend
0027  * @package    Zend_Application
0028  * @subpackage Resource
0029  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0030  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0031  */
0032 interface Zend_Application_Resource_Resource
0033 {
0034     /**
0035      * Constructor
0036      *
0037      * Must take an optional single argument, $options.
0038      *
0039      * @param  mixed $options
0040      */
0041     public function __construct($options = null);
0042
0043     /**
0044      * Set the bootstrap to which the resource is attached
0045      *
0046      * @param  Zend_Application_Bootstrap_Bootstrapper $bootstrap
0047      * @return Zend_Application_Resource_Resource
0048      */
0049     public function setBootstrap(Zend_Application_Bootstrap_Bootstrapper $bootstrap);
0050
0051     /**
0052      * Retrieve the bootstrap to which the resource is attached
0053      *
0054      * @return Zend_Application_Bootstrap_Bootstrapper
0055      */
0056     public function getBootstrap();
0057
0058     /**
0059      * Set resource options
0060      *
0061      * @param  array $options
0062      * @return Zend_Application_Resource_Resource
0063      */
0064     public function setOptions(array $options);
0065
0066     /**
0067      * Retrieve resource options
0068      *
0069      * @return array
0070      */
0071     public function getOptions();
0072
0073     /**
0074      * Strategy pattern: initialize resource
0075      *
0076      * @return mixed
0077      */
0078     public function init();
0079 }