[DOCUMENTATION] English:

 - fixed all compilation errors

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@16831 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Db_Table.xml

@@ -26,32 +26,32 @@
 
     <sect2 id="zend.db.table.concrete">
         <title>Using Zend_Db_Table as a concrete class</title>
-        
+
         <para>
             As of ZF 1.9, you can instantiate Zend_Db_Table.  This added benefit is that
             you do not have to extend a base class and configure it to do simple operations
             such as selecting, inserting, updating and deleteing on a single table.  Below
             is an example of the simplest of use cases.
         </para>
-        
+
         <example id="zend.db.table.defining.concrete-instantiation.example1">
 
             <title>Declaring a table class with just the string name</title>
-        
+
                 <programlisting language="php"><![CDATA[
 Zend_Db_Table::setDefaultAdapter($dbAdapter);
 $bugTable = new Zend_Db_Table('bug');
 ]]></programlisting>
 
         </example>
-        
+
         <para>
             The above example represents the simplest of use cases.  Make not of all the
             options describe below for configuring Zend_Db_Table tables.  If you want to be
             able to use the concrete usage case, in addition to the more complex relationhip
             features, see the Zend_Db_Table_Definition documentation.
         </para>
-        
+
     </sect2>
 
     <sect2 id="zend.db.table.defining">
