documentation/manual/en/module_specs/Zend_Application-Examples.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <sect1 id="zend.application.examples">
   4     <title>Examples</title>
   5
   6     <para>
   7         The Bootstrap class itself will typically be fairly minimal; often,
   8         it will simply be an empty stub extending the base bootstrap class:
   9     </para>
  10
  11     <programlisting language="php"><![CDATA[
  12 class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  13 {
  14 }
  15 ]]></programlisting>
  16
  17     <para>
  18         With a corresponding configuration file:
  19     </para>
  20
  21     <programlisting language="ini"><![CDATA[
  22 ; APPLICATION_PATH/configs/application.ini
  23 [production]
  24 bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
  25 bootstrap.class = "Bootstrap"
  26 resources.frontController.controllerDirectory = APPLICATION_PATH "/controllers"
  27
  28 [testing : production]
  29 [development : production]
  30 ]]></programlisting>
  31
  32     <para>
  33         However, should custom initialization be necessary, you have two
  34         choices. First, you can write methods prefixed with <emphasis>_init</emphasis>
  35         to specify discrete code to bootstrap. These methods will be called by
  36         <methodname>bootstrap()</methodname>, and can also be called as if they were public methods:
  37         <emphasis>bootstrap&lt;resource&gt;()</emphasis>. They should accept an optional
  38         array of options.
  39     </para>
  40
  41     <para>
  42         If your resource method returns a value, it will be stored in a
  43         container in the bootstrap. This can be useful when different resources
  44         need to interact (such as one resource injecting itself into another).
  45         The method <methodname>getResource()</methodname> can then be used to retrieve those
  46         values.
  47     </para>
  48
  49     <para>
  50         The example below shows a resource method for initializing the request
  51         object. It makes use of dependency tracking (it depends on the front
  52         controller resource), fetching a resource from the bootstrap, and
  53         returning a value to store in the bootstrap.
  54     </para>
  55
  56     <programlisting language="php"><![CDATA[
  57 class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
  58 {
  59     protected function _initRequest()
  60     {
  61         // Ensure front controller instance is present, and fetch it
  62         $this->bootstrap('FrontController');
  63         $front = $this->getResource('FrontController');
  64
  65         // Initialize the request object
  66         $request = new Zend_Controller_Request_Http();
  67         $request->setBaseUrl('/foo');
  68
  69         // Add it to the front controller
  70         $front->setRequest($request);
  71
  72         // Bootstrap will store this value in the 'request' key of its container
  73         return $request;
  74     }
  75 }
  76 ]]></programlisting>
  77
  78     <para>
  79         Note in this example the call to <methodname>bootstrap()</methodname>;
  80         this ensures that the front controller has been initialized prior to
  81         calling this method. That call may trigger either a resource or another
  82         method in the class.
  83     </para>
  84
  85     <para>
  86         The other option is to use resource plugins. Resource plugins are
  87         objects that perform specific initializations, and may be specified:
  88     </para>
  89
  90     <itemizedlist>
  91         <listitem>
  92             <para>
  93                 When instantiating the <classname>Zend_Application</classname> object
  94             </para>
  95         </listitem>
  96
  97         <listitem>
  98             <para>
  99                 During initialization of the bootstrap object
 100             </para>
 101         </listitem>
 102
 103         <listitem>
 104             <para>
 105                 By explicitly enabling them via method calls to the bootstrap
 106                 object
 107             </para>
 108         </listitem>
 109     </itemizedlist>
 110
 111     <para>
 112         Resource plugins implement
 113         <classname>Zend_Application_Resource_ResourceAbstract</classname>,
 114         which defines simply that they allow injection of the caller and
 115         options, and that they have an <methodname>init()</methodname> method. As an
 116         example, a custom "View" bootstrap resource might look like the
 117         following:
 118     </para>
 119
 120     <programlisting language="php"><![CDATA[
 121 class My_Bootstrap_Resource_View
 122     extends Zend_Application_Resource_ResourceAbstract
 123 {
 124     public function init()
 125     {
 126         $view = new Zend_View($this->getOptions());
 127         Zend_Dojo::enableView($view);
 128
 129         $view->doctype('XHTML1_STRICT');
 130         $view->headTitle()->setSeparator(' - ')->append('My Site');
 131         $view->headMeta()->appendHttpEquiv('Content-Type',
 132                                            'text/html; charset=utf-8');
 133
 134         $view->dojo()->setDjConfigOption('parseOnLoad', true)
 135                      ->setLocalPath('/js/dojo/dojo.js')
 136                      ->registerModulePath('../spindle', 'spindle')
 137                      ->addStylesheetModule('spindle.themes.spindle')
 138                      ->requireModule('spindle.main')
 139                      ->disable();
 140
 141         $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper(
 142             'ViewRenderer'
 143         );
 144         $viewRenderer->setView($view);
 145
 146         return $view;
 147     }
 148 }
 149 ]]></programlisting>
 150
 151     <para>
 152         To tell the bootstrap to use this, you would need to provide either the
 153         class name of the resource plugin, or a combination of a plugin loader prefix
 154         path and the short name of the resource plugin (e.g, "view"):
 155     </para>
 156
 157     <programlisting language="php"><![CDATA[
 158 $application = new Zend_Application(
 159     APPLICATION_ENV,
 160     array(
 161         'resources' => array(
 162             'My_Bootstrap_Resource_View' => array(), // full class name; OR
 163             'view' => array(),                       // short name
 164
 165             'FrontController' => array(
 166                 'controllerDirectory' => APPLICATION_PATH . '/controllers',
 167             ),
 168         ),
 169
 170         // For short names, define plugin paths:
 171         'pluginPaths = array(
 172             'My_Bootstrap_Resource' => 'My/Bootstrap/Resource',
 173         )
 174     )
 175 );
 176 ]]></programlisting>
 177
 178     <para>
 179         Resource plugins can call on other resources and initializers by accessing the
 180         parent bootstrap:
 181     </para>
 182
 183     <programlisting language="php"><![CDATA[
 184 class My_Bootstrap_Resource_Layout
 185     extends Zend_Application_Resource_ResourceAbstract
 186 {
 187     public function init()
 188     {
 189         // ensure view is initialized...
 190         $this->getBootstrap()->bootstrap('view');
 191
 192         // Get view object:
 193         $view = $this->getBootstrap()->getResource('view');
 194
 195         // ...
 196     }
 197 }
 198 ]]></programlisting>
 199
 200     <para>
 201         In normal usage, you would instantiate the application, bootstrap it,
 202         and run it:
 203     </para>
 204
 205     <programlisting language="php"><![CDATA[
 206 $application = new Zend_Application(...);
 207 $application->bootstrap()
 208             ->run();
 209 ]]></programlisting>
 210
 211     <para>
 212         For a custom script, you might need to simply initialize specific
 213         resources:
 214     </para>
 215
 216     <programlisting language="php"><![CDATA[
 217 $application = new Zend_Application(...);
 218 $application->getBootstrap()->bootstrap('db');
 219
 220 $service = new Zend_XmlRpc_Server();
 221 $service->setClass('Foo');  // uses database...
 222 echo $service->handle();
 223 ]]></programlisting>
 224
 225     <para>
 226         Instead of using the <methodname>bootstrap()</methodname> method to call the
 227         internal methods or resources, you may also use overloading:
 228     </para>
 229
 230     <programlisting language="php"><![CDATA[
 231 $application = new Zend_Application(...);
 232 $application->getBootstrap()->bootstrapDb();
 233 ]]></programlisting>
 234 </sect1>