[DOCUMENTATION] English:

 - change (true|false|null) in <para> by <constant>(TRUE|FALSE|NULL)</constant>

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

documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Application.xml

@@ -215,7 +215,7 @@
                     </itemizedlist></entry>
                     <entry><para>
                         Retrieve the option value of a given key. Returns
-                        null if the key does not exist.
+                        <constant>NULL</constant> if the key does not exist.
                     </para></entry>
                 </row>
 

documentation/manual/en/module_specs/Zend_Application-CoreFunctionality-Bootstrap_BootstrapAbstract.xml

@@ -104,7 +104,7 @@
                     </itemizedlist></entry>
                     <entry><para>
                         Retrieve the value associated with an option key;
-                        returns null if no option is registered with that key.
+                        returns <constant>NULL</constant> if no option is registered with that key.
                     </para></entry>
                 </row>
 

documentation/manual/en/module_specs/Zend_Auth_Adapter_Ldap.xml

@@ -484,8 +484,8 @@ Array
 
         <note>
             <para>
-                If you enable <emphasis>useStartTls = true</emphasis> or
-                <emphasis>useSsl = true</emphasis> you may find that the <acronym>LDAP</acronym>
+                If you enable <emphasis>useStartTls = <constant>TRUE</constant></emphasis> or
+                <emphasis>useSsl = <constant>TRUE</constant></emphasis> you may find that the <acronym>LDAP</acronym>
                 client generates an error claiming that it cannot validate the server's
                 certificate. Assuming the <acronym>PHP</acronym> <acronym>LDAP</acronym> extension
                 is ultimately linked to the OpenLDAP client libraries, to resolve this issue you

documentation/manual/en/module_specs/Zend_Controller-ActionHelpers-ContextSwitch.xml

@@ -258,8 +258,8 @@ $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
             </para></listitem>
 
             <listitem><para>
-                <methodname>hasContext($context)</methodname>: returns true if the context
-                exists, false otherwise.
+                <methodname>hasContext($context)</methodname>: returns <constant>TRUE</constant> if the context
+                exists, <constant>FALSE</constant> otherwise.
             </para></listitem>
 
             <listitem><para> <methodname>getContext($context)</methodname>: retrieve a
@@ -274,7 +274,7 @@ $this->_helper->contextSwitch()->setAutoJsonSerialization(false);
 
             <listitem><para>
                 <methodname>removeContext($context)</methodname>: remove a single context by
-                name. Returns true if successful, false if the context was not
+                name. Returns <constant>TRUE</constant> if successful, <constant>FALSE</constant> if the context was not
                 found.
             </para></listitem>
 
@@ -565,7 +565,7 @@ $contextSwitch->initContext();
             <listitem>
                 <para>
                     <methodname>getHeader($context, $header)</methodname>: retrieve the
-                    value of a header for a given context. Returns null if not
+                    value of a header for a given context. Returns <constant>NULL</constant> if not
                     found.
                 </para>
             </listitem>
@@ -655,7 +655,7 @@ $contextSwitch->initContext();
                     normal responses, and have no meaning in alternate contexts.
                     However, if you wish to use layouts (perhaps you may have a
                     layout for the new context), you can change this behaviour
-                    by passing a false value to
+                    by passing a <constant>FALSE</constant> value to
                     <methodname>setAutoDisableLayout()</methodname>. You should do this
                     <emphasis>before</emphasis> calling
                     <methodname>initContext()</methodname>.
@@ -670,7 +670,7 @@ $contextSwitch->initContext();
             <listitem>
                 <para>
                     <methodname>getCurrentContext()</methodname> can be used to determine
-                    what context was detected, if any. This returns null if no
+                    what context was detected, if any. This returns <constant>NULL</constant> if no
                     context switch occurred, or if called before
                     <methodname>initContext()</methodname> has been invoked.
                 </para>

documentation/manual/en/module_specs/Zend_Controller-ActionHelpers-Redirector.xml

@@ -33,7 +33,7 @@
                 <para>
                     <methodname>setExit()</methodname> can be used to force an
                     <methodname>exit()</methodname> following a redirect. By default this is
-                    true.
+                    <constant>TRUE</constant>.
                 </para>
             </listitem>
 

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

@@ -64,7 +64,7 @@
                 <para><methodname>Zend_Controller_Front::throwExceptions()</methodname></para>
 
                 <para>
-                    By passing a boolean true value to this method, you can tell
+                    By passing a boolean <constant>TRUE</constant> value to this method, you can tell
                     the front controller that instead of aggregating exceptions
                     in the response object or using the error handler plugin,
                     you'd rather handle them yourself. As an example:
