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

documentation/manual/en/module_specs/Zend_Auth.xml

@@ -22,9 +22,9 @@
     <note>
         <para>
             The <classname>Zend_Auth</classname> class implements the Singleton pattern - only one instance of the class is
-            available - through its static <code>getInstance()</code> method. This means that using the <code>new</code>
-            operator and the <code>clone</code> keyword will not work with the <classname>Zend_Auth</classname> class; use
-            <classname>Zend_Auth::getInstance()</classname> instead.
+            available - through its static <methodname>getInstance()</methodname> method. This means that using the <emphasis>new</emphasis>
+            operator and the <emphasis>clone</emphasis> keyword will not work with the <classname>Zend_Auth</classname> class; use
+            <methodname>Zend_Auth::getInstance()</methodname> instead.
         </para>
     </note>
 
@@ -42,8 +42,8 @@
 
         <para>
             Each <classname>Zend_Auth</classname> adapter class implements <classname>Zend_Auth_Adapter_Interface</classname>. This interface defines one
-            method, <code>authenticate()</code>, that an adapter class must implement for performing an authentication
-            query. Each adapter class must be prepared prior to calling <code>authenticate()</code>. Such adapter
+            method, <methodname>authenticate()</methodname>, that an adapter class must implement for performing an authentication
+            query. Each adapter class must be prepared prior to calling <methodname>authenticate()</methodname>. Such adapter
             preparation includes setting up credentials (e.g., username and password) and defining values for adapter-
             specific configuration options, such as database connection settings for a database table adapter.
         </para>
@@ -80,9 +80,9 @@ class MyAuthAdapter implements Zend_Auth_Adapter_Interface
 }
 ]]></programlisting>
 
-            As indicated in its docblock, <code>authenticate()</code> must return an instance of
+            As indicated in its docblock, <methodname>authenticate()</methodname> must return an instance of
             <classname>Zend_Auth_Result</classname> (or of a class derived from <classname>Zend_Auth_Result</classname>). If for some
-            reason performing an authentication query is impossible, <code>authenticate()</code> should throw
+            reason performing an authentication query is impossible, <methodname>authenticate()</methodname> should throw
             an exception that derives from <classname>Zend_Auth_Adapter_Exception</classname>.
         </para>
 
@@ -94,19 +94,19 @@ class MyAuthAdapter implements Zend_Auth_Adapter_Interface
 
         <para>
             <classname>Zend_Auth</classname> adapters return an instance of <classname>Zend_Auth_Result</classname> with
-            <code>authenticate()</code> in order to represent the results of an authentication attempt. Adapters
+            <methodname>authenticate()</methodname> in order to represent the results of an authentication attempt. Adapters
             populate the <classname>Zend_Auth_Result</classname> object upon construction, so that the following four methods
             provide a basic set of user-facing operations that are common to the results of <classname>Zend_Auth</classname> adapters:
             <itemizedlist>
                 <listitem>
                     <para>
-                        <code>isValid()</code> - returns true if and only if the result represents a
+                        <methodname>isValid()</methodname> - returns true if and only if the result represents a
                         successful authentication attempt
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <code>getCode()</code> - returns a <classname>Zend_Auth_Result</classname> constant identifier for
+                        <methodname>getCode()</methodname> - returns a <classname>Zend_Auth_Result</classname> constant identifier for
                         determining the type of authentication failure or whether success has occurred. This may be
                         used in situations where the developer wishes to distinguish among several authentication
                         result types. This allows developers to maintain detailed authentication result statistics,
@@ -118,12 +118,12 @@ class MyAuthAdapter implements Zend_Auth_Adapter_Interface
                 </listitem>
                 <listitem>
                     <para>
-                        <code>getIdentity()</code> - returns the identity of the authentication attempt
+                        <methodname>getIdentity()</methodname> - returns the identity of the authentication attempt
                     </para>
                 </listitem>
                 <listitem>
                     <para>
-                        <code>getMessages()</code> - returns an array of messages regarding a failed
+                        <methodname>getMessages()</methodname> - returns an array of messages regarding a failed
                         authentication attempt
                     </para>
                 </listitem>
@@ -377,7 +377,7 @@ $result = Zend_Auth::getInstance()->authenticate($authAdapter);
             </listitem>
             <listitem>
                 <para>
-                    directly, through the adapter's <code>authenticate()</code> method
+                    directly, through the adapter's <methodname>authenticate()</methodname> method
                 </para>
             </listitem>
             </orderedlist>
