[DOCUMENTATION] English:

 - manual fixes: <code>(true|false|null)</code> => <constant>(TRUE|FALSE|NULL)</constant>

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

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

@@ -23,8 +23,8 @@
 
         <varlistentry>
             <term><code>boolean</code></term>
-            <listitem><para><code>true</code> will be converted to <code>'TRUE'</code> and
-            <code>false</code> to <code>'FALSE'</code></para></listitem>
+            <listitem><para><constant>TRUE</constant> will be converted to <code>'TRUE'</code> and
+            <constant>FALSE</constant> to <code>'FALSE'</code></para></listitem>
         </varlistentry>
 
         <varlistentry>
@@ -52,12 +52,12 @@
     <variablelist>
         <varlistentry>
             <term><code>'TRUE'</code></term>
-            <listitem><para>Converted to <code>true</code>.</para></listitem>
+            <listitem><para>Converted to <constant>TRUE</constant>.</para></listitem>
         </varlistentry>
 
         <varlistentry>
             <term><code>'FALSE'</code></term>
-            <listitem><para>Converted to <code>false</code>.</para></listitem>
+            <listitem><para>Converted to <constant>FALSE</constant>.</para></listitem>
         </varlistentry>
 
         <varlistentry>
@@ -88,7 +88,7 @@
                     <entry>
                         Sets the attribute <varname>$attribName</varname> in
                         <varname>$data</varname> to the value <varname>$value</varname>. If