@@ -878,7 +878,7 @@ $rows = $table->fetchAll(
 
 // Fetching a single row
 $row = $table->fetchRow(
-    'bug_status = "NEW"', 
+    'bug_status = "NEW"',
     'bug_id ASC'
     );
 $row = $table->fetchRow(

documentation/manual/en/module_specs/Zend_Db_Table_Definition.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
-<sect1 id="zend.db.table.row">
+<sect1 id="zend.db.table.definition">
 
     <title>Zend_Db_Table_Definition</title>
 
@@ -9,13 +9,13 @@
         <title>Introduction</title>
 
         <para>
-            <classname>Zend_Db_Table_Definition</classname> is a class that can be used to 
+            <classname>Zend_Db_Table_Definition</classname> is a class that can be used to
             describe the relationships and configuration options that should be used when
             <classname>Zend_Db_Table</classname> is used via concrete instantiation.
         </para>
 
     </sect2>
-    
+
     <sect2 id="zend.db.table.definition.usage">
 
         <title>Basic Usage</title>
@@ -79,7 +79,7 @@ $definition = new Zend_Db_Table_Definition(array(
             As you can see, the same options you'd generally see inside of an
             extended Zend_Db_Table_Abstract class are documented in this
             array as well.  When passed into Zend_Db_Table constructor, this
-            definition is <strong>persisted</strong> to any tables it will need
+            definition is <emphasis>persisted</emphasis> to any tables it will need
             to create in order to return the proper rows.
         </para>
 
@@ -91,9 +91,9 @@ $definition = new Zend_Db_Table_Definition(array(
 
 
         <example id="zend.db.table.definition.example2">
-        
+
             <title>Interacting with the described definition</title>
-        
+
             <programlisting language="php"><![CDATA[
 $authorTable = new Zend_Db_Table('author', $definition);
 $authors = $authorTable->fetchAll();
@@ -118,28 +118,28 @@ foreach ($authors as $author) {
     </sect2>
 
     <sect2 id="zend.db.table.definition.advanced-usage">
-    
+
         <title>Advanced Usage</title>
-        
+
         <para>
-            Sometimes you want to use both paradigms for defining and using the 
+            Sometimes you want to use both paradigms for defining and using the
             table gateway: both by extension and concrete instantiation.  To do this
             simply leave out any table configurations out of the definition.  This will
             allow Zend_Db_Table to look for the actual refered class instead of the
             definition key.
         </para>
-    
+
         <para>
             Building on the example above, we will allow for one of the table configurations
             to be a Zend_Db_Table_Abstract extended class, while keeping the rest of the tables
-            as part of the definition.  We will also show how one would interact with this 
+            as part of the definition.  We will also show how one would interact with this
             new definition.
         </para>
-    
+
         <example id="zend.db.table.definition.example3">
-        
+
             <title>Interacting A Mixed Use Zend_Db_Table Definition</title>
-        
+
             <programlisting language="php"><![CDATA[
 class MyBook extends Zend_Db_Table_Abstract
 {
@@ -191,10 +191,10 @@ foreach ($authors as $author) {
     }
 }
 
-]]></programlisting>    
-    
+]]></programlisting>
+
         </example>
-    
+
     </sect2>
 
 </sect1>

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Attribute.xml

@@ -13,36 +13,36 @@
     <variablelist>
         <varlistentry>
             <term><code>string</code></term>
-            <listitem>No conversion will be done.</listitem>
+            <listitem><para>No conversion will be done.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>integer</code> and <code>float</code></term>
-            <listitem>The value will be converted to a string.</listitem>
+            <listitem><para>The value will be converted to a string.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>boolean</code></term>
-            <listitem><code>true</code> will be converted to <code>'TRUE'</code> and
-            <code>false</code> to <code>'FALSE'</code></listitem>
+            <listitem><para><code>true</code> will be converted to <code>'TRUE'</code> and
+            <code>false</code> to <code>'FALSE'</code></para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>object</code> and <code>array</code></term>
-            <listitem>The value will be converted to a string by using
-            <code>serialize()</code>.</listitem>
+            <listitem><para>The value will be converted to a string by using
+            <code>serialize()</code>.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>resource</code></term>
-            <listitem>If a <code>stream</code> resource is given, the data will be
-            fetched by calling <code>stream_get_contents()</code>.</listitem>
+            <listitem><para>If a <code>stream</code> resource is given, the data will be
+            fetched by calling <code>stream_get_contents()</code>.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term>others</term>
-            <listitem>All other data types (namely non-stream resources) will be
-            ommitted.</listitem>
+            <listitem><para>All other data types (namely non-stream resources) will be
+            ommitted.</para></listitem>
         </varlistentry>
 
     </variablelist>
@@ -52,23 +52,23 @@
     <variablelist>
         <varlistentry>
             <term><code>'TRUE'</code></term>
-            <listitem>Converted to <code>true</code>.</listitem>
+            <listitem><para>Converted to <code>true</code>.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>'FALSE'</code></term>
-            <listitem>Converted to <code>false</code>.</listitem>
+            <listitem><para>Converted to <code>false</code>.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term>others</term>
-            <listitem>All other strings won't be automatically converted and are passed
-            as they are.</listitem>
+            <listitem><para>All other strings won't be automatically converted and are passed
+            as they are.</para></listitem>
         </varlistentry>
 
     </variablelist>
 
-    <table id="zend.ldap.api.reference.zend-ldap-attribute">
+    <table id="zend.ldap.api.reference.zend-ldap-attribute.table">
         <title>Zend_Ldap_Attribute API</title>
 
         <tgroup cols="2">
@@ -257,10 +257,6 @@
                     </entry>
                 </row>
             </tbody>
-
         </tgroup>
-
     </table>
-
-</sect3>
-
+</sect3>

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Dn.xml

@@ -13,17 +13,17 @@
     <variablelist>
         <varlistentry>
             <term><code>Zend_Ldap_Dn::ATTR_CASEFOLD_NONE</code></term>
-            <listitem>No case-folding will be done.</listitem>
+            <listitem><para>No case-folding will be done.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>Zend_Ldap_Dn::ATTR_CASEFOLD_UPPER</code></term>
-            <listitem>All attributes will be converted to upper-case.</listitem>
+            <listitem><para>All attributes will be converted to upper-case.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>Zend_Ldap_Dn::ATTR_CASEFOLD_LOWER</code></term>
-            <listitem>All attributes will be converted to lower-case.</listitem>
+            <listitem><para>All attributes will be converted to lower-case.</para></listitem>
         </varlistentry>
     </variablelist>
 
@@ -45,7 +45,7 @@
         is within the bounds.
     </para>
 
-    <table id="zend.ldap.api.reference.zend-ldap-dn">
+    <table id="zend.ldap.api.reference.zend-ldap-dn.table">
         <title>Zend_Ldap_Dn API</title>
 
         <tgroup cols="2">

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Filter.xml

@@ -231,5 +231,4 @@
             </tbody>
         </tgroup>
     </table>
-</sect3>
-
+</sect3>

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Ldif-Encoder.xml

@@ -36,22 +36,34 @@
                         <variablelist>
                             <varlistentry>
                                 <term><code>'sort'</code></term>
-                                <listitem>Sort the given attributes with <code>dn</code>
-                                following <code>objectClass</code> and following all other
-                                attributes sorted alphabetically. <code>true</code> by
-                                default.</listitem>
+                                <listitem>
+                                    <para>
+                                        Sort the given attributes with <code>dn</code>
+                                        following <code>objectClass</code> and following all other
+                                        attributes sorted alphabetically. <code>true</code> by
+                                        default.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>'version'</code></term>
-                                <listitem>The <acronym>LDIF</acronym> format version. <code>1</code> by
-                                default.</listitem>
+                                <listitem>
+                                    <para>
+                                        The <acronym>LDIF</acronym> format version. <code>1</code> by
+                                        default.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>'wrap'</code></term>
-                                <listitem>The line-length. <code>78</code> by default to
-                                conform to the <acronym>LDIF</acronym> specification.</listitem>
+                                <listitem>
+                                <para>
+                                    The line-length. <code>78</code> by default to
+                                    conform to the <acronym>LDIF</acronym> specification.
+                                </para>
+                                </listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Node-RootDse.xml

@@ -215,25 +215,25 @@
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_RootDse::SERVER_TYPE_GENERIC</code></term>
-                                <listitem>for unknown <acronym>LDAP</acronym> servers</listitem>
+                                <listitem><para>for unknown <acronym>LDAP</acronym> servers</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</code></term>
-                                <listitem>for OpenLDAP servers</listitem>
+                                <listitem><para>for OpenLDAP servers</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</code></term>
-                                <listitem>for Microsoft ActiveDirectory servers</listitem>
+                                <listitem><para>for Microsoft ActiveDirectory servers</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</code></term>
-                                <listitem>For Novell eDirectory servers</listitem>
+                                <listitem><para>For Novell eDirectory servers</para></listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap-Node-Schema.xml

@@ -285,25 +285,25 @@
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_UNKNOWN</code></term>
-                                <listitem>for unknown class types</listitem>
+                                <listitem><para>for unknown class types</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_STRUCTURAL</code></term>
-                                <listitem>for structural classes</listitem>
+                                <listitem><para>for structural classes</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_ABSTRACT</code></term>
-                                <listitem>for abstract classes</listitem>
+                                <listitem><para>for abstract classes</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
                                 <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_AUXILIARY</code></term>
-                                <listitem>for auxiliary classes</listitem>
+                                <listitem><para>for auxiliary classes</para></listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>
@@ -477,7 +477,6 @@
                 <tbody>
                     <row>
                         <entry>
-
                             <code>Zend_Ldap_Node_Schema_AttributeType_ActiveDirectory</code>
                             does not provide any additional methods.
                         </entry>
@@ -494,7 +493,6 @@
                 <tbody>
                     <row>
                         <entry>
-
                             <code>Zend_Ldap_Node_Schema_ObjectClass_ActiveDirectory</code>
                             does not provide any additional methods.
                         </entry>

documentation/manual/en/module_specs/Zend_Ldap-API-Ldap.xml

@@ -52,7 +52,7 @@
                         parameters must be passed to the instance using
                         <code>Zend_Ldap::setOptions()</code>. The allowed options are
                         specified in <link
-                            linkend="zend.ldap.using.theory-of-operation.options.table">Zend_Ldap
+                            linkend="zend.ldap.api.configuration.table">Zend_Ldap
                             Options</link>
                     </entry>
                 </row>
@@ -87,7 +87,7 @@
                         <code>$options</code> can be an array or an instance of
                         <classname>Zend_Config</classname>. The allowed options are specified in
                         <link
-                            linkend="zend.ldap.using.theory-of-operation.options.table">Zend_Ldap Options</link>
+                            linkend="zend.ldap.api.configuration.table">Zend_Ldap Options</link>
                     </entry>
                 </row>
                 <row>
@@ -165,65 +165,89 @@
                                 <term><code>string|Zend_Ldap_Filter_Abstract
                                 $filter</code></term>
 
-                                <listitem>The filter string to be used in the search, e.g.
-                                <code>(objectClass=posixAccount)</code>.</listitem>
+                                <listitem>
+                                    <para>
+                                        The filter string to be used in the search, e.g.
+                                        <code>(objectClass=posixAccount)</code>.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>string|Zend_Ldap_Dn $basedn</code></term>
 
-                                <listitem>The search base for the search. If omitted or
-                                <code>null</code>, the <code>baseDn</code> from the
-                                connection and binding parameters is used.</listitem>
+                                <listitem>
+                                    <para>
+                                        The search base for the search. If omitted or
+                                        <code>null</code>, the <code>baseDn</code> from the
+                                        connection and binding parameters is used.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>integer $scope</code></term>
 
-                                <listitem>The search scope.
-                                <code>Zend_Ldap::SEARCH_SCOPE_SUB</code> searches the
-                                complete subtree including the <code>$baseDn</code> node.
-                                <code>Zend_Ldap::SEARCH_SCOPE_ONE</code> restricts search
-                                to one level below <code>$baseDn</code>.
-                                <code>Zend_Ldap::SEARCH_SCOPE_BASE</code> restricts search
-                                to the <code>$baseDn</code> itself; this can be used to
-                                efficiently retrieve a single entry by its DN. The default
-                                value is
-                                <code>Zend_Ldap::SEARCH_SCOPE_SUB</code>.</listitem>
+                                <listitem>
+                                    <para>
+                                        The search scope.
+                                        <code>Zend_Ldap::SEARCH_SCOPE_SUB</code> searches the
+                                        complete subtree including the <code>$baseDn</code> node.
+                                        <code>Zend_Ldap::SEARCH_SCOPE_ONE</code> restricts search
+                                        to one level below <code>$baseDn</code>.
+                                        <code>Zend_Ldap::SEARCH_SCOPE_BASE</code> restricts search
+                                        to the <code>$baseDn</code> itself; this can be used to
+                                        efficiently retrieve a single entry by its DN. The default
+                                        value is
+                                        <code>Zend_Ldap::SEARCH_SCOPE_SUB</code>.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>array $attributes</code></term>
 
-                                <listitem>Specifies the attributes contained in the
-                                returned entries. To include all possible attributes (ACL
-                                restrictions can disallow certain attribute to be retrieved
-                                by a given user) pass either an empty array
-                                <code>array()</code> or <code>array('*')</code> to the
-                                method. On some <acronym>LDAP</acronym> servers you can retrieve special
-                                internal attributes by passing <code>array('*', '+')</code>
-                                to the method.</listitem>
+                                <listitem>
+                                    <para>
+                                        Specifies the attributes contained in the
+                                        returned entries. To include all possible attributes (ACL
+                                        restrictions can disallow certain attribute to be retrieved
+                                        by a given user) pass either an empty array
+                                        <code>array()</code> or <code>array('*')</code> to the
+                                        method. On some <acronym>LDAP</acronym> servers you can retrieve special
+                                        internal attributes by passing <code>array('*', '+')</code>
+                                        to the method.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>string $sort</code></term>
 
-                                <listitem>If given the result collection will be sorted
-                                after the attribute <code>$sort</code>. Results can only be
-                                sorted after one single attribute as this parameter uses
-                                the ext/ldap function <code>ldap_sort()</code>.</listitem>
+                                <listitem>
+                                    <para>
+                                        If given the result collection will be sorted
+                                        after the attribute <code>$sort</code>. Results can only be
+                                        sorted after one single attribute as this parameter uses
+                                        the ext/ldap function <code>ldap_sort()</code>.
+                                    </para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>string $collectionClass</code></term>
 
-                                <listitem>If given the result will be wrapped in an object
-                                of type <code>$collectionClass</code>. By default an object
-                                of type <code>Zend_Ldap_Collection</code> will be returned.
-                                The custom class must extend
-                                <code>Zend_Ldap_Collection</code> and will be passed a
-                                <code>Zend_Ldap_Collection_Iterator_Default</code> on
-                                instantiation.</listitem>
+                                <listitem>
+                                    <para>
+                                        If given the result will be wrapped in an object
+                                        of type <code>$collectionClass</code>. By default an object
+                                        of type <code>Zend_Ldap_Collection</code> will be returned.
+                                        The custom class must extend
+                                        <code>Zend_Ldap_Collection</code> and will be passed a
+                                        <code>Zend_Ldap_Collection_Iterator_Default</code> on
+                                        instantiation.
+                                    </para>
+                                </listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>
@@ -485,10 +509,10 @@
             point for developers needing custom result objects.
         </para>
 
-        <table id="zend.ldap.api.reference.zend-collection.table">
+        <table id="zend.ldap.api.reference.zend-ldap.zend-ldap-collection.table">
             <title>Zend_Ldap_Collection API</title>
 
-            <tgroup cols="2">zend.ldap.api.reference.zend-ldap.zend-ldap-collection
+            <tgroup cols="2">
             <thead>
                 <row>
                     <entry>Method</entry>

documentation/manual/en/module_specs/Zend_Ldap-API.xml

@@ -180,13 +180,13 @@
             <para>Method names in <emphasis>italics</emphasis> are static methods.</para>
         </note>
 
-    <xi:include href="Zend_Ldap-API-Ldap.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Attribute.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Dn.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Filter.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Node.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Node-RootDse.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Node-Schema.xml" />
-    <xi:include href="Zend_Ldap-API-Ldap-Ldif-Encoder.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Attribute.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Dn.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Filter.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Node.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Node-RootDse.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Node-Schema.xml" />
+        <xi:include href="Zend_Ldap-API-Ldap-Ldif-Encoder.xml" />
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Ldap-LDIF.xml

@@ -65,7 +65,7 @@ title;lang-en: Sales, Director
 
     </sect2>
 
-    <sect2 id="zend.ldap.ldif.encode">
+    <sect2 id="zend.ldap.ldif.decode">
         <title>Deserialize a LDIF string into a LDAP entry</title>
 
         <programlisting language="php"><![CDATA[

documentation/manual/en/ref/coding_standard.xml

@@ -18,11 +18,11 @@
 
             <note>
                 <para>
-                    Note: Sometimes developers consider the establishment of a standard more 
-                    important than what that standard actually suggests at the most detailed level 
-                    of design. The guidelines in the Zend Framework coding standards capture 
-                    practices that have worked well on the ZF project. You may modify these 
-                    standards or use them as is in accordance with the terms of our <ulink 
+                    Note: Sometimes developers consider the establishment of a standard more
+                    important than what that standard actually suggests at the most detailed level
+                    of design. The guidelines in the Zend Framework coding standards capture
+                    practices that have worked well on the ZF project. You may modify these
+                    standards or use them as is in accordance with the terms of our <ulink
                         url="http://framework.zend.com/license">license</ulink>.
                 </para>
             </note>
@@ -171,20 +171,20 @@
             <title>Abstract Classes</title>
 
             <para>
-                In general, abstract classes follow the same conventions as <link 
+                In general, abstract classes follow the same conventions as <link
                     linkend="coding-standard.naming-conventions.classes">classes</link>,
-                with one additional rule: abstract class names must end in the term, "Abstract", 
+                with one additional rule: abstract class names must end in the term, "Abstract",
                 and that term must not be preceded by an underscore. As an example,
-                <classname>Zend_Controller_Plugin_Abstract</classname> is considered an 
+                <classname>Zend_Controller_Plugin_Abstract</classname> is considered an
                 invalid name, but <classname>Zend_Controller_PluginAbstract</classname> or
-                <classname>Zend_Controller_Plugin_PluginAbstract</classname> would be valid 
+                <classname>Zend_Controller_Plugin_PluginAbstract</classname> would be valid
                 names.
             </para>
 
             <note>
                 <para>
-                    This naming convention is new with version 1.9.0 of Zend Framework. Classes 
-                    that pre-date that version may not follow this rule, but will be renamed in 
+                    This naming convention is new with version 1.9.0 of Zend Framework. Classes
+                    that pre-date that version may not follow this rule, but will be renamed in
                     the future in order to comply.
                 </para>
             </note>
@@ -194,26 +194,26 @@
             <title>Interfaces</title>
 
             <para>
-                In general, interfaces follow the same conventions as <link 
+                In general, interfaces follow the same conventions as <link
                     linkend="coding-standard.naming-conventions.classes">classes</link>,
-                with one additional rule: interface names may optionally end in the term, 
+                with one additional rule: interface names may optionally end in the term,
                 "Interface", but that term must not be preceded by an underscore. As an example,
-                <classname>Zend_Controller_Plugin_Interface</classname> is considered an 
+                <classname>Zend_Controller_Plugin_Interface</classname> is considered an
                 invalid name, but <classname>Zend_Controller_PluginInterface</classname> or
-                <classname>Zend_Controller_Plugin_PluginInterface</classname> would be valid 
+                <classname>Zend_Controller_Plugin_PluginInterface</classname> would be valid
                 names.
             </para>
 
             <para>
-                While this rule is not required, it is strongly recommended, as it provides a 
-                good visual cue to developers as to which files contain interfaces rather than 
+                While this rule is not required, it is strongly recommended, as it provides a
+                good visual cue to developers as to which files contain interfaces rather than
                 classes.
             </para>
 
             <note>
                 <para>
-                    This naming convention is new with version 1.9.0 of Zend Framework. Classes 
-                    that pre-date that version may not follow this rule, but will be renamed in 
+                    This naming convention is new with version 1.9.0 of Zend Framework. Classes
+                    that pre-date that version may not follow this rule, but will be renamed in
                     the future in order to comply.
                 </para>
             </note>
@@ -497,10 +497,10 @@ $sampleArray = array(1, 2, 3, 'Zend', 'Studio',
 ]]></programlisting>
 
                 <para>
-                    Alternately, the initial array item may begin on the following line. If so, 
-                    it should be padded at one indentation level greater than the line containing 
+                    Alternately, the initial array item may begin on the following line. If so,
+                    it should be padded at one indentation level greater than the line containing
                     the array declaration, and all successive lines should have the same
-                    indentation; the closing paren should be on a line by itself at the same 
+                    indentation; the closing paren should be on a line by itself at the same
                     indentation level as the line containing the array declaration:
                 </para>
 
@@ -513,9 +513,9 @@ $sampleArray = array(
 ]]></programlisting>
 
                 <para>
-                    When using this latter declaration, we encourage using a trailing comma for 
-                    the last item in the array; this minimizes the impact of adding new items on 
-                    successive lines, and helps to ensure no parse errors occur due to a missing 
+                    When using this latter declaration, we encourage using a trailing comma for
+                    the last item in the array; this minimizes the impact of adding new items on
+                    successive lines, and helps to ensure no parse errors occur due to a missing
                     comma.
                 </para>
             </sect3>
@@ -536,12 +536,12 @@ $sampleArray = array('firstKey'  => 'firstValue',
 ]]></programlisting>
 
                 <para>
-                    Alternately, the initial array item may begin on the following line. If so, 
-                    it should be padded at one indentation level greater than the line containing 
+                    Alternately, the initial array item may begin on the following line. If so,
+                    it should be padded at one indentation level greater than the line containing
                     the array declaration, and all successive lines should have the same
-                    indentation; the closing paren should be on a line by itself at the same 
-                    indentation level as the line containing the array declaration. For 
-                    readability, the various "=>" assignment operators should be padded such that 
+                    indentation; the closing paren should be on a line by itself at the same
+                    indentation level as the line containing the array declaration. For
+                    readability, the various "=>" assignment operators should be padded such that
                     they align.
                 </para>
 
@@ -553,9 +553,9 @@ $sampleArray = array(
 ]]></programlisting>
 
                 <para>
-                    When using this latter declaration, we encourage using a trailing comma for 
-                    the last item in the array; this minimizes the impact of adding new items on 
-                    successive lines, and helps to ensure no parse errors occur due to a missing 
+                    When using this latter declaration, we encourage using a trailing comma for
+                    the last item in the array; this minimizes the impact of adding new items on
+                    successive lines, and helps to ensure no parse errors occur due to a missing
                     comma.
                 </para>
             </sect3>
@@ -610,7 +610,7 @@ class SampleClass
 ]]></programlisting>
 
                 <para>
-                    Classes that extend other classes or which implement interfaces should 
+                    Classes that extend other classes or which implement interfaces should
                     declare their dependencies on the same line when possible.
                 </para>
 
@@ -622,13 +622,13 @@ class SampleClass extends FooAbstract implements BarInterface
 
                 <para>
                     If as a result of such declarations, the line length exceeds the <link
-                        linkend="coding-standard.php-file-formatting.max-line-length">maximum line 
-                        length</link>, break the line before the "extends" and/or "implements" 
+                        linkend="coding-standard.php-file-formatting.max-line-length">maximum line
+                        length</link>, break the line before the "extends" and/or "implements"
                     keywords, and pad those lines by one indentation level.
                 </para>
 
                 <programlisting language="php"><![CDATA[
-class SampleClass 
+class SampleClass
     extends FooAbstract
     implements BarInterface
 {
@@ -636,13 +636,13 @@ class SampleClass
 ]]></programlisting>
 
                 <para>
-                    If the class implements multiple interfaces and the declaration exceeds the 
-                    maximum line length, break after each comma separating the interfaces, and 
+                    If the class implements multiple interfaces and the declaration exceeds the
+                    maximum line length, break after each comma separating the interfaces, and
                     indent the interface names such that they align.
                 </para>
 
                 <programlisting language="php"><![CDATA[
-class SampleClass 
+class SampleClass
     implements BarInterface,
                BazInterface
 {
@@ -723,14 +723,14 @@ class Foo
                 </para>
 
                 <para>
-                    In cases where the argument list exceeds the <link 
-                        linkend="coding-standard.php-file-formatting.max-line-length">maximum line 
-                        length</link>, you may introduce line breaks. Additional arguments to the 
-                    function or method must be indented one additional level beyond the function 
-                    or method declaration.  A line break should then occur before the closing 
-                    argument paren, which should then be placed on the same line as the opening 
-                    brace of the function or method with one space separating the two, and at the 
-                    same indentation level as the function or method declaration. The following is 
+                    In cases where the argument list exceeds the <link
+                        linkend="coding-standard.php-file-formatting.max-line-length">maximum line
+                        length</link>, you may introduce line breaks. Additional arguments to the
+                    function or method must be indented one additional level beyond the function
+                    or method declaration.  A line break should then occur before the closing
+                    argument paren, which should then be placed on the same line as the opening
+                    brace of the function or method with one space separating the two, and at the
+                    same indentation level as the function or method declaration. The following is
                     an example of one such situation:
 
                     <programlisting language="php"><![CDATA[
@@ -880,26 +880,26 @@ if ($a != 2) {
 
                 <para>
                     If the conditional statement causes the line length to exceed the <link
-                        linkend="coding-standard.php-file-formatting.max-line-length">maximum line 
-                        length</link> and has several clauses, you may break the conditional into 
-                    multiple lines. In such a case, break the line prior to a logic operator, and 
-                    pad the line such that it aligns under the first character of the conditional 
-                    clause. The closing paren in the conditional will then be placed on a line with 
-                    the opening brace, with one space separating the two, at an indentation level 
+                        linkend="coding-standard.php-file-formatting.max-line-length">maximum line
+                        length</link> and has several clauses, you may break the conditional into
+                    multiple lines. In such a case, break the line prior to a logic operator, and
+                    pad the line such that it aligns under the first character of the conditional
+                    clause. The closing paren in the conditional will then be placed on a line with
+                    the opening brace, with one space separating the two, at an indentation level
                     equivalent to the opening control statement.
                 </para>
 
                 <programlisting language="php"><![CDATA[
-if (($a == $b) 
+if (($a == $b)
     && ($b == $c)
     || (Foo::CONST == $d)
 ) {
     $a = $d;
 }
 ]]></programlisting>
-                
+
                 <para>
-                    The intention of this latter declaration format is to prevent issues when 
+                    The intention of this latter declaration format is to prevent issues when
                     adding or removing clauses from the conditional during later revisions.
                 </para>
 
@@ -924,7 +924,7 @@ if ($a != 2) {
     $a = 7;
 }
 
-if (($a == $b) 
+if (($a == $b)
     && ($b == $c)
     || (Foo::CONST == $d)
 ) {

documentation/manual/en/ref/project-structure.xml

@@ -8,26 +8,26 @@
 
         <para>
             Many developers seek guidance on the best project structure for a Zend Framework project
-            in a relatively flexible environment. A "flexible" environment is one in which the 
-            developer can manipulate their file systems and web server configurations as needed to 
-            achieve the most ideal project structure to run and secure their application. The 
-            default project structure will assume that the developer has such flexibility at their 
+            in a relatively flexible environment. A "flexible" environment is one in which the
+            developer can manipulate their file systems and web server configurations as needed to
+            achieve the most ideal project structure to run and secure their application. The
+            default project structure will assume that the developer has such flexibility at their
             disposal.
         </para>
 
         <para>
-            The following directory structure is designed to be maximally extensible for complex 
-            projects, while providing a simple subset of folder and files for project with simpler 
-            requirements. This structure also works without alteration for both modular and 
-            non-modular ZF applications. The <filename>.htaccess</filename> files require URL 
-            rewrite functionality in the web server as described in the <link 
-                linkend="project-structure.rewrite-guide">Rewrite Configuration Guide</link>, also 
+            The following directory structure is designed to be maximally extensible for complex
+            projects, while providing a simple subset of folder and files for project with simpler
+            requirements. This structure also works without alteration for both modular and
+            non-modular ZF applications. The <filename>.htaccess</filename> files require URL
+            rewrite functionality in the web server as described in the <link
+                linkend="project-structure.rewrite">Rewrite Configuration Guide</link>, also
             included in this appendix.
         </para>
 
         <para>
             It is not the intention that this project structure will support all possible ZF project
-            requirements. The default project profile used by <classname>Zend_Tool</classname> 
+            requirements. The default project profile used by <classname>Zend_Tool</classname>
             reflect this project structure, but applications with requirements not supported by this
             structure should use a custom project profile.
         </para>
@@ -85,34 +85,34 @@
             <listitem>
                 <para>
                     <emphasis>application/</emphasis>: This directory contains your application. It
-                    will house the MVC system, as well as configurations, services used, and your 
+                    will house the MVC system, as well as configurations, services used, and your
                     bootstrap file.
                 </para>
 
                 <itemizedlist>
                     <listitem>
                         <para>
-                            <emphasis>configs/</emphasis>: The application-wide configuration 
+                            <emphasis>configs/</emphasis>: The application-wide configuration
                             directory.
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <emphasis>controllers/</emphasis>, <emphasis>models/</emphasis>, and 
-                            <emphasis>views/</emphasis>: These directories serve as the default 
+                            <emphasis>controllers/</emphasis>, <emphasis>models/</emphasis>, and
+                            <emphasis>views/</emphasis>: These directories serve as the default
                             controller/model/view directories. Having these three directories inside
-                            the application directory provides the best layout for starting a simple 
-                            project as well as starting a modular project that has global 
+                            the application directory provides the best layout for starting a simple
+                            project as well as starting a modular project that has global
                             controllers/models/views.
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <emphasis>controllers/helpers/</emphasis>: These directories will 
-                            contain action helpers. Action helpers will be namespaced either as 
-                            "Controller_Helper_" for the default module or 
+                            <emphasis>controllers/helpers/</emphasis>: These directories will
+                            contain action helpers. Action helpers will be namespaced either as
+                            "Controller_Helper_" for the default module or
                             "&lt;Module&gt;_Controller_Helper" in other modules.
                         </para>
                     </listitem>
@@ -120,38 +120,38 @@
                     <listitem>
                         <para>
                             <emphasis>layouts/</emphasis>: This layout directory is for MCV-based
-                            layouts. Since <classname>Zend_Layout</classname> is capable of MVC- 
-                            and non-MVC-based layouts, the location of this directory reflects that 
-                            layouts are not on a 1-to-1 relationship with controllers and are 
+                            layouts. Since <classname>Zend_Layout</classname> is capable of MVC-
+                            and non-MVC-based layouts, the location of this directory reflects that
+                            layouts are not on a 1-to-1 relationship with controllers and are
                             independent of templates within <filename>views/</filename>.
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <emphasis>modules/</emphasis>: Modules allow a developer to group a set 
-                            of related controllers into a logically organized group. The structure 
-                            under the modules directory would resemble the structure under the 
+                            <emphasis>modules/</emphasis>: Modules allow a developer to group a set
+                            of related controllers into a logically organized group. The structure
+                            under the modules directory would resemble the structure under the
                             application directory.
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <emphasis>services</emphasis>: This directory is for your application 
+                            <emphasis>services</emphasis>: This directory is for your application
                             specific web-service files that are provided by your application, or for
-                            implementing a <ulink 
-                            url="http://www.martinfowler.com/eaaCatalog/serviceLayer.html">Service 
+                            implementing a <ulink
+                            url="http://www.martinfowler.com/eaaCatalog/serviceLayer.html">Service
                             Layer</ulink> for your models.
                         </para>
                     </listitem>
 
                     <listitem>
                         <para>
-                            <emphasis>Bootstrap.php</emphasis>: This file is the entry point for 
-                            your application, and should implement 
-                            <interfacename>Zend_Application_Bootstrap_Bootstrapper</interfacename>. 
-                            The purpose for this file is to bootstrap the application and make 
+                            <emphasis>Bootstrap.php</emphasis>: This file is the entry point for
+                            your application, and should implement
+                            <interfacename>Zend_Application_Bootstrap_Bootstrapper</interfacename>.
+                            The purpose for this file is to bootstrap the application and make
                             components available to the application by initializing them.
                         </para>
                     </listitem>
@@ -160,75 +160,75 @@
 
             <listitem>
                 <para>
-                    <emphasis>data</emphasis>: This directory provides a place to store application 
-                    data that is volatile and possibly temporary. The disturbance of data in this 
-                    directory might cause the application to fail. Also, the information in this 
-                    directory may or may not be committed to a subversion repository. Examples of 
-                    things in this directory are session files, cache files, sqlite databases, logs 
+                    <emphasis>data</emphasis>: This directory provides a place to store application
+                    data that is volatile and possibly temporary. The disturbance of data in this
+                    directory might cause the application to fail. Also, the information in this
+                    directory may or may not be committed to a subversion repository. Examples of
+                    things in this directory are session files, cache files, sqlite databases, logs
                     and indexes.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>docs/</emphasis>: This directory contains documentation, either 
+                    <emphasis>docs/</emphasis>: This directory contains documentation, either
                     generated or directly authored.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>library/</emphasis>: This directory is for common libraries on which 
-                    the application depends, and should be on the PHP 
-                    <varname>include_path</varname>.  Developers should place their application's 
-                    library code under this directory in a unique namespace, following the 
-                    guidelines established in the PHP manual's <ulink 
-                        url="http://www.php.net/manual/en/userlandnaming.php">Userland Naming 
-                    Guide</ulink>, as well as those established by Zend itself.  This may directory 
-                    may also include Zend Framework itself; if so, you would house it in 
+                    <emphasis>library/</emphasis>: This directory is for common libraries on which
+                    the application depends, and should be on the PHP
+                    <varname>include_path</varname>.  Developers should place their application's
+                    library code under this directory in a unique namespace, following the
+                    guidelines established in the PHP manual's <ulink
+                        url="http://www.php.net/manual/en/userlandnaming.php">Userland Naming
+                    Guide</ulink>, as well as those established by Zend itself.  This may directory
+                    may also include Zend Framework itself; if so, you would house it in
                     <filename>library/Zend/</filename>.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>public/</emphasis>: This directory contains all public files for your 
-                    application.  <filename>index.php</filename> sets up and invokes 
-                    <classname>Zend_Application</classname>, which in turn invokes the 
-                    <filename>application/Bootstrap.php</filename> file, resulting in dispatching 
-                    the front controller. The web root of your web server would typically be set to 
+                    <emphasis>public/</emphasis>: This directory contains all public files for your
+                    application.  <filename>index.php</filename> sets up and invokes
+                    <classname>Zend_Application</classname>, which in turn invokes the
+                    <filename>application/Bootstrap.php</filename> file, resulting in dispatching
+                    the front controller. The web root of your web server would typically be set to
                     this directory.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>scripts/</emphasis>: This directory contains maintenance and/or build 
-                    scripts. Such scripts might include command line, cron, or phing build scripts 
-                    that are not executed at runtime but are part of the correct functioning of the 
+                    <emphasis>scripts/</emphasis>: This directory contains maintenance and/or build
+                    scripts. Such scripts might include command line, cron, or phing build scripts
+                    that are not executed at runtime but are part of the correct functioning of the
                     application.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>temp/</emphasis>: The <filename>temp/</filename> folder is set aside 
-                    for transient application data. This information would not typically be 
-                    committed to the applications svn repository. If data under the 
-                    <filename>temp/</filename> directory were deleted, the application should be 
-                    able to continue running with a possible decrease in performance until data is 
+                    <emphasis>temp/</emphasis>: The <filename>temp/</filename> folder is set aside
+                    for transient application data. This information would not typically be
+                    committed to the applications svn repository. If data under the
+                    <filename>temp/</filename> directory were deleted, the application should be
+                    able to continue running with a possible decrease in performance until data is
                     once again restored/recached.
                 </para>
             </listitem>
 
             <listitem>
                 <para>
-                    <emphasis>tests/</emphasis>: This directory contains application tests. These 
-                    could be hand-written, PHPUnit tests, Selenium-RC based tests or based on some 
-                    other testing framework. By default, library code can be tested by mimicing the 
-                    directory structure of your <filename>library/</filename> directory. 
-                    Additionally, functional tests for your application could be written mimicing 
-                    the <filename>application/</filename> directory structure (including the 
+                    <emphasis>tests/</emphasis>: This directory contains application tests. These
+                    could be hand-written, PHPUnit tests, Selenium-RC based tests or based on some
+                    other testing framework. By default, library code can be tested by mimicing the
+                    directory structure of your <filename>library/</filename> directory.
+                    Additionally, functional tests for your application could be written mimicing
+                    the <filename>application/</filename> directory structure (including the
                     application subdirectory).
                 </para>
             </listitem>
@@ -239,7 +239,7 @@
         <title>Module Structure</title>
 
         <para>
-            The directory structure for modules should mimic that of the 
+            The directory structure for modules should mimic that of the
             <filename>application/</filename> directory in the recommended project structure:
         </para>
 
@@ -263,7 +263,7 @@
         </literallayout>
 
         <para>
-            The purpose of these directories remains exactly the same as for the recommended 
+            The purpose of these directories remains exactly the same as for the recommended
             project directory structure.
         </para>
     </sect1>
@@ -272,8 +272,8 @@
         <title>Rewrite Configuration Guide</title>
 
         <para>
-            URL rewriting is a common function of HTTP servers. However, the rules and configuration 
-            differ widely between them. Below are some common approaches across a variety of popular 
+            URL rewriting is a common function of HTTP servers. However, the rules and configuration
+            differ widely between them. Below are some common approaches across a variety of popular
             web servers available at the time of writing.
         </para>
 
@@ -281,11 +281,11 @@
             <title>Apache HTTP Server</title>
 
             <para>
-                All examples that follow use <application>mod_rewrite</application>, an official 
-                module that comes bundled with Apache. To use it, 
-                <application>mod_rewrite</application> must either be included at compile time or 
-                enabled as a Dynamic Shared Object (DSO). Please consult the <ulink 
-                    url="http://httpd.apache.org/docs/">Apache documentation</ulink> for your 
+                All examples that follow use <application>mod_rewrite</application>, an official
+                module that comes bundled with Apache. To use it,
+                <application>mod_rewrite</application> must either be included at compile time or
+                enabled as a Dynamic Shared Object (DSO). Please consult the <ulink
+                    url="http://httpd.apache.org/docs/">Apache documentation</ulink> for your
                 version for more information.
             </para>
 
@@ -293,8 +293,8 @@
                 <title>Rewriting inside a VirtualHost</title>
 
                 <para>
-                    Here is a very basic virtual host definition. These rules direct all requests 
-                    to <filename>index.php</filename>, except when a matching file is found under 
+                    Here is a very basic virtual host definition. These rules direct all requests
+                    to <filename>index.php</filename>, except when a matching file is found under
                     the <option>document_root</option>.
                 </para>
 
@@ -317,7 +317,7 @@
 ]]></programlisting>
 
                 <para>
-                    Note the slash ("/") prefixing <filename>index.php</filename>; the rules for 
+                    Note the slash ("/") prefixing <filename>index.php</filename>; the rules for
                     <filename>.htaccess</filename> differ in this regard.
                 </para>
             </sect3>
@@ -326,9 +326,9 @@
                 <title>Rewriting within a .htaccess file</title>
 
                 <para>
-                    Below is a sample <filename>.htaccess</filename> file that utilizes 
-                    <application>mod_rewrite</application>. It is similar to the virtual host 
-                    configuration, except that it specifies only the rewrite rules, and the leading 
+                    Below is a sample <filename>.htaccess</filename> file that utilizes
+                    <application>mod_rewrite</application>. It is similar to the virtual host
+                    configuration, except that it specifies only the rewrite rules, and the leading
                     slash is omitted from <filename>index.php</filename>.
                 </para>
 
@@ -340,21 +340,22 @@ RewriteCond %{REQUEST_FILENAME} -d
 RewriteRule ^.*$ - [NC,L]
 RewriteRule ^.*$ index.php [NC,L]
 ]]></programlisting>
+
+                <para>
+                    There are many ways to configure <application>mod_rewrite</application>; if you
+                    would like more information, see Jayson Minard's <ulink
+                        url="http://devzone.zend.com/a/70">Blueprint for PHP Applications:
+                    Bootstrapping</ulink>.
+                </para>
             </sect3>
 
-            <para>
-                There are many ways to configure <application>mod_rewrite</application>; if you 
-                would like more information, see Jayson Minard's <ulink 
-                    url="http://devzone.zend.com/a/70">Blueprint for PHP Applications: 
-                Bootstrapping</ulink>.
-            </para>
         </sect2>
 
         <sect2 id="project-structure.rewrite.iis">
             <title>Microsoft Internet Information Server</title>
 
             <para>
-                As of version 7.0, IIS now ships with a standard rewrite engine.  You may use the 
+                As of version 7.0, IIS now ships with a standard rewrite engine.  You may use the
                 following configuration to create the appropriate rewrite rules.
             </para>