[DOCUMENTATION] English:

- manual fixes (<code>false</code> ==> <constant>FALSE</constant>)

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

documentation/manual/en/module_specs/Zend_Cache-Frontends.xml

@@ -67,7 +67,7 @@
                           <row>
                               <entry><code>logging</code></entry>
                               <entry><code>boolean</code></entry>
-                              <entry><code>false</code></entry>
+                              <entry><constant>FALSE</constant></entry>
                               <entry>
                                 if set to true, logging through <classname>Zend_Log</classname> is activated
                                 (but the system is slower)
@@ -87,7 +87,7 @@
                           <row>
                               <entry><code>automatic_serialization</code></entry>
                               <entry><code>boolean</code></entry>
-                              <entry><code>false</code></entry>
+                              <entry><constant>FALSE</constant></entry>
                               <entry>
                                 Enable / disable automatic serialization, it can be used to save directly datas
                                 which aren't strings (but it's slower)
@@ -106,7 +106,7 @@
                           <row>
                               <entry><code>ignore_user_abort</code></entry>
                               <entry><code>boolean</code></entry>
-                              <entry><code>false</code></entry>
+                              <entry><constant>FALSE</constant></entry>
                               <entry>
                                 if set to true, the core will set the ignore_user_abort PHP flag inside the
                                 save() method to avoid cache corruptions in some cases
@@ -528,7 +528,7 @@ $result = $cache->foobar2('1', '2');
                          <row>
                               <entry><code>ignore_missing_master_files</code></entry>
                               <entry><code>boolean</code></entry>
-                              <entry><code>false</code></entry>
+                              <entry><constant>FALSE</constant></entry>
                               <entry>
                                   if true, missing master files are ignored silently (an exception is raised else)
                               </entry>
@@ -586,7 +586,7 @@ $result = $cache->foobar2('1', '2');
                           <row>
                               <entry><code>http_conditional</code></entry>
                               <entry><code>boolean</code></entry>
-                              <entry><code>false</code></entry>
+                              <entry><constant>FALSE</constant></entry>
                               <entry>
                                   use the http_conditional system (not implemented for the moment)
                               </entry>
@@ -594,7 +594,7 @@ $result = $cache->foobar2('1', '2');
                          <row>
                               <entry><code>debug_header</code></entry>
                               <entry><code>boolean</code></entry>
-                              <entry><code>false</code></entry>
+                              <entry><constant>FALSE</constant></entry>
                               <entry>
                                   if true, a debug text is added before each cached pages
                               </entry>

documentation/manual/en/module_specs/Zend_Config_Ini.xml

@@ -17,7 +17,7 @@
             <ulink url="http://php.net/parse_ini_file"><code>parse_ini_file()</code></ulink>
             PHP function. Please review this documentation to be aware of its specific behaviors,
             which propagate to <classname>Zend_Config_Ini</classname>, such as how the special values of
-            <code>true</code>, <code>false</code>, <code>yes</code>, <code>no</code>,
+            <code>true</code>, <constant>FALSE</constant>, <code>yes</code>, <code>no</code>,
             and <code>null</code> are handled.
         </para>
     </note>

documentation/manual/en/module_specs/Zend_Controller-FrontController.xml

@@ -407,7 +407,7 @@ Zend_Controller_Front::run('../application/controllers');
                     controller whether to return the response
                     (<code>true</code>) from <code>dispatch()</code>, or if the
                     response should be automatically emitted
-                    (<code>false</code>). By default, the response is
+                    (<constant>FALSE</constant>). By default, the response is
                     automatically emitted (by calling
                     <classname>Zend_Controller_Response_Abstract::sendResponse()</classname>);
                     turning on <code>returnResponse()</code> will override this

documentation/manual/en/module_specs/Zend_Controller-Response.xml

@@ -151,7 +151,7 @@ $front->dispatch();
                     indicating whether or not to throw an exception if headers
                     have already been sent. This can be overridden by setting
                     the property <code>headersSentThrowsException</code> to