@@ -92,7 +92,7 @@ try {
                 </para>
 
                 <para>
-                    By passing a boolean true value to this method, you tell the
+                    By passing a boolean <constant>TRUE</constant> value to this method, you tell the
                     response object that it should render an exception message
                     and backtrace when rendering itself. In this scenario, any
                     exception raised by your application will be displayed. This
@@ -107,7 +107,7 @@ try {
                 </para>
 
                 <para>
-                    By passing a boolean true to
+                    By passing a boolean <constant>TRUE</constant> to
                     <methodname>Zend_Controller_Front::returnResponse()</methodname>,
                     <methodname>Zend_Controller_Front::dispatch()</methodname> will not render the
                     response, but instead return it. Once you have the response,

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

@@ -519,7 +519,7 @@ Zend_Controller_Front::run('../application/controllers');
                 <para>
                     <emphasis>noViewRenderer</emphasis> is used to disable the <link
                         linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>.
-                    Set this parameter to true to disable it.
+                    Set this parameter to <constant>TRUE</constant> to disable it.
                 </para>
             </listitem>
 
@@ -527,7 +527,7 @@ Zend_Controller_Front::run('../application/controllers');
                 <para>
                     <emphasis>noErrorHandler</emphasis> is used to disable the <link
                         linkend="zend.controller.plugins.standard.errorhandler">Error
-                        Handler plugin</link>. Set this parameter to true to
+                        Handler plugin</link>. Set this parameter to <constant>TRUE</constant> to
                     disable it.
                 </para>
             </listitem>

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

@@ -528,7 +528,7 @@ final protected function _forward($action,
                     <varname>$params</varname> provided will be appended to the
                     request object. If you do not require the controller or
                     module, but still need to pass parameters, simply specify
-                    null for those values.
+                    <constant>NULL</constant> for those values.
                 </para>
             </listitem>
         </itemizedlist>

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

@@ -119,7 +119,7 @@
 
                 <para>
                     As of 1.5.0, you can also retrieve the raw post data via the
-                    <methodname>getRawBody()</methodname> method. This method returns false
+                    <methodname>getRawBody()</methodname> method. This method returns <constant>FALSE</constant>
                     if no data was submitted in that fashion, but the full body
                     of the post otherwise.
                 </para>
@@ -284,7 +284,7 @@ $response   = $controller->dispatch();
                 method for detecting AJAX requests:
                 <methodname>isXmlHttpRequest()</methodname>. This method looks for an
                 HTTP request header <code>X-Requested-With</code> with the value
-                'XMLHttpRequest'; if found, it returns true.
+                'XMLHttpRequest'; if found, it returns <constant>TRUE</constant>.
             </para>
 
             <para>

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

@@ -160,7 +160,7 @@ $front->dispatch();
                     <methodname>setHeader($name, $value, $replace = false)</methodname> is
                     used to set an individual header. By default, it does not
                     replace existing headers of the same name in the object;
-                    however, setting <varname>$replace</varname> to true will force it
+                    however, setting <varname>$replace</varname> to <constant>TRUE</constant> will force it
                     to do so.
                 </para>
 
@@ -371,9 +371,9 @@ array(
                 <para>
                     <methodname>getBody($spec = false)</methodname> can be used to retrieve a
                     single array segment if <varname>$spec</varname> is the name of a named
-                    segment. If <varname>$spec</varname> is false, it returns a string
+                    segment. If <varname>$spec</varname> is <constant>FALSE</constant>, it returns a string
                     formed by concatenating all named segments in order. If
-                    <varname>$spec</varname> is true, it returns the body content
+                    <varname>$spec</varname> is <constant>TRUE</constant>, it returns the body content
                     array.
                 </para>
             </listitem>
@@ -442,7 +442,7 @@ array(
                 <para>
                     <methodname>getExceptionByType($type)</methodname> allows you to
                     retrieve all exceptions of a specific class from the stack.
-                    It will return false if none are found, and an array of
+                    It will return <constant>FALSE</constant> if none are found, and an array of
                     exceptions otherwise.
                 </para>
             </listitem>
@@ -451,7 +451,7 @@ array(
                 <para>
                     <methodname>getExceptionByMessage($message)</methodname> allows you to
                     retrieve all exceptions with a specific message from the stack.
-                    It will return false if none are found, and an array of
+                    It will return <constant>FALSE</constant> if none are found, and an array of
                     exceptions otherwise.
                 </para>
             </listitem>
@@ -460,7 +460,7 @@ array(
                 <para>
                     <methodname>getExceptionByCode($code)</methodname> allows you to
                     retrieve all exceptions with a specific code from the stack.
-                    It will return false if none are found, and an array of
+                    It will return <constant>FALSE</constant> if none are found, and an array of
                     exceptions otherwise.
                 </para>
             </listitem>

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Rest.xml

@@ -85,7 +85,7 @@ $front->getRouter()->addRoute('default', $restRoute);
     <note>
         <para>
             If <classname>Zend_Rest_Route</classname> cannot match a valid
-            module, controller, or action, it will return false and the router
+            module, controller, or action, it will return <constant>FALSE</constant> and the router
             will attempt to match using the next route in the router.
         </para>
     </note>

documentation/manual/en/module_specs/Zend_Currency-Migrating.xml

@@ -17,7 +17,7 @@
 
         <para>
             Creating an object of <classname>Zend_Currency</classname> has become simpler.
-            You no longer have to give a script or set it to null. The optional
+            You no longer have to give a script or set it to <constant>NULL</constant>. The optional
             script parameter is now an option which can be set through the
             <methodname>setFormat()</methodname> method.
         </para>

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

@@ -48,7 +48,7 @@
             create a date like '31.February.2000' with <classname>Zend_Date</classname> because
             <classname>Zend_Date</classname> will automatically correct the date and return the
             proper date. In our case '03.March.2000'. <methodname>isDate()</methodname> on the
-            other side does this check and will return false on '31.February.2000' because it knows
+            other side does this check and will return <constant>FALSE</constant> on '31.February.2000' because it knows
             that this date is impossible.
         </para>
 

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

@@ -51,7 +51,7 @@
                 if the time part of the date was originally 00:00:00. Since Zend_Date is based on
                 timestamps, and not calendar dates with a time component, the timestamp loses an
                 hour, resulting in the date having a calendar day value one less than expected. To
-                prevent such problems use the option <code>fix_dst</code>, which defaults to true,
+                prevent such problems use the option <code>fix_dst</code>, which defaults to <constant>TRUE</constant>,
                 causing DST to have no effect on date "math" (<methodname>addMonth()</methodname>,
                 <methodname>subMonth()</methodname>). Use
                 <methodname>Zend_Date::setOptions(array('fix_dst' => false))</methodname> to
@@ -82,8 +82,8 @@
                 only occurs, if the resulting month does not have the day, which is set in the
                 original date. For Zend Framework developers, the desired behavior is selectable
                 using the <code>extend_month</code> option to choose either the SQL behaviour, if
-                set to false, or the spreadsheet behaviour when set to true. The default behaviour
-                for <code>extend_month</code> is false, providing behavior compatible to SQL. By
+                set to <constant>FALSE</constant>, or the spreadsheet behaviour when set to <constant>TRUE</constant>. The default behaviour
+                for <code>extend_month</code> is <constant>FALSE</constant>, providing behavior compatible to SQL. By
                 default, <classname>Zend_Date</classname> computes month calculations by truncating
                 dates to the end of the month (if necessary), without wrapping into the next month
                 when the original date designates a day of the month exceeding the number of days in
@@ -599,10 +599,10 @@ print $date;
                                 <emphasis>equals($date, $part = null, $locale = null)</emphasis>
                             </para>
                             <para>
-                                returns true, if <varname>$part</varname> of
+                                returns <constant>TRUE</constant>, if <varname>$part</varname> of
                                 <varname>$date</varname> having locale <varname>$locale</varname> is
                                 the same as this object's date <varname>$part</varname>, otherwise
-                                false
+                                <constant>FALSE</constant>
                             </para>
                         </entry>
                     </row>
@@ -613,7 +613,7 @@ print $date;
                                 <emphasis>isEarlier($date, $part = null, $locale = null)</emphasis>
                             </para>
                             <para>
-                                returns true, if <varname>$part</varname> of this object's date is
+                                returns <constant>TRUE</constant>, if <varname>$part</varname> of this object's date is
                                 earlier than <varname>$part</varname> of <varname>$date</varname>
                                 having a locale <varname>$locale</varname>
                             </para>
@@ -626,7 +626,7 @@ print $date;
                                 <emphasis>isLater($date, $part = null, $locale = null)</emphasis>
                             </para>
                             <para>
-                                returns true, if <varname>$part</varname> of this object's date is
+                                returns <constant>TRUE</constant>, if <varname>$part</varname> of this object's date is
                                 later than <varname>$part</varname> of <varname>$date</varname>
                                 having a locale <varname>$locale</varname>
                             </para>
@@ -691,10 +691,10 @@ print $date;
                                 <emphasis>isDate($date, $format = null, $locale = null)</emphasis>
                             </para>
                             <para>
-                                This method checks if a given date is a real date and returns true
+                                This method checks if a given date is a real date and returns <constant>TRUE</constant>
                                 if all checks are ok. It works like PHP's checkdate() function but
                                 can also check for localized month names and for dates extending the
-                                range of checkdate() false
+                                range of checkdate() <constant>FALSE</constant>
                             </para>
                         </entry>
                     </row>