@@ -424,7 +424,7 @@ if ($auth->hasIdentity()) {
         </para>
 
         <para>
-            To remove an identity from persistent storage, simply use the <code>clearIdentity()</code> method.
+            To remove an identity from persistent storage, simply use the <methodname>clearIdentity()</methodname> method.
             This typically would be used for implementing an application "logout" operation:
             <programlisting language="php"><![CDATA[
 Zend_Auth::getInstance()->clearIdentity();
@@ -435,9 +435,9 @@ Zend_Auth::getInstance()->clearIdentity();
             When the automatic use of persistent storage is inappropriate for a particular use case, a
             developer may simply bypass the use of the <classname>Zend_Auth</classname> class, using an adapter class
             directly. Direct use of an adapter class involves configuring and preparing an adapter object and
-            then calling its <code>authenticate()</code> method. Adapter-specific details are discussed in the
+            then calling its <methodname>authenticate()</methodname> method. Adapter-specific details are discussed in the
             documentation for each adapter. The following example directly utilizes
-            <code>MyAuthAdapter</code>:
+            <emphasis>MyAuthAdapter</emphasis>:
 
             <programlisting language="php"><![CDATA[
 // Set up the authentication adapter

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

@@ -27,17 +27,17 @@
                  </thead>
                  <tbody>
                       <row>
-                          <entry><code>cache_dir</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>'/tmp/'</code></entry>
+                          <entry><emphasis>cache_dir</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry><filename>'/tmp/'</filename></entry>
                           <entry>
                               Directory where to store cache files
                           </entry>
                       </row>
                       <row>
-                          <entry><code>file_locking</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>true</code></entry>
+                          <entry><emphasis>file_locking</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>TRUE</constant></entry>
                           <entry>
                             Enable / disable file_locking : Can avoid cache corruption under
                             bad circumstances but it doesn't help on multithread webservers
@@ -45,9 +45,9 @@
                           </entry>
                       </row>
                       <row>
-                          <entry><code>read_control</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>true</code></entry>
+                          <entry><emphasis>read_control</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>TRUE</constant></entry>
                           <entry>
                             Enable / disable read control : if enabled, a control key is
                             embedded in the cache file and this key is compared with the
@@ -55,9 +55,9 @@
                           </entry>
                       </row>
                       <row>
-                          <entry><code>read_control_type</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>'crc32'</code></entry>
+                          <entry><emphasis>read_control_type</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry>'crc32'</entry>
                           <entry>
                             Type of read control (only if read control is enabled). Available values are :
                             'md5' (best but slowest), 'crc32' (lightly less safe but faster, better choice),
@@ -66,11 +66,11 @@
                         </entry>
                       </row>
                       <row>
-                          <entry><code>hashed_directory_level</code></entry>
-                          <entry><code>int</code></entry>
-                          <entry><code>0</code></entry>
+                          <entry><emphasis>hashed_directory_level</emphasis></entry>
+                          <entry><type>Integer</type></entry>
+                          <entry>0</entry>
                           <entry>
-                            Hashed directory structure level :     0 means "no hashed directory
+                            Hashed directory structure level : 0 means "no hashed directory
                              structure", 1 means "one level of directory", 2 means "two levels"...
                              This option can speed up the cache only when you have many thousands of
                              cache files. Only specific benchs can help you to choose the perfect
@@ -78,17 +78,17 @@
                           </entry>
                       </row>
                       <row>
-                          <entry><code>hashed_directory_umask</code></entry>
-                          <entry><code>int</code></entry>
-                          <entry><code>0700</code></entry>
+                          <entry><emphasis>hashed_directory_umask</emphasis></entry>
+                          <entry><type>Integer</type></entry>
+                          <entry>0700</entry>
                           <entry>
                               Umask for the hashed directory structure
                         </entry>
                       </row>
                       <row>
-                          <entry><code>file_name_prefix</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>'zend_cache'</code></entry>
+                          <entry><emphasis>file_name_prefix</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry>'zend_cache'</entry>
                           <entry>
                               prefix for cache files ; be really careful with this option because
                               a too generic value in a system cache dir (like /tmp) can cause
@@ -96,17 +96,17 @@
                         </entry>
                       </row>
                       <row>
-                          <entry><code>cache_file_umask</code></entry>
-                          <entry><code>int</code></entry>
-                          <entry><code>0700</code></entry>
+                          <entry><emphasis>cache_file_umask</emphasis></entry>
+                          <entry><type>Integer</type></entry>
+                          <entry>0700</entry>
                           <entry>
                               umask for cache files
                           </entry>
                       </row>
                        <row>
-                          <entry><code>metatadatas_array_max_size</code></entry>
-                          <entry><code>int</code></entry>
-                          <entry><code>100</code></entry>
+                          <entry><emphasis>metatadatas_array_max_size</emphasis></entry>
+                          <entry><type>Integer</type></entry>
+                          <entry>100</entry>
                           <entry>
                               internal max size for the metadatas array (don't change this value unless you
                               know what you are doing)
@@ -137,17 +137,17 @@
                  </thead>
                  <tbody>
                       <row>
-                          <entry><code>cache_db_complete_path (mandatory)</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>null</code></entry>
+                          <entry><emphasis>cache_db_complete_path (mandatory)</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry><constant>NULL</constant></entry>
                           <entry>
                               The complete path (filename included) of the SQLite database
                           </entry>
                       </row>
                       <row>
-                          <entry><code>automatic_vacuum_factor</code></entry>
-                          <entry><code>int</code></entry>
-                          <entry><code>10</code></entry>
+                          <entry><emphasis>automatic_vacuum_factor</emphasis></entry>
+                          <entry><type>Integer</type></entry>
+                          <entry>10</entry>
                           <entry>
                               Disable / Tune the automatic vacuum process.
                               The automatic vacuum process defragment the database file (and make it smaller)
@@ -188,13 +188,11 @@
                  </thead>
                  <tbody>
                       <row>
-                          <entry><code>servers</code></entry>
-                          <entry><code>array</code></entry>
+                          <entry><emphasis>servers</emphasis></entry>
+                          <entry><type>Array</type></entry>
                           <entry>
-                            <code>
                               array(array('host' => 'localhost', 'port' => 11211, 'persistent' => true, 'weight' => 1,
                               'timeout' => 5, 'retry_interval' => 15, 'status' => true, 'failure_callback' => '' ))
-                            </code>
                           </entry>
                           <entry>
                               An array of memcached servers ; each memcached server is described by an associative array :
@@ -209,17 +207,17 @@
                           </entry>
                       </row>
                       <row>
-                          <entry><code>compression</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>false</code></entry>
+                          <entry><emphasis>compression</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>FALSE</constant></entry>
                           <entry>
                              true if you want to use on-the-fly compression
                           </entry>
                       </row>
                       <row>
-                          <entry><code>compatibility</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>false</code></entry>
+                          <entry><emphasis>compatibility</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>FALSE</constant></entry>
                           <entry>
                              true if you want to use this compatibility mode with old memcache servers/extensions
                           </entry>
@@ -270,17 +268,17 @@
                  </thead>
                  <tbody>
                       <row>
-                          <entry><code>user</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>null</code></entry>
+                          <entry><emphasis>user</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry><constant>NULL</constant></entry>
                           <entry>
                               xcache.admin.user, necessary for the clean() method
                           </entry>
                       </row>
                       <row>
-                          <entry><code>password</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>null</code></entry>
+                          <entry><emphasis>password</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry><constant>NULL</constant></entry>
                           <entry>
                               xcache.admin.pass (in clear form, not MD5), necessary for the clean() method
                           </entry>
@@ -295,7 +293,7 @@
             This backend uses content caching API of the <ulink url="http://www.zend.com/products/platform">Zend Platform</ulink> product. Naturally, to use this backend you need to have Zend Platform installed.
         </para>
         <para>
-    This backend supports tags, but does not support <code>CLEANING_MODE_NOT_MATCHING_TAG</code> cleaning mode.
+    This backend supports tags, but does not support <constant>CLEANING_MODE_NOT_MATCHING_TAG</constant> cleaning mode.
         </para>
         <para>
             Specify this backend using a word separator -- '-', '.', ' ', or '_'
@@ -336,41 +334,41 @@ $cache = Zend_Cache::factory('Core', 'Zend Platform');
                  </thead>
                  <tbody>
                       <row>
-                          <entry><code>slow_backend</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>File</code></entry>
+                          <entry><emphasis>slow_backend</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry>File</entry>
                           <entry>
                               the "slow" backend name
                           </entry>
                       </row>
                       <row>
-                          <entry><code>fast_backend</code></entry>
-                          <entry><code>string</code></entry>
-                          <entry><code>Apc</code></entry>
+                          <entry><emphasis>fast_backend</emphasis></entry>
+                          <entry><type>String</type></entry>
+                          <entry>Apc</entry>
                           <entry>
                               the "fast" backend name
                           </entry>
                       </row>
                       <row>
-                          <entry><code>slow_backend_options</code></entry>
-                          <entry><code>array</code></entry>
-                          <entry><code>array()</code></entry>
+                          <entry><emphasis>slow_backend_options</emphasis></entry>
+                          <entry><type>Array</type></entry>
+                          <entry><methodname>array()</methodname></entry>
                           <entry>
                               the "slow" backend options
                           </entry>
                       </row>
                       <row>
-                          <entry><code>fast_backend_options</code></entry>
-                          <entry><code>array</code></entry>
-                          <entry><code>array()</code></entry>
+                          <entry><emphasis>fast_backend_options</emphasis></entry>
+                          <entry><type>Array</type></entry>
+                          <entry><methodname>array()</methodname></entry>
                           <entry>
                               the "fast" backend options
                           </entry>
                       </row>
                       <row>
-                          <entry><code>slow_backend_custom_naming</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>false</code></entry>
+                          <entry><emphasis>slow_backend_custom_naming</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>FALSE</constant></entry>
                           <entry>
                               if true, the slow_backend argument is used as a complete class name ; if false,
                               the frontend argument is used as the end of "Zend_Cache_Backend_[...]"
@@ -378,9 +376,9 @@ $cache = Zend_Cache::factory('Core', 'Zend Platform');
                           </entry>
                       </row>
                       <row>
-                          <entry><code>fast_backend_custom_naming</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>false</code></entry>
+                          <entry><emphasis>fast_backend_custom_naming</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>FALSE</constant></entry>
                           <entry>
                               if true, the fast_backend argument is used as a complete class name ; if false,
                               the frontend argument is used as the end of "Zend_Cache_Backend_[...]"
@@ -388,35 +386,35 @@ $cache = Zend_Cache::factory('Core', 'Zend Platform');
                           </entry>
                       </row>
                       <row>
-                          <entry><code>slow_backend_autoload</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>false</code></entry>
+                          <entry><emphasis>slow_backend_autoload</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>FALSE</constant></entry>
                           <entry>
                               if true, there will no require_once for the slow backend
                               (useful only for custom backends)
                           </entry>
                       </row>
                       <row>
-                          <entry><code>fast_backend_autoload</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>false</code></entry>
+                          <entry><emphasis>fast_backend_autoload</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>FALSE</constant></entry>
                           <entry>
                               if true, there will no require_once for the fast backend
                               (useful only for custom backends)
                           </entry>
                       </row>
                       <row>
-                          <entry><code>auto_refresh_fast_cache</code></entry>
-                          <entry><code>boolean</code></entry>
-                          <entry><code>true</code></entry>
+                          <entry><emphasis>auto_refresh_fast_cache</emphasis></entry>
+                          <entry><type>Boolean</type></entry>
+                          <entry><constant>TRUE</constant></entry>
                           <entry>
                               if true, auto refresh the fast cache when a cache record is hit
                           </entry>
                       </row>
                       <row>
-                          <entry><code>stats_update_factor</code></entry>
-                          <entry><code>integer</code></entry>
-                          <entry><code>10</code></entry>
+                          <entry><emphasis>stats_update_factor</emphasis></entry>
+                          <entry><type>Integer</type></entry>
+                          <entry>10</entry>
                           <entry>
                               disable / tune the computation of the fast backend filling percentage
                               (when saving a record into cache, computation of the fast backend filling percentage

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

@@ -35,20 +35,20 @@
                      </thead>
                      <tbody>
                           <row>
-                              <entry><code>caching</code></entry>
-                              <entry><code>boolean</code></entry>
-                              <entry><code>true</code></entry>
+                              <entry><emphasis>caching</emphasis></entry>
+                              <entry><type>Boolean</type></entry>
+                              <entry><constant>TRUE</constant></entry>
                               <entry>
                                   enable / disable caching (can be very useful for the debug of
                                   cached scripts)
                               </entry>
                           </row>
                           <row>
-                              <entry><code>cache_id_prefix</code></entry>
-                              <entry><code>string</code></entry>
-                              <entry><code>null</code></entry>
+                              <entry><emphasis>cache_id_prefix</emphasis></entry>
+                              <entry><type>String</type></entry>
+                              <entry><constant>NULL</constant></entry>
                               <entry>
-                                A prefix for all cache ids, if set to <code>null</code>, no
+                                A prefix for all cache ids, if set to <constant>null</constant>, no
                                 cache id prefix will be used. The cache id prefix essentially creates
                                 a namespace in the cache, allowing multiple applications or websites
                                 to use a shared cache. Each application or website can use a different
@@ -56,11 +56,11 @@
                               </entry>
                           </row>
                           <row>
-                              <entry><code>lifetime</code></entry>
-                              <entry><code>int</code></entry>
-                              <entry><code>3600</code></entry>
+                              <entry><emphasis>lifetime</emphasis></entry>
+                              <entry><type>Integer</type></entry>
+                              <entry>3600</entry>
                               <entry>
-                                cache lifetime (in seconds), if set to <code>null</code>, the
+                                cache lifetime (in seconds), if set to <constant>NULL</constant>, the
                                 cache is valid forever.
                               </entry>
                           </row>