-                    <code>false</code>.
+                    <constant>FALSE</constant>.
                 </para>
             </listitem>
 

documentation/manual/en/module_specs/Zend_Date-Overview.xml

@@ -714,7 +714,7 @@ print $date;
                             </para>
                             <para>
                                 Returns an integer representation of the selected date <varname>$part</varname> according to
-                                the conventions of the object's locale. Returns <code>false</code> when
+                                the conventions of the object's locale. Returns <constant>FALSE</constant> when
                                 <varname>$part</varname> selects a non-numeric value, such as
                                 <classname>Zend_Date::MONTH_NAME_SHORT</classname>. <emphasis>NOTE:</emphasis> This
                                 method calls

documentation/manual/en/module_specs/Zend_Db_Adapter.xml

@@ -371,7 +371,7 @@ $db = Zend_Db::factory('Db2', $params);
                     names, column names, and even aliases are delimited in all
                     SQL syntax generated by the Adapter object. This makes it
                     simple to use identifiers that contain SQL keywords, or
-                    special characters. If the value is <code>false</code>,
+                    special characters. If the value is <constant>FALSE</constant>,
                     identifiers are not delimited automatically. If you need
                     to delimit identifiers, you must do so yourself using the
                     <code>quoteIdentifier()</code> method.

documentation/manual/en/module_specs/Zend_Db_Profiler.xml

@@ -49,7 +49,7 @@ $db->getProfiler()->setEnabled(true);
 
         <para>
             A boolean argument sets the profiler to enabled if it is a <code>true</code> value, or disabled if
