[DOCUMENTATION] English:

- manual fixes (<code>null</code> ==> <constant>NULL</constant>)

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

documentation/manual/en/module_specs/Zend_Config_Ini.xml

@@ -18,7 +18,7 @@
             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
             <constant>TRUE</constant>, <constant>FALSE</constant>, <code>yes</code>, <code>no</code>,
-            and <code>null</code> are handled.
+            and <constant>NULL</constant> are handled.
         </para>
     </note>
     <note>

documentation/manual/en/module_specs/Zend_Console_Getopt-Fetching.xml

@@ -75,7 +75,7 @@ try {
             of an option. If the option had a parameter, this method returns
             the value of the parameter. If the option had no parameter but
             the user did specify it on the command-line, the method returns
-            <constant>TRUE</constant>. Otherwise the method returns <code>null</code>.
+            <constant>TRUE</constant>. Otherwise the method returns <constant>NULL</constant>.
         </para>
         <example id="zend.console.getopt.fetching.byname.example.setoption">
             <title>Using getOption()</title>

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

@@ -148,7 +148,7 @@
             </link>
             . If a date object is constructed using an obviously invalid date (e.g. a month number greater than 12),
             then <classname>Zend_Date</classname> will throw an exception, unless no specific date format has been selected -i.e.
-            <varname>$part</varname> is either <code>null</code> or <classname>Zend_Date::DATES</classname> (a "loose" format).
+            <varname>$part</varname> is either <constant>NULL</constant> or <classname>Zend_Date::DATES</classname> (a "loose" format).
         </para>
 
         <example id="zend.date.values.example-1">

documentation/manual/en/module_specs/Zend_Db_Adapter.xml

@@ -1024,7 +1024,7 @@ $id = $db->lastSequenceId('bugs_id_gen');
                 lastInsertId() method are ignored, and the value returned is the
                 most recent value generated for any table by INSERT operations
                 during the current connection. For these RDBMS brands, the
-                lastSequenceId() method always returns <code>null</code>.
+                lastSequenceId() method always returns <constant>NULL</constant>.
             </para>
 
             <note>
@@ -1776,7 +1776,7 @@ $result = $db->getConnection()->exec('DROP TABLE bugs');
         <para>
             Since release 1.7.2, you could retrieve the server version in PHP syntax
             style to be able to use <code>version_compare()</code>. If the information
-            isn't available, you will receive <code>null</code>.
+            isn't available, you will receive <constant>NULL</constant>.
         </para>
 
         <example id="zend.db.adapter.server-version.example">
@@ -1854,7 +1854,7 @@ if (!is_null($version)) {
                         <code>lastInsertId()</code> ignores its arguments and
                         always returns the last value generated for an
                         auto-increment key. The <code>lastSequenceId()</code>
-                        method returns <code>null</code>.
+                        method returns <constant>NULL</constant>.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -1950,7 +1950,7 @@ if (!is_null($version)) {
                         <code>lastInsertId()</code> ignores its arguments and
                         always returns the last value generated for an
                         auto-increment key. The <code>lastSequenceId()</code>
-                        method returns <code>null</code>.
+                        method returns <constant>NULL</constant>.
                     </para>
                 </listitem>
                 <listitem>
@@ -2011,7 +2011,7 @@ if (!is_null($version)) {
                         <code>lastInsertId()</code> ignores its arguments and
                         always returns the last value generated for an
                         auto-increment key. The <code>lastSequenceId()</code>
-                        method returns <code>null</code>.
+                        method returns <constant>NULL</constant>.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -2091,7 +2091,7 @@ if (!is_null($version)) {
                         <code>lastInsertId()</code> ignores its arguments and
                         always returns the last value generated for an
                         auto-increment key. The <code>lastSequenceId()</code>
-                        method returns <code>null</code>.
+                        method returns <constant>NULL</constant>.
                     </para>
                 </listitem>
                 <listitem>

documentation/manual/en/module_specs/Zend_Db_Profiler.xml

@@ -333,7 +333,7 @@ $profiler->setFilterElapsedSecs(null);
 
             <para>
                 As with <code>setFilterElapsedSecs()</code>, you can remove any
-                existing filters by passing <code>null</code> as the sole
+                existing filters by passing <constant>NULL</constant> as the sole
                 argument.
             </para>
 

documentation/manual/en/module_specs/Zend_Db_Table.xml

@@ -1153,7 +1153,7 @@ $row = $table->fetchRow($select);
         <para>
             This method returns an object of type <classname>Zend_Db_Table_Row_Abstract</classname>. If the search
             criteria you specified match no rows in the database table, then
-            <code>fetchRow()</code> returns PHP's <code>null</code> value.
+            <code>fetchRow()</code> returns PHP's <constant>NULL</constant> value.
         </para>
 
     </sect2>
@@ -1308,7 +1308,7 @@ echo "The table name is " . $info['name'] . "\n";
                 </listitem>
             </itemizedlist>
 
-            In both cases, the cache specification must be either <code>null</code> (i.e., no cache
+            In both cases, the cache specification must be either <constant>NULL</constant> (i.e., no cache
             used) or an instance of
             <link linkend="zend.cache.frontends.core"><classname>Zend_Cache_Core</classname></link>. The
             methods may be used in conjunction when it is desirable to have both a default metadata

documentation/manual/en/module_specs/Zend_Db_Table_Rowset.xml

@@ -92,7 +92,7 @@ $row    = $rowset->current();
 
         <para>
             If the Rowset contains zero rows, <code>current()</code> returns
-            PHP's <code>null</code> value.
+            PHP's <constant>NULL</constant> value.
         </para>
 
         <example id="zend.db.table.rowset.rows.iterate.example">

documentation/manual/en/module_specs/Zend_Gdata_ClientLogin.xml

@@ -53,7 +53,7 @@
         <para>
             The optional fourth parameter is an instance of <classname>Zend_Http_Client</classname>.
             This allows you to set options in the client, such as proxy
-            server settings. If you pass <code>null</code> for this
+            server settings. If you pass <constant>NULL</constant> for this
             parameter, a generic <classname>Zend_Http_Client</classname> object is created.
         </para>
 

documentation/manual/en/module_specs/Zend_Gdata_Gapps.xml

@@ -148,7 +148,7 @@ $user = $gdata->insertUser($user);
             <para>
                 Individual user accounts can be retrieved by calling the
                 <code>retrieveUser()</code> convenience method. If the user is
-                not found, <code>null</code> will be returned.
+                not found, <constant>NULL</constant> will be returned.
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -440,7 +440,7 @@ $nickname = $gdata->insertNickname($nickname);
             <para>
                 Nicknames can be retrieved by calling the
                 <code>retrieveNickname()</code> convenience method. This will
-                return <code>null</code> if a user is not found.
+                return <constant>NULL</constant> if a user is not found.
             </para>
 
             <programlisting language="php"><![CDATA[

documentation/manual/en/module_specs/Zend_Loader.xml

@@ -51,7 +51,7 @@ Zend_Loader::loadFile($filename, $dirs=null, $once=false);
 
         <para>
             The <code>$dirs</code> argument specifies which directories to search for
-            the file in. If the value is <code>NULL</code>, only the <code>include_path</code>
+            the file in. If the value is <constant>NULL</constant>, only the <code>include_path</code>
             is searched; if the value is a string or an array, the directory or directories
             specified will be searched, followed by the <code>include_path</code>.
         </para>

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

@@ -104,7 +104,7 @@ $logger->emerg('Emergency message');
     <title>Destroying a Log</title>
     <para>
       If the Log object is no longer needed, set the variable containing it to
-      <code>null</code> to destroy it. This will automatically call the
+      <constant>NULL</constant> to destroy it. This will automatically call the
       <code>shutdown()</code> instance method of each attached Writer before
       the Log object is destroyed:
 

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

@@ -38,7 +38,7 @@
                 <row>
                     <entry><code>label</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         A page label, such as 'Home' or 'Blog'.
                     </entry>
@@ -46,7 +46,7 @@
                 <row>
                     <entry><code>id</code></entry>
                     <entry><code>string</code> | <code>int</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         An id tag/attribute that may be used when rendering
                         the page, typically in an anchor element.
@@ -55,7 +55,7 @@
                 <row>
                     <entry><code>class</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         A CSS class that may be used when rendering the page,
                         typically in an anchor element.
@@ -64,7 +64,7 @@
                 <row>
                     <entry><code>title</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         A short page description, typically for using
                         as the <code>title</code> attribute in an anchor.
@@ -73,7 +73,7 @@
                 <row>
                     <entry><code>target</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Specifies a target that may be used for the page,
                         typically in an anchor element.
@@ -107,8 +107,8 @@
                 </row>
                 <row>
                     <entry><code>order</code></entry>
-                    <entry><code>string</code> | <code>int</code> | <code>null</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><code>string</code> | <code>int</code> | <constant>NULL</constant></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Works like order for elements in
                         <link linkend="zend.form.quickstart.render">
@@ -117,15 +117,15 @@
                         you can force a page to be iterated before others by
                         setting the <code>order</code> attribute to a low number,
                         e.g. -100. If a <code>string</code> is given, it must
-                        parse to a valid <code>int</code>. If <code>null</code>
+                        parse to a valid <code>int</code>. If <constant>NULL</constant>
                         is given, it will be reset, meaning the order in which
                         the page was added to the container will be used.
                     </entry>
                 </row>
                 <row>
                     <entry><code>resource</code></entry>
-                    <entry><code>string</code> | <classname>Zend_Acl_Resource_Interface</classname> | <code>null</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><code>string</code> | <classname>Zend_Acl_Resource_Interface</classname> | <constant>NULL</constant></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         ACL resource to associate with the page. Read more in
                         <link linkend="zend.view.helpers.initial.navigation.acl">the
@@ -134,8 +134,8 @@
                 </row>
                 <row>
                     <entry><code>privilege</code></entry>
-                    <entry><code>string</code> | <code>null</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><code>string</code> | <constant>NULL</constant></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         ACL privilege to associate with the page. Read more in
                         <link linkend="zend.view.helpers.initial.navigation.acl">the
@@ -165,8 +165,8 @@
                 </row>
                 <row>
                     <entry><code>pages</code></entry>
-                    <entry><code>array</code> | <classname>Zend_Config</classname> | <code>null</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><code>array</code> | <classname>Zend_Config</classname> | <constant>NULL</constant></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Child pages of the page. This could be an <code>array</code>
                         or <classname>Zend_Config</classname> object containing either page

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

@@ -28,7 +28,7 @@
                 <row>
                     <entry><code>action</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Action name to use when generating
                         href to the page.
@@ -37,7 +37,7 @@
                 <row>
                     <entry><code>controller</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Controller name to use when generating
                         href to the page.
@@ -46,7 +46,7 @@
                 <row>
                     <entry><code>module</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Module name to use when generating
                         href to the page.
@@ -63,7 +63,7 @@
                 <row>
                     <entry><code>route</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         Route name to use when generating
                         href to the page.

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

@@ -10,7 +10,7 @@
         to the common page options, a URI page takes only one option —
         <code>uri</code>. The <code>uri</code> will be returned when
         calling <code>$page->getHref()</code>, and may be a
-        <code>string</code> or <code>null</code>.
+        <code>string</code> or <constant>NULL</constant>.
     </para>
 
     <note>
@@ -38,7 +38,7 @@
                 <row>
                     <entry><code>uri</code></entry>
                     <entry><code>string</code></entry>
-                    <entry><code>null</code></entry>
+                    <entry><constant>NULL</constant></entry>
                     <entry>
                         URI to page. This can be any string or null.
                     </entry>

documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_Console.xml

@@ -38,7 +38,7 @@
         </listitem>
         <listitem>
             <para>
-                <code>elements</code>: Either <code>NULL</code> for default
+                <code>elements</code>: Either <constant>NULL</constant> for default
                 or an array with at least one of the following constants
                 of <classname>Zend_Console_ProgressBar</classname> as value:
             </para>

documentation/manual/en/module_specs/Zend_ProgressBar_Adapter_JsPush.xml

@@ -26,7 +26,7 @@
             <para>
                 <code>finishMethodName</code>: The javascript method which
                 should be called after finish status was set. Default value is
-                <code>NULL</code>, which means nothing is done.
+                <constant>NULL</constant>, which means nothing is done.
             </para>
         </listitem>
     </itemizedlist>

documentation/manual/en/module_specs/Zend_Registry.xml

@@ -40,7 +40,7 @@ Zend_Registry::set('index', $value);
         </para>
 
         <para>
-            The index can be a scalar (<code>null</code>, string, or number), like an ordinary array.
+            The index can be a scalar (<constant>NULL</constant>, string, or number), like an ordinary array.
         </para>
 
     </sect2>

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

@@ -40,7 +40,7 @@ $index->addDocument($doc);
             The <classname>Zend_Search_Lucene_Analysis_Analyzer_Common</classname> class is designed to be an ancestor of all user
             defined analyzers. User should only define the <code>reset()</code> and <code>nextToken()</code> methods,
             which takes its string from the $_input member and returns tokens one by one
-            (a <code>null</code> value indicates the end of the stream).
+            (a <constant>NULL</constant> value indicates the end of the stream).
         </para>
 
         <para>

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

@@ -207,7 +207,7 @@ $hits  = $index->find($query);
                 </listitem>
                 <listitem>
                     <para>
-                        <code>null</code> is used to define a term that is neither required nor prohibited.
+                        <constant>NULL</constant> is used to define a term that is neither required nor prohibited.
                     </para>
                 </listitem>
             </itemizedlist>
@@ -337,7 +337,7 @@ $hits  = $index->find($query);
                 </listitem>
                 <listitem>
                     <para>
-                        <code>null</code> is used to define a subquery that is neither required nor prohibited.
+                        <constant>NULL</constant> is used to define a subquery that is neither required nor prohibited.
                     </para>
                 </listitem>
             </itemizedlist>

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

@@ -59,7 +59,7 @@ Zend_Search_Lucene::setDefaultSearchField('contents');
 ]]></programlisting>
 
         <para>
-            The <code>null</code> value indicated that the search is performed across all fields. It's the default setting.
+            The <constant>NULL</constant> value indicated that the search is performed across all fields. It's the default setting.
         </para>
         <para>
             You can search specific fields by typing the field name followed by a colon ":" followed by the term you
@@ -90,7 +90,7 @@ title:"Do it right" AND go
 title:Do it right
 ]]></programlisting>
             Will only find "Do" in the title field. It will find "it" and "right" in the default field (if the default field is set)
-            or in all indexed fields (if the default field is set to <code>null</code>).
+            or in all indexed fields (if the default field is set to <constant>NULL</constant>).
         </para>
     </sect2>
 

documentation/manual/en/module_specs/Zend_Soap_Server.xml

@@ -96,7 +96,7 @@
         <sect3 id="zend.soap.server.wsdl_mode">
             <title>Zend_Soap_Server constructor for the non-WSDL mode</title>
             <para>
-                The first constructor parameter <emphasis>must</emphasis> be set to <code>null</code> if you
+                The first constructor parameter <emphasis>must</emphasis> be set to <constant>NULL</constant> if you
                 plan to use <classname>Zend_Soap_Server</classname> functionality in non-WSDL mode.
             </para>
             <para>

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

@@ -223,7 +223,7 @@ if ($validator->isValid($iban)) {
         <para>
             Returns <constant>TRUE</constant> if and only if the string length of <code>$value</code> is at
             least a minimum and no greater than a maximum (when the max option is not
-            <code>null</code>). The <code>setMin()</code> method throws an exception if the minimum
+            <constant>NULL</constant>). The <code>setMin()</code> method throws an exception if the minimum
             length is set to a value greater than the set maximum length, and the
             <code>setMax()</code> method throws an exception if the maximum length is set to a
             value less than than the set minimum length. This class supports UTF-8 and other

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

@@ -123,14 +123,14 @@
                 <para>
                     <code>{get|set}MinDepth()</code> gets/set the minimum depth
                     a page must have to be included by the helper. Setting
-                    <code>null</code> means no minimum depth.
+                    <constant>NULL</constant> means no minimum depth.
                 </para>
             </listitem>
             <listitem>
                 <para>
                     <code>{get|set}MaxDepth()</code> gets/set the maximum depth
                     a page can have to be included by the helper. Setting
-                    <code>null</code> means no maximum depth.
+                    <constant>NULL</constant> means no maximum depth.
                 </para>
             </listitem>
             <listitem>
@@ -1251,14 +1251,14 @@ Output:
                         <listitem>
                             <para>
                                 <code>minDepth</code>; minimum depth. Expcects
-                                an <code>int</code> or <code>null</code> (no
+                                an <code>int</code> or <constant>NULL</constant> (no
                                 minimum depth).
                             </para>
                         </listitem>
                         <listitem>
                             <para>
                                 <code>maxDepth</code>; maximum depth. Expcects
-                                an <code>int</code> or <code>null</code> (no
+                                an <code>int</code> or <constant>NULL</constant> (no
                                 maximum depth).
                             </para>
                         </listitem>