-                        <varname>$append</varname> is <code>true</code> (<code>false</code> by
+                        <varname>$append</varname> is <constant>TRUE</constant> (<constant>FALSE</constant> by
                         default) <varname>$value</varname> will be appended to the attribute.
                         <varname>$value</varname> can be a scalar value or an array of scalar
                         values. Conversion will take place.
@@ -101,12 +101,12 @@
                     </entry>
                     <entry>
                         Returns the attribute <varname>$attribName</varname> from
-                        <varname>$data</varname>. If <varname>$index</varname> is <code>null</code>
+                        <varname>$data</varname>. If <varname>$index</varname> is <constant>NULL</constant>
                         (default) an array will be returned containing all the values for
                         the given attribute. An empty array will be returned if the
                         attribute does not exist in the given array. If an integer index is
                         specified the corresponding value at the given index will be
-                        returned. If the index is out of bounds, <code>null</code> will be
+                        returned. If the index is out of bounds, <constant>NULL</constant> will be
                         returned. Conversion will take place.
                     </entry>
                 </row>
@@ -118,7 +118,7 @@
                     <entry>
                         Checks if the attribute <varname>$attribName</varname> in
                         <varname>$data</varname> has the value(s) given in <varname>$value</varname>.
-                        The method returns <code>true</code> only if all values in
+                        The method returns <constant>TRUE</constant> only if all values in
                         <varname>$value</varname> are present in the attribute. Comparison is
                         done strictly (respecting the data type).
                     </entry>
@@ -172,7 +172,7 @@
                     </entry>
                     <entry>
                         Converts a timestamp into its <acronym>LDAP</acronym> date/time representation.
-                        If <varname>$utc</varname> is <code>true</code> (<code>false</code> by
+                        If <varname>$utc</varname> is <constant>TRUE</constant> (<constant>FALSE</constant> by
                         default) the resulting <acronym>LDAP</acronym> date/time string will be in UTC,
                         otherwise a local date/time string will be returned.
                     </entry>
@@ -185,7 +185,7 @@
                     </entry>
                     <entry>
                         Converts <acronym>LDAP</acronym> date/time representation into a timestamp. The
-                        method returns <code>null</code> if <varname>$value</varname> can not be
+                        method returns <constant>NULL</constant> if <varname>$value</varname> can not be
                         converted back into a PHP timestamp.
                     </entry>
                 </row>
@@ -228,7 +228,7 @@
                     <entry>
                         Sets the attribute <varname>$attribName</varname> in
                         <varname>$data</varname> to the date/time value <varname>$value</varname>. If
-                        <varname>$append</varname> is <code>true</code> (<code>false</code> by
+                        <varname>$append</varname> is <constant>TRUE</constant> (<constant>FALSE</constant> by
                         default) <varname>$value</varname> will be appended to the attribute.
                         <varname>$value</varname> can be an integer value or an array of
                         integers. Date-time-conversion according to
@@ -245,12 +245,12 @@
                     <entry>
                         Returns the date/time attribute <varname>$attribName</varname>
                         from <varname>$data</varname>. If <varname>$index</varname> is
-                        <code>null</code> (default) an array will be returned containing
+                        <constant>NULL</constant> (default) an array will be returned containing
                         all the date/time values for the given attribute. An empty array
                         will be returned if the attribute does not exist in the given
                         array. If an integer index is specified the corresponding date/time
                         value at the given index will be returned. If the index is out of
-                        bounds, <code>null</code> will be returned. Date-time-conversion
+                        bounds, <constant>NULL</constant> will be returned. Date-time-conversion
                         according to
                         <methodname>Zend_Ldap_Attribute::convertFromLdapDateTimeValue()</methodname>
                         will take place.

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

@@ -40,7 +40,7 @@
                                     <para>
                                         Sort the given attributes with <code>dn</code>
                                         following <code>objectClass</code> and following all other
-                                        attributes sorted alphabetically. <code>true</code> by
+                                        attributes sorted alphabetically. <constant>TRUE</constant> by
                                         default.
                                     </para>
                                 </listitem>

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

@@ -74,8 +74,8 @@
                     </entry>
                     <entry>
                         Returns an array representation of the current node. If
-                        <varname>$includeSystemAttributes</varname> is <code>false</code>
-                        (defaults to <code>true</code>) the system specific attributes are
+                        <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
+                        (defaults to <constant>TRUE</constant>) the system specific attributes are
                         stripped from the array. Unlike
                         <methodname>Zend_Ldap_Node_RootDse::getAttributes()</methodname> the resulting
                         array contains the DN with key <code>'dn'</code>.
@@ -108,11 +108,11 @@
                     </entry>
                     <entry>
                         Checks whether a given attribute exists. If
-                        <varname>$emptyExists</varname> is <code>false</code> empty attributes
+                        <varname>$emptyExists</varname> is <constant>FALSE</constant> empty attributes
                         (containing only array()) are treated as non-existent returning
-                        <code>false</code>. If <varname>$emptyExists</varname> is true empty
-                        attributes are treated as existent returning <code>true</code>. In
-                        this case teh method returns <code>false</code> only if the
+                        <constant>FALSE</constant>. If <varname>$emptyExists</varname> is true empty
+                        attributes are treated as existent returning <constant>TRUE</constant>. In
+                        this case teh method returns <constant>FALSE</constant> only if the
                         attribute name is missing in the key-collection.
                     </entry>
                 </row>
@@ -123,7 +123,7 @@
                     </entry>
                     <entry>
                         Checks if the given value(s) exist in the attribute. The
-                        method returns <code>true</code> only if all values in
+                        method returns <constant>TRUE</constant> only if all values in
                         <varname>$value</varname> are present in the attribute. Comparison is
                         done strictly (respecting the data type).
                     </entry>
@@ -152,8 +152,8 @@
                     </entry>
                     <entry>
                         Gets all attributes of node. If
-                        <varname>$includeSystemAttributes</varname> is <code>false</code>
-                        (defaults to <code>true</code>) the system specific attributes are
+                        <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
+                        (defaults to <constant>TRUE</constant>) the system specific attributes are
                         stripped from the array.
                     </entry>
                 </row>

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

@@ -93,8 +93,8 @@
                     <entry>
                         Factory method to create a detached
                         <classname>Zend_Ldap_Node</classname> from array data <varname>$data</varname>. If
-                        <varname>$fromDataSource</varname> is <code>true</code>
-                        (<code>false</code> by default), the data is treated as beeing
+                        <varname>$fromDataSource</varname> is <constant>TRUE</constant>
+                        (<constant>FALSE</constant> by default), the data is treated as beeing
                         present in a <acronym>LDAP</acronym> tree.
                     </entry>
                 </row>
@@ -272,8 +272,8 @@
                     </entry>
                     <entry>
                         Returns an array representation of the current node. If
-                        <varname>$includeSystemAttributes</varname> is <code>false</code>
-                        (defaults to <code>true</code>) the system specific attributes are
+                        <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
+                        (defaults to <constant>TRUE</constant>) the system specific attributes are
                         stripped from the array. Unlike
                         <methodname>Zend_Ldap_Node::getAttributes()</methodname> the resulting array
                         contains the DN with key <code>'dn'</code>.
@@ -306,11 +306,11 @@
                     </entry>
                     <entry>
                         Checks whether a given attribute exists. If
-                        <varname>$emptyExists</varname> is <code>false</code> empty attributes
+                        <varname>$emptyExists</varname> is <constant>FALSE</constant> empty attributes
                         (containing only array()) are treated as non-existent returning
-                        <code>false</code>. If <varname>$emptyExists</varname> is true empty
-                        attributes are treated as existent returning <code>true</code>. In
-                        this case teh method returns <code>false</code> only if the
+                        <constant>FALSE</constant>. If <varname>$emptyExists</varname> is true empty
+                        attributes are treated as existent returning <constant>TRUE</constant>. In
+                        this case teh method returns <constant>FALSE</constant> only if the
                         attribute name is missing in the key-collection.
                     </entry>
                 </row>
@@ -321,7 +321,7 @@
                     </entry>
                     <entry>
                         Checks if the given value(s) exist in the attribute. The
-                        method returns <code>true</code> only if all values in
+                        method returns <constant>TRUE</constant> only if all values in
                         <varname>$value</varname> are present in the attribute. Comparison is
                         done strictly (respecting the data type).
                     </entry>
@@ -350,8 +350,8 @@
                     </entry>
                     <entry>
                         Gets all attributes of node. If
-                        <varname>$includeSystemAttributes</varname> is <code>false</code>
-                        (defaults to <code>true</code>) the system specific attributes are
+                        <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
+                        (defaults to <constant>TRUE</constant>) the system specific attributes are
                         stripped from the array.
                     </entry>
                 </row>
@@ -445,14 +445,14 @@
                     <entry><code>boolean exists(Zend_Ldap $ldap)</code></entry>
                     <entry>
                         Checks if the current node exists on the given <acronym>LDAP</acronym> server
-                        (current server is used if <code>null</code> is passed).
+                        (current server is used if <constant>NULL</constant> is passed).
                     </entry>
                 </row>
                 <row>
                     <entry><code>Zend_Ldap_Node reload(Zend_Ldap $ldap)</code></entry>
                     <entry>
                         Reloads the current node's attributes from the given LDAP
-                        server (current server is used if <code>null</code> is
+                        server (current server is used if <constant>NULL</constant> is
                         passed).
                     </entry>
                 </row>

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

@@ -133,7 +133,7 @@
                         All parameters are optional and will be taken from the LDAP
                         connection and binding parameters passed to the instance via the
                         construtor or via <methodname>Zend_Ldap::setOptions()</methodname> when set to
-                        <code>null</code>.
+                        <constant>NULL</constant>.
                     </entry>
                 </row>
                 <row>
@@ -150,7 +150,7 @@
                         allowed on the <acronym>LDAP</acronym> server. An empty string <code>''</code> can be
                         passed as <varname>$password</varname> together with a username if, and
                         only if, <code>allowEmptyPassword</code> is set to
-                        <code>true</code> in the connection and binding parameters.
+                        <constant>TRUE</constant> in the connection and binding parameters.
                     </entry>
                 </row>
                 <row>
@@ -179,7 +179,7 @@
                                 <listitem>
                                     <para>
                                         The search base for the search. If omitted or
-                                        <code>null</code>, the <code>baseDn</code> from the
+                                        <constant>NULL</constant>, the <code>baseDn</code> from the
                                         connection and binding parameters is used.
                                     </para>
                                 </listitem>
@@ -305,9 +305,9 @@
                         the attributes specified in <varname>$attributes</varname>. If
                         <varname>$attributes</varname> is ommitted, all attributes
                         (<methodname>array()</methodname>) are included in the result.
-                        <varname>$throwOnNotFound</varname> is <code>false</code> by default, so
-                        the method will return <code>null</code> if the specified entry
-                        cannot be found. If set to <code>true</code>, a
+                        <varname>$throwOnNotFound</varname> is <constant>FALSE</constant> by default, so
+                        the method will return <constant>NULL</constant> if the specified entry
+                        cannot be found. If set to <constant>TRUE</constant>, a
                         <classname>Zend_Ldap_Exception</classname> will be thrown instead.
                     </entry>
                 </row>
@@ -369,10 +369,10 @@
                         Deletes the entry identified by <varname>$dn</varname> from the
                         <acronym>LDAP</acronym> tree. Throws a <classname>Zend_Ldap_Exception</classname> if the entry
                         could not be deleted. <varname>$recursively</varname> is
-                        <code>false</code> by default. If set to <code>true</code> the
+                        <constant>FALSE</constant> by default. If set to <constant>TRUE</constant> the
                         deletion will be carried out recursively and will effectively
                         delete a complete subtree. Deletion will fail if
-                        <varname>$recursively</varname> is <code>false</code> and the entry
+                        <varname>$recursively</varname> is <constant>FALSE</constant> and the entry
                         <varname>$dn</varname> is not a leaf entry.
                     </entry>
                 </row>
@@ -386,14 +386,14 @@
                         Moves the entry identified by <varname>$from</varname> to a
                         location below <varname>$to</varname> keeping its <acronym>RDN</acronym> unchanged.
                         <varname>$recursively</varname> specifies if the operation will be
-                        carried out recursively (<code>false</code> by default) so that the
+                        carried out recursively (<constant>FALSE</constant> by default) so that the
                         entry <varname>$from</varname> and all its descendants will be moved.
-                        Moving will fail if <varname>$recursively</varname> is <code>false</code>
+                        Moving will fail if <varname>$recursively</varname> is <constant>FALSE</constant>
                         and the entry <varname>$from</varname> is not a leaf entry.
                         <varname>$alwaysEmulate</varname> controls whether the ext/ldap function
                         <methodname>ldap_rename()</methodname> should be used if available. This can
                         only work for leaf entries and for servers and for ext/ldap
-                        supporting this function. Set to <code>true</code> to always use an
+                        supporting this function. Set to <constant>TRUE</constant> to always use an
                         emulated rename operation.
                         <note>
                             <para>All move-operations are carried out by copying and then
@@ -426,15 +426,15 @@
                     <entry>
                         Renames the entry identified by <varname>$from</varname> to
                         <varname>$to</varname>. <varname>$recursively</varname> specifies if the
-                        operation will be carried out recursively (<code>false</code> by
+                        operation will be carried out recursively (<constant>FALSE</constant> by
                         default) so that the entry <varname>$from</varname> and all its
                         descendants will be moved. Moving will fail if
-                        <varname>$recursively</varname> is <code>false</code> and the entry
+                        <varname>$recursively</varname> is <constant>FALSE</constant> and the entry
                         <varname>$from</varname> is not a leaf entry. <varname>$alwaysEmulate</varname>
                         controls whether the ext/ldap function <methodname>ldap_rename()</methodname>
                         should be used if available. This can only work for leaf entries
                         and for servers and for ext/ldap supporting this function. Set to
-                        <code>true</code> to always use an emulated rename
+                        <constant>TRUE</constant> to always use an emulated rename
                         operation.
                     </entry>
                 </row>
@@ -447,10 +447,10 @@
                         Copies the entry identified by <varname>$from</varname> to a
                         location below <varname>$to</varname> keeping its <acronym>RDN</acronym> unchanged.
                         <varname>$recursively</varname> specifies if the operation will be
-                        carried out recursively (<code>false</code> by default) so that the
+                        carried out recursively (<constant>FALSE</constant> by default) so that the
                         entry <varname>$from</varname> and all its descendants will be copied.
                         Copying will fail if <varname>$recursively</varname> is
-                        <code>false</code> and the entry <varname>$from</varname> is not a leaf
+                        <constant>FALSE</constant> and the entry <varname>$from</varname> is not a leaf
                         entry.
                     </entry>
                 </row>
@@ -462,10 +462,10 @@
                     <entry>
                         Copies the entry identified by <varname>$from</varname> to
                         <varname>$to</varname>. <varname>$recursively</varname> specifies if the
-                        operation will be carried out recursively (<code>false</code> by
+                        operation will be carried out recursively (<constant>FALSE</constant> by
                         default) so that the entry <varname>$from</varname> and all its
                         descendants will be copied. Copying will fail if
-                        <varname>$recursively</varname> is <code>false</code> and the entry
+                        <varname>$recursively</varname> is <constant>FALSE</constant> and the entry
                         <varname>$from</varname> is not a leaf entry.
                     </entry>
                 </row>
@@ -548,7 +548,7 @@
                     <entry><code>array getFirst()</code></entry>
                     <entry>
                         Returns the first entry in the collection or
-                        <code>null</code> if the collection is empty.
+                        <constant>NULL</constant> if the collection is empty.
                     </entry>
                 </row>
             </tbody></tgroup>

documentation/manual/en/module_specs/Zend_Navigation-Migration.xml

@@ -16,8 +16,8 @@
             Prior to the 1.9 release, the menu helper
             (<classname>Zend_View_Helper_Navigation_Menu</classname>) did not
             render sub menus correctly. When the <code>onlyActiveBranch</code>
-            was <code>true</code> and the option <code>renderParents</code>
-            <code>false</code>, nothing would be rendered if the deepest active
+            was <constant>TRUE</constant> and the option <code>renderParents</code>
+            <constant>FALSE</constant>, nothing would be rendered if the deepest active
             page was at a depth lower than the <code>minDepth</code> option.
         </para>
 

documentation/manual/en/module_specs/Zend_Translate-Additional.xml

@@ -212,7 +212,7 @@ $translate->addTranslation('/path/to/new.csv', 'fr', $options);
 
         <para>
             The <methodname>isAvailable()</methodname> method checks if a given language is already available.
-            It returns <code>true</code> if data for the given language exist.
+            It returns <constant>TRUE</constant> if data for the given language exist.
         </para>
 
         <para>