-            <code>false</code>. The profiler class is the adapter's default profiler class,
+            <constant>FALSE</constant>. The profiler class is the adapter's default profiler class,
             <classname>Zend_Db_Profiler</classname>.
             <programlisting language="php"><![CDATA[
 $params['profiler'] = true;

documentation/manual/en/module_specs/Zend_Db_Statement.xml

@@ -183,7 +183,7 @@ $stmt->execute(array(':reporter' => 'goofy', ':status' => 'FIXED'));
             </itemizedlist>
 
             <para>
-                <code>fetch()</code> returns <code>false</code> if all rows of
+                <code>fetch()</code> returns <constant>FALSE</constant> if all rows of
                 the result set have been fetched.
             </para>
 
@@ -281,7 +281,7 @@ echo $rows[0][0];
                 To return a single column from the next row of the result set,
                 use <code>fetchColumn()</code>. The optional argument is the
                 integer index of the column, and it defaults to 0. This method
-                returns a scalar value, or <code>false</code> if all rows of
+                returns a scalar value, or <constant>FALSE</constant> if all rows of
                 the result set have been fetched.
             </para>
 

documentation/manual/en/module_specs/Zend_Db_Table.xml

@@ -579,7 +579,7 @@ class Bugs extends Zend_Db_Table_Abstract
 
             <para>
                 If you define the <varname>$_sequence</varname> to be the Boolean value
-                <code>false</code>, then <classname>Zend_Db_Table_Abstract</classname> assumes that the table has a
+                <constant>FALSE</constant>, then <classname>Zend_Db_Table_Abstract</classname> assumes that the table has a
                 natural primary key. You must provide values for the primary key columns in the
                 array of data to the <code>insert()</code> method, or else this method throws a
                 <classname>Zend_Db_Table_Exception</classname>.

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

@@ -333,7 +333,7 @@ $upload->addValidator('Size',
             </itemizedlist>
 
             <para>
-                To migrate your scripts to the new API, simply add a <code>false</code>
+                To migrate your scripts to the new API, simply add a <constant>FALSE</constant>
                 after defining the wished validator.
             </para>
 

documentation/manual/en/module_specs/Zend_Filter-RealPath.xml

@@ -12,7 +12,7 @@
     </para>
 
     <para>
-        <classname>Zend_Filter_RealPath</classname> will return <code>FALSE</code> on failure, e.g.
+        <classname>Zend_Filter_RealPath</classname> will return <constant>FALSE</constant> on failure, e.g.
         if the file does not exist. On BSD systems <classname>Zend_Filter_RealPath</classname>
         doesn't fail if only the last path component doesn't exist, while other systems will return
         <constant>FALSE</constant>.

documentation/manual/en/module_specs/Zend_Filter_Input.xml

@@ -275,7 +275,7 @@ $input->setData($newData);
                 If all input data pass the validation rules, the
                 <code>isValid()</code> method returns <code>true</code>.
                 If any field is invalid or any required field is missing,
-                <code>isValid()</code> returns <code>false</code>.
+                <code>isValid()</code> returns <constant>FALSE</constant>.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -705,13 +705,13 @@ $validators = array(
 ]]></programlisting>
 
             <para>
-                The default value of this metacommand is <code>false</code>.
+                The default value of this metacommand is <constant>FALSE</constant>.
             </para>
 
             <para>
                 In the uncommon case that you declare a validation rule with
                 no validators, but the 'allowEmpty' metacommand is
-                <code>false</code> (that is, the field is considered invalid if
+                <constant>FALSE</constant> (that is, the field is considered invalid if
                 it is empty), Zend_Filter_Input returns a default error message
                 that you can retrieve with <code>getMessages()</code>. You can
                 specify this message using the 'notEmptyMessage' option, as an
@@ -772,7 +772,7 @@ $input = new Zend_Filter_Input(null, $validators);
 ]]></programlisting>
 
             <para>
-                The default value of this metacommand is <code>false</code>.
+                The default value of this metacommand is <constant>FALSE</constant>.
             </para>
 
             <para>

documentation/manual/en/module_specs/Zend_Form-StandardDecorators.xml

@@ -92,7 +92,7 @@ class Util
         <para>
             The description is escaped using the view object's escaping
             mechanisms by default. You can disable this by passing a
-            <code>false</code> value to the decorator's 'escape' option or
+            <constant>FALSE</constant> value to the decorator's 'escape' option or
             <code>setEscape()</code> method.
         </para>
     </sect2>

documentation/manual/en/module_specs/Zend_Gdata_Gapps.xml

@@ -297,7 +297,7 @@ $user = $user->save();
                 <para>
                     Similarly, this can be undone by setting the
                     <code>login->changePasswordAtNextLogin</code> property to
-                    <code>false</code>.
+                    <constant>FALSE</constant>.
                 </para>
 
             </sect4>
@@ -334,7 +334,7 @@ $user = $user->save();
                 <para>
                     To restore the user's access, set the
                     <code>login->suspended</code> property to
-                    <code>false</code>.
+                    <constant>FALSE</constant>.
                 </para>
 
             </sect4>
@@ -356,7 +356,7 @@ $user = $user->save();
 
                 <para>
                     And as expected, setting a user's <code>login->admin</code>
-                    property to <code>false</code> revokes their
+                    property to <constant>FALSE</constant> revokes their
                     administrative rights.
                 </para>
 

documentation/manual/en/module_specs/Zend_Gdata_Gbase.xml

@@ -274,7 +274,7 @@ foreach ($feed->entries as $entry) {
             A customer/owner can access his own Customer Items feed to insert, update, or delete their items. These operations do not apply to the public snippets feed.
         </para>
         <para>
-            You can test a feed operation before it is actually executed by setting the dry-run flag (<code>$dryRun</code>) to <code>true</code>. Once you are sure that you want to submit the data, set it to <code>false</code> to execute the operation.
+            You can test a feed operation before it is actually executed by setting the dry-run flag (<code>$dryRun</code>) to <code>true</code>. Once you are sure that you want to submit the data, set it to <constant>FALSE</constant> to execute the operation.
         </para>
         <sect3 id="zend.gdata.gbase.crud.insert">
             <title>Insert an Item</title>

documentation/manual/en/module_specs/Zend_Ldap.xml

@@ -161,7 +161,7 @@ echo "$acctname\n";
                         <entry>
                             Whether or not the LDAP client should use TLS (aka SSLv2) encrypted transport. A value of
                             <code>true</code> is strongly favored in production environments to prevent passwords from
-                            be transmitted in clear text. The default value is <code>false</code>, as servers
+                            be transmitted in clear text. The default value is <constant>FALSE</constant>, as servers
                             frequently require that a certificate be installed separately after installation.
                             The <code>useSsl</code> and <code>useStartTls</code> options are mutually exclusive.
                             The <code>useStartTls</code> option should be favored over <code>useSsl</code> but
@@ -192,7 +192,7 @@ echo "$acctname\n";
                         <entry>
                             If <code>true</code>, this instructs <classname>Zend_Ldap</classname> to retrieve the DN for the
                             account used to bind if the username is not already in DN form. The default value is
-                            <code>false</code>.
+                            <constant>FALSE</constant>.
                         </entry>
                       </row>
                       <row>
@@ -250,7 +250,7 @@ echo "$acctname\n";
                         <entry>optReferrals</entry>
                         <entry>
                             If set to <code>true</code>, this option indicates to the LDAP client that referrals should
-                            be followed. The default value is <code>false</code>.
+                            be followed. The default value is <constant>FALSE</constant>.
                         </entry>
                       </row>
                     </tbody>

documentation/manual/en/module_specs/Zend_Loader.xml

@@ -122,7 +122,7 @@ Zend_Loader::loadClass('Container_Tree',
         <para>
             The static method <classname>Zend_Loader::isReadable($pathname)</classname>
             returns <code>TRUE</code> if a file at the specified pathname exists
-            and is readable, <code>FALSE</code> otherwise.
+            and is readable, <constant>FALSE</constant> otherwise.
         </para>
 
         <example id="zend.loader.load.isreadable.example">
@@ -219,7 +219,7 @@ Zend_Loader::registerAutoload('My_Loader');
             You can remove an autoload callback. The
             <code>registerAutoload()</code> has an optional second argument,
             which is <code>true</code> by default. If this argument is
-            <code>false</code>, the autoload callback is unregistered from the
+            <constant>FALSE</constant>, the autoload callback is unregistered from the
             SPL autoload stack.
         </para>
 

documentation/manual/en/module_specs/Zend_Locale-Functions.xml

@@ -1271,7 +1271,7 @@ if (Zend_Locale::isLocale($input)) {
         <para>
             Still it's sometimes usefull to prevent this automatic degrading, and this is where the second
             parameter of <code>isLocale()</code> comes in place. The <code>strict</code> parameter defaults to
-            <code>false</code> and can be used to prevent degrading when set to <code>true</code>.
+            <constant>FALSE</constant> and can be used to prevent degrading when set to <code>true</code>.
         </para>
 
         <example id="zend.locale.detection.example-2">

documentation/manual/en/module_specs/Zend_Memory-MemoryObjects.xml

@@ -249,9 +249,9 @@ public function isLocked();
             <para>
                 The <code>isLocked()</code> method can be used to check if
                 object is locked. It returns <code>true</code> if the object
-                is locked, or <code>false</code> if it is not locked.
+                is locked, or <constant>FALSE</constant> if it is not locked.
                 This is always <code>true</code> for "locked" objects,
-                and may be either <code>true</code> or <code>false</code>
+                and may be either <code>true</code> or <constant>FALSE</constant>
                 for "movable" objects.
             </para>
 

documentation/manual/en/module_specs/Zend_Navigation-Pages-Common.xml

@@ -145,10 +145,10 @@
                 <row>
                     <entry><code>active</code></entry>
                     <entry><code>bool</code></entry>
-                    <entry><code>false</code></entry>
+                    <entry><constant>FALSE</constant></entry>
                     <entry>
                         Whether the page should be considered active for the
-                        current request. If active is <code>false</code> or not
+                        current request. If active is <constant>FALSE</constant> or not
                         given, MVC pages will check its properties against the
                         request object upon calling <code>$page->isActive()</code>.
                     </entry>

documentation/manual/en/module_specs/Zend_OpenId-Provider.xml

@@ -59,7 +59,7 @@ if (!$server->hasUser(TEST_ID)) {
         <para>
             On success, the method <classname>Zend_OpenId_Provider::handle</classname>
             returns a string that should be passed back to the OpenID-enabled site. On
-            failure, it returns <code>false</code>. This example will return an
+            failure, it returns <constant>FALSE</constant>. This example will return an
             HTTP 403 response if <classname>Zend_OpenId_Provider::handle</classname> fails. You will get this response if you open this script with a
             web browser, because it sends a non-OpenID conforming request.
         </para>

documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_JsPull.xml

@@ -10,7 +10,7 @@
         the adapter sends a JSON string to the browser, which looks exactly
         like the JSON string which is send by the jsPush adapter. The only
         difference is, that it contains an additional parameter,
-        <code>finished</code>, which is either <code>false</code> when
+        <code>finished</code>, which is either <constant>FALSE</constant> when
         <code>update()</code> is called or <code>true</code>, when
         <code>finish()</code> is called.
     </para>

documentation/manual/en/module_specs/Zend_Reflection-Reference.xml

@@ -80,7 +80,7 @@
 
             <listitem><para>
                 <code>getTag($name)</code>: Retrieve the given annotation tag
-                reflection object, or a boolean <code>false</code> if it's not
+                reflection object, or a boolean <constant>FALSE</constant> if it's not
                 present.
             </para></listitem>
 

documentation/manual/en/module_specs/Zend_Search_Lucene-Queries.xml

@@ -202,7 +202,7 @@ $hits  = $index->find($query);
                 </listitem>
                 <listitem>
                     <para>
-                        <code>false</code> is used to define prohibited term.
+                        <constant>FALSE</constant> is used to define prohibited term.
                     </para>
                 </listitem>
                 <listitem>
@@ -332,7 +332,7 @@ $hits  = $index->find($query);
                 </listitem>
                 <listitem>
                     <para>
-                        <code>false</code> is used to define prohibited subquery.
+                        <constant>FALSE</constant> is used to define prohibited subquery.
                     </para>
                 </listitem>
                 <listitem>

documentation/manual/en/module_specs/Zend_Soap_Server.xml

@@ -319,7 +319,7 @@ $request = $server->getLastRequest();
 
             <para>
                 <classname>Zend_Soap_Server::handle()</classname> method automatically emits generated response to the output stream.
-                It may be blocked using <code>setReturnResponse()</code> with <code>true</code> or <code>false</code>
+                It may be blocked using <code>setReturnResponse()</code> with <code>true</code> or <constant>FALSE</constant>
                 as a parameter<footnote>
                                 <para>
                                     Current state of the Return Response flag may be requested with

documentation/manual/en/module_specs/Zend_Text_Figlet.xml

@@ -55,7 +55,7 @@
                     how new lines are handled. When set to true, single new lines
                     are ignored and instead treated as single spaces. Only multiple
                     new lines will be handled as such. The default value is
-                    <code>false</code>.
+                    <constant>FALSE</constant>.
                 </para>
             </listitem>
             <listitem>

documentation/manual/en/module_specs/Zend_Validate-EmailAddress.xml

@@ -104,7 +104,7 @@ $validator = new Zend_Validate_EmailAddress(Zend_Validate_Hostname::ALLOW_DNS,
                                             true);
 ]]></programlisting>
 
-        Alternatively you can either pass <code>true</code> or <code>false</code> to
+        Alternatively you can either pass <code>true</code> or <constant>FALSE</constant> to
         <code>$validator->setValidateMx()</code> to enable or disable MX validation.
     </para>
 

documentation/manual/en/module_specs/Zend_Validate-WritingValidators.xml

@@ -36,7 +36,7 @@
         extending class you would implement the <code>isValid()</code> method logic and define the
         message variables and message templates that correspond to the types of validation failures
         that can occur. If a value fails your validation tests, then <code>isValid()</code> should
-        return <code>false</code>. If the value passes your validation tests, then
+        return <constant>FALSE</constant>. If the value passes your validation tests, then
         <code>isValid()</code> should return <code>true</code>.
     </para>
 
@@ -172,7 +172,7 @@ class MyValid_NumericBetween extends Zend_Validate_Abstract
         <para>
             Note that if any one of the validation checks in <code>isValid()</code> fails, an
             appropriate failure message is prepared, and the method immediately returns
-            <code>false</code>. These validation rules are therefore sequentially dependent. That
+            <constant>FALSE</constant>. These validation rules are therefore sequentially dependent. That
             is, if one test should fail, there is no need to test any subsequent validation rules.
             This need not be the case, however. The following example illustrates how to write a
             class having independent validation rules, where the validation object may return
@@ -256,7 +256,7 @@ class MyValid_PasswordStrength extends Zend_Validate_Abstract
 ]]></programlisting>
 
             Note that the four criteria tests in <code>isValid()</code> do not immediately return
-            <code>false</code>. This allows the validation class to provide <emphasis>all</emphasis>
+            <constant>FALSE</constant>. This allows the validation class to provide <emphasis>all</emphasis>
             of the reasons that the input password failed to meet the validation requirements. if,
             for example, a user were to input the string "<code>#$%</code>" as a password,
             <code>isValid()</code> would cause all four validation failure messages to be returned

documentation/manual/en/module_specs/Zend_Validate.xml

@@ -48,7 +48,7 @@
         </para>
 
         <para>
-            If <code>isValid()</code> returns <code>false</code>, the
+            If <code>isValid()</code> returns <constant>FALSE</constant>, the
             <code>getMessages()</code> returns an array of messages explaining
             the reason(s) for validation failure. The array keys are short
             strings that identify the reasons for validation failure, and the

documentation/manual/en/module_specs/Zend_View-Helpers-Navigation.xml

@@ -584,7 +584,7 @@ Zend_View_Helper_Navigation_HelperAbstract::setDefaultRole('member');
                <para>
                    <code>{get|set}LinkLast()</code> gets/sets whether the
                    last breadcrumb should be rendered as an anchor or not.
-                   Default is <code>false</code>.
+                   Default is <constant>FALSE</constant>.
                </para>
            </listitem>
            <listitem>
@@ -1194,7 +1194,7 @@ Output:
                     <code>{get|set}RenderParents()</code> gets/sets a flag
                     specifying whether parents should be rendered when only
                     rendering active branch of a container. If set to
-                    <code>false</code>, only the deepest active menu will be
+                    <constant>FALSE</constant>, only the deepest active menu will be
                     rendered.
                 </para>
             </listitem>
@@ -1882,7 +1882,7 @@ foreach ($this->container as $page) {
                     of the native <classname>DOMDocument</classname> class.
                     Read more at
                     <ulink url="http://php.net/domdocument">PHP: DOMDocument - Manual</ulink>.
-                    Default is <code>false</code>.
+                    Default is <constant>FALSE</constant>.
                 </para>
            </listitem>
            <listitem>
@@ -1905,7 +1905,7 @@ foreach ($this->container as $page) {
                     <code>{get|set}UseSchemaValidation()</code> gets/sets a
                     flag indicating whether the helper should use XML Schema
                     validation when generating the DOM sitemap. Default is
-                    <code>false</code>. If <code>true</code>.
+                    <constant>FALSE</constant>. If <code>true</code>.
                 </para>
            </listitem>
            <listitem>