|
|
@@ -25,11 +25,11 @@
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<row>
|
|
|
- <entry><code>__construct($application)</code></entry>
|
|
|
+ <entry><methodname>__construct($application)</methodname></entry>
|
|
|
<entry><code>void</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$application</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$application</varname>: <emphasis>required</emphasis>.
|
|
|
Accepts either a <classname>Zend_Application</classname> or a
|
|
|
<classname>Zend_Application_Bootstrap_Bootstrapper</classname>
|
|
|
object as the sole argument.
|
|
|
@@ -43,11 +43,11 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>setOptions(array $options)</code></entry>
|
|
|
+ <entry><methodname>setOptions(array $options)</methodname></entry>
|
|
|
<entry><classname>Zend_Application_Bootstrap_Bootstrapper</classname></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$options</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$options</varname>: <emphasis>required</emphasis>.
|
|
|
Array of options to set.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
@@ -56,37 +56,37 @@
|
|
|
Any option that has a matching setter will
|
|
|
invoke that setter; otherwise, the option will simply be
|
|
|
stored for later retrieval. As an example, if your
|
|
|
- extending class defined a <code>setFoo()</code> method,
|
|
|
+ extending class defined a <methodname>setFoo()</methodname> method,
|
|
|
the option 'foo' would pass the value to that method.
|
|
|
</para>
|
|
|
<para>
|
|
|
Two additional, special options keys may also be used.
|
|
|
- <code>pluginPaths</code> may be used to specify prefix
|
|
|
+ <emphasis>pluginPaths</emphasis> may be used to specify prefix
|
|
|
paths to plugin resources; it should be an array of
|
|
|
- class prefix/filesystem path pairs.
|
|
|
- <code>resources</code> may be used to specify plugin
|
|
|
+ class prefix to filesystem path pairs.
|
|
|
+ <emphasis>resources</emphasis> may be used to specify plugin
|
|
|
resources to use, and should consist of plugin
|
|
|
- resource/instantiation options pairs.
|
|
|
+ resource to instantiation options pairs.
|
|
|
</para>
|
|
|
</entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getOption()</code></entry>
|
|
|
+ <entry><methodname>getOption()</methodname></entry>
|
|
|
<entry><code>array</code></entry>
|
|
|
<entry>N/A</entry>
|
|
|
<entry><para>
|
|
|
Returns all options registered via
|
|
|
- <code>setOptions()</code>.
|
|
|
+ <methodname>setOptions()</methodname>.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>hasOption($key)</code></entry>
|
|
|
+ <entry><methodname>hasOption($key)</methodname></entry>
|
|
|
<entry><code>boolean</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$key</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$key</varname>: <emphasis>required</emphasis>.
|
|
|
Option key to test.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
@@ -94,11 +94,11 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getOption($key)</code></entry>
|
|
|
+ <entry><methodname>getOption($key)</methodname></entry>
|
|
|
<entry><code>mixed</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$key</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$key</varname>: <emphasis>required</emphasis>.
|
|
|
Option key to retrieve.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
@@ -109,44 +109,48 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>setApplication(Zend_Application |
|
|
|
- Zend_Application_Bootstrap_Bootstrapper $application)</code></entry>
|
|
|
+ <entry>
|
|
|
+ <methodname>setApplication(Zend_Application |
|
|
|
+ Zend_Application_Bootstrap_Bootstrapper $application)</methodname>
|
|
|
+ </entry>
|
|
|
<entry>
|
|
|
<classname>Zend_Application_Bootstrap_BootstrapAbstract</classname>
|
|
|
</entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$application</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$application</varname>: <emphasis>required</emphasis>.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
<entry><para>
|
|
|
- Register the parent application/bootstrap object.
|
|
|
+ Register the parent application or bootstrap object.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getApplication()</code></entry>
|
|
|
- <entry><classname>Zend_Application |
|
|
|
- Zend_Application_Bootstrap_Bootstrapper</classname></entry>
|
|
|
+ <entry><methodname>getApplication()</methodname></entry>
|
|
|
+ <entry>
|
|
|
+ <classname>Zend_Application</classname> |
|
|
|
+ <classname>Zend_Application_Bootstrap_Bootstrapper</classname>
|
|
|
+ </entry>
|
|
|
<entry>N/A</entry>
|
|
|
<entry><para>
|
|
|
- Retrieve the application/bootstrap object passed via the
|
|
|
+ Retrieve the application or bootstrap object passed via the
|
|
|
constructor.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getEnvironment()</code></entry>
|
|
|
+ <entry><methodname>getEnvironment()</methodname></entry>
|
|
|
<entry><code>string</code></entry>
|
|
|
<entry>N/A</entry>
|
|
|
<entry><para>
|
|
|
Retrieve the environment string registered with the
|
|
|
- parent application/bootstrap object.
|
|
|
+ parent application or bootstrap object.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getClassResources()</code></entry>
|
|
|
+ <entry><methodname>getClassResources()</methodname></entry>
|
|
|
<entry><code>array</code></entry>
|
|
|
<entry>N/A</entry>
|
|
|
<entry><para>
|
|
|
@@ -157,7 +161,7 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getContainer()</code></entry>
|
|
|
+ <entry><methodname>getContainer()</methodname></entry>
|
|
|
<entry><code>object</code></entry>
|
|
|
<entry>N/A</entry>
|
|
|
<entry><para>
|
|
|
@@ -169,13 +173,13 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>setContainer($container)</code></entry>
|
|
|
+ <entry><methodname>setContainer($container)</methodname></entry>
|
|
|
<entry>
|
|
|
<classname>Zend_Application_Bootstrap_BootstrapAbstract</classname>
|
|
|
</entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$container</code>, <emphasis>required</emphasis>.
|
|
|
+ <varname>$container</varname>, <emphasis>required</emphasis>.
|
|
|
An object in which to store resources.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
@@ -187,52 +191,52 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>hasResource($name)</code></entry>
|
|
|
+ <entry><methodname>hasResource($name)</methodname></entry>
|
|
|
<entry><code>boolean</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$name</code>, <emphasis>required</emphasis>.
|
|
|
+ <varname>$name</varname>, <emphasis>required</emphasis>.
|
|
|
Name of a resource to check.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
<entry><para>
|
|
|
When a resource method or plugin returns a value, it
|
|
|
will be stored in the resource container (see
|
|
|
- <code>getContainer()</code> and
|
|
|
- <code>setContainer()</code>. This method will indicate
|
|
|
+ <methodname>getContainer()</methodname> and
|
|
|
+ <methodname>setContainer()</methodname>. This method will indicate
|
|
|
whether or not a value for that resource has been set.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>getResource($name)</code></entry>
|
|
|
+ <entry><methodname>getResource($name)</methodname></entry>
|
|
|
<entry><code>mixed</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$name</code>, <emphasis>required</emphasis>.
|
|
|
+ <varname>$name</varname>, <emphasis>required</emphasis>.
|
|
|
Name of a resource to fetch.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
<entry><para>
|
|
|
When a resource method or plugin returns a value, it
|
|
|
will be stored in the resource container (see
|
|
|
- <code>getContainer()</code> and
|
|
|
- <code>setContainer()</code>. This method will retrieve a
|
|
|
+ <methodname>getContainer()</methodname> and
|
|
|
+ <methodname>setContainer()</methodname>. This method will retrieve a
|
|
|
resources from the container.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>bootstrap($resource = null)</code></entry>
|
|
|
+ <entry><methodname>bootstrap($resource = null)</methodname></entry>
|
|
|
<entry><code>mixed</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$resource</code>: <emphasis>optional</emphasis>.
|
|
|
+ <varname>$resource</varname>: <emphasis>optional</emphasis>.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
<entry>
|
|
|
<para>
|
|
|
- If <code>$resource</code> is empty, execute all
|
|
|
+ If <varname>$resource</varname> is empty, execute all
|
|
|
bootstrap resources. If a string, execute that single
|
|
|
resource; if an array, execute each resource in the
|
|
|
array.
|
|
|
@@ -249,7 +253,7 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>run()</code></entry>
|
|
|
+ <entry><methodname>run()</methodname></entry>
|
|
|
<entry><code>void</code></entry>
|
|
|
<entry>N/A</entry>
|
|
|
<entry><para>
|
|
|
@@ -259,16 +263,16 @@
|
|
|
</row>
|
|
|
|
|
|
<row>
|
|
|
- <entry><code>__call($method, $args)</code></entry>
|
|
|
+ <entry><methodname>__call($method, $args)</methodname></entry>
|
|
|
<entry><code>mixed</code></entry>
|
|
|
<entry><itemizedlist>
|
|
|
<listitem><para>
|
|
|
- <code>$method</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$method</varname>: <emphasis>required</emphasis>.
|
|
|
The method name to call.
|
|
|
</para></listitem>
|
|
|
|
|
|
<listitem><para>
|
|
|
- <code>$args</code>: <emphasis>required</emphasis>.
|
|
|
+ <varname>$args</varname>: <emphasis>required</emphasis>.
|
|
|
Array of arguments to use in the method call.
|
|
|
</para></listitem>
|
|
|
</itemizedlist></entry>
|
|
|
@@ -276,7 +280,7 @@
|
|
|
Provides convenience to bootstrapping individual
|
|
|
resources by allowing you to call
|
|
|
'bootstrap<ResourceName>()' instead of using the
|
|
|
- <code>bootstrap()</code> method.
|
|
|
+ <methodname>bootstrap()</methodname> method.
|
|
|
</para></entry>
|
|
|
</row>
|
|
|
</tbody>
|