[MANUAL] English:

- structural fixes (no translations needed)

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

documentation/manual/en/module_specs/Zend_Json-Basics.xml

@@ -22,10 +22,10 @@ $json = Zend_Json::encode($phpNative);
 
         <para>
             Sometimes, it may be hard to explore <acronym>JSON</acronym> data generated by
-            <methodname>Zend_Json::encode()</methodname>,
-            since it has no spacing or indentation. In order to make it easier, <classname>Zend_Json</classname>
-            allows you to pretty-print <acronym>JSON</acronym> data in the human-readable format
-            with <methodname>Zend_Json::prettyPrint()</methodname>.
+            <methodname>Zend_Json::encode()</methodname>, since it has no spacing or indentation.
+            In order to make it easier, <classname>Zend_Json</classname> allows you to pretty-print
+            <acronym>JSON</acronym> data in the human-readable format with
+            <methodname>Zend_Json::prettyPrint()</methodname>.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -37,8 +37,9 @@ if($debug) {
 ]]></programlisting>
 
         <para>
-            Second optional argument of <methodname>Zend_Json::prettyPrint()</methodname> is an option array.
-            Option <code>indent</code> allows to set indentation string - by default it's a single tab character.
+            Second optional argument of <methodname>Zend_Json::prettyPrint()</methodname> is an
+            option array. Option <code>indent</code> allows to set indentation string - by default
+            it's a single tab character.
         </para>
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Json-Introduction.xml

@@ -2,12 +2,14 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.json.introduction">
     <title>Introduction</title>
+
     <para>
-        <classname>Zend_Json</classname> provides convenience methods for serializing
-        native <acronym>PHP</acronym> to <acronym>JSON</acronym> and decoding <acronym>JSON</acronym> to native <acronym>PHP</acronym>. For more information
-        on <acronym>JSON</acronym>, <ulink url="http://www.json.org/">visit the <acronym>JSON</acronym> project
-        site</ulink>.
+        <classname>Zend_Json</classname> provides convenience methods for serializing native
+        <acronym>PHP</acronym> to <acronym>JSON</acronym> and decoding <acronym>JSON</acronym> to
+        native <acronym>PHP</acronym>. For more information on <acronym>JSON</acronym>, <ulink
+            url="http://www.json.org/">visit the <acronym>JSON</acronym> project site</ulink>.
     </para>
+
     <para>
         <acronym>JSON</acronym>, JavaScript Object Notation, can be used for data
         interchange between JavaScript and other languages. Since <acronym>JSON</acronym> can be
@@ -17,15 +19,14 @@
 
     <para>
         In addition, <classname>Zend_Json</classname> provides a useful way to convert any
-        arbitrary <acronym>XML</acronym> formatted string into a <acronym>JSON</acronym> formatted string. This built-in
-        feature will enable <acronym>PHP</acronym> developers to transform the enterprise data
-        encoded in <acronym>XML</acronym> format into <acronym>JSON</acronym> format before sending it to browser-based
-        Ajax client applications. It provides an easy way to do dynamic data
-        conversion on the server-side code thereby avoiding unnecessary <acronym>XML</acronym>
-        parsing in the browser-side applications. It offers a nice utility
+        arbitrary <acronym>XML</acronym> formatted string into a <acronym>JSON</acronym> formatted
+        string. This built-in feature will enable <acronym>PHP</acronym> developers to transform the
+        enterprise data encoded in <acronym>XML</acronym> format into <acronym>JSON</acronym> format
+        before sending it to browser-based Ajax client applications. It provides an easy way to do
+        dynamic data conversion on the server-side code thereby avoiding unnecessary
+        <acronym>XML</acronym> parsing in the browser-side applications. It offers a nice utility
         function that results in easier application-specific data processing techniques.
     </para>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

documentation/manual/en/module_specs/Zend_Json-Objects.xml

@@ -5,10 +5,12 @@
 
     <sect2 id="zend.json.advanced.objects1">
         <title>JSON Objects</title>
+
         <para>
-            When encoding <acronym>PHP</acronym> objects as <acronym>JSON</acronym>, all public properties of that object
-            will be encoded in a <acronym>JSON</acronym> object.
+            When encoding <acronym>PHP</acronym> objects as <acronym>JSON</acronym>, all public
+            properties of that object will be encoded in a <acronym>JSON</acronym> object.
         </para>
+
         <para>
             <acronym>JSON</acronym> does not allow object references, so care should be taken not to
             encode objects with recursive references. If you have issues with
@@ -17,28 +19,32 @@
             parameter to check for recursion; if an object is serialized twice, an
             exception will be thrown.
         </para>
+
         <para>
             Decoding <acronym>JSON</acronym> objects poses an additional difficulty, however, since
-            Javascript objects correspond most closely to <acronym>PHP</acronym>'s associative array.
-            Some suggest that a class identifier should be passed, and an object
+            Javascript objects correspond most closely to <acronym>PHP</acronym>'s associative
+            array. Some suggest that a class identifier should be passed, and an object
             instance of that class should be created and populated with the
             key/value pairs of the <acronym>JSON</acronym> object; others feel this could pose a
             substantial security risk.
         </para>
+
         <para>
-            By default, <classname>Zend_Json</classname> will decode <acronym>JSON</acronym> objects as
-            associative arrays. However, if you desire an object returned, you can
-            specify this:
+            By default, <classname>Zend_Json</classname> will decode <acronym>JSON</acronym> objects
+            as associative arrays. However, if you desire an object returned, you can specify this:
         </para>
+
         <programlisting language="php"><![CDATA[
 // Decode JSON objects as PHP objects
 $phpNative = Zend_Json::decode($encodedValue, Zend_Json::TYPE_OBJECT);
 ]]></programlisting>
+
         <para>
             Any objects thus decoded are returned as <code>StdClass</code> objects
             with properties corresponding to the key/value pairs in the <acronym>JSON</acronym>
             notation.
         </para>
+
         <para>
             The recommendation of Zend Framework is that the individual
             developer should decide how to decode <acronym>JSON</acronym> objects. If an object of a
@@ -53,9 +59,9 @@ $phpNative = Zend_Json::decode($encodedValue, Zend_Json::TYPE_OBJECT);
         <para>
             If you are encoding <acronym>PHP</acronym> objects by default the encoding mechanism
             can only access public properties of these objects. When a method
-            <methodname>toJson()</methodname> is implemented on an object to encode, <classname>Zend_Json</classname>
-            calls this method and expects the object to return a <acronym>JSON</acronym> representation
-            of its internal state.
+            <methodname>toJson()</methodname> is implemented on an object to encode,
+            <classname>Zend_Json</classname> calls this method and expects the object to return a
+            <acronym>JSON</acronym> representation of its internal state.
         </para>
     </sect2>
 
@@ -63,13 +69,13 @@ $phpNative = Zend_Json::decode($encodedValue, Zend_Json::TYPE_OBJECT);
         <title>Internal Encoder/Decoder</title>
 
         <para>
-            <classname>Zend_Json</classname> has two different modes depending if ext/json is enabled in
-            your <acronym>PHP</acronym> installation or not. If ext/json is installed by default
-            <methodname>json_encode()</methodname> and <methodname>json_decode()</methodname> functions
-            are used for encoding and decoding <acronym>JSON</acronym>. If ext/json is not installed
-            a Zend Framework implementation in <acronym>PHP</acronym> code is used for en-/decoding.
-            This is considerably slower than using the php extension, but behaves
-            exactly the same.
+            <classname>Zend_Json</classname> has two different modes depending if ext/json is
+            enabled in your <acronym>PHP</acronym> installation or not. If ext/json is installed by
+            default <methodname>json_encode()</methodname> and
+            <methodname>json_decode()</methodname> functions are used for encoding and decoding
+            <acronym>JSON</acronym>. If ext/json is not installed a Zend Framework implementation in
+            <acronym>PHP</acronym> code is used for en-/decoding. This is considerably slower than
+            using the php extension, but behaves exactly the same.
         </para>
 
         <para>
@@ -86,21 +92,22 @@ Zend_Json::$useBuiltinEncoderDecoder = true:
         <title>JSON Expressions</title>
 
         <para>
-            Javascript makes heavy use of anonymnous function callbacks, which
-            can be saved within <acronym>JSON</acronym> object variables. Still they only work if not
+            Javascript makes heavy use of anonymnous function callbacks, which can be saved
+            within <acronym>JSON</acronym> object variables. Still they only work if not
             returned inside double qoutes, which <classname>Zend_Json</classname> naturally does.
-            With the Expression support for <classname>Zend_Json</classname> support you can encode <acronym>JSON</acronym>
-            objects with valid javascript callbacks. This works for both <methodname>json_encode()</methodname>
-            or the internal encoder.
+            With the Expression support for <classname>Zend_Json</classname> support you can encode
+            <acronym>JSON</acronym> objects with valid javascript callbacks. This works for both
+            <methodname>json_encode()</methodname> or the internal encoder.
         </para>
 
         <para>
-            A javascript callback is represented using the <classname>Zend_Json_Expr</classname> object.
-            It implements the value object pattern and is immutable. You can set the javascript
-            expression as the first constructor argument. By default <classname>Zend_Json::encode</classname>
-            does not encode javascript callbacks, you have to pass the option <code>'enableJsonExprFinder' = true</code>
-            into the <code>encode</code> function. If enabled the expression support works for all nested expressions
-            in large object structures. A usage example would look like:
+            A javascript callback is represented using the <classname>Zend_Json_Expr</classname>
+            object. It implements the value object pattern and is immutable. You can set the
+            javascript expression as the first constructor argument. By default
+            <classname>Zend_Json::encode</classname> does not encode javascript callbacks, you have
+            to pass the option <code>'enableJsonExprFinder' = true</code> into the
+            <code>encode</code> function. If enabled the expression support works for all nested
+            expressions in large object structures. A usage example would look like:
         </para>
 
         <programlisting language="php"><![CDATA[

documentation/manual/en/module_specs/Zend_Json-Server.xml

@@ -5,13 +5,13 @@
 
     <para>
         <classname>Zend_Json_Server</classname> is a <ulink
-            url="http://groups.google.com/group/json-rpc/">JSON-RPC</ulink>
-        server implementation. It supports both the
-        <ulink url="http://json-rpc.org/wiki/specification">JSON-RPC
-            version 1 specification</ulink> as well as the
-        <ulink url="http://groups.google.com/group/json-rpc/web/json-rpc-1-2-proposal">version 2 specification</ulink>;
-        additionally, it provides a <acronym>PHP</acronym> implementation of the
-        <ulink url="http://groups.google.com/group/json-schema/web/service-mapping-description-proposal">Service
+            url="http://groups.google.com/group/json-rpc/">JSON-RPC</ulink> server implementation.
+        It supports both the <ulink url="http://json-rpc.org/wiki/specification">JSON-RPC
+            version 1 specification</ulink> as well as the <ulink
+            url="http://groups.google.com/group/json-rpc/web/json-rpc-1-2-proposal">version 2
+            specification</ulink>; additionally, it provides a <acronym>PHP</acronym> implementation
+        of the <ulink
+            url="http://groups.google.com/group/json-schema/web/service-mapping-description-proposal">Service
             Mapping Description (SMD) specification</ulink>
         for providing service metadata to service consumers.
     </para>
@@ -26,14 +26,17 @@
 
     <itemizedlist>
         <listitem><para>Instantiate the server object</para></listitem>
-        <listitem><para>Attach one or more functions and/or classes/objects to
-                the server object</para></listitem>
+
+        <listitem>
+            <para>Attach one or more functions and/or classes/objects to the server object</para>
+        </listitem>
+
         <listitem><para>handle() the request</para></listitem>
     </itemizedlist>
 
     <para>
-        <classname>Zend_Json_Server</classname> utilizes <xref linkend="zend.server.reflection" /> to
-        perform reflection on any attached classes or functions, and uses that
+        <classname>Zend_Json_Server</classname> utilizes <xref linkend="zend.server.reflection" />
+        to perform reflection on any attached classes or functions, and uses that
         information to build both the SMD and enforce method call signatures. As
         such, it is imperative that any attached functions and/or class methods
         have full <acronym>PHP</acronym> docblocks documenting, minimally:
@@ -213,39 +216,95 @@ $server->handle();
             </para>
 
             <itemizedlist>
-                <listitem><para><methodname>addFunction($function)</methodname>: Specify a
-                        userland function to attach to the server.</para></listitem>
-                <listitem><para><methodname>setClass($class)</methodname>: Specify a class
+                <listitem>
+                    <para>
+                        <methodname>addFunction($function)</methodname>: Specify a
+                        userland function to attach to the server.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setClass($class)</methodname>: Specify a class
                         or object to attach to the server; all public methods of
-                        that item will be exposed as JSON-RPC methods.</para></listitem>
-                <listitem><para><code>fault($fault = null, $code = 404, $data =
-                        null)</code>: Create and return a
-                        <classname>Zend_Json_Server_Error</classname> object.</para></listitem>
-                <listitem><para><methodname>handle($request = false)</methodname>: Handle a
+                        that item will be exposed as JSON-RPC methods.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <code>fault($fault = null, $code = 404, $data = null)</code>: Create and
+                        return a <classname>Zend_Json_Server_Error</classname> object.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>handle($request = false)</methodname>: Handle a
                         JSON-RPC request; optionally, pass a
                         <classname>Zend_Json_Server_Request</classname> object to utilize
-                        (creates one by default).</para></listitem>
-                <listitem><para><methodname>getFunctions()</methodname>: Return a list of
-                        all attached methods.</para></listitem>
-                <listitem><para><code>setRequest(Zend_Json_Server_Request
-                        $request)</code>: Specify a request object for the
-                        server to utilize.</para></listitem>
-                <listitem><para><methodname>getRequest()</methodname>: Retrieve the request
-                        object used by the server.</para></listitem>
-                <listitem><para><code>setResponse(Zend_Json_Server_Response
-                        $response)</code>: Set the response object for the
-                        server to utilize.</para></listitem>
-                <listitem><para><methodname>getResponse()</methodname>: Retrieve the
-                        response object used by the server.</para></listitem>
-                <listitem><para><methodname>setAutoEmitResponse($flag)</methodname>:
+                        (creates one by default).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getFunctions()</methodname>: Return a list of
+                        all attached methods.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <code>setRequest(Zend_Json_Server_Request $request)</code>: Specify a
+                        request object for the server to utilize.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getRequest()</methodname>: Retrieve the request
+                        object used by the server.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <code>setResponse(Zend_Json_Server_Response $response)</code>: Set the
+                        response object for the server to utilize.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getResponse()</methodname>: Retrieve the
+                        response object used by the server.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setAutoEmitResponse($flag)</methodname>:
                         Indicate whether the server should automatically emit
                         the response and all headers; by default, this is
-                        <constant>TRUE</constant>.</para></listitem>
-                <listitem><para><methodname>autoEmitResponse()</methodname>: Determine if
-                        auto-emission of the response is enabled.</para></listitem>
-                <listitem><para><methodname>getServiceMap()</methodname>: Retrieve the
+                        <constant>TRUE</constant>.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>autoEmitResponse()</methodname>: Determine if
+                        auto-emission of the response is enabled.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getServiceMap()</methodname>: Retrieve the
                         service map description in the form of a
-                        <classname>Zend_Json_Server_Smd</classname> object</para></listitem>
+                        <classname>Zend_Json_Server_Smd</classname> object
+                    </para>
+                </listitem>
             </itemizedlist>
         </sect3>
 
@@ -258,8 +317,8 @@ $server->handle();
                 you to set necessary portions of the JSON-RPC request, including
                 the request ID, parameters, and JSON-RPC specification version.
                 It has the ability to load itself via <acronym>JSON</acronym> or a set of options,
-                and can render itself as <acronym>JSON</acronym> via the <methodname>toJson()</methodname>
-                method.
+                and can render itself as <acronym>JSON</acronym> via the
+                <methodname>toJson()</methodname> method.
             </para>
 
             <para>
@@ -267,55 +326,121 @@ $server->handle();
             </para>
 
             <itemizedlist>
-                <listitem><para><methodname>setOptions(array $options)</methodname>: Specify
+                <listitem>
+                    <para>
+                        <methodname>setOptions(array $options)</methodname>: Specify
                         object configuration. <varname>$options</varname> may contain
                         keys matching any 'set' method:
                         <methodname>setParams()</methodname>, <methodname>setMethod()</methodname>,
                         <methodname>setId()</methodname>, and
-                        <methodname>setVersion()</methodname>.</para></listitem>
-                <listitem><para><methodname>addParam($value, $key = null)</methodname>: Add
+                        <methodname>setVersion()</methodname>.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>addParam($value, $key = null)</methodname>: Add
                         a parameter to use with the method call. Parameters can be
-                        just the values, or can optionally include the parameter
-                        name.</para></listitem>
-                <listitem><para><methodname>addParams(array $params)</methodname>: Add
+                        just the values, or can optionally include the parameter name.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>addParams(array $params)</methodname>: Add
                         multiple parameters at once; proxies to
-                        <methodname>addParam()</methodname></para></listitem>
-                <listitem><para><methodname>setParams(array $params)</methodname>: Set all
-                        parameters at once; overwrites any existing
-                        parameters.</para></listitem>
-                <listitem><para><methodname>getParam($index)</methodname>: Retrieve a
-                        parameter by position or name.</para></listitem>
-                <listitem><para><methodname>getParams()</methodname>: Retrieve all
-                        parameters at once.</para></listitem>
-                <listitem><para><methodname>setMethod($name)</methodname>: Set the method to
-                        call.</para></listitem>
-                <listitem><para><methodname>getMethod()</methodname>: Retrieve the method
-                        that will be called.</para></listitem>
-                <listitem><para><methodname>isMethodError()</methodname>: Determine whether
-                        or not the request is malformed and would result in an
-                        error.</para></listitem>
-                <listitem><para><methodname>setId($name)</methodname>: Set the request
-                        identifier (used by the client to match requests to
-                        responses).</para></listitem>
-                <listitem><para><methodname>getId()</methodname>: Retrieve the request
-                        identifier.</para></listitem>
-                <listitem><para><methodname>setVersion($version)</methodname>: Set the
+                        <methodname>addParam()</methodname>
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setParams(array $params)</methodname>: Set all
+                        parameters at once; overwrites any existing parameters.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getParam($index)</methodname>: Retrieve a
+                        parameter by position or name.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getParams()</methodname>: Retrieve all parameters at once.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setMethod($name)</methodname>: Set the method to call.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getMethod()</methodname>: Retrieve the method
+                        that will be called.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>isMethodError()</methodname>: Determine whether
+                        or not the request is malformed and would result in an error.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setId($name)</methodname>: Set the request
+                        identifier (used by the client to match requests to responses).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getId()</methodname>: Retrieve the request identifier.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setVersion($version)</methodname>: Set the
                         JSON-RPC specification version the request conforms to.
-                        May be either '1.0' or '2.0'.</para></listitem>
-                <listitem><para><methodname>getVersion()</methodname>: Retrieve the JSON-RPC
-                        specification version used by the
-                        request.</para></listitem>
-                <listitem><para><methodname>loadJson($json)</methodname>: Load the request
-                        object from a <acronym>JSON</acronym> string.</para></listitem>
-                <listitem><para><methodname>toJson()</methodname>: Render the request as
-                        a <acronym>JSON</acronym> string.</para></listitem>
+                        May be either '1.0' or '2.0'.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getVersion()</methodname>: Retrieve the JSON-RPC
+                        specification version used by the request.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>loadJson($json)</methodname>: Load the request
+                        object from a <acronym>JSON</acronym> string.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toJson()</methodname>: Render the request as
+                        a <acronym>JSON</acronym> string.
+                    </para>
+                </listitem>
             </itemizedlist>
 
             <para>
                 An <acronym>HTTP</acronym> specific version is available via
                 <classname>Zend_Json_Server_Request_Http</classname>. This class will
-                retrieve the request via <code>php://input</code>, and allows
-                access to the raw <acronym>JSON</acronym> via the <methodname>getRawJson()</methodname> method.
+                retrieve the request via <code>php://input</code>, and allows access to the raw
+                <acronym>JSON</acronym> via the <methodname>getRawJson()</methodname> method.
             </para>
         </sect3>
 
@@ -336,33 +461,87 @@ $server->handle();
             </para>
 
             <itemizedlist>
-                <listitem><para><methodname>setResult($value)</methodname>: Set the response
-                    result.</para></listitem>
-                <listitem><para><methodname>getResult()</methodname>: Retrieve the response
-                    result.</para></listitem>
-                <listitem><para><code>setError(Zend_Json_Server_Error
-                    $error)</code>: Set an error object. If set, this will be
-                    used as the response when serializing to <acronym>JSON</acronym>.</para></listitem>
-                <listitem><para><methodname>getError()</methodname>: Retrieve the error
-                    object, if any.</para></listitem>
-                <listitem><para><methodname>isError()</methodname>: Whether or not the
-                    response is an error response.</para></listitem>
-                <listitem><para><methodname>setId($name)</methodname>: Set the request
-                    identifier (so the client may match the response with
-                    the original request).</para></listitem>
-                <listitem><para><methodname>getId()</methodname>: Retrieve the request
-                    identifier.</para></listitem>
-                <listitem><para><methodname>setVersion($version)</methodname>: Set the
-                    JSON-RPC version the response conforms to.</para></listitem>
-                <listitem><para><methodname>getVersion()</methodname>: Retrieve the JSON-RPC
-                    version the response conforms to.</para></listitem>
-                <listitem><para><methodname>toJson()</methodname>: Serialize the response to
-                    <acronym>JSON</acronym>. If the response is an error response, serializes the
-                    error object.</para></listitem>
-                <listitem><para><methodname>setServiceMap($serviceMap)</methodname>: Set the
-                    service map object for the response.</para></listitem>
-                <listitem><para><methodname>getServiceMap()</methodname>: Retrieve the
-                    service map object, if any.</para></listitem>
+                <listitem>
+                    <para>
+                        <methodname>setResult($value)</methodname>: Set the response result.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getResult()</methodname>: Retrieve the response result.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <code>setError(Zend_Json_Server_Error $error)</code>: Set an error object.
+                        If set, this will be used as the response when serializing to
+                        <acronym>JSON</acronym>.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getError()</methodname>: Retrieve the error object, if any.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>isError()</methodname>: Whether or not the response is an error
+                        response.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setId($name)</methodname>: Set the request identifier (so the
+                        client may match the response with the original request).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getId()</methodname>: Retrieve the request identifier.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setVersion($version)</methodname>: Set the
+                        JSON-RPC version the response conforms to.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getVersion()</methodname>: Retrieve the JSON-RPC
+                        version the response conforms to.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toJson()</methodname>: Serialize the response to
+                        <acronym>JSON</acronym>. If the response is an error response, serializes
+                        the error object.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setServiceMap($serviceMap)</methodname>: Set the
+                        service map object for the response.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getServiceMap()</methodname>: Retrieve the
+                        service map object, if any.
+                    </para>
+                </listitem>
             </itemizedlist>
 
             <para>
@@ -397,25 +576,59 @@ $server->handle();
             </para>
 
             <itemizedlist>
-                <listitem><para><methodname>setCode($code)</methodname>: Set the error code;
-                    if the code is not in the accepted XML-RPC error code range,
-                    -32000 will be assigned.</para></listitem>
-                <listitem><para><methodname>getCode()</methodname>: Retrieve the current
-                    error code.</para></listitem>
-                <listitem><para><methodname>setMessage($message)</methodname>: Set the error
-                    message.</para></listitem>
-                <listitem><para><methodname>getMessage()</methodname>: Retrieve the current
-                    error message.</para></listitem>
-                <listitem><para><methodname>setData($data)</methodname>: Set auxiliary data
-                    further qualifying the error, such as a
-                    backtrace.</para></listitem>
-                <listitem><para><methodname>getData()</methodname>: Retrieve any current
-                    auxiliary error data.</para></listitem>
-                <listitem><para><methodname>toArray()</methodname>: Cast the error to an
-                    array. The array will contain the keys 'code', 'message',
-                    and 'data'.</para></listitem>
-                <listitem><para><methodname>toJson()</methodname>: Cast the error to a
-                    JSON-RPC error representation.</para></listitem>
+                <listitem>
+                    <para>
+                        <methodname>setCode($code)</methodname>: Set the error code;
+                        if the code is not in the accepted XML-RPC error code range,
+                        -32000 will be assigned.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getCode()</methodname>: Retrieve the current error code.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setMessage($message)</methodname>: Set the error message.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getMessage()</methodname>: Retrieve the current error message.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setData($data)</methodname>: Set auxiliary data
+                        further qualifying the error, such as a backtrace.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getData()</methodname>: Retrieve any current auxiliary error
+                        data.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toArray()</methodname>: Cast the error to an
+                        array. The array will contain the keys 'code', 'message', and 'data'.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toJson()</methodname>: Cast the error to a
+                        JSON-RPC error representation.
+                    </para>
+                </listitem>
             </itemizedlist>
         </sect3>
 
@@ -474,42 +687,99 @@ $server->handle();
             </para>
 
             <itemizedlist>
-                <listitem><para><methodname>setOptions(array $options)</methodname>: Setup
+                <listitem>
+                    <para>
+                        <methodname>setOptions(array $options)</methodname>: Setup
                         an SMD object from an array of options. All mutators
-                        (methods beginning with 'set') can be used as
-                        keys.</para></listitem>
-                <listitem><para><methodname>setTransport($transport)</methodname>: Set the
-                        transport used to access the service; only POST is
-                        currently supported.</para></listitem>
-                <listitem><para><methodname>getTransport()</methodname>: Get the current
-                        service transport.</para></listitem>
-                <listitem><para><methodname>setEnvelope($envelopeType)</methodname>: Set the
+                        (methods beginning with 'set') can be used as keys.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setTransport($transport)</methodname>: Set the
+                        transport used to access the service; only POST is currently supported.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getTransport()</methodname>: Get the current service transport.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setEnvelope($envelopeType)</methodname>: Set the
                         request envelope that should be used to access the
                         service. Currently, supports the constants
                         <constant>Zend_Json_Server_Smd::ENV_JSONRPC_1</constant> and
-                        <constant>Zend_Json_Server_Smd::ENV_JSONRPC_2</constant>.</para></listitem>
-                <listitem><para><methodname>getEnvelope()</methodname>: Get the current
-                        request envelope.</para></listitem>
-                <listitem><para><methodname>setContentType($type)</methodname>: Set the
-                        content type requests should use (by default, this is
-                        'application/json').</para></listitem>
-                <listitem><para><methodname>getContentType()</methodname>: Get the current
-                        content type for requests to the service.</para></listitem>
-                <listitem><para><methodname>setTarget($target)</methodname>: Set the <acronym>URL</acronym>
-                        endpoint for the service.</para></listitem>
-                <listitem><para><methodname>getTarget()</methodname>: Get the <acronym>URL</acronym> endpoint
-                        for the service.</para></listitem>
-                <listitem><para><methodname>setId($id)</methodname>: Typically, this is the
-                        <acronym>URL</acronym> endpoint of the service (same as the
-                        target).</para></listitem>
-                <listitem><para><methodname>getId()</methodname>: Retrieve the service ID
-                        (typically the <acronym>URL</acronym> endpoint of the
-                        service).</para></listitem>
-                <listitem><para><methodname>setDescription($description)</methodname>: Set a
+                        <constant>Zend_Json_Server_Smd::ENV_JSONRPC_2</constant>.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getEnvelope()</methodname>: Get the current request envelope.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setContentType($type)</methodname>: Set the
+                        content type requests should use (by default, this is 'application/json').
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getContentType()</methodname>: Get the current
+                        content type for requests to the service.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setTarget($target)</methodname>: Set the <acronym>URL</acronym>
+                        endpoint for the service.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getTarget()</methodname>: Get the <acronym>URL</acronym>
+                        endpoint for the service.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setId($id)</methodname>: Typically, this is the
+                        <acronym>URL</acronym> endpoint of the service (same as the target).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getId()</methodname>: Retrieve the service ID
+                        (typically the <acronym>URL</acronym> endpoint of the service).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setDescription($description)</methodname>: Set a
                         service description (typically narrative information
-                        describing the purpose of the service).</para></listitem>
-                <listitem><para><methodname>getDescription()</methodname>: Get the service
-                        description.</para></listitem>
+                        describing the purpose of the service).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getDescription()</methodname>: Get the service description.
+                    </para>
+                </listitem>
+
                 <listitem>
                     <para>
                         <methodname>setDojoCompatible($flag)</methodname>: Set a flag indicating
@@ -518,31 +788,76 @@ $server->handle();
                         be formatted to comply with the format that Dojo's JSON-RPC client expects.
                     </para>
                 </listitem>
-                <listitem><para><methodname>isDojoCompatible()</methodname>: Returns the
-                        value of the Dojo compatibility flag (<constant>FALSE</constant>, by
-                        default).</para></listitem>
-                <listitem><para><methodname>addService($service)</methodname>: Add a service
+
+                <listitem>
+                    <para>
+                        <methodname>isDojoCompatible()</methodname>: Returns the value of the
+                        Dojo compatibility flag (<constant>FALSE</constant>, by default).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>addService($service)</methodname>: Add a service
                         to the map. May be an array of information to pass to
                         the constructor of
                         <classname>Zend_Json_Server_Smd_Service</classname>, or an
-                        instance of that class.</para></listitem>
-                <listitem><para><methodname>addServices(array $services)</methodname>: Add
-                        multiple services at once.</para></listitem>
-                <listitem><para><methodname>setServices(array $services)</methodname>: Add
-                        multiple services at once, overwriting any previously
-                        set services.</para></listitem>
-                <listitem><para><methodname>getService($name)</methodname>: Get a service by
-                        its name.</para></listitem>
-                <listitem><para><methodname>getServices()</methodname>: Get all attached
-                        services.</para></listitem>
-                <listitem><para><methodname>removeService($name)</methodname>: Remove a
-                        service from the map.</para></listitem>
-                <listitem><para><methodname>toArray()</methodname>: Cast the service map to
-                        an array.</para></listitem>
-                <listitem><para><methodname>toDojoArray()</methodname>: Cast the service map
-                        to an array compatible with Dojo Toolkit.</para></listitem>
-                <listitem><para><methodname>toJson()</methodname>: Cast the service map to a
-                        <acronym>JSON</acronym> representation.</para></listitem>
+                        instance of that class.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>addServices(array $services)</methodname>: Add
+                        multiple services at once.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setServices(array $services)</methodname>: Add
+                        multiple services at once, overwriting any previously set services.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getService($name)</methodname>: Get a service by its name.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getServices()</methodname>: Get all attached services.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>removeService($name)</methodname>: Remove a
+                        service from the map.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toArray()</methodname>: Cast the service map to an array.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toDojoArray()</methodname>: Cast the service map
+                        to an array compatible with Dojo Toolkit.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toJson()</methodname>: Cast the service map to a
+                        <acronym>JSON</acronym> representation.
+                    </para>
+                </listitem>
             </itemizedlist>
 
             <para>
@@ -551,65 +866,157 @@ $server->handle();
             </para>
 
             <itemizedlist>
-                <listitem><para><methodname>setOptions(array $options)</methodname>: Set
+                <listitem>
+                    <para>
+                        <methodname>setOptions(array $options)</methodname>: Set
                         object state from an array. Any mutator (methods
-                        beginning with 'set') may be used as a key and set via
-                        this method.</para></listitem>
-                <listitem><para><methodname>setName($name)</methodname>: Set the service
-                        name (typically, the function or method name).</para></listitem>
-                <listitem><para><methodname>getName()</methodname>: Retrieve the service
-                        name.</para></listitem>
-                <listitem><para><methodname>setTransport($transport)</methodname>: Set the
+                        beginning with 'set') may be used as a key and set via this method.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setName($name)</methodname>: Set the service
+                        name (typically, the function or method name).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getName()</methodname>: Retrieve the service name.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setTransport($transport)</methodname>: Set the
                         service transport (currently, only transports supported
-                        by <classname>Zend_Json_Server_Smd</classname> are allowed).</para></listitem>
-                <listitem><para><methodname>getTransport()</methodname>: Retrieve the
-                        current transport.</para></listitem>
-                <listitem><para><methodname>setTarget($target)</methodname>: Set the <acronym>URL</acronym>
+                        by <classname>Zend_Json_Server_Smd</classname> are allowed).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getTransport()</methodname>: Retrieve the current transport.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setTarget($target)</methodname>: Set the <acronym>URL</acronym>
                         endpoint of the service (typically, this will be the
-                        same as the overall SMD to which the service is
-                        attached).</para></listitem>
-                <listitem><para><methodname>getTarget()</methodname>: Get the <acronym>URL</acronym> endpoint
-                        of the service.</para></listitem>
-                <listitem><para><methodname>setEnvelope($envelopeType)</methodname>: Set the
+                        same as the overall SMD to which the service is attached).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getTarget()</methodname>: Get the <acronym>URL</acronym>
+                        endpoint of the service.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setEnvelope($envelopeType)</methodname>: Set the
                         service envelope (currently, only envelopes supported
-                        by <classname>Zend_Json_Server_Smd</classname> are allowed).</para></listitem>
-                <listitem><para><methodname>getEnvelope()</methodname>: Retrieve the service
-                        envelope type.</para></listitem>
-                <listitem><para><code>addParam($type, array $options = array(),
+                        by <classname>Zend_Json_Server_Smd</classname> are allowed).
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getEnvelope()</methodname>: Retrieve the service envelope type.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <code>addParam($type, array $options = array(),
                             $order = null)</code>: Add a parameter to the
                         service. By default, only the parameter type is
                         necessary. However, you may also specify the order, as
-                        well as options such as:</para>
+                        well as options such as:
+                    </para>
+
                     <itemizedlist>
-                        <listitem><para><emphasis>name</emphasis>: the parameter
-                            name</para></listitem>
-                        <listitem><para><emphasis>optional</emphasis>: whether
-                            or not the parameter is optional</para></listitem>
-                        <listitem><para><emphasis>default</emphasis>: a default
-                            value for the parameter</para></listitem>
-                        <listitem><para><emphasis>description</emphasis>: text
-                            describing the parameter</para></listitem>
+                        <listitem>
+                            <para>
+                                <emphasis>name</emphasis>: the parameter name
+                            </para>
+                        </listitem>
+
+                        <listitem>
+                            <para>
+                                <emphasis>optional</emphasis>: whether or not the parameter is
+                                optional
+                            </para>
+                        </listitem>
+
+                        <listitem>
+                            <para>
+                                <emphasis>default</emphasis>: a default value for the parameter
+                            </para>
+                        </listitem>
+
+                        <listitem>
+                            <para>
+                                <emphasis>description</emphasis>: text describing the parameter
+                            </para>
+                        </listitem>
                     </itemizedlist>
                 </listitem>
-                <listitem><para><methodname>addParams(array $params)</methodname>: Add
-                    several parameters at once; each param should be an assoc
-                    array containing minimally the key 'type' describing the
-                    parameter type, and optionally the key 'order'; any other
-                    keys will be passed as <varname>$options</varname> to
-                    <methodname>addOption()</methodname>.</para></listitem>
-                <listitem><para><methodname>setParams(array $params)</methodname>: Set many
-                    parameters at once, overwriting any existing
-                    parameters.</para></listitem>
-                <listitem><para><methodname>getParams()</methodname>: Retrieve all currently
-                    set parameters.</para></listitem>
-                <listitem><para><methodname>setReturn($type)</methodname>: Set the return
-                    value type of the service.</para></listitem>
-                <listitem><para><methodname>getReturn()</methodname>: Get the return value
-                    type of the service.</para></listitem>
-                <listitem><para><methodname>toArray()</methodname>: Cast the service to an
-                    array.</para></listitem>
-                <listitem><para><methodname>toJson()</methodname>: Cast the service to a
-                    <acronym>JSON</acronym> representation.</para></listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>addParams(array $params)</methodname>: Add
+                        several parameters at once; each param should be an assoc
+                        array containing minimally the key 'type' describing the
+                        parameter type, and optionally the key 'order'; any other
+                        keys will be passed as <varname>$options</varname> to
+                        <methodname>addOption()</methodname>.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setParams(array $params)</methodname>: Set many
+                        parameters at once, overwriting any existing parameters.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getParams()</methodname>: Retrieve all currently set parameters.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>setReturn($type)</methodname>: Set the return
+                        value type of the service.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>getReturn()</methodname>: Get the return value type of the
+                        service.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toArray()</methodname>: Cast the service to an array.
+                    </para>
+                </listitem>
+
+                <listitem>
+                    <para>
+                        <methodname>toJson()</methodname>: Cast the service to a
+                        <acronym>JSON</acronym> representation.
+                    </para>
+                </listitem>
             </itemizedlist>
         </sect3>
     </sect2>

documentation/manual/en/module_specs/Zend_Json-xml2json.xml

@@ -2,21 +2,25 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.json.xml2json">
     <title>XML to JSON conversion</title>
+
     <para>
         <classname>Zend_Json</classname> provides a convenience method for transforming
-        <acronym>XML</acronym> formatted data into <acronym>JSON</acronym> format. This feature was inspired from an
-        <ulink url="http://www.ibm.com/developerworks/xml/library/x-xml2jsonphp/">
+        <acronym>XML</acronym> formatted data into <acronym>JSON</acronym> format. This feature was
+        inspired from an <ulink url="http://www.ibm.com/developerworks/xml/library/x-xml2jsonphp/">
         IBM developerWorks article</ulink>.
     </para>
 
     <para>
-        <classname>Zend_Json</classname> includes a static function called <methodname>Zend_Json::fromXml()</methodname>.
-        This function will generate <acronym>JSON</acronym> from a given <acronym>XML</acronym> input. This function takes any arbitrary
-        <acronym>XML</acronym> string as an input parameter. It also takes an optional boolean input parameter to instruct the
-        conversion logic to ignore or not ignore the <acronym>XML</acronym> attributes during the conversion process. If this
-        optional input parameter is not given, then the default behavior is to ignore the <acronym>XML</acronym> attributes.
-        This function call is made as shown below:
+        <classname>Zend_Json</classname> includes a static function called
+        <methodname>Zend_Json::fromXml()</methodname>. This function will generate
+        <acronym>JSON</acronym> from a given <acronym>XML</acronym> input. This function takes any
+        arbitrary <acronym>XML</acronym> string as an input parameter. It also takes an optional
+        boolean input parameter to instruct the conversion logic to ignore or not ignore the
+        <acronym>XML</acronym> attributes during the conversion process. If this optional input
+        parameter is not given, then the default behavior is to ignore the <acronym>XML</acronym>
+        attributes. This function call is made as shown below:
     </para>
+
     <programlisting language="php"><![CDATA[
 // fromXml function simply takes a String containing XML contents
 // as input.
@@ -24,25 +28,30 @@ $jsonContents = Zend_Json::fromXml($xmlStringContents, true);
 ]]></programlisting>
 
     <para>
-        <methodname>Zend_Json::fromXml()</methodname> function does the conversion of the <acronym>XML</acronym> formatted string input
-        parameter and returns the equivalent <acronym>JSON</acronym> formatted string output. In case of any <acronym>XML</acronym> input format
-        error or conversion logic error, this function will throw an exception. The conversion logic also
-        uses recursive techniques to traverse the <acronym>XML</acronym> tree. It supports recursion upto 25 levels deep.
-        Beyond that depth, it will throw a <classname>Zend_Json_Exception</classname>. There are several <acronym>XML</acronym> files with varying
-        degree of complexity provided in the tests directory of Zend Framework. They can be used to
-        test the functionality of the xml2json feature.
+        <methodname>Zend_Json::fromXml()</methodname> function does the conversion of the
+        <acronym>XML</acronym> formatted string input parameter and returns the equivalent
+        <acronym>JSON</acronym> formatted string output. In case of any <acronym>XML</acronym> input
+        format error or conversion logic error, this function will throw an exception. The
+        conversion logic also uses recursive techniques to traverse the <acronym>XML</acronym> tree.
+        It supports recursion upto 25 levels deep. Beyond that depth, it will throw a
+        <classname>Zend_Json_Exception</classname>. There are several <acronym>XML</acronym> files
+        with varying degree of complexity provided in the tests directory of Zend Framework. They
+        can be used to test the functionality of the xml2json feature.
     </para>
 
     <para>
-        The following is a simple example that shows both the <acronym>XML</acronym> input string passed to
-        and the <acronym>JSON</acronym> output string returned as a result from the
-        <methodname>Zend_Json::fromXml()</methodname> function. This example used the optional function parameter as
-        not to ignore the <acronym>XML</acronym> attributes during the conversion. Hence, you can notice that the
-        resulting <acronym>JSON</acronym> string includes a representation of the <acronym>XML</acronym> attributes present in the <acronym>XML</acronym> input string.
+        The following is a simple example that shows both the <acronym>XML</acronym> input string
+        passed to and the <acronym>JSON</acronym> output string returned as a result from the
+        <methodname>Zend_Json::fromXml()</methodname> function. This example used the optional
+        function parameter as not to ignore the <acronym>XML</acronym> attributes during the
+        conversion. Hence, you can notice that the resulting <acronym>JSON</acronym> string includes
+        a representation of the <acronym>XML</acronym> attributes present in the
+        <acronym>XML</acronym> input string.
     </para>
 
     <para>
-        <acronym>XML</acronym> input string passed to <methodname>Zend_Json::fromXml()</methodname> function:
+        <acronym>XML</acronym> input string passed to <methodname>Zend_Json::fromXml()</methodname>
+        function:
     </para>
 
     <programlisting language="php"><![CDATA[
@@ -69,7 +78,8 @@ $jsonContents = Zend_Json::fromXml($xmlStringContents, true);
 ]]></programlisting>
 
     <para>
-        <acronym>JSON</acronym> output string returned from <methodname>Zend_Json::fromXml()</methodname> function:
+        <acronym>JSON</acronym> output string returned from
+        <methodname>Zend_Json::fromXml()</methodname> function:
     </para>
 
     <programlisting language="php"><![CDATA[
@@ -110,7 +120,6 @@ $jsonContents = Zend_Json::fromXml($xmlStringContents, true);
         Take a look at the
         <ulink url="http://tinyurl.com/2tfa8z">Zend_xml2json proposal</ulink>.
     </para>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

documentation/manual/en/module_specs/Zend_Layout-Advanced.xml

@@ -14,33 +14,41 @@
     </para>
 
     <itemizedlist>
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>Custom view objects.</emphasis>
                 <classname>Zend_Layout</classname> allows you to utilize any class that
                 implements <classname>Zend_View_Interface</classname>.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>Custom front controller plugins.</emphasis>
                 <classname>Zend_Layout</classname> ships with a standard front controller
                 plugin that automates rendering of layouts prior to returning
                 the response. You can substitute your own plugin.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>Custom action helpers.</emphasis>
                 <classname>Zend_Layout</classname> ships with a standard action helper
                 that should be suitable for most needs as it is a dumb proxy
                 to the layout object itself.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>Custom layout script path resolution</emphasis>.
                 <classname>Zend_Layout</classname> allows you to use your own <link
                     linkend="zend.filter.inflector">inflector</link> for layout
                 script path resolution, or simply to modify the attached
                 inflector to specify your own inflection rules.
-        </para></listitem>
+            </para>
+        </listitem>
     </itemizedlist>
 
     <sect2 id="zend.layout.advanced.view">
@@ -158,13 +166,13 @@ $layoutVars   = $placeholders->placeholder('Zend_Layout')->getArrayCopy();
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                    'foo' will be transformed to 'foo.phtml'.
-            </para></listitem>
+            <listitem>
+                <para>'foo' will be transformed to 'foo.phtml'.</para>
+            </listitem>
 
-            <listitem><para>
-                    'FooBarBaz' will be transformed to 'foo-bar-baz.phtml'.
-            </para></listitem>
+            <listitem>
+                <para>'FooBarBaz' will be transformed to 'foo-bar-baz.phtml'.</para>
+            </listitem>
         </itemizedlist>
 
         <para>

documentation/manual/en/module_specs/Zend_Layout-Introduction.xml

@@ -16,35 +16,47 @@
     </para>
 
     <itemizedlist>
-        <listitem><para>
+        <listitem>
+            <para>
                 Automate selection and rendering of layouts when used with the
                 Zend Framework <acronym>MVC</acronym> components.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 Provide separate scope for layout related variables and content.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 Allow configuration, including layout name, layout script
                 resolution (inflection), and layout script path.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 Allow disabling layouts, changing layout scripts, and other
                 states; allow these actions from within action controllers and
                 view scripts.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 Follow same script resolution rules (inflection) as the <link
                 linkend="zend.controller.actionhelpers.viewrenderer">ViewRenderer</link>,
                 but allow them to also use different rules.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 Allow usage without Zend Framework <acronym>MVC</acronym> components.
-        </para></listitem>
+            </para>
+        </listitem>
     </itemizedlist>
 </sect1>
 <!--

documentation/manual/en/module_specs/Zend_Layout-Options.xml

@@ -8,33 +8,40 @@
         may be set by calling the appropriate accessors, passing an array or
         <classname>Zend_Config</classname> object to the constructor or
         <methodname>startMvc()</methodname>, passing an array of options to
-        <methodname>setOptions()</methodname>, or passing a <classname>Zend_Config</classname> object
-        to <methodname>setConfig()</methodname>.
+        <methodname>setOptions()</methodname>, or passing a <classname>Zend_Config</classname>
+        object to <methodname>setConfig()</methodname>.
     </para>
 
     <itemizedlist>
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>layout</emphasis>: the layout to use. Uses the
                 current inflector to resolve the name provided to the
                 appropriate layout view script. By default, this value is
                 'layout' and resolves to 'layout.phtml'. Accessors
                 are <methodname>setLayout()</methodname> and <methodname>getLayout()</methodname>.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>layoutPath</emphasis>: the base path to layout view
                 scripts. Accessors are <methodname>setLayoutPath()</methodname> and
                 <methodname>getLayoutPath()</methodname>.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>contentKey</emphasis>: the layout variable used for
                 default content (when used with the <acronym>MVC</acronym>). Default value is
                 'content'. Accessors are <methodname>setContentKey()</methodname> and
                 <methodname>getContentKey()</methodname>.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>mvcSuccessfulActionOnly</emphasis>: when using the
                 <acronym>MVC</acronym>, if an action throws an exception and this flag is
                 <constant>TRUE</constant>, the layout will not be rendered (this is to prevent
@@ -43,44 +50,52 @@
                     plugin</link> is in use). By default, the flat is <constant>TRUE</constant>.
                 Accessors are <methodname>setMvcSuccessfulActionOnly()</methodname> and
                 <methodname>getMvcSuccessfulActionOnly()</methodname>.
-        </para></listitem>
-
-        <listitem><para>
-                <emphasis>view</emphasis>: the view object to use when
-                rendering. When used with the <acronym>MVC</acronym>, <classname>Zend_Layout</classname> will
-                attempt to use the view object registered with <link
-                    linkend="zend.controller.actionhelpers.viewrenderer">the
-                    ViewRenderer</link> if no view object has been passed to it
-                explicitly. Accessors are <methodname>setView()</methodname> and
-                <methodname>getView()</methodname>.
-        </para></listitem>
-
-        <listitem><para>
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis>view</emphasis>: the view object to use when rendering. When used with the
+                <acronym>MVC</acronym>, <classname>Zend_Layout</classname> will attempt to use the
+                view object registered with <link
+                    linkend="zend.controller.actionhelpers.viewrenderer">the ViewRenderer</link> if
+                no view object has been passed to it explicitly. Accessors are
+                <methodname>setView()</methodname> and <methodname>getView()</methodname>.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
                 <emphasis>helperClass</emphasis>: the action helper class to use
-                when using <classname>Zend_Layout</classname> with the <acronym>MVC</acronym> components. By
-                default, this is
+                when using <classname>Zend_Layout</classname> with the <acronym>MVC</acronym>
+                components. By default, this is
                 <classname>Zend_Layout_Controller_Action_Helper_Layout</classname>.
                 Accessors are <methodname>setHelperClass()</methodname> and
                 <methodname>getHelperClass()</methodname>.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>pluginClass</emphasis>: the front controller plugin
-                class to use when using <classname>Zend_Layout</classname> with the <acronym>MVC</acronym>
-                components. By default, this is
+                class to use when using <classname>Zend_Layout</classname> with the
+                <acronym>MVC</acronym> components. By default, this is
                 <classname>Zend_Layout_Controller_Plugin_Layout</classname>. Accessors
                 are <methodname>setPluginClass()</methodname> and
                 <methodname>getPluginClass()</methodname>.
-        </para></listitem>
+            </para>
+        </listitem>
 
-        <listitem><para>
+        <listitem>
+            <para>
                 <emphasis>inflector</emphasis>: the inflector to use when
                 resolving layout names to layout view script paths; see <link
                     linkend="zend.layout.advanced.inflector">the
                     <classname>Zend_Layout</classname> inflector documentation for more
                     details</link>. Accessors are <methodname>setInflector()</methodname>
                 and <methodname>getInflector()</methodname>.
-        </para></listitem>
+            </para>
+        </listitem>
     </itemizedlist>
 
     <note>
@@ -168,8 +183,8 @@ $layout = Zend_Layout::startMvc($config);
             <para>
                 Sometimes you need to configure the <classname>Zend_Layout</classname>
                 object after it has already been instantiated;
-                <methodname>setOptions()</methodname> and <methodname>setConfig()</methodname> give you
-                a quick and easy way to do so:
+                <methodname>setOptions()</methodname> and <methodname>setConfig()</methodname> give
+                you a quick and easy way to do so:
             </para>
 
             <programlisting language="php"><![CDATA[

documentation/manual/en/module_specs/Zend_Layout-QuickStart.xml

@@ -12,10 +12,10 @@
         <title>Layout scripts</title>
 
         <para>
-            In both cases, however, you'll need to create a layout script.
-            Layout scripts simply utilize <classname>Zend_View</classname> (or whatever view
-            implementation you are using). Layout variables are registered with
-            a <classname>Zend_Layout</classname> <link linkend="zend.view.helpers.initial.placeholder">placeholder</link>,
+            In both cases, however, you'll need to create a layout script. Layout scripts simply
+            utilize <classname>Zend_View</classname> (or whatever view implementation you are
+            using). Layout variables are registered with a <classname>Zend_Layout</classname> <link
+                linkend="zend.view.helpers.initial.placeholder">placeholder</link>,
             and may be accessed via the placeholder helper or by fetching them
             as object properties of the layout object via the layout helper.
         </para>
@@ -111,8 +111,8 @@
         </para>
 
         <para>
-            First, let's look at how to initialize <classname>Zend_Layout</classname> for use with the
-            <acronym>MVC</acronym>:
+            First, let's look at how to initialize <classname>Zend_Layout</classname> for use with
+            the <acronym>MVC</acronym>:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -162,8 +162,8 @@ class FooController extends Zend_Controller_Action
 
         <para>
             At any time, you can fetch the <classname>Zend_Layout</classname> instance
-            registered with the <acronym>MVC</acronym> via the <methodname>getMvcInstance()</methodname> static
-            method:
+            registered with the <acronym>MVC</acronym> via the
+            <methodname>getMvcInstance()</methodname> static method:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -216,19 +216,17 @@ $layout = Zend_Layout::getMvcInstance();
         <title>Using Zend_Layout as a Standalone Component</title>
 
         <para>
-            As a standalone component, <classname>Zend_Layout</classname> does not offer nearly as many
-            features or as much convenience as when used with the <acronym>MVC</acronym>. However,
-            it still has two chief benefits:
+            As a standalone component, <classname>Zend_Layout</classname> does not offer nearly as
+            many features or as much convenience as when used with the <acronym>MVC</acronym>.
+            However, it still has two chief benefits:
         </para>
 
         <itemizedlist>
-            <listitem><para>
-                    Scoping of layout variables.
-            </para></listitem>
+            <listitem><para>Scoping of layout variables.</para></listitem>
 
-            <listitem><para>
-                    Isolation of layout view script from other view scripts.
-            </para></listitem>
+            <listitem>
+               <para>Isolation of layout view script from other view scripts.</para>
+            </listitem>
         </itemizedlist>
 
         <para>

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

@@ -6,8 +6,9 @@
     <para>
         <classname>Zend_Ldap_Attribute</classname> is a helper class providing only static
         methods to manipulate arrays suitable to the structure used in
-        <classname>Zend_Ldap</classname> data modification methods and to the data format required by
-        the <acronym>LDAP</acronym> server. <acronym>PHP</acronym> data types are converted the following way:
+        <classname>Zend_Ldap</classname> data modification methods and to the data format required
+        by the <acronym>LDAP</acronym> server. <acronym>PHP</acronym> data types are converted the
+        following way:
     </para>
 
     <variablelist>
@@ -23,8 +24,9 @@
 
         <varlistentry>
             <term><code>boolean</code></term>
-            <listitem><para><constant>TRUE</constant> will be converted to <emphasis>'<constant>TRUE</constant>'</emphasis> and
-            <constant>FALSE</constant> to <emphasis>'<constant>FALSE</constant>'</emphasis></para></listitem>
+            <listitem><para><constant>TRUE</constant> will be converted to
+            <emphasis>'<constant>TRUE</constant>'</emphasis> and <constant>FALSE</constant> to
+            <emphasis>'<constant>FALSE</constant>'</emphasis></para></listitem>
         </varlistentry>
 
         <varlistentry>
@@ -44,7 +46,6 @@
             <listitem><para>All other data types (namely non-stream resources) will be
             ommitted.</para></listitem>
         </varlistentry>
-
     </variablelist>
 
     <para>On reading attribute values the following conversion will take place:</para>
@@ -65,7 +66,6 @@
             <listitem><para>All other strings won't be automatically converted and are passed
             as they are.</para></listitem>
         </varlistentry>
-
     </variablelist>
 
     <table id="zend.ldap.api.reference.zend-ldap-attribute.table">
@@ -78,6 +78,7 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry>
@@ -85,116 +86,136 @@
                         $attribName, mixed $value, boolean $append)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
                         Sets the attribute <varname>$attribName</varname> in
                         <varname>$data</varname> to the value <varname>$value</varname>. If
-                        <varname>$append</varname> is <constant>TRUE</constant> (<constant>FALSE</constant> by
-                        default) <varname>$value</varname> will be appended to the attribute.
-                        <varname>$value</varname> can be a scalar value or an array of scalar
-                        values. Conversion will take place.
+                        <varname>$append</varname> is <constant>TRUE</constant>
+                        (<constant>FALSE</constant> by default) <varname>$value</varname> will be
+                        appended to the attribute. <varname>$value</varname> can be a scalar value
+                        or an array of scalar values. Conversion will take place.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>array|mixed getAttribute(array $data,
                         string $attribName, integer|null $index)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Returns the attribute <varname>$attribName</varname> from
-                        <varname>$data</varname>. If <varname>$index</varname> is <constant>NULL</constant>
-                        (default) an array will be returned containing all the values for
-                        the given attribute. An empty array will be returned if the
+                        <varname>$data</varname>. If <varname>$index</varname> is
+                        <constant>NULL</constant> (default) an array will be returned containing all
+                        the values for the given attribute. An empty array will be returned if the
                         attribute does not exist in the given array. If an integer index is
                         specified the corresponding value at the given index will be
                         returned. If the index is out of bounds, <constant>NULL</constant> will be
                         returned. Conversion will take place.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>boolean attributeHasValue(array &amp;$data,
                         string $attribName, mixed|array $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Checks if the attribute <varname>$attribName</varname> in
-                        <varname>$data</varname> has the value(s) given in <varname>$value</varname>.
-                        The method returns <constant>TRUE</constant> only if all values in
-                        <varname>$value</varname> are present in the attribute. Comparison is
-                        done strictly (respecting the data type).
+                        <varname>$data</varname> has the value(s) given in
+                        <varname>$value</varname>. The method returns <constant>TRUE</constant> only
+                        if all values in <varname>$value</varname> are present in the attribute.
+                        Comparison is done strictly (respecting the data type).
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>void removeDuplicatesFromAttribute(array
                         &amp;$data, string $attribName)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Removes all duplicates from the attribute
                         <varname>$attribName</varname> in <varname>$data</varname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>void removeFromAttribute(array &amp;$data,
                         string $attribName, mixed|array $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Removes the value(s) given in <varname>$value</varname> from
                         the attribute <varname>$attribName</varname> in
                         <varname>$data</varname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string|null convertToLdapValue(mixed
                         $value)</code> </emphasis>
                     </entry>
+
                     <entry>
-                        Converts a <acronym>PHP</acronym> data type into its <acronym>LDAP</acronym> representation. See
-                        introduction for details.
+                        Converts a <acronym>PHP</acronym> data type into its <acronym>LDAP</acronym>
+                        representation. See introduction for details.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>mixed convertFromLdapValue(string
                         $value)</code> </emphasis>
                     </entry>
+
                     <entry>
-                        Converts an <acronym>LDAP</acronym> value into its <acronym>PHP</acronym> data type. See
-                        introduction for details.
+                        Converts an <acronym>LDAP</acronym> value into its <acronym>PHP</acronym>
+                        data type. See introduction for details.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string|null
                         convertToLdapDateTimeValue(integer $value, boolean $utc)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
-                        Converts a timestamp into its <acronym>LDAP</acronym> date/time representation.
-                        If <varname>$utc</varname> is <constant>TRUE</constant> (<constant>FALSE</constant> by
-                        default) the resulting <acronym>LDAP</acronym> date/time string will be in <acronym>UTC</acronym>,
+                        Converts a timestamp into its <acronym>LDAP</acronym> date/time
+                        representation. If <varname>$utc</varname> is <constant>TRUE</constant>
+                        (<constant>FALSE</constant> by default) the resulting
+                        <acronym>LDAP</acronym> date/time string will be in <acronym>UTC</acronym>,
                         otherwise a local date/time string will be returned.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>integer|null
                         convertFromLdapDateTimeValue(string $value)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
-                        Converts <acronym>LDAP</acronym> date/time representation into a timestamp. The
-                        method returns <constant>NULL</constant> if <varname>$value</varname> can not be
-                        converted back into a <acronym>PHP</acronym> timestamp.
+                        Converts <acronym>LDAP</acronym> date/time representation into a timestamp.
+                        The method returns <constant>NULL</constant> if <varname>$value</varname>
+                        can not be converted back into a <acronym>PHP</acronym> timestamp.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>void setPassword(array &amp;$data, string
                         $password, string $hashType, string $attribName)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
                         Sets a <acronym>LDAP</acronym> password for the attribute
                         <varname>$attribName</varname> in <varname>$data</varname>.
@@ -206,42 +227,48 @@
                         possibilty.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string createPassword(string $password,
                         string $hashType)</code> </emphasis>
                     </entry>
+
                     <entry>
-                        Creates a <acronym>LDAP</acronym> password. The password hash can be specified
-                        with <varname>$hashType</varname>. The default value here is
+                        Creates a <acronym>LDAP</acronym> password. The password hash can be
+                        specified with <varname>$hashType</varname>. The default value here is
                         <constant>Zend_Ldap_Attribute::PASSWORD_HASH_MD5</constant> with
                         <constant>Zend_Ldap_Attribute::PASSWORD_HASH_SHA</constant> as the other
                         possibilty.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>void setDateTimeAttribute(array &amp;$data,
                         string $attribName, integer|array $value, boolean $utc, boolean
                         $append)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Sets the attribute <varname>$attribName</varname> in
-                        <varname>$data</varname> to the date/time value <varname>$value</varname>. If
-                        <varname>$append</varname> is <constant>TRUE</constant> (<constant>FALSE</constant> by
-                        default) <varname>$value</varname> will be appended to the attribute.
-                        <varname>$value</varname> can be an integer value or an array of
-                        integers. Date-time-conversion according to
-                        <methodname>Zend_Ldap_Attribute::convertToLdapDateTimeValue()</methodname> will
-                        take place.
+                        <varname>$data</varname> to the date/time value <varname>$value</varname>.
+                        if <varname>$append</varname> is <constant>TRUE</constant>
+                        (<constant>FALSE</constant> by default) <varname>$value</varname> will be
+                        appended to the attribute. <varname>$value</varname> can be an integer value
+                        or an array of integers. Date-time-conversion according to
+                        <methodname>Zend_Ldap_Attribute::convertToLdapDateTimeValue()</methodname>
+                        will take place.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>array|integer getDateTimeAttribute(array
                         $data, string $attribName, integer|null $index)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
                         Returns the date/time attribute <varname>$attribName</varname>
                         from <varname>$data</varname>. If <varname>$index</varname> is
@@ -259,4 +286,4 @@
             </tbody>
         </tgroup>
     </table>
-</sect3>
+</sect3>

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

@@ -5,9 +5,9 @@
 
     <para>
         <classname>Zend_Ldap_Dn</classname> provides an object-oriented interface to
-        manipulating <acronym>LDAP</acronym> distinguished names (DN). The parameter <varname>$caseFold</varname>
-        that is used in several methods determines the way DN attributes are handled
-        regarding their case. Allowed values for this paraneter are:
+        manipulating <acronym>LDAP</acronym> distinguished names (DN). The parameter
+        <varname>$caseFold</varname> that is used in several methods determines the way DN
+        attributes are handled regarding their case. Allowed values for this paraneter are:
     </para>
 
     <variablelist>
@@ -29,8 +29,8 @@
 
     <para>
         The default case-folding is <constant>Zend_Ldap_Dn::ATTR_CASEFOLD_NONE</constant> and
-        can be set with <methodname>Zend_Ldap_Dn::setDefaultCaseFold()</methodname>. Each instance of
-        <classname>Zend_Ldap_Dn</classname> can have its own case-folding-setting. If the
+        can be set with <methodname>Zend_Ldap_Dn::setDefaultCaseFold()</methodname>. Each instance
+        of <classname>Zend_Ldap_Dn</classname> can have its own case-folding-setting. If the
         <varname>$caseFold</varname> parameter is ommitted in method-calls it defaults to the
         instance's case-folding setting.
     </para>
@@ -40,9 +40,10 @@
         different parts of the DN. The <code>ArrayAccess</code>-methods proxy to
         <methodname>Zend_Ldap_Dn::get($offset, 1, null)</methodname> for <code>offsetGet(integer
         $offset)</code>, to <methodname>Zend_Ldap_Dn::set($offset, $value)</methodname> for
-        <methodname>offsetSet()</methodname> and to <methodname>Zend_Ldap_Dn::remove($offset, 1)</methodname> for
-        <methodname>offsetUnset()</methodname>. <methodname>offsetExists()</methodname> simply checks if the index
-        is within the bounds.
+        <methodname>offsetSet()</methodname> and to
+        <methodname>Zend_Ldap_Dn::remove($offset, 1)</methodname> for
+        <methodname>offsetUnset()</methodname>. <methodname>offsetExists()</methodname> simply
+        checks if the index is within the bounds.
     </para>
 
     <table id="zend.ldap.api.reference.zend-ldap-dn.table">
@@ -55,125 +56,135 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Dn factory(string|array $dn,
                         string|null $caseFold)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates a <classname>Zend_Ldap_Dn</classname> instance from an array
                         or a string. The array must conform to the array structure detailed
                         under <methodname>Zend_Ldap_Dn::implodeDn()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Dn fromString(string $dn,
                         string|null $caseFold)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates a <classname>Zend_Ldap_Dn</classname> instance from a
                         string.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Dn fromArray(array $dn,
                         string|null $caseFold)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates a <classname>Zend_Ldap_Dn</classname> instance from an array.
                         The array must conform to the array structure detailed under
                         <methodname>Zend_Ldap_Dn::implodeDn()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getRdn(string|null $caseFold)</code></entry>
+
                     <entry>
-                        Gets the <acronym>RDN</acronym> of the current DN. The return value is an array
-                        with the <acronym>RDN</acronym> attribute names its keys and the <acronym>RDN</acronym> attribute
-                        values.
+                        Gets the <acronym>RDN</acronym> of the current DN. The return value is an
+                        array with the <acronym>RDN</acronym> attribute names its keys and the
+                        <acronym>RDN</acronym> attribute values.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>string getRdnString(string|null
-                        $caseFold)</code>
-                    </entry>
+                    <entry><code>string getRdnString(string|null $caseFold)</code></entry>
+
                     <entry>
                         Gets the <acronym>RDN</acronym> of the current DN. The return value is a
                         string.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Dn getParentDn(integer
-                        $levelUp)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Dn getParentDn(integer $levelUp)</code></entry>
+
                     <entry>
                         Gets the DN of the current DN's ancestor
                         <varname>$levelUp</varname> levels up the tree. <varname>$levelUp</varname>
                         defaults to <code>1</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>array get(integer $index, integer $length, string|null
                         $caseFold)</code>
                     </entry>
+
                     <entry>
                         Returns a slice of the current DN determined by
                         <varname>$index</varname> and <varname>$length</varname>. <varname>$index</varname>
                         starts with <code>0</code> on the DN part from the left.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Dn set(integer $index, array
-                        $value)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Dn set(integer $index, array $value)</code></entry>
+
                     <entry>
                         Replaces a DN part in the current DN. This operation
                         manipulates the current instance.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Dn remove(integer $index, integer
-                        $length)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Dn remove(integer $index, integer $length)</code></entry>
+
                     <entry>
                         Removes a DN part from the current DN. This operation
                         manipulates the current instance. <varname>$length</varname> defaults to
                         <code>1</code>
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Dn append(array $value)</code></entry>
+
                     <entry>
                         Appends a DN part to the current DN. This operation
                         manipulates the current instance.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Dn prepend(array $value)</code></entry>
+
                     <entry>
                         Prepends a DN part to the current DN. This operation
                         manipulates the current instance.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Dn insert(integer $index, array
-                        $value)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Dn insert(integer $index, array $value)</code></entry>
+
                     <entry>
                         Inserts a DN part after the index <varname>$index</varname> to the
                         current DN. This operation manipulates the current
                         instance.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>void setCaseFold(string|null $caseFold)</code></entry>
 
@@ -186,61 +197,74 @@
                         the current instance.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string toString(string|null $caseFold)</code></entry>
                     <entry>Returns DN as a string.</entry>
                 </row>
+
                 <row>
                     <entry><code>array toArray(string|null $caseFold)</code></entry>
                     <entry>Returns DN as an array.</entry>
                 </row>
+
                 <row>
                     <entry><code>string __toString()</code></entry>
+
                     <entry>
                         Returns DN as a string - proxies to
                         <methodname>Zend_Ldap_Dn::toString(null)</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>void setDefaultCaseFold(string
                         $caseFold)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Sets the default case-folding option used by all instances
                         on creation by default. Already existing instances are not affected
                         by this setting.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>array escapeValue(string|array
                         $values)</code> </emphasis>
                     </entry>
+
                     <entry>Escapes a DN value according to <acronym>RFC</acronym> 2253.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>array unescapeValue(string|array
                         $values)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Undoes the conversion done by
                         <methodname>Zend_Ldap_Dn::escapeValue()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>array explodeDn(string $dn, array
                         &amp;$keys, array &amp;$vals, string|null $caseFold)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
                         Explodes the DN <varname>$dn</varname> into an array containing
                         all parts of the given DN. <varname>$keys</varname> optinally receive DN
                         keys (e.g. CN, OU, DC, ...). <varname>$vals</varname> optionally receive
                         DN values. The resulting array will be of type
-                    <programlisting language="php"><![CDATA[
+
+                        <programlisting language="php"><![CDATA[
 array(
 array("cn" => "name1", "uid" => "user"),
 array("cn" => "name2"),
@@ -250,42 +274,49 @@ array("dc" => "org")
 ]]></programlisting>for a DN of <code>cn=name1+uid=user,cn=name2,dc=example,dc=org</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>boolean checkDn(string $dn, array
                         &amp;$keys, array &amp;$vals, string|null $caseFold)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
                         Checks if a given DN <varname>$dn</varname> is malformed. If
-                        <varname>$keys</varname> or <varname>$keys</varname> and <varname>$vals</varname> are
-                        given, these arrays will be filled with the appropriate DN keys and
-                        values.
+                        <varname>$keys</varname> or <varname>$keys</varname> and
+                        <varname>$vals</varname> are given, these arrays will be filled with the
+                        appropriate DN keys and values.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string implodeRdn(array $part, string|null
                         $caseFold)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Returns a DN part in the form
                         <code>$attribute=$value</code>
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string implodeDn(array $dnArray,
                         string|null $caseFold, string $separator)</code>
                         </emphasis>
                     </entry>
+
                     <entry>
                         Implodes an array in the form delivered by
                         <methodname>Zend_Ldap_Dn::explodeDn()</methodname> to a DN string.
                         <varname>$separator</varname> defaults to <code>','</code> but some LDAP
                         servers also understand <code>';'</code>. <varname>$dnArray</varname>
                         must of type
-                    <programlisting language="php"><![CDATA[
+
+                        <programlisting language="php"><![CDATA[
 array(
 array("cn" => "name1", "uid" => "user"),
 array("cn" => "name2"),
@@ -295,11 +326,13 @@ array("dc" => "org")
 ]]></programlisting>
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>boolean isChildOf(string|Zend_Ldap_Dn
                         $childDn, string|Zend_Ldap_Dn $parentDn)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Checks if given <varname>$childDn</varname> is beneath
                         <varname>$parentDn</varname> subtree.
@@ -309,4 +342,3 @@ array("dc" => "org")
         </tgroup>
     </table>
 </sect3>
-

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

@@ -13,120 +13,144 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter equals(string $attr,
                         string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'equals' filter:
                         <code>(attr=value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter begins(string $attr,
                         string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'begins with' filter:
                         <code>(attr=value*)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter ends(string $attr, string
                         $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'ends with' filter:
                         <code>(attr=*value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter contains(string $attr,
                         string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'contains' filter:
                         <code>(attr=*value*)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter greater(string $attr,
                         string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'greater' filter:
                         <code>(attr&gt;value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter greaterOrEqual(string
                         $attr, string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'greater or equal' filter:
                         <code>(attr&gt;=value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter less(string $attr, string
                         $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'less' filter:
                         <code>(attr&lt;value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter lessOrEqual(string $attr,
                         string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'less or equal' filter:
                         <code>(attr&lt;=value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter approx(string $attr,
                         string $value)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates an 'approx' filter:
                         <code>(attr~=value)</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter any(string $attr)</code>
                         </emphasis>
                     </entry>
+
                     <entry>Creates an 'any' filter: <code>(attr=*)</code>.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter string(string
                         $filter)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates a simple custom string filter. The user is
                         responsible for all value-escaping as the filter is used as
                         is.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter mask(string $mask, string
                         $value,...)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Creates a filter from a string mask. All <varname>$value</varname>
                         parameters will be escaped and substituted into <varname>$mask</varname>
@@ -135,28 +159,34 @@
                         <methodname>sprintf()</methodname></ulink>
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter
                         andFilter(Zend_Ldap_Filter_Abstract $filter,...)</code>
                         </emphasis>
                     </entry>
+
                     <entry>Creates an 'and' filter from all arguments given.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Filter
                         orFilter(Zend_Ldap_Filter_Abstract $filter,...)</code>
                         </emphasis>
                     </entry>
+
                     <entry>Creates an 'or' filter from all arguments given.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>__construct(string $attr, string $value, string
                         $filtertype, string|null $prepend, string|null
                         $append)</code>
                     </entry>
+
                     <entry>
                         Constructor. Creates an arbitrary filter according to the
                         parameters supplied. The resulting filter will be a concatenation
@@ -165,62 +195,74 @@
                         created by using the appropriate factory methods.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string toString()</code></entry>
                     <entry>Returns a string representation of the filter.</entry>
                 </row>
+
                 <row>
                     <entry><code>string __toString()</code></entry>
+
                     <entry>
                         Returns a string representation of the filter. Proxies to
                         <methodname>Zend_Ldap_Filter::toString()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Filter_Abstract negate()</code></entry>
                     <entry>Negates the current filter.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Filter_Abstract
                         addAnd(Zend_Ldap_Filter_Abstract $filter,...)</code>
                     </entry>
+
                     <entry>
                         Creates an 'and' filter from the current filter and all
                         filters passed in as the arguments.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Filter_Abstract
                         addOr(Zend_Ldap_Filter_Abstract $filter,...)</code>
                     </entry>
+
                     <entry>
                         Creates an 'or' filter from the current filter and all
                         filters passed in as the arguments.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string|array escapeValue(string|array
                         $values)</code> </emphasis>
                     </entry>
+
                     <entry>
-                        Escapes the given <varname>$values</varname> according to <acronym>RFC</acronym> 2254
-                        so that they can be safely used in <acronym>LDAP</acronym> filters. If a single string
-                        is given, a string is returned - otherwise an array is returned.
-                        Any control characters with an <acronym>ASCII</acronym> code &lt; 32 as well as the
-                        characters with special meaning in <acronym>LDAP</acronym> filters "*", "(", ")", and
-                        "\" (the backslash) are converted into the representation of a
-                        backslash followed by two hex digits representing the hexadecimal
-                        value of the character.
+                        Escapes the given <varname>$values</varname> according to
+                        <acronym>RFC</acronym> 2254 so that they can be safely used in
+                        <acronym>LDAP</acronym> filters. If a single string is given, a string is
+                        returned - otherwise an array is returned. Any control characters with an
+                        <acronym>ASCII</acronym> code &lt; 32 as well as the characters with special
+                        meaning in <acronym>LDAP</acronym> filters "*", "(", ")", and "\" (the
+                        backslash) are converted into the representation of a backslash followed by
+                        two hex digits representing the hexadecimal value of the character.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string|array unescapeValue(string|array
                         $values)</code> </emphasis>
                     </entry>
+
                     <entry>
                         Undoes the conversion done by
                         <methodname>Zend_Ldap_Filter::escapeValue()</methodname>. Converts any

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

@@ -13,56 +13,63 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry>
-                        <emphasis><code>array decode(string $string)</code>
-                        </emphasis>
+                        <emphasis><code>array decode(string $string)</code></emphasis>
                     </entry>
+
                     <entry>
                         Decodes the string <varname>$string</varname> into an array of
                         <acronym>LDIF</acronym> items.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>string encode(scalar|array|Zend_Ldap_Node
                         $value, array $options)</code> </emphasis>
                     </entry>
+
                     <entry>
-                        Encode <varname>$value</varname> into a <acronym>LDIF</acronym> representation.
-                        <varname>$options</varname> is an array that may contain the following
-                        keys:
+                        Encode <varname>$value</varname> into a <acronym>LDIF</acronym>
+                        representation. <varname>$options</varname> is an array that may contain the
+                        following keys:
+
                         <variablelist>
                             <varlistentry>
                                 <term><code>'sort'</code></term>
+
                                 <listitem>
                                     <para>
                                         Sort the given attributes with <code>dn</code>
                                         following <code>objectClass</code> and following all other
-                                        attributes sorted alphabetically. <constant>TRUE</constant> by
-                                        default.
+                                        attributes sorted alphabetically. <constant>TRUE</constant>
+                                        by default.
                                     </para>
                                 </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>'version'</code></term>
+
                                 <listitem>
                                     <para>
-                                        The <acronym>LDIF</acronym> format version. <code>1</code> by
-                                        default.
+                                        The <acronym>LDIF</acronym> format version. <code>1</code>
+                                        by default.
                                     </para>
                                 </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term><code>'wrap'</code></term>
+
                                 <listitem>
-                                <para>
-                                    The line-length. <code>78</code> by default to
-                                    conform to the <acronym>LDIF</acronym> specification.
-                                </para>
+                                    <para>
+                                        The line-length. <code>78</code> by default to
+                                        conform to the <acronym>LDIF</acronym> specification.
+                                    </para>
                                 </listitem>
                             </varlistentry>
                         </variablelist>
@@ -72,4 +79,3 @@
         </tgroup>
     </table>
 </sect3>
-

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

@@ -7,15 +7,16 @@
 
     <para>
         <classname>Zend_Ldap_Node_RootDse</classname> includes the magic property accessors
-        <methodname>__get()</methodname> and <methodname>__isset()</methodname> to access the attributes by their
-        name. They proxy to <methodname>Zend_Ldap_Node_RootDse::getAttribute()</methodname> and
+        <methodname>__get()</methodname> and <methodname>__isset()</methodname> to access the
+        attributes by their name. They proxy to
+        <methodname>Zend_Ldap_Node_RootDse::getAttribute()</methodname> and
         <methodname>Zend_Ldap_Node_RootDse::existsAttribute()</methodname> respectively.
-        <methodname>__set()</methodname> and <methodname>__unset()</methodname> are also implemented but they throw
-        a <code>BadMethodCallException</code> as modifications are not allowed on RootDSE
-        nodes. Furthermore the class implements <code>ArrayAccess</code> for
+        <methodname>__set()</methodname> and <methodname>__unset()</methodname> are also implemented
+        but they throw a <code>BadMethodCallException</code> as modifications are not allowed on
+        RootDSE nodes. Furthermore the class implements <code>ArrayAccess</code> for
         array-style-access to the attributes. <methodname>offsetSet()</methodname> and
-        <methodname>offsetUnset()</methodname> also throw a <code>BadMethodCallException</code> due ro
-        obvious reasons.
+        <methodname>offsetUnset()</methodname> also throw a <code>BadMethodCallException</code> due
+        ro obvious reasons.
     </para>
 
     <table id="zend.ldap.api.reference.zend-ldap-node-rootdse.table">
@@ -28,84 +29,92 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry><code>Zend_Ldap_Dn getDn()</code></entry>
                     <entry>Gets the DN of the current node as a Zend_Ldap_Dn.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getDnString(string $caseFold)</code></entry>
                     <entry>Gets the DN of the current node as a string.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getDnArray(string $caseFold)</code></entry>
                     <entry>Gets the DN of the current node as an array.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getRdnString(string $caseFold)</code></entry>
                     <entry>Gets the <acronym>RDN</acronym> of the current node as a string.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getRdnArray(string $caseFold)</code></entry>
                     <entry>Gets the <acronym>RDN</acronym> of the current node as an array.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getObjectClass()</code></entry>
                     <entry>Returns the objectClass of the node.</entry>
                 </row>
+
                 <row>
                     <entry><code>string toString()</code></entry>
+
                     <entry>
                         Returns the DN of the current node - proxies to
                         <methodname>Zend_Ldap_Dn::getDnString()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string __toString()</code></entry>
+
                     <entry>
                         Casts to string representation - proxies to
                         <methodname>Zend_Ldap_Dn::toString()</methodname>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>array toArray(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>array toArray(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns an array representation of the current node. If
                         <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
                         (defaults to <constant>TRUE</constant>) the system specific attributes are
                         stripped from the array. Unlike
-                        <methodname>Zend_Ldap_Node_RootDse::getAttributes()</methodname> the resulting
-                        array contains the DN with key <code>'dn'</code>.
+                        <methodname>Zend_Ldap_Node_RootDse::getAttributes()</methodname> the
+                        resulting array contains the DN with key <code>'dn'</code>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>string toJson(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>string toJson(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns a <acronym>JSON</acronym> representation of the current node using
                         <methodname>Zend_Ldap_Node_RootDse::toArray()</methodname>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>array getData(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>array getData(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns the node's attributes. The array contains all
                         attributes in its internal format (no conversion).
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean existsAttribute(string $name, boolean
-                        $emptyExists)</code>
+                        <code>boolean existsAttribute(string $name, boolean $emptyExists)</code>
                     </entry>
+
                     <entry>
                         Checks whether a given attribute exists. If
                         <varname>$emptyExists</varname> is <constant>FALSE</constant>, empty
@@ -117,11 +126,12 @@
                         key-collection.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean attributeHasValue(string $name, mixed|array
-                        $value)</code>
+                        <code>boolean attributeHasValue(string $name, mixed|array $value)</code>
                     </entry>
+
                     <entry>
                         Checks if the given value(s) exist in the attribute. The
                         method returns <constant>TRUE</constant> only if all values in
@@ -129,28 +139,31 @@
                         done strictly (respecting the data type).
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>integer count()</code></entry>
+
                     <entry>
-                        Returns the number of attributes in the node. Implements
-                        Countable.
+                        Returns the number of attributes in the node. Implements Countable.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>mixed getAttribute(string $name, integer|null
-                        $index)</code>
+                        <code>mixed getAttribute(string $name, integer|null $index)</code>
                     </entry>
+
                     <entry>
                         Gets a <acronym>LDAP</acronym> attribute. Data conversion is applied using
                         <methodname>Zend_Ldap_Attribute::getAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>array getAttributes(boolean
-                        $includeSystemAttributes)</code>
+                        <code>array getAttributes(boolean $includeSystemAttributes)</code>
                     </entry>
+
                     <entry>
                         Gets all attributes of node. If
                         <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
@@ -158,95 +171,113 @@
                         stripped from the array.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>array|integer getDateTimeAttribute(string $name,
-                        integer|null $index)</code>
+                            integer|null $index)</code>
                     </entry>
+
                     <entry>
-                        Gets a <acronym>LDAP</acronym> date/time attribute. Data conversion is applied
-                        using
+                        Gets a <acronym>LDAP</acronym> date/time attribute. Data conversion is
+                        applied using
                         <methodname>Zend_Ldap_Attribute::getDateTimeAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node_RootDse reload(Zend_Ldap
-                        $ldap)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node_RootDse reload(Zend_Ldap $ldap)</code></entry>
+
                     <entry>
                         Reloads the current node's attributes from the given <acronym>LDAP</acronym>
                         server.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Node_RootDse create(Zend_Ldap
-                        $ldap)</code> </emphasis>
+                            $ldap)</code></emphasis>
                     </entry>
+
                     <entry>Factory method to create the RootDSE.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getNamingContexts()</code></entry>
                     <entry>Gets the namingContexts.</entry>
                 </row>
+
                 <row>
                     <entry><code>string|null getSubschemaSubentry()</code></entry>
                     <entry>Gets the subschemaSubentry.</entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>boolean supportsVersion(string|int|array
-                        $versions)</code>
-                    </entry>
+                    <entry><code>boolean supportsVersion(string|int|array $versions)</code></entry>
                     <entry>Determines if the <acronym>LDAP</acronym> version is supported.</entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean supportsSaslMechanism(string|array
-                        $mechlist)</code>
+                        <code>boolean supportsSaslMechanism(string|array $mechlist)</code>
                     </entry>
+
                     <entry>Determines if the sasl mechanism is supported.</entry>
                 </row>
+
                 <row>
                     <entry><code>integer getServerType()</code></entry>
+
                     <entry>
                         Gets the server type. Returns
+
                         <variablelist>
                             <varlistentry>
                                 <term>
-                                <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_GENERIC</constant></term>
-                                <listitem><para>for unknown <acronym>LDAP</acronym> servers</para></listitem>
+                                    <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_GENERIC</constant>
+                                </term>
+
+                                <listitem>
+                                    <para>for unknown <acronym>LDAP</acronym> servers</para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
-                                <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant></term>
+                                    <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant>
+                                </term>
+
                                 <listitem><para>for OpenLDAP servers</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
-                                <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant></term>
-                                <listitem><para>for Microsoft ActiveDirectory servers</para></listitem>
+                                    <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant>
+                                </term>
+
+                                <listitem>
+                                    <para>for Microsoft ActiveDirectory servers</para>
+                                </listitem>
                             </varlistentry>
 
                             <varlistentry>
                                 <term>
-                                <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant></term>
+                                    <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant>
+                                </term>
+
                                 <listitem><para>For Novell eDirectory servers</para></listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Dn getSchemaDn()</code></entry>
                     <entry>Returns the schema DN.</entry>
                 </row>
             </tbody>
-
         </tgroup>
-
     </table>
 
     <sect4 id="zend.ldap.api.reference.zend-ldap-node-rootdse.openldap">
@@ -276,41 +307,39 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><code>integer getServerType()</code></entry>
+
                         <entry>
                             Gets the server type. Returns
                             <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_OPENLDAP</constant>
                         </entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getConfigContext()</code></entry>
                         <entry>Gets the configContext.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getMonitorContext()</code></entry>
                         <entry>Gets the monitorContext.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsControl(string|array
-                            $oids)</code>
-                        </entry>
+                        <entry><code>boolean supportsControl(string|array $oids)</code></entry>
                         <entry>Determines if the control is supported.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsExtension(string|array
-                            $oids)</code>
-                        </entry>
+                        <entry><code>boolean supportsExtension(string|array $oids)</code></entry>
                         <entry>Determines if the extension is supported.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsFeature(string|array
-                            $oids)</code>
-                        </entry>
+                        <entry><code>boolean supportsFeature(string|array $oids)</code></entry>
                         <entry>Determines if the feature is supported.</entry>
                     </row>
                 </tbody>
@@ -345,120 +374,104 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><code>integer getServerType()</code></entry>
+
                         <entry>
                             Gets the server type. Returns
                             <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_ACTIVEDIRECTORY</constant>
                         </entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getConfigurationNamingContext()</code>
-                        </entry>
+                        <entry><code>string|null getConfigurationNamingContext()</code></entry>
                         <entry>Gets the configurationNamingContext.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getCurrentTime()</code></entry>
                         <entry>Gets the currentTime.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getDefaultNamingContext()</code>
-                        </entry>
+                        <entry><code>string|null getDefaultNamingContext()</code></entry>
                         <entry>Gets the defaultNamingContext.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getDnsHostName()</code></entry>
                         <entry>Gets the dnsHostName.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getDomainControllerFunctionality()</code>
-                        </entry>
+                        <entry><code>string|null getDomainControllerFunctionality()</code></entry>
                         <entry>Gets the domainControllerFunctionality.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getDomainFunctionality()</code>
-                        </entry>
+                        <entry><code>string|null getDomainFunctionality()</code></entry>
                         <entry>Gets the domainFunctionality.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getDsServiceName()</code></entry>
                         <entry>Gets the dsServiceName.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getForestFunctionality()</code>
-                        </entry>
+                        <entry><code>string|null getForestFunctionality()</code></entry>
                         <entry>Gets the forestFunctionality.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getHighestCommittedUSN()</code>
-                        </entry>
+                        <entry><code>string|null getHighestCommittedUSN()</code></entry>
                         <entry>Gets the highestCommittedUSN.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getIsGlobalCatalogReady()</code>
-                        </entry>
+                        <entry><code>string|null getIsGlobalCatalogReady()</code></entry>
                         <entry>Gets the isGlobalCatalogReady.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getIsSynchronized()</code></entry>
                         <entry>Gets the isSynchronized.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getLdapServiceName()</code></entry>
                         <entry>Gets the ldapServiceName.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getRootDomainNamingContext()</code>
-                        </entry>
+                        <entry><code>string|null getRootDomainNamingContext()</code></entry>
                         <entry>Gets the rootDomainNamingContext.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getSchemaNamingContext()</code>
-                        </entry>
+                        <entry><code>string|null getSchemaNamingContext()</code></entry>
                         <entry>Gets the schemaNamingContext.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getServerName()</code></entry>
                         <entry>Gets the serverName.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsCapability(string|array
-                            $oids)</code>
-                        </entry>
+                        <entry><code>boolean supportsCapability(string|array $oids)</code></entry>
                         <entry>Determines if the capability is supported.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsControl(string|array
-                            $oids)</code>
-                        </entry>
+                        <entry><code>boolean supportsControl(string|array $oids)</code></entry>
                         <entry>Determines if the control is supported.</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsPolicy(string|array
-                            $policies)</code>
-                        </entry>
+                        <entry><code>boolean supportsPolicy(string|array $policies)</code></entry>
                         <entry>Determines if the version is supported.</entry>
                     </row>
                 </tbody>
@@ -476,10 +489,10 @@
 
         <note>
             <para>
-                Refer to
-                <ulink url="http://www.novell.com/documentation/edir88/edir88/index.html?page=/documentation/edir88/edir88/data/ah59jqq.html">
-                Getting Information about the <acronym>LDAP</acronym> Server</ulink>for information on the
-                attributes of Novell eDirectory RootDSE.
+                Refer to <ulink
+                    url="http://www.novell.com/documentation/edir88/edir88/index.html?page=/documentation/edir88/edir88/data/ah59jqq.html">Getting
+                    Information about the <acronym>LDAP</acronym> Server</ulink>for information on
+                the attributes of Novell eDirectory RootDSE.
             </para>
         </note>
 
@@ -493,89 +506,74 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><code>integer getServerType()</code></entry>
+
                         <entry>
                             Gets the server type. Returns
                             <constant>Zend_Ldap_Node_RootDse::SERVER_TYPE_EDIRECTORY</constant>
                         </entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>boolean supportsExtension(string|array
-                            $oids)</code>
-                        </entry>
+                        <entry><code>boolean supportsExtension(string|array $oids)</code></entry>
                         <entry>Determines if the extension is supported.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getVendorName()</code></entry>
                         <entry>Gets the vendorName.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getVendorVersion()</code></entry>
                         <entry>Gets the vendorVersion.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getDsaName()</code></entry>
                         <entry>Gets the dsaName.</entry>
                     </row>
+
                     <row>
                         <entry><code>string|null getStatisticsErrors()</code></entry>
                         <entry>Gets the server statistics "errors".</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getStatisticsSecurityErrors()</code>
-                        </entry>
+                        <entry><code>string|null getStatisticsSecurityErrors()</code></entry>
                         <entry>Gets the server statistics "securityErrors".</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getStatisticsChainings()</code>
-                        </entry>
+                        <entry><code>string|null getStatisticsChainings()</code></entry>
                         <entry>Gets the server statistics "chainings".</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getStatisticsReferralsReturned()</code>
-                        </entry>
+                        <entry><code>string|null getStatisticsReferralsReturned()</code></entry>
                         <entry>Gets the server statistics "referralsReturned".</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getStatisticsExtendedOps()</code>
-                        </entry>
+                        <entry><code>string|null getStatisticsExtendedOps()</code></entry>
                         <entry>Gets the server statistics "extendedOps".</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getStatisticsAbandonOps()</code>
-                        </entry>
+                        <entry><code>string|null getStatisticsAbandonOps()</code></entry>
                         <entry>Gets the server statistics "abandonOps".</entry>
                     </row>
+
                     <row>
-                        <entry>
-                            <code>string|null
-                            getStatisticsWholeSubtreeSearchOps()</code>
-                        </entry>
-                        <entry>
-                            Gets the server statistics
-                            "wholeSubtreeSearchOps".
-                        </entry>
+                        <entry><code>string|null getStatisticsWholeSubtreeSearchOps()</code></entry>
+                        <entry>Gets the server statistics "wholeSubtreeSearchOps".</entry>
                     </row>
                 </tbody>
-
             </tgroup>
-
         </table>
-
     </sect4>
-
 </sect3>
 

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

@@ -28,50 +28,59 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry><code>Zend_Ldap_Dn getDn()</code></entry>
                     <entry>Gets the DN of the current node as a Zend_Ldap_Dn.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getDnString(string $caseFold)</code></entry>
                     <entry>Gets the DN of the current node as a string.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getDnArray(string $caseFold)</code></entry>
                     <entry>Gets the DN of the current node as an array.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getRdnString(string $caseFold)</code></entry>
                     <entry>Gets the <acronym>RDN</acronym> of the current node as a string.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getRdnArray(string $caseFold)</code></entry>
                     <entry>Gets the <acronym>RDN</acronym> of the current node as an array.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getObjectClass()</code></entry>
                     <entry>Returns the objectClass of the node.</entry>
                 </row>
+
                 <row>
                     <entry><code>string toString()</code></entry>
+
                     <entry>
                         Returns the DN of the current node - proxies to
                         <code>Zend_Ldap_Dn::getDnString()</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string __toString()</code></entry>
+
                     <entry>
                         Casts to string representation - proxies to
                         <code>Zend_Ldap_Dn::toString()</code>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>array toArray(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>array toArray(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns an array representation of the current node. If
                         <code>$includeSystemAttributes</code> is <constant>FALSE</constant>
@@ -81,31 +90,30 @@
                         array contains the DN with key <code>'dn'</code>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>string toJson(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>string toJson(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns a <acronym>JSON</acronym> representation of the current node using
                         <code>Zend_Ldap_Node_Schema::toArray()</code>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>array getData(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>array getData(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns the node's attributes. The array contains all
                         attributes in its internal format (no conversion).
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean existsAttribute(string $name, boolean
-                        $emptyExists)</code>
+                        <code>boolean existsAttribute(string $name, boolean $emptyExists)</code>
                     </entry>
+
                     <entry>
                         Checks whether a given attribute exists. If
                         <code>$emptyExists</code> is <constant>FALSE</constant>, empty attributes
@@ -117,11 +125,12 @@
                         key-collection.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean attributeHasValue(string $name, mixed|array
-                        $value)</code>
+                        <code>boolean attributeHasValue(string $name, mixed|array $value)</code>
                     </entry>
+
                     <entry>
                         Checks if the given value(s) exist in the attribute. The
                         method returns <constant>TRUE</constant> only if all values in
@@ -129,28 +138,31 @@
                         done strictly (respecting the data type).
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>integer count()</code></entry>
+
                     <entry>
-                        Returns the number of attributes in the node. Implements
-                        Countable.
+                        Returns the number of attributes in the node. Implements Countable.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>mixed getAttribute(string $name, integer|null
-                        $index)</code>
+                        <code>mixed getAttribute(string $name, integer|null $index)</code>
                     </entry>
+
                     <entry>
                         Gets a <acronym>LDAP</acronym> attribute. Data conversion is applied using
                         <code>Zend_Ldap_Attribute::getAttribute()</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>array getAttributes(boolean
-                        $includeSystemAttributes)</code>
+                        <code>array getAttributes(boolean $includeSystemAttributes)</code>
                     </entry>
+
                     <entry>
                         Gets all attributes of node. If
                         <code>$includeSystemAttributes</code> is <constant>FALSE</constant>
@@ -158,40 +170,47 @@
                         stripped from the array.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>array|integer getDateTimeAttribute(string $name,
                         integer|null $index)</code>
                     </entry>
+
                     <entry>
-                        Gets a <acronym>LDAP</acronym> date/time attribute. Data conversion is applied
-                        using
-                        <code>Zend_Ldap_Attribute::getDateTimeAttribute()</code>.
+                        Gets a <acronym>LDAP</acronym> date/time attribute. Data conversion is
+                        applied using <code>Zend_Ldap_Attribute::getDateTimeAttribute()</code>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node_Schema reload(Zend_Ldap
-                        $ldap)</code>
+                        <code>Zend_Ldap_Node_Schema reload(Zend_Ldap $ldap)</code>
                     </entry>
+
                     <entry>
                         Reloads the current node's attributes from the given <acronym>LDAP</acronym>
                         server.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Node_Schema create(Zend_Ldap
                         $ldap)</code> </emphasis>
                     </entry>
+
                     <entry>Factory method to create the Schema node.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getAttributeTypes()</code></entry>
                     <entry>Gets the attribute types as an array of <code/>.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getObjectClasses()</code></entry>
+
                     <entry>
                         Gets the object classes as an array of
                         <code>Zend_Ldap_Node_Schema_ObjectClass_Interface</code>.
@@ -211,27 +230,33 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry><code>string getName()</code></entry>
                     <entry>Gets the attribute name.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getOid()</code></entry>
                     <entry>Gets the attribute <acronym>OID</acronym>.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getSyntax()</code></entry>
                     <entry>Gets the attribute syntax.</entry>
                 </row>
+
                 <row>
                     <entry><code>int|null getMaxLength()</code></entry>
                     <entry>Gets the attribute maximum length.</entry>
                 </row>
+
                 <row>
                     <entry><code>boolean isSingleValued()</code></entry>
                     <entry>Returns if the attribute is single-valued.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getDescription()</code></entry>
                     <entry>Gets the attribute description</entry>
@@ -250,76 +275,74 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry><code>string getName()</code></entry>
                     <entry>Returns the objectClass name.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getOid()</code></entry>
                     <entry>Returns the objectClass <acronym>OID</acronym>.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getMustContain()</code></entry>
-                    <entry>
-                        Returns the attributes that this objectClass must
-                        contain.
-                    </entry>
+                    <entry>Returns the attributes that this objectClass must contain.</entry>
                 </row>
+
                 <row>
                     <entry><code>array getMayContain()</code></entry>
-                    <entry>
-                        Returns the attributes that this objectClass may
-                        contain.
-                    </entry>
+                    <entry>Returns the attributes that this objectClass may contain.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getDescription()</code></entry>
                     <entry>Returns the attribute description</entry>
                 </row>
+
                 <row>
                     <entry><code>integer getType()</code></entry>
+
                     <entry>
-                        Returns the objectClass type. The method returns one of the
-                        following values:
+                        Returns the objectClass type. The method returns one of the following
+                        values:
+
                         <variablelist>
                             <varlistentry>
-                                <term>
-                                <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_UNKNOWN</code></term>
+                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_UNKNOWN</code></term>
                                 <listitem><para>for unknown class types</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
-                                <term>
-                                <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_STRUCTURAL</code></term>
+                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_STRUCTURAL</code></term>
                                 <listitem><para>for structural classes</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
-                                <term>
-                                <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_ABSTRACT</code></term>
+                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_ABSTRACT</code></term>
                                 <listitem><para>for abstract classes</para></listitem>
                             </varlistentry>
 
                             <varlistentry>
-                                <term>
-                                <code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_AUXILIARY</code></term>
+                                <term><code>Zend_Ldap_Node_Schema::OBJECTCLASS_TYPE_AUXILIARY</code></term>
                                 <listitem><para>for auxiliary classes</para></listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getParentClasses()</code></entry>
+
                     <entry>
                         Returns the parent objectClasses of this class. This
                         includes structural, abstract and auxiliary objectClasses.
                     </entry>
                 </row>
             </tbody>
-
         </tgroup>
-
     </table>
 
     <para>
@@ -344,16 +367,16 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry><code>array getData()</code></entry>
-                    <entry>
-                        Gets all the underlying data from the schema information
-                        node.
-                    </entry>
+                    <entry>Gets all the underlying data from the schema information node.</entry>
                 </row>
+
                 <row>
                     <entry><code>integer count()</code></entry>
+
                     <entry>
                         Returns the number of attributes in this schema information
                         node. Implements Countable.
@@ -381,23 +404,24 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><code>array getLdapSyntaxes()</code></entry>
                         <entry>Gets the <acronym>LDAP</acronym> syntaxes.</entry>
                     </row>
+
                     <row>
                         <entry><code>array getMatchingRules()</code></entry>
                         <entry>Gets the matching rules.</entry>
                     </row>
+
                     <row>
                         <entry><code>array getMatchingRuleUse()</code></entry>
                         <entry>Gets the matching rule use.</entry>
                     </row>
                 </tbody>
-
             </tgroup>
-
         </table>
 
         <table
@@ -411,15 +435,16 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>
                             <code>Zend_Ldap_Node_Schema_AttributeType_OpenLdap|null
-                            getParent()</code>
+                                getParent()</code>
                         </entry>
+
                         <entry>
-                            Returns the parent attribute type in the inheritance
-                            tree if one exists.
+                            Returns the parent attribute type in the inheritance tree if one exists.
                         </entry>
                     </row>
                 </tbody>
@@ -437,9 +462,11 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><code>array getParents()</code></entry>
+
                         <entry>
                             Returns the parent object classes in the inheritance
                             tree if one exists. The returned array is an array of
@@ -456,6 +483,7 @@
 
         <note>
             <title>Schema browsing on ActiveDirectory servers</title>
+
             <para>
                 Due to restrictions on Microsoft ActiveDirectory servers regarding
                 the number of entries returned by generic search routines and due to the
@@ -503,4 +531,3 @@
         </table>
     </sect4>
 </sect3>
-

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

@@ -5,13 +5,14 @@
 
     <para>
         <classname>Zend_Ldap_Node</classname> includes the magic property accessors
-        <methodname>__set()</methodname>, <methodname>__get()</methodname>, <methodname>__unset()</methodname> and
-        <methodname>__isset()</methodname> to access the attributes by their name. They proxy to
+        <methodname>__set()</methodname>, <methodname>__get()</methodname>,
+        <methodname>__unset()</methodname> and <methodname>__isset()</methodname> to access the
+        attributes by their name. They proxy to
         <methodname>Zend_Ldap_Node::setAttribute()</methodname>,
         <methodname>Zend_Ldap_Node::getAttribute()</methodname>,
         <methodname>Zend_Ldap_Node::deleteAttribute()</methodname> and
-        <methodname>Zend_Ldap_Node::existsAttribute()</methodname> respectively. Furthermore the class
-        implements <code>ArrayAccess</code> for array-style-access to the attributes.
+        <methodname>Zend_Ldap_Node::existsAttribute()</methodname> respectively. Furthermore the
+        class implements <code>ArrayAccess</code> for array-style-access to the attributes.
         <classname>Zend_Ldap_Node</classname> also implements <code>Iterator</code> and
         <code>RecursiveIterato</code> to allow for recursive tree-traversal.
     </para>
@@ -26,96 +27,110 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
                     <entry><code>Zend_Ldap getLdap()</code></entry>
+
                     <entry>
                         Returns the current <acronym>LDAP</acronym> connection. Throws
                         <classname>Zend_Ldap_Exception</classname> if current node is in detached
                         mode (not connected to a <classname>Zend_Ldap</classname> instance).
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node attachLdap(Zend_Ldap
-                        $ldap)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node attachLdap(Zend_Ldap $ldap)</code></entry>
+
                     <entry>
                         Attach the current node to the <varname>$ldap</varname>
                         <classname>Zend_Ldap</classname> instance. Throws
-                        <classname>Zend_Ldap_Exception</classname> if <varname>$ldap</varname> is not
-                        responsible for the current node (node is not a child of the
+                        <classname>Zend_Ldap_Exception</classname> if <varname>$ldap</varname> is
+                        not responsible for the current node (node is not a child of the
                         <varname>$ldap</varname> base DN).
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node detachLdap()</code></entry>
                     <entry>Detach node from <acronym>LDAP</acronym> connection.</entry>
                 </row>
+
                 <row>
                     <entry><code>boolean isAttached()</code></entry>
+
                     <entry>
                         Checks if the current node is attached to a <acronym>LDAP</acronym>
                         connection.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <emphasis><code>Zend_Ldap_Node
-                        create(string|array|Zend_Ldap_Dn $dn, array $objectClass)</code>
-                        </emphasis>
+                        <emphasis><code>Zend_Ldap_Node create(string|array|Zend_Ldap_Dn $dn, array
+                            $objectClass)</code></emphasis>
                     </entry>
+
                     <entry>
                         Factory method to create a new detached
                         <classname>Zend_Ldap_Node</classname> for a given DN. Creates a new
-                        <classname>Zend_Ldap_Node</classname> with the DN <varname>$dn</varname> and the
-                        object-classes <varname>$objectClass</varname>.
+                        <classname>Zend_Ldap_Node</classname> with the DN <varname>$dn</varname> and
+                        the object-classes <varname>$objectClass</varname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <emphasis><code>Zend_Ldap_Node
-                        fromLdap(string|array|Zend_Ldap_Dn $dn, Zend_Ldap $ldap)</code>
-                        </emphasis>
+                        <emphasis><code>Zend_Ldap_Node fromLdap(string|array|Zend_Ldap_Dn $dn,
+                            Zend_Ldap $ldap)</code></emphasis>
                     </entry>
+
                     <entry>
                         Factory method to create an attached
                         <classname>Zend_Ldap_Node</classname> for a given DN. Loads an existing
-                        <classname>Zend_Ldap_Node</classname> with the DN <varname>$dn</varname> from the
-                        <acronym>LDAP</acronym> connection <varname>$ldap</varname>.
+                        <classname>Zend_Ldap_Node</classname> with the DN <varname>$dn</varname>
+                        from the <acronym>LDAP</acronym> connection <varname>$ldap</varname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>Zend_Ldap_Node fromArray((array $data,
-                        boolean $fromDataSource)</code> </emphasis>
+                            boolean $fromDataSource)</code></emphasis>
                     </entry>
+
                     <entry>
-                        Factory method to create a detached
-                        <classname>Zend_Ldap_Node</classname> from array data <varname>$data</varname>. If
+                        Factory method to create a detached <classname>Zend_Ldap_Node</classname>
+                        from array data <varname>$data</varname>. if
                         <varname>$fromDataSource</varname> is <constant>TRUE</constant>
                         (<constant>FALSE</constant> by default), the data is treated as beeing
                         present in a <acronym>LDAP</acronym> tree.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>boolean isNew()</code></entry>
+
                     <entry>
                         Tells if the node is consiedered as new (not present on the
                         server). Please note, that this doesn't tell if the node is really
-                        present on the server. Use <methodname>Zend_Ldap_Node::exists()</methodname> to
-                        see if a node is already there.
+                        present on the server. Use <methodname>Zend_Ldap_Node::exists()</methodname>
+                        to see if a node is already there.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>boolean willBeDeleted()</code></entry>
+
                     <entry>
                         Tells if this node is going to be deleted once
                         <methodname>Zend_Ldap_Node::update()</methodname> is called.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node delete()</code></entry>
+
                     <entry>
                         Marks this node as to be deleted. Node will be deleted on
                         calling <methodname>Zend_Ldap_Node::update()</methodname> if
@@ -123,124 +138,146 @@
                         <constant>TRUE</constant>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>boolean willBeMoved()</code></entry>
+
                     <entry>
                         Tells if this node is going to be moved once
                         <methodname>Zend_Ldap_Node::update()</methodname> is called.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node update(Zend_Ldap $ldap)</code></entry>
+
                     <entry>
                         Sends all pending changes to the <acronym>LDAP</acronym> server. If
-                        <varname>$ldap</varname> is omitted the current <acronym>LDAP</acronym> connection is used.
-                        If the current node is detached from a <acronym>LDAP</acronym> connection a
+                        <varname>$ldap</varname> is omitted the current <acronym>LDAP</acronym>
+                        connection is used. If the current node is detached from a
+                        <acronym>LDAP</acronym> connection a
                         <classname>Zend_Ldap_Exception</classname> will be thrown. If
                         <varname>$ldap</varname> is provided the current node will be attached to
                         the given <acronym>LDAP</acronym> connection.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Dn getCurrentDn()</code></entry>
+
                     <entry>
                         Gets the current DN of the current node as a Zend_Ldap_Dn.
                         This does not reflect possible rename-operations.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Dn getDn()</code></entry>
+
                     <entry>
                         Gets the original DN of the current node as a Zend_Ldap_Dn.
                         This reflects possible rename-operations.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string getDnString(string $caseFold)</code></entry>
+
                     <entry>
                         Gets the original DN of the current node as a string. This
                         reflects possible rename-operations.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getDnArray(string $caseFold)</code></entry>
+
                     <entry>
                         Gets the original DN of the current node as an array. This
                         reflects possible rename-operations.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string getRdnString(string $caseFold)</code></entry>
+
                     <entry>
-                        Gets the <acronym>RDN</acronym> of the current node as a string. This reflects
-                        possible rename-operations.
+                        Gets the <acronym>RDN</acronym> of the current node as a string. This
+                        reflects possible rename-operations.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getRdnArray(string $caseFold)</code></entry>
+
                     <entry>
-                        Gets the <acronym>RDN</acronym> of the current node as an array. This reflects
-                        possible rename-operations.
+                        Gets the <acronym>RDN</acronym> of the current node as an array. This
+                        reflects possible rename-operations.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node setDn(Zend_Ldap_Dn|string|array
-                        $newDn)</code>
+                        <code>Zend_Ldap_Node setDn(Zend_Ldap_Dn|string|array $newDn)</code>
                     </entry>
+
                     <entry>
                         Sets the new DN for this node effectively moving the node
                         once <methodname>Zend_Ldap_Node::update()</methodname> is called.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node move(Zend_Ldap_Dn|string|array
-                        $newDn)</code>
+                        <code>Zend_Ldap_Node move(Zend_Ldap_Dn|string|array $newDn)</code>
                     </entry>
+
                     <entry>
-                        This is an alias for
-                        <methodname>Zend_Ldap_Node::setDn()</methodname>.
+                        This is an alias for <methodname>Zend_Ldap_Node::setDn()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node rename(Zend_Ldap_Dn|string|array
-                        $newDn)</code>
+                        <code>Zend_Ldap_Node rename(Zend_Ldap_Dn|string|array $newDn)</code>
                     </entry>
+
                     <entry>
-                        This is an alias for
-                        <methodname>Zend_Ldap_Node::setDn()</methodname>.
+                        This is an alias for <methodname>Zend_Ldap_Node::setDn()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getObjectClass()</code></entry>
                     <entry>Returns the objectClass of the node.</entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node setObjectClass(array|string
-                        $value)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node setObjectClass(array|string $value)</code></entry>
                     <entry>Sets the objectClass attribute.</entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node appendObjectClass(array|string
-                        $value)</code>
+                        <code>Zend_Ldap_Node appendObjectClass(array|string $value)</code>
                     </entry>
+
                     <entry>Appends to the objectClass attribute.</entry>
                 </row>
+
                 <row>
                     <entry><code>string toLdif(array $options)</code></entry>
+
                     <entry>
                         Returns a <acronym>LDIF</acronym> representation of the current node.
                         <varname>$options</varname> will be passed to the
                         <classname>Zend_Ldap_Ldif_Encoder</classname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getChangedData()</code></entry>
+
                     <entry>
                         Gets changed node data. The array contains all changed
                         attributes. This format can be used in
@@ -248,29 +285,33 @@
                         <methodname>Zend_Ldap::update()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getChanges()</code></entry>
                     <entry>Returns all changes made.</entry>
                 </row>
+
                 <row>
                     <entry><code>string toString()</code></entry>
+
                     <entry>
                         Returns the DN of the current node - proxies to
                         <methodname>Zend_Ldap_Dn::getDnString()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>string __toString()</code></entry>
+
                     <entry>
                         Casts to string representation - proxies to
                         <methodname>Zend_Ldap_Dn::toString()</methodname>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>array toArray(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>array toArray(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns an array representation of the current node. If
                         <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
@@ -280,31 +321,30 @@
                         contains the DN with key <code>'dn'</code>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>string toJson(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>string toJson(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns a <acronym>JSON</acronym> representation of the current node using
                         <methodname>Zend_Ldap_Node::toArray()</methodname>.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>array getData(boolean
-                        $includeSystemAttributes)</code>
-                    </entry>
+                    <entry><code>array getData(boolean $includeSystemAttributes)</code></entry>
+
                     <entry>
                         Returns the node's attributes. The array contains all
                         attributes in its internal format (no conversion).
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean existsAttribute(string $name, boolean
-                        $emptyExists)</code>
+                        <code>boolean existsAttribute(string $name, boolean $emptyExists)</code>
                     </entry>
+
                     <entry>
                         Checks whether a given attribute exists. If
                         <varname>$emptyExists</varname> is <constant>FALSE</constant> empty
@@ -316,11 +356,12 @@
                         key-collection.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean attributeHasValue(string $name, mixed|array
-                        $value)</code>
+                        <code>boolean attributeHasValue(string $name, mixed|array $value)</code>
                     </entry>
+
                     <entry>
                         Checks if the given value(s) exist in the attribute. The
                         method returns <constant>TRUE</constant> only if all values in
@@ -328,28 +369,31 @@
                         done strictly (respecting the data type).
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>integer count()</code></entry>
+
                     <entry>
-                        Returns the number of attributes in the node. Implements
-                        Countable.
+                        Returns the number of attributes in the node. Implements Countable.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>mixed getAttribute(string $name, integer|null
-                        $index)</code>
+                        <code>mixed getAttribute(string $name, integer|null $index)</code>
                     </entry>
+
                     <entry>
                         Gets a <acronym>LDAP</acronym> attribute. Data conversion is applied using
                         <methodname>Zend_Ldap_Attribute::getAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>array getAttributes(boolean
-                        $includeSystemAttributes)</code>
+                        <code>array getAttributes(boolean $includeSystemAttributes)</code>
                     </entry>
+
                     <entry>
                         Gets all attributes of node. If
                         <varname>$includeSystemAttributes</varname> is <constant>FALSE</constant>
@@ -357,113 +401,132 @@
                         stripped from the array.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node setAttribute(string $name, mixed
-                        $value)</code>
+                        <code>Zend_Ldap_Node setAttribute(string $name, mixed $value)</code>
                     </entry>
+
                     <entry>
                         Sets a <acronym>LDAP</acronym> attribute. Data conversion is applied using
                         <methodname>Zend_Ldap_Attribute::setAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Node appendToAttribute(string $name, mixed
-                        $value)</code>
+                        <code>Zend_Ldap_Node appendToAttribute(string $name, mixed $value)</code>
                     </entry>
+
                     <entry>
                         Appends to a <acronym>LDAP</acronym> attribute. Data conversion is applied
                         using <methodname>Zend_Ldap_Attribute::setAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>array|integer getDateTimeAttribute(string $name,
-                        integer|null $index)</code>
+                            integer|null $index)</code>
                     </entry>
+
                     <entry>
-                        Gets a <acronym>LDAP</acronym> date/time attribute. Data conversion is applied
-                        using
+                        Gets a <acronym>LDAP</acronym> date/time attribute. Data conversion is
+                        applied using
                         <methodname>Zend_Ldap_Attribute::getDateTimeAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Node setDateTimeAttribute(string $name,
-                        integer|array $value, boolean $utc)</code>
+                            integer|array $value, boolean $utc)</code>
                     </entry>
+
                     <entry>
-                        Sets a <acronym>LDAP</acronym> date/time attribute. Data conversion is applied
-                        using
+                        Sets a <acronym>LDAP</acronym> date/time attribute. Data conversion is
+                        applied using
                         <methodname>Zend_Ldap_Attribute::setDateTimeAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Node appendToDateTimeAttribute(string $name,
-                        integer|array $value, boolean $utc)</code>
+                            integer|array $value, boolean $utc)</code>
                     </entry>
+
                     <entry>
                         Appends to a <acronym>LDAP</acronym> date/time attribute. Data conversion is
                         applied using
                         <methodname>Zend_Ldap_Attribute::setDateTimeAttribute()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Node setPasswordAttribute(string $password,
-                        string $hashType, string $attribName)</code>
+                            string $hashType, string $attribName)</code>
                     </entry>
+
                     <entry>
-                        Sets a <acronym>LDAP</acronym> password on <varname>$attribName</varname> (defaults
-                        to <code>'userPassword'</code>) to <varname>$password</varname> with the
-                        hash type <varname>$hashType</varname> (defaults to
+                        Sets a <acronym>LDAP</acronym> password on <varname>$attribName</varname>
+                        (defaults to <code>'userPassword'</code>) to <varname>$password</varname>
+                        with the hash type <varname>$hashType</varname> (defaults to
                         <constant>Zend_Ldap_Attribute::PASSWORD_HASH_MD5</constant>).
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node deleteAttribute(string
-                        $name)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node deleteAttribute(string $name)</code></entry>
                     <entry>Deletes a <acronym>LDAP</acronym> attribute.</entry>
                 </row>
+
                 <row>
+                    <entry><code>void removeDuplicatesFromAttribute(string$name)</code></entry>
+
                     <entry>
-                        <code>void removeDuplicatesFromAttribute(string
-                        $name)</code>
+                        Removes duplicate values from a <acronym>LDAP</acronym> attribute.
                     </entry>
-                    <entry>Removes duplicate values from a <acronym>LDAP</acronym> attribute.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>void removeFromAttribute(string $attribName,
-                        mixed|array $value)</code>
+                            mixed|array $value)</code>
+                    </entry>
+
+                    <entry>
+                        Removes the given values from a <acronym>LDAP</acronym> attribute.
                     </entry>
-                    <entry>Removes the given values from a <acronym>LDAP</acronym> attribute.</entry>
                 </row>
+
                 <row>
                     <entry><code>boolean exists(Zend_Ldap $ldap)</code></entry>
+
                     <entry>
-                        Checks if the current node exists on the given <acronym>LDAP</acronym> server
-                        (current server is used if <constant>NULL</constant> is passed).
+                        Checks if the current node exists on the given <acronym>LDAP</acronym>
+                        server (current server is used if <constant>NULL</constant> is passed).
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node reload(Zend_Ldap $ldap)</code></entry>
+
                     <entry>
                         Reloads the current node's attributes from the given <acronym>LDAP</acronym>
                         server (current server is used if <constant>NULL</constant> is
                         passed).
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Node_Collection
-                        searchSubtree(string|Zend_Ldap_Filter_Abstract $filter, integer
-                        $scope, string $sort)</code>
+                            searchSubtree(string|Zend_Ldap_Filter_Abstract $filter, integer
+                            $scope, string $sort)</code>
                     </entry>
+
                     <entry>
                         Searches the nodes's subtree with the given
                         <varname>$filter</varname> and the given search parameters. See
@@ -471,11 +534,13 @@
                         <varname>$scope</varname> and <varname>$sort</varname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>integer countSubtree(string|Zend_Ldap_Filter_Abstract
-                        $filter, integer $scope)</code>
+                            $filter, integer $scope)</code>
                     </entry>
+
                     <entry>
                         Count the nodes's subtree items matching the given
                         <varname>$filter</varname> and the given search scope. See
@@ -483,46 +548,46 @@
                         <varname>$scope</varname> parameter.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>integer countChildren()</code></entry>
                     <entry>Count the nodes's children.</entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap_Node_Collection
-                        searchChildren(string|Zend_Ldap_Filter_Abstract $filter, string
-                        $sort)</code>
+                            searchChildren(string|Zend_Ldap_Filter_Abstract $filter, string
+                            $sort)</code>
                     </entry>
+
                     <entry>
                         Searches the nodes's children matching the given
-                        <varname>$filter</varname>. See <methodname>Zend_Ldap::search()</methodname> for
-                        details on the <varname>$sort</varname> parameter.
+                        <varname>$filter</varname>. See <methodname>Zend_Ldap::search()</methodname>
+                        for details on the <varname>$sort</varname> parameter.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>boolean hasChildren()</code></entry>
                     <entry>Returns whether the current node has children.</entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node_ChildrenIterator
-                        getChildren()</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node_ChildrenIterator getChildren()</code></entry>
                     <entry>Returns all children of the current node.</entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node getParent(Zend_Ldap
-                        $ldap)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node getParent(Zend_Ldap $ldap)</code></entry>
+
                     <entry>
                         Returns the parent of the current node using the <acronym>LDAP</acronym>
-                        connection <varname>$ldap</varname> (uses the current <acronym>LDAP</acronym> connection if
-                        omitted).
+                        connection <varname>$ldap</varname> (uses the current
+                        <acronym>LDAP</acronym> connection if omitted).
                     </entry>
                 </row>
             </tbody>
         </tgroup>
     </table>
 </sect3>
-

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

@@ -4,9 +4,9 @@
     <title>Zend_Ldap</title>
 
     <para>
-        <classname>Zend_Ldap</classname> is the base interface into a <acronym>LDAP</acronym> server. It provides
-        connection and binding methods as well as methods to operate on the <acronym>LDAP</acronym>
-        tree.
+        <classname>Zend_Ldap</classname> is the base interface into a <acronym>LDAP</acronym>
+        server. It provides connection and binding methods as well as methods to operate on the
+        <acronym>LDAP</acronym> tree.
     </para>
 
     <table id="zend.ldap.api.reference.zend-ldap.table">
@@ -19,32 +19,38 @@
                     <entry>Description</entry>
                 </row>
             </thead>
+
             <tbody>
                 <row>
+                    <entry><code>string filterEscape(string $str)</code></entry>
+
                     <entry>
-                        <code>string filterEscape(string $str)</code>
-                    </entry>
-                    <entry>
-                        Escapes a value to be used in a <acronym>LDAP</acronym> filter according to <acronym>RFC</acronym>
-                        2254. This method is <emphasis>deprecated</emphasis>, please use
-                        <methodname>Zend_Ldap_Filter_Abstract::escapeValue()</methodname>
+                        Escapes a value to be used in a <acronym>LDAP</acronym> filter according to
+                        <acronym>RFC</acronym> 2254. This method is <emphasis>deprecated</emphasis>,
+                        please use <methodname>Zend_Ldap_Filter_Abstract::escapeValue()</methodname>
                         instead.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>boolean explodeDn($dn, array &amp;$keys = null, array &amp;$vals = null)</code>
+                        <code>boolean explodeDn($dn, array &amp;$keys = null, array &amp;$vals =
+                            null)</code>
                     </entry>
+
                     <entry>
                         Checks if a given DN <varname>$dn</varname> is malformed. If
-                        <varname>$keys</varname> or <varname>$keys</varname> and <varname>$vals</varname> are
-                        given, these arrays will be filled with the appropriate DN keys and
-                        values. This method is <emphasis>deprecated</emphasis>, please use
+                        <varname>$keys</varname> or <varname>$keys</varname> and
+                        <varname>$vals</varname> are given, these arrays will be filled with the
+                        appropriate DN keys and values. This method is
+                        <emphasis>deprecated</emphasis>, please use
                         <methodname>Zend_Ldap_Dn::checkDn()</methodname> instead.
                     </entry>
                 </row>
+
                 <row>
                     <entry><methodname>__construct($options)</methodname></entry>
+
                     <entry>
                         Constructor. The <varname>$options</varname> parameter is optional
                         and can be set to an array or a <classname>Zend_Config</classname> instance.
@@ -56,32 +62,44 @@
                             Options</link>
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>resource getResource()</code></entry>
-                    <entry>Returns the raw <acronym>LDAP</acronym> extension (ext/ldap) resource.</entry>
+
+                    <entry>
+                        Returns the raw <acronym>LDAP</acronym> extension (ext/ldap) resource.
+                    </entry>
                 </row>
+
                 <row>
                     <entry><code>integer getLastErrorCode()</code></entry>
+
                     <entry>
-                        Returns the <acronym>LDAP</acronym> error number of the last <acronym>LDAP</acronym>
-                        command.
+                        Returns the <acronym>LDAP</acronym> error number of the last
+                        <acronym>LDAP</acronym> command.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>string getLastError(integer &amp;$errorCode, array &amp;$errorMessages)</code>
+                        <code>string getLastError(integer &amp;$errorCode, array
+                            &amp;$errorMessages)</code>
                     </entry>
+
                     <entry>
-                        Returns the <acronym>LDAP</acronym> error message of the last <acronym>LDAP</acronym> command. The
-                        optional <varname>$errorCode</varname> parameter is set to the <acronym>LDAP</acronym> error
-                        number when given. The optional <varname>$errorMessages</varname> array
-                        will be filled with the raw error messages when given. The various
-                        <acronym>LDAP</acronym> error retrieval functions can return different things, so they
-                        are all collected if <varname>$errorMessages</varname> is given.
+                        Returns the <acronym>LDAP</acronym> error message of the last
+                        <acronym>LDAP</acronym> command. The optional <varname>$errorCode</varname>
+                        parameter is set to the <acronym>LDAP</acronym> error number when given. The
+                        optional <varname>$errorMessages</varname> array will be filled with the raw
+                        error messages when given. The various <acronym>LDAP</acronym> error
+                        retrieval functions can return different things, so they are all collected
+                        if <varname>$errorMessages</varname> is given.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap setOptions($options)</code></entry>
+
                     <entry>
                         Sets the <acronym>LDAP</acronym> connection and binding parameters.
                         <varname>$options</varname> can be an array or an instance of
@@ -90,80 +108,94 @@
                             linkend="zend.ldap.api.configuration.table">Zend_Ldap Options</link>
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>array getOptions()</code></entry>
-                    <entry>
-                        Returns the current connection and binding
-                        parameters.
-                    </entry>
+                    <entry>Returns the current connection and binding parameters.</entry>
                 </row>
+
                 <row>
                     <entry><code>string getBaseDn()</code></entry>
+
                     <entry>
                         Returns the base DN this <acronym>LDAP</acronym> connection is bound
                         to.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>string getCanonicalAccountName(string $acctname, integer $form)</code>
                     </entry>
+
                     <entry>
                         Returns the canonical account name of the given account name
                         <varname>$acctname</varname>. <varname>$form</varname> specifies the <link
                             linkend="zend.ldap.using.theory-of-operation.account-name-canonicalization.table">format</link>
                         into which the account name is canonicalized. See <link
-                            linkend="zend.ldap.introduction.theory-of-operations.account-name-canonicalization">Account Name Canonicalization</link>
-                        for more details.
+                            linkend="zend.ldap.introduction.theory-of-operations.account-name-canonicalization">Account
+                            Name Canonicalization</link> for more details.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap disconnect()</code></entry>
+
                     <entry>
                         Disconnects the Zend_Ldap instance from the <acronym>LDAP</acronym>
                         server.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap connect(string $host, integer $port, boolean $useSsl, boolean $useStartTls)</code>
+                        <code>Zend_Ldap connect(string $host, integer $port, boolean $useSsl,
+                            boolean $useStartTls)</code>
                     </entry>
+
                     <entry>
                         Connects the Zend_Ldap instance to the given <acronym>LDAP</acronym> server.
-                        All parameters are optional and will be taken from the <acronym>LDAP</acronym>
-                        connection and binding parameters passed to the instance via the
-                        construtor or via <methodname>Zend_Ldap::setOptions()</methodname> when set to
+                        All parameters are optional and will be taken from the
+                        <acronym>LDAP</acronym> connection and binding parameters passed to the
+                        instance via the construtor or via
+                        <methodname>Zend_Ldap::setOptions()</methodname> when set to
                         <constant>NULL</constant>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap bind(string $username, string $password)</code>
                     </entry>
+
                     <entry>
                         Authenticates <varname>$username</varname> with
-                        <varname>$password</varname> at the <acronym>LDAP</acronym> server. If both paramaters are
-                        omitted the binding will be carried out with the credentials given
-                        in the connection and binding parameters. If no credentials are
+                        <varname>$password</varname> at the <acronym>LDAP</acronym> server. If both
+                        paramaters are omitted the binding will be carried out with the credentials
+                        given in the connection and binding parameters. If no credentials are
                         given in the connection and binding parameters an anonymous bind
-                        will be performed. Note that this requires anonymous binds to be
-                        allowed on the <acronym>LDAP</acronym> server. An empty string <code>''</code> can be
-                        passed as <varname>$password</varname> together with a username if, and
+                        will be performed. Note that this requires anonymous binds to be allowed
+                        on the <acronym>LDAP</acronym> server. An empty string <code>''</code> can
+                        be passed as <varname>$password</varname> together with a username if, and
                         only if, <code>allowEmptyPassword</code> is set to
                         <constant>TRUE</constant> in the connection and binding parameters.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap_Collection search(string|Zend_Ldap_Filter_Abstract $filter, string|Zend_Ldap_Dn $basedn, integer $scope, array $attributes, string $sort, string $collectionClass)</code>
+                        <code>Zend_Ldap_Collection search(string|Zend_Ldap_Filter_Abstract $filter,
+                            string|Zend_Ldap_Dn $basedn, integer $scope, array $attributes, string
+                            $sort, string $collectionClass)</code>
                     </entry>
+
                     <entry>
-                        Searches the <acronym>LDAP</acronym> tree with the given <varname>$filter</varname>
-                        and the given search parameters.
+                        Searches the <acronym>LDAP</acronym> tree with the given
+                        <varname>$filter</varname> and the given search parameters.
+
                         <variablelist>
                             <varlistentry>
-                                <term><code>string|Zend_Ldap_Filter_Abstract
-                                $filter</code></term>
+                                <term><code>string|Zend_Ldap_Filter_Abstract $filter</code></term>
 
                                 <listitem>
                                     <para>
@@ -191,14 +223,15 @@
                                 <listitem>
                                     <para>
                                         The search scope.
-                                        <constant>Zend_Ldap::SEARCH_SCOPE_SUB</constant> searches the
-                                        complete subtree including the <varname>$baseDn</varname> node.
-                                        <constant>Zend_Ldap::SEARCH_SCOPE_ONE</constant> restricts search
-                                        to one level below <varname>$baseDn</varname>.
-                                        <constant>Zend_Ldap::SEARCH_SCOPE_BASE</constant> restricts search
-                                        to the <varname>$baseDn</varname> itself; this can be used to
-                                        efficiently retrieve a single entry by its DN. The default
-                                        value is
+                                        <constant>Zend_Ldap::SEARCH_SCOPE_SUB</constant> searches
+                                        the complete subtree including the
+                                        <varname>$baseDn</varname> node.
+                                        <constant>Zend_Ldap::SEARCH_SCOPE_ONE</constant> restricts
+                                        search to one level below <varname>$baseDn</varname>.
+                                        <constant>Zend_Ldap::SEARCH_SCOPE_BASE</constant> restricts
+                                        search to the <varname>$baseDn</varname> itself; this can be
+                                        used to efficiently retrieve a single entry by its DN. The
+                                        default value is
                                         <constant>Zend_Ldap::SEARCH_SCOPE_SUB</constant>.
                                     </para>
                                 </listitem>
@@ -213,10 +246,11 @@
                                         returned entries. To include all possible attributes (ACL
                                         restrictions can disallow certain attribute to be retrieved
                                         by a given user) pass either an empty array
-                                        <methodname>array()</methodname> or <methodname>array('*')</methodname> to the
-                                        method. On some <acronym>LDAP</acronym> servers you can retrieve special
-                                        internal attributes by passing <methodname>array('*', '+')</methodname>
-                                        to the method.
+                                        <methodname>array()</methodname> or
+                                        <methodname>array('*')</methodname> to the method. On some
+                                        <acronym>LDAP</acronym> servers you can retrieve special
+                                        internal attributes by passing
+                                        <methodname>array('*', '+')</methodname> to the method.
                                     </para>
                                 </listitem>
                             </varlistentry>
@@ -226,8 +260,8 @@
 
                                 <listitem>
                                     <para>
-                                        If given the result collection will be sorted
-                                        after the attribute <varname>$sort</varname>. Results can only be
+                                        If given the result collection will be sorted after the
+                                        attribute <varname>$sort</varname>. Results can only be
                                         sorted after one single attribute as this parameter uses
                                         the ext/ldap function <methodname>ldap_sort()</methodname>.
                                     </para>
@@ -239,83 +273,94 @@
 
                                 <listitem>
                                     <para>
-                                        If given the result will be wrapped in an object
-                                        of type <varname>$collectionClass</varname>. By default an object
-                                        of type <classname>Zend_Ldap_Collection</classname> will be returned.
-                                        The custom class must extend
-                                        <classname>Zend_Ldap_Collection</classname> and will be passed a
-                                        <classname>Zend_Ldap_Collection_Iterator_Default</classname> on
-                                        instantiation.
+                                        If given the result will be wrapped in an object of type
+                                        <varname>$collectionClass</varname>. By default an object
+                                        of type <classname>Zend_Ldap_Collection</classname> will be
+                                        returned. The custom class must extend
+                                        <classname>Zend_Ldap_Collection</classname> and will be
+                                        passed a
+                                        <classname>Zend_Ldap_Collection_Iterator_Default</classname>
+                                        on instantiation.
                                     </para>
                                 </listitem>
                             </varlistentry>
                         </variablelist>
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>integer count(string|Zend_Ldap_Filter_Abstract
                         $filter, string|Zend_Ldap_Dn $basedn, integer
                         $scope)</code>
                     </entry>
+
                     <entry>
                         Counts the elements returned by the given search parameters.
-                        See <methodname>Zend_Ldap::search()</methodname> for a detailed description of
-                        the method parameters.
+                        See <methodname>Zend_Ldap::search()</methodname> for a detailed description
+                        of the method parameters.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>integer countChildren(string|Zend_Ldap_Dn
-                        $dn)</code>
-                    </entry>
+                    <entry><code>integer countChildren(string|Zend_Ldap_Dn $dn)</code></entry>
+
                     <entry>
                         Counts the direct descendants (children) of the entry
                         identified by the given <varname>$dn</varname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>boolean exists(string|Zend_Ldap_Dn $dn)</code></entry>
+
                     <entry>
                         Checks whether the entry identified by the given
                         <varname>$dn</varname> exists.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>array searchEntries(string|Zend_Ldap_Filter_Abstract
                         $filter, string|Zend_Ldap_Dn $basedn, integer $scope, array
                         $attributes, string $sort)</code>
                     </entry>
+
                     <entry>
-                        Performs a search operation and returns the result as an <acronym>PHP</acronym>
-                        array. This is essentially the same method as
+                        Performs a search operation and returns the result as an
+                        <acronym>PHP</acronym> array. This is essentially the same method as
                         <methodname>Zend_Ldap::search()</methodname> except for the return type. See
-                        <methodname>Zend_Ldap::search()</methodname> for a detailed description of the
-                        method parameters.
+                        <methodname>Zend_Ldap::search()</methodname> for a detailed description of
+                        the method parameters.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>array getEntry(string|Zend_Ldap_Dn $dn, array
                         $attributes, boolean $throwOnNotFound)</code>
                     </entry>
+
                     <entry>
-                        Retrieves the <acronym>LDAP</acronym> entry identified by <varname>$dn</varname> with
-                        the attributes specified in <varname>$attributes</varname>. If
-                        <varname>$attributes</varname> is ommitted, all attributes
-                        (<methodname>array()</methodname>) are included in the result.
-                        <varname>$throwOnNotFound</varname> is <constant>FALSE</constant> by default, so
-                        the method will return <constant>NULL</constant> if the specified entry
-                        cannot be found. If set to <constant>TRUE</constant>, a
-                        <classname>Zend_Ldap_Exception</classname> will be thrown instead.
+                        Retrieves the <acronym>LDAP</acronym> entry identified by
+                        <varname>$dn</varname> with the attributes specified in
+                        <varname>$attributes</varname>. if <varname>$attributes</varname> is
+                        ommitted, all attributes (<methodname>array()</methodname>) are included in
+                        the result. <varname>$throwOnNotFound</varname> is
+                        <constant>FALSE</constant> by default, so the method will return
+                        <constant>NULL</constant> if the specified entry cannot be found. If set to
+                        <constant>TRUE</constant>, a <classname>Zend_Ldap_Exception</classname> will
+                        be thrown instead.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <emphasis><code>void prepareLdapEntryArray(array
-                        &amp;$entry)</code> </emphasis>
+                            &amp;$entry)</code></emphasis>
                     </entry>
+
                     <entry>
                         Prepare an array for the use in <acronym>LDAP</acronym> modification
                         operations. This method does not need to be called by the end-user
@@ -323,106 +368,120 @@
                         method.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap add(string|Zend_Ldap_Dn $dn, array
                         $entry)</code>
                     </entry>
+
                     <entry>
-                        Adds the entry identified by <varname>$dn</varname> with its
-                        attributes <varname>$entry</varname> to the <acronym>LDAP</acronym> tree. Throws a
+                        Adds the entry identified by <varname>$dn</varname> with its attributes
+                        <varname>$entry</varname> to the <acronym>LDAP</acronym> tree. Throws a
                         <classname>Zend_Ldap_Exception</classname> if the entry could not be
                         added.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap update(string|Zend_Ldap_Dn $dn, array
-                        $entry)</code>
+                        <code>Zend_Ldap update(string|Zend_Ldap_Dn $dn, array $entry)</code>
                     </entry>
+
                     <entry>
-                        Updates the entry identified by <varname>$dn</varname> with its
-                        attributes <varname>$entry</varname> to the <acronym>LDAP</acronym> tree. Throws a
+                        Updates the entry identified by <varname>$dn</varname> with its attributes
+                        <varname>$entry</varname> to the <acronym>LDAP</acronym> tree. Throws a
                         <classname>Zend_Ldap_Exception</classname> if the entry could not be
                         modified.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap save(string|Zend_Ldap_Dn $dn, array
-                        $entry)</code>
+                        <code>Zend_Ldap save(string|Zend_Ldap_Dn $dn, array $entry)</code>
                     </entry>
+
                     <entry>
-                        Saves the entry identified by <varname>$dn</varname> with its
-                        attributes <varname>$entry</varname> to the <acronym>LDAP</acronym> tree. Throws a
+                        Saves the entry identified by <varname>$dn</varname> with its attributes
+                        <varname>$entry</varname> to the <acronym>LDAP</acronym> tree. Throws a
                         <classname>Zend_Ldap_Exception</classname> if the entry could not be saved.
-                        This method decides by querying the <acronym>LDAP</acronym> tree if the entry will be
-                        added or updated.
+                        This method decides by querying the <acronym>LDAP</acronym> tree if the
+                        entry will be added or updated.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
-                        <code>Zend_Ldap delete(string|Zend_Ldap_Dn $dn, boolean
-                        $recursively)</code>
+                        <code>Zend_Ldap delete(string|Zend_Ldap_Dn $dn, boolean $recursively)</code>
                     </entry>
+
                     <entry>
                         Deletes the entry identified by <varname>$dn</varname> from the
-                        <acronym>LDAP</acronym> tree. Throws a <classname>Zend_Ldap_Exception</classname> if the entry
-                        could not be deleted. <varname>$recursively</varname> is
-                        <constant>FALSE</constant> by default. If set to <constant>TRUE</constant> the
-                        deletion will be carried out recursively and will effectively
-                        delete a complete subtree. Deletion will fail if
-                        <varname>$recursively</varname> is <constant>FALSE</constant> and the entry
-                        <varname>$dn</varname> is not a leaf entry.
+                        <acronym>LDAP</acronym> tree. Throws a
+                        <classname>Zend_Ldap_Exception</classname> if the entry could not be
+                        deleted. <varname>$recursively</varname> is <constant>FALSE</constant> by
+                        default. If set to <constant>TRUE</constant> the deletion will be carried
+                        out recursively and will effectively delete a complete subtree. Deletion
+                        will fail if <varname>$recursively</varname> is <constant>FALSE</constant>
+                        and the entry <varname>$dn</varname> is not a leaf entry.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap moveToSubtree(string|Zend_Ldap_Dn $from,
                         string|Zend_Ldap_Dn $to, boolean $recursively, boolean
                         $alwaysEmulate)</code>
                     </entry>
+
                     <entry>
-                        Moves the entry identified by <varname>$from</varname> to a
-                        location below <varname>$to</varname> keeping its <acronym>RDN</acronym> unchanged.
+                        Moves the entry identified by <varname>$from</varname> to a location below
+                        <varname>$to</varname> keeping its <acronym>RDN</acronym> unchanged.
                         <varname>$recursively</varname> specifies if the operation will be
                         carried out recursively (<constant>FALSE</constant> by default) so that the
                         entry <varname>$from</varname> and all its descendants will be moved.
-                        Moving will fail if <varname>$recursively</varname> is <constant>FALSE</constant>
-                        and the entry <varname>$from</varname> is not a leaf entry.
-                        <varname>$alwaysEmulate</varname> controls whether the ext/ldap function
-                        <methodname>ldap_rename()</methodname> should be used if available. This can
-                        only work for leaf entries and for servers and for ext/ldap
+                        Moving will fail if <varname>$recursively</varname> is
+                        <constant>FALSE</constant> and the entry <varname>$from</varname> is not a
+                        leaf entry. <varname>$alwaysEmulate</varname> controls whether the ext/ldap
+                        function <methodname>ldap_rename()</methodname> should be used if available.
+                        This can only work for leaf entries and for servers and for ext/ldap
                         supporting this function. Set to <constant>TRUE</constant> to always use an
                         emulated rename operation.
+
                         <note>
-                            <para>All move-operations are carried out by copying and then
-                            deleting the corresponding entries in the <acronym>LDAP</acronym> tree. These
-                            operations are not <emphasis>atomic</emphasis> so that failures
-                            during the operation will result in an
-                            <emphasis>inconsistent</emphasis> state on the <acronym>LDAP</acronym> server. The
-                            same is true for all recursive operations. They also are by no
-                            means atomic. Please keep this in mind.
-                        </para>
-                    </note></entry>
+                            <para>
+                                All move-operations are carried out by copying and then deleting the
+                                corresponding entries in the <acronym>LDAP</acronym> tree. These
+                                operations are not <emphasis>atomic</emphasis> so that failures
+                                during the operation will result in an
+                                <emphasis>inconsistent</emphasis> state on the
+                                <acronym>LDAP</acronym> server. The same is true for all recursive
+                                operations. They also are by no means atomic. Please keep this in
+                                mind.
+                            </para>
+                        </note>
+                    </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap move(string|Zend_Ldap_Dn $from,
                         string|Zend_Ldap_Dn $to, boolean $recursively, boolean
                         $alwaysEmulate)</code>
                     </entry>
+
                     <entry>
-                        This is an alias for
-                        <methodname>Zend_Ldap::rename()</methodname>.
+                        This is an alias for <methodname>Zend_Ldap::rename()</methodname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap rename(string|Zend_Ldap_Dn $from,
                         string|Zend_Ldap_Dn $to, boolean $recursively, boolean
                         $alwaysEmulate)</code>
                     </entry>
+
                     <entry>
                         Renames the entry identified by <varname>$from</varname> to
                         <varname>$to</varname>. <varname>$recursively</varname> specifies if the
@@ -430,35 +489,39 @@
                         default) so that the entry <varname>$from</varname> and all its
                         descendants will be moved. Moving will fail if
                         <varname>$recursively</varname> is <constant>FALSE</constant> and the entry
-                        <varname>$from</varname> is not a leaf entry. <varname>$alwaysEmulate</varname>
-                        controls whether the ext/ldap function <methodname>ldap_rename()</methodname>
-                        should be used if available. This can only work for leaf entries
-                        and for servers and for ext/ldap supporting this function. Set to
-                        <constant>TRUE</constant> to always use an emulated rename
+                        <varname>$from</varname> is not a leaf entry.
+                        <varname>$alwaysEmulate</varname> controls whether the ext/ldap function
+                        <methodname>ldap_rename()</methodname> should be used if available. This can
+                        only work for leaf entries and for servers and for ext/ldap supporting this
+                        function. Set to <constant>TRUE</constant> to always use an emulated rename
                         operation.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap copyToSubtree(string|Zend_Ldap_Dn $from,
                         string|Zend_Ldap_Dn $to, boolean $recursively)</code>
                     </entry>
+
                     <entry>
-                        Copies the entry identified by <varname>$from</varname> to a
-                        location below <varname>$to</varname> keeping its <acronym>RDN</acronym> unchanged.
+                        Copies the entry identified by <varname>$from</varname> to a location below
+                        <varname>$to</varname> keeping its <acronym>RDN</acronym> unchanged.
                         <varname>$recursively</varname> specifies if the operation will be
                         carried out recursively (<constant>FALSE</constant> by default) so that the
                         entry <varname>$from</varname> and all its descendants will be copied.
                         Copying will fail if <varname>$recursively</varname> is
-                        <constant>FALSE</constant> and the entry <varname>$from</varname> is not a leaf
-                        entry.
+                        <constant>FALSE</constant> and the entry <varname>$from</varname> is not a
+                        leaf entry.
                     </entry>
                 </row>
+
                 <row>
                     <entry>
                         <code>Zend_Ldap copy(string|Zend_Ldap_Dn $from,
                         string|Zend_Ldap_Dn $to, boolean $recursively)</code>
                     </entry>
+
                     <entry>
                         Copies the entry identified by <varname>$from</varname> to
                         <varname>$to</varname>. <varname>$recursively</varname> specifies if the
@@ -469,30 +532,35 @@
                         <varname>$from</varname> is not a leaf entry.
                     </entry>
                 </row>
+
                 <row>
-                    <entry>
-                        <code>Zend_Ldap_Node getNode(string|Zend_Ldap_Dn
-                        $dn)</code>
-                    </entry>
+                    <entry><code>Zend_Ldap_Node getNode(string|Zend_Ldap_Dn $dn)</code></entry>
+
                     <entry>
                         Returns the entry <varname>$dn</varname> wrapped in a
                         <classname>Zend_Ldap_Node</classname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node getBaseNode()</code></entry>
+
                     <entry>
                         Returns the entry for the base DN <varname>$baseDn</varname>
                         wrapped in a <classname>Zend_Ldap_Node</classname>.
                     </entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node_RootDse getRootDse()</code></entry>
                     <entry>Returns the RootDSE for the current server.</entry>
                 </row>
+
                 <row>
                     <entry><code>Zend_Ldap_Node_Schema getSchema()</code></entry>
-                    <entry>Returns the <acronym>LDAP</acronym> schema for the current server.</entry>
+                    <entry>
+                        Returns the <acronym>LDAP</acronym> schema for the current server.
+                    </entry>
                 </row>
             </tbody>
         </tgroup>
@@ -504,54 +572,61 @@
         <para>
             <classname>Zend_Ldap_Collection</classname> implements <code>Iterator</code> to
             allow for item traversal using <methodname>foreach()</methodname> and
-            <code>Countable</code> to be able to respond to <methodname>count()</methodname>. With its
-            protected <methodname>_createEntry()</methodname> method it provides a simple extension
-            point for developers needing custom result objects.
+            <code>Countable</code> to be able to respond to <methodname>count()</methodname>. With
+            its protected <methodname>_createEntry()</methodname> method it provides a simple
+            extension point for developers needing custom result objects.
         </para>
 
         <table id="zend.ldap.api.reference.zend-ldap.zend-ldap-collection.table">
             <title>Zend_Ldap_Collection API</title>
 
             <tgroup cols="2">
-            <thead>
-                <row>
-                    <entry>Method</entry>
-                    <entry>Description</entry>
-                </row>
-            </thead>
-            <tbody>
-                <row>
-                    <entry>
-                        <code>__construct(Zend_Ldap_Collection_Iterator_Interface
-                        $iterator)</code>
-                    </entry>
-                    <entry>
-                        Constructor. The constrcutor must be provided by a
-                        <classname>Zend_Ldap_Collection_Iterator_Interface</classname> which does the
-                        real result iteration.
-                        <classname>Zend_Ldap_Collection_Iterator_Default</classname> is the default
-                        implementation for iterating ext/ldap results.
-                    </entry>
-                </row>
-                <row>
-                    <entry><code>boolean close()</code></entry>
-                    <entry>
-                        Closes the internal iterator. This is also called in the
-                        destructor.
-                    </entry>
-                </row>
-                <row>
-                    <entry><code>array toArray()</code></entry>
-                    <entry>Returns all entries as an array.</entry>
-                </row>
-                <row>
-                    <entry><code>array getFirst()</code></entry>
-                    <entry>
-                        Returns the first entry in the collection or
-                        <constant>NULL</constant> if the collection is empty.
-                    </entry>
-                </row>
-            </tbody></tgroup>
+                <thead>
+                    <row>
+                        <entry>Method</entry>
+                        <entry>Description</entry>
+                    </row>
+                </thead>
+
+                <tbody>
+                    <row>
+                        <entry>
+                            <code>__construct(Zend_Ldap_Collection_Iterator_Interface
+                            $iterator)</code>
+                        </entry>
+
+                        <entry>
+                            Constructor. The constrcutor must be provided by a
+                            <classname>Zend_Ldap_Collection_Iterator_Interface</classname> which
+                            does the real result iteration.
+                            <classname>Zend_Ldap_Collection_Iterator_Default</classname> is the
+                            default implementation for iterating ext/ldap results.
+                        </entry>
+                    </row>
+
+                    <row>
+                        <entry><code>boolean close()</code></entry>
+
+                        <entry>
+                            Closes the internal iterator. This is also called in the destructor.
+                        </entry>
+                    </row>
+
+                    <row>
+                        <entry><code>array toArray()</code></entry>
+                        <entry>Returns all entries as an array.</entry>
+                    </row>
+
+                    <row>
+                        <entry><code>array getFirst()</code></entry>
+
+                        <entry>
+                            Returns the first entry in the collection or
+                            <constant>NULL</constant> if the collection is empty.
+                        </entry>
+                    </row>
+                </tbody>
+            </tgroup>
         </table>
     </sect4>
 </sect3>

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

@@ -22,9 +22,11 @@
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><property>host</property></entry>
+
                         <entry>
                             The default hostname of <acronym>LDAP</acronym> server if not
                             supplied to <methodname>connect()</methodname> (also may be used
@@ -32,15 +34,19 @@
                             <methodname>bind()</methodname>).
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>port</property></entry>
+
                         <entry>
                             Default port of <acronym>LDAP</acronym> server if not supplied to
                             <methodname>connect()</methodname>.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>useStartTls</property></entry>
+
                         <entry>
                             Whether or not the <acronym>LDAP</acronym> client should use
                             <acronym>TLS</acronym> (aka <acronym>SSLv2</acronym>) encrypted
@@ -55,8 +61,10 @@
                             this newer mechanism.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>useSsl</property></entry>
+
                         <entry>
                             Whether or not the <acronym>LDAP</acronym> client should use
                             <acronym>SSL</acronym> encrypted transport. The
@@ -64,8 +72,10 @@
                             options are mutually exclusive.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>username</property></entry>
+
                         <entry>
                             The default credentials username. Some servers require that this
                             be in DN form. This must be given in DN form if the
@@ -73,15 +83,19 @@
                             should be possible with simple usernames.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>password</property></entry>
+
                         <entry>
                             The default credentials password (used only with username
                             above).
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>bindRequiresDn</property></entry>
+
                         <entry>
                             If <constant>TRUE</constant>, this instructs
                             <classname>Zend_Ldap</classname> to retrieve the DN for the
@@ -89,16 +103,20 @@
                             already in DN form. The default value is <constant>FALSE</constant>.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>baseDn</property></entry>
+
                         <entry>
                             The default base DN used for searching (e.g., for accounts).
                             This option is required for most account related operations and should
                             indicate the DN under which accounts are located.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>accountCanonicalForm</property></entry>
+
                         <entry>
                             A small integer indicating the form to which account names
                             should be canonicalized. See the <link
@@ -107,23 +125,29 @@
                             section below.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>accountDomainName</property></entry>
+
                         <entry>
-                            The <acronym>FQDN</acronym> domain for which the target <acronym>LDAP</acronym> server
-                            is an authority (e.g., example.com).
+                            The <acronym>FQDN</acronym> domain for which the target
+                            <acronym>LDAP</acronym> server is an authority (e.g., example.com).
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>accountDomainNameShort</property></entry>
+
                         <entry>
                             The 'short' domain for which the target <acronym>LDAP</acronym> server
                             is an authority. This is usually used to specify the NetBIOS
                             domain name for Windows networks but may also be used by non-AD servers.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>accountFilterFormat</property></entry>
+
                         <entry>
                             The <acronym>LDAP</acronym> search filter used to search for accounts.
                             This string is a <ulink
@@ -137,8 +161,10 @@
                             Users of custom schemas may need to change this option.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>allowEmptyPassword</property></entry>
+
                         <entry>
                             Some <acronym>LDAP</acronym> servers can be configured to accept an
                             empty string password as an anonymous bind. This behavior is almost
@@ -147,16 +173,20 @@
                             empty string password to be submitted during the bind.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>optReferrals</property></entry>
+
                         <entry>
                             If set to <constant>TRUE</constant>, this option indicates to the
                             <acronym>LDAP</acronym> client that referrals should be followed.
                             The default value is <constant>FALSE</constant>.
                         </entry>
                     </row>
+
                     <row>
                         <entry><property>tryUsernameSplit</property></entry>
+
                         <entry>
                             If set to <constant>FALSE</constant>, this option indicates that the
                             given username should not be split at the first <emphasis>@</emphasis>

documentation/manual/en/module_specs/Zend_Ldap-Introduction.xml

@@ -157,6 +157,7 @@ echo "$acctname\n";
 
             <table id="zend.ldap.using.theory-of-operation.account-name-canonicalization.table">
                 <title>Options for accountCanonicalForm</title>
+
                 <tgroup cols="3">
                     <thead>
                         <row>
@@ -165,32 +166,28 @@ echo "$acctname\n";
                             <entry>Example</entry>
                         </row>
                     </thead>
+
                     <tbody>
                         <row>
-                            <entry>
-                                <constant>ACCTNAME_FORM_DN</constant>
-                            </entry>
+                            <entry><constant>ACCTNAME_FORM_DN</constant></entry>
                             <entry>1</entry>
                             <entry>CN=Alice Baker,CN=Users,DC=example,DC=com</entry>
                         </row>
+
                         <row>
-                            <entry>
-                                <constant>ACCTNAME_FORM_USERNAME</constant>
-                            </entry>
+                            <entry><constant>ACCTNAME_FORM_USERNAME</constant></entry>
                             <entry>2</entry>
                             <entry>abaker</entry>
                         </row>
+
                         <row>
-                            <entry>
-                                <constant>ACCTNAME_FORM_BACKSLASH</constant>
-                            </entry>
+                            <entry><constant>ACCTNAME_FORM_BACKSLASH</constant></entry>
                             <entry>3</entry>
                             <entry>EXAMPLE\abaker</entry>
                         </row>
+
                         <row>
-                            <entry>
-                                <constant>ACCTNAME_FORM_PRINCIPAL</constant>
-                            </entry>
+                            <entry><constant>ACCTNAME_FORM_PRINCIPAL</constant></entry>
                             <entry>4</entry>
                             <entry><filename>abaker@example.com</filename></entry>
                         </row>

documentation/manual/en/module_specs/Zend_Ldap-LDIF.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.ldap.ldif">
     <title>Serializing LDAP data to and from LDIF</title>
+
     <sect2 id="zend.ldap.ldif.encode">
         <title>Serialize a LDAP entry to LDIF</title>
 
@@ -62,7 +63,6 @@ cn;lang-en: Rodney Ogasawara
 title;lang-en: Sales, Director
 */
 ]]></programlisting>
-
     </sect2>
 
     <sect2 id="zend.ldap.ldif.decode">
@@ -123,7 +123,6 @@ $data = array(
 );
 */
 ]]></programlisting>
-
     </sect2>
 </sect1>
 

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

@@ -2,43 +2,53 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.ldap.node">
     <title>Object oriented access to the LDAP tree using Zend_Ldap_Node</title>
+
     <sect2 id="zend.ldap.node.basic">
         <title>Basic CRUD operations</title>
+
         <sect3 id="zend.ldap.node.basic.retrieve">
             <title>Retrieving data from the LDAP</title>
+
             <sect4 id="zend.ldap.node.basic.retrieve.dn">
                 <title>Getting a node by its DN</title>
                 <para/>
             </sect4>
+
             <sect4 id="zend.ldap.node.basic.retrieve.search">
                 <title>Searching a node's subtree</title>
                 <para/>
             </sect4>
         </sect3>
+
         <sect3 id="zend.ldap.node.basic.add">
             <title>Adding a new node to the LDAP</title>
             <para/>
         </sect3>
+
         <sect3 id="zend.ldap.node.basic.delete">
             <title>Deleting a node from the LDAP</title>
             <para/>
         </sect3>
+
         <sect3 id="zend.ldap.node.basic.update">
             <title>Updating a node on the LDAP</title>
             <para/>
         </sect3>
     </sect2>
+
     <sect2 id="zend.ldap.node.extended">
         <title>Extended operations</title>
+
         <sect3 id="zend.ldap.node.extended.copy-and-move">
             <title>Copy and move nodes in the LDAP</title>
             <para/>
         </sect3>
     </sect2>
+
     <sect2 id="zend.ldap.node.traversal">
         <title>Tree traversal</title>
 
-            <example>
+        <example>
             <title>Traverse LDAP tree recursively</title>
 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
@@ -51,6 +61,5 @@ foreach ($ri as $rdn => $n) {
 }
 ]]></programlisting>
             </example>
-
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Ldap-Server.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.ldap.server">
     <title>Getting information from the LDAP server</title>
+
     <sect2 id="zend.ldap.server.rootdse">
         <title>RootDSE</title>
 
@@ -16,6 +17,7 @@
                     <ulink url="http://www.zytrax.com/books/ldap/ch3/#operational">OpenLDAP</ulink>
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <ulink
@@ -23,6 +25,7 @@
                         ActiveDirectory</ulink>
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <ulink
@@ -34,6 +37,7 @@
 
         <example id="zend.ldap.server.rootdse.getting">
             <title>Getting hands on the RootDSE</title>
+
             <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -48,6 +52,7 @@ $serverType = $rootdse->getServerType();
 
         <example id="zend.ldap.server.schema.getting">
             <title>Getting hands on the server schema</title>
+
             <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -63,8 +68,10 @@ $classes = $schema->getObjectClasses();
 
         <sect3 id="zend.ldap.server.schema.activedirectory">
             <title>ActiveDirectory</title>
+
             <note>
                 <title>Schema browsing on ActiveDirectory servers</title>
+
                 <para>
                     Due to restrictions on Microsoft ActiveDirectory servers regarding
                     the number of entries returned by generic search routines and due to

documentation/manual/en/module_specs/Zend_Ldap-Tools.xml

@@ -13,6 +13,7 @@
 
         <example>
             <title>Create simple LDAP filters</title>
+
             <programlisting language="php"><![CDATA[
 $f1  = Zend_Ldap_Filter::equals('name', 'value');         // (name=value)
 $f2  = Zend_Ldap_Filter::begins('name', 'value');         // (name=value*)
@@ -29,6 +30,7 @@ $f10 = Zend_Ldap_Filter::any('name');                     // (name=*)
 
         <example>
             <title>Create more complex LDAP filters</title>
+
             <programlisting language="php"><![CDATA[
 $f1 = Zend_Ldap_Filter::ends('name', 'value')->negate(); // (!(name=*value))
 
@@ -42,7 +44,6 @@ $f5 = Zend_Ldap_Filter::andFilter($f2, $f3, $f4);
 // (|(name=value)(name=value*)(name=*value))
 $f6 = Zend_Ldap_Filter::orFilter($f2, $f3, $f4);
 ]]></programlisting>
-
         </example>
     </sect2>
 

documentation/manual/en/module_specs/Zend_Ldap-Usage.xml

@@ -2,6 +2,7 @@
 <!-- Reviewed: no -->
 <sect1 id="zend.ldap.usage">
     <title>Usage Scenarios</title>
+
     <sect2 id="zend.ldap.usage.authentication">
         <title>Authentication scenarios</title>
 
@@ -21,8 +22,10 @@
 
         <sect3 id="zend.ldap.usage.basic.retrieve">
             <title>Retrieving data from the LDAP</title>
+
             <example id="zend.ldap.usage.basic.retrieve.dn">
                 <title>Getting an entry by its DN</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -43,6 +46,7 @@ array(
 
             <example id="zend.ldap.usage.basic.retrieve.exists">
                 <title>Check for the existence of a given DN</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -53,6 +57,7 @@ $isThere = $ldap->exists('cn=Hugo Müller,ou=People,dc=my,dc=local');
 
             <example id="zend.ldap.usage.basic.retrieve.counting-children">
                 <title>Count children of a given DN</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -60,10 +65,11 @@ $ldap->bind();
 $childrenCount = $ldap->countChildren(
                             'cn=Hugo Müller,ou=People,dc=my,dc=local');
 ]]></programlisting>
-        </example>
+            </example>
 
             <example id="zend.ldap.usage.basic.retrieve.search">
                 <title>Searching the LDAP tree</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -80,8 +86,10 @@ foreach ($result as $item) {
 
         <sect3 id="zend.ldap.usage.basic.add">
             <title>Adding data to the LDAP</title>
+
             <example>
                 <title>Add a new entry to the LDAP</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -92,26 +100,30 @@ Zend_Ldap_Attribute::setAttribute($entry, 'sn', 'Meier');
 Zend_Ldap_Attribute::setAttribute($entry, 'objectClass', 'inetOrgPerson');
 $ldap->add('cn=Hans Meier,ou=People,dc=my,dc=local', $entry);
 ]]></programlisting>
-                </example>
+            </example>
         </sect3>
 
         <sect3 id="zend.ldap.usage.basic.delete">
             <title>Deleting from the LDAP</title>
+
             <example>
                 <title>Delete an existing entry from the LDAP</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
 $ldap->bind();
 $ldap->delete('cn=Hans Meier,ou=People,dc=my,dc=local');
 ]]></programlisting>
-                </example>
+            </example>
         </sect3>
 
         <sect3 id="zend.ldap.usage.basic.update">
             <title>Updating the LDAP</title>
+
             <example>
                 <title>Update an existing entry on the LDAP</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -123,7 +135,7 @@ Zend_Ldap_Attribute::setPassword($hm,
                                  Zend_Ldap_Attribute::PASSWORD_HASH_SHA1);
 $ldap->update('cn=Hugo Müller,ou=People,dc=my,dc=local', $hm);
 ]]></programlisting>
-                </example>
+            </example>
         </sect3>
     </sect2>
 
@@ -135,6 +147,7 @@ $ldap->update('cn=Hugo Müller,ou=People,dc=my,dc=local', $hm);
 
             <example id="zend.ldap.usage.extended.copy-and-move.copy">
                 <title>Copy a LDAP entry recursively with all its descendants</title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -149,6 +162,7 @@ $ldap->copy('cn=Hugo Müller,ou=People,dc=my,dc=local',
                 <title>
                     Move a LDAP entry recursively with all its descendants to a different subtree
                 </title>
+
                 <programlisting language="php"><![CDATA[
 $options = array(/* ... */);
 $ldap = new Zend_Ldap($options);
@@ -158,7 +172,6 @@ $ldap->moveToSubtree('cn=Hugo Müller,ou=People,dc=my,dc=local',
                      true);
 ]]></programlisting>
             </example>
-
         </sect3>
     </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Loader-Autoloader.xml

@@ -10,22 +10,27 @@
     </para>
 
     <itemizedlist>
-        <listitem><para>
-            Provide a true namespace autoloader. (Previous incarnations
-            intercepted all userland namespaces.)
-        </para></listitem>
-
-        <listitem><para>
-            Allow registering arbitrary callbacks as autoloaders, and manage
-            them as a stack. (At the time of this writing, this overcomes some
-            issues with <code>spl_autoload</code>, which does not allow
-            re-registering a callback that utilizes an instance method.)
-        </para></listitem>
-
-        <listitem><para>
-            Allow optimistic matching of namespaces to provide faster class
-            resolution.
-        </para></listitem>
+        <listitem>
+            <para>
+                Provide a true namespace autoloader. (Previous incarnations
+                intercepted all userland namespaces.)
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                Allow registering arbitrary callbacks as autoloaders, and manage
+                them as a stack. (At the time of this writing, this overcomes some
+                issues with <code>spl_autoload</code>, which does not allow
+                re-registering a callback that utilizes an instance method.)
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                Allow optimistic matching of namespaces to provide faster class resolution.
+            </para>
+        </listitem>
     </itemizedlist>
 
     <para>
@@ -378,7 +383,8 @@ interface Zend_Loader_Autoloader_Interface
 
         <para>
             When using this interface, you can simply pass a class instance to
-            <classname>Zend_Loader_Autoloader</classname>'s <methodname>pushAutoloader()</methodname>
+            <classname>Zend_Loader_Autoloader</classname>'s
+            <methodname>pushAutoloader()</methodname>
             and <methodname>unshiftAutoloader()</methodname> methods:
         </para>
 
@@ -400,6 +406,7 @@ $autoloader->pushAutoloader($foo, 'Foo_');
 
         <table id="zend.loader.autoloader.reference.api">
             <title>Zend_Loader_Autoloader Methods</title>
+
             <tgroup cols="4">
                 <thead>
                     <row>
@@ -409,281 +416,406 @@ $autoloader->pushAutoloader($foo, 'Foo_');
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry><methodname>getInstance()</methodname></entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
                         <entry>N/A</entry>
-                        <entry><para>
-                            Retrieve the <classname>Zend_Loader_Autoloader</classname>
-                            singleton instance. On first retrieval, it registers
-                            itself with <code>spl_autoload</code>. This method
-                            is static.
-                        </para></entry>
+
+                        <entry>
+                            <para>
+                                Retrieve the <classname>Zend_Loader_Autoloader</classname>
+                                singleton instance. On first retrieval, it registers
+                                itself with <code>spl_autoload</code>. This method is static.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>resetInstance()</methodname></entry>
                         <entry><code>void</code></entry>
                         <entry>N/A</entry>
-                        <entry><para>
-                            Resets the state of the <classname>Zend_Loader_Autoloader</classname>
-                            singleton instance to it's original state,
-                            unregistering all autoloader callbacks and all
-                            registered namespaces.
-                        </para></entry>
+
+                        <entry>
+                            <para>
+                                Resets the state of the
+                                <classname>Zend_Loader_Autoloader</classname> singleton instance to
+                                it's original state, unregistering all autoloader callbacks and all
+                                registered namespaces.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>autoload($class)</methodname></entry>
                         <entry><code>string|<constant>FALSE</constant></code></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$class</varname>, <emphasis>required</emphasis>.
-                                A string class name to load.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Attempt to resolve a class name to a file and load
-                            it.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$class</varname>, <emphasis>required</emphasis>.
+                                        A string class name to load.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>Attempt to resolve a class name to a file and load it.</para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>setDefaultAutoloader($callback)</methodname></entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$callback</varname>, <emphasis>required</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Specify an alternate <acronym>PHP</acronym> callback to use for the
-                            default autoloader implementation.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$callback</varname>, <emphasis>required</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Specify an alternate <acronym>PHP</acronym> callback to use for the
+                                default autoloader implementation.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>getDefaultAutoloader()</methodname></entry>
                         <entry><code>callback</code></entry>
                         <entry>N/A</entry>
-                        <entry><para>
-                            Retrieve the default autoloader implementation; by
-                            default, this is
-                            <methodname>Zend_Loader::loadClass()</methodname>.
-                        </para></entry>
+
+                        <entry>
+                            <para>
+                                Retrieve the default autoloader implementation; by default, this is
+                                <methodname>Zend_Loader::loadClass()</methodname>.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>setAutoloaders(array $autoloaders)</methodname></entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$autoloaders</varname>, <emphasis>required</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Set a list of concrete autoloaders to use in the
-                            autoloader stack. Each item in the autoloaders array
-                            must be a <acronym>PHP</acronym> callback.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$autoloaders</varname>,
+                                        <emphasis>required</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Set a list of concrete autoloaders to use in the
+                                autoloader stack. Each item in the autoloaders array
+                                must be a <acronym>PHP</acronym> callback.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>getAutoloaders()</methodname></entry>
                         <entry><type>Array</type></entry>
                         <entry>N/A</entry>
-                        <entry><para>
-                            Retrieve the internal autoloader stack.
-                        </para></entry>
+                        <entry><para>Retrieve the internal autoloader stack.</para></entry>
                     </row>
 
                     <row>
                         <entry><methodname>getNamespaceAutoloaders($namespace)</methodname></entry>
                         <entry><type>Array</type></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$namespace</varname>, <emphasis>required</emphasis>
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Fetch all autoloaders that have registered to load a
-                            specific namespace.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$namespace</varname>, <emphasis>required</emphasis>
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Fetch all autoloaders that have registered to load a
+                                specific namespace.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>registerNamespace($namespace)</methodname></entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$namespace</varname>, <emphasis>required</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Register one or more namespaces with the default
-                            autoloader. If <varname>$namespace</varname> is a string,
-                            it registers that namespace; if it's an array of
-                            strings, registers each as a namespace.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$namespace</varname>,
+                                        <emphasis>required</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Register one or more namespaces with the default
+                                autoloader. If <varname>$namespace</varname> is a string,
+                                it registers that namespace; if it's an array of
+                                strings, registers each as a namespace.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>unregisterNamespace($namespace)</methodname></entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$namespace</varname>, <emphasis>required</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Unregister one or more namespaces from the default
-                            autoloader. If <varname>$namespace</varname> is a string,
-                            it unregisters that namespace; if it's an array of
-                            strings, unregisters each as a namespace.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$namespace</varname>,
+                                        <emphasis>required</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Unregister one or more namespaces from the default
+                                autoloader. If <varname>$namespace</varname> is a string,
+                                it unregisters that namespace; if it's an array of
+                                strings, unregisters each as a namespace.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>getRegisteredNamespaces()</methodname></entry>
                         <entry><type>Array</type></entry>
                         <entry>N/A</entry>
-                        <entry><para>
-                            Returns an array of all namespaces registered with
-                            the default autoloader.
-                        </para></entry>
+
+                        <entry>
+                            <para>
+                                Returns an array of all namespaces registered with the default
+                                autoloader.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
-                        <entry><methodname>suppressNotFoundWarnings($flag = null)</methodname></entry>
+                        <entry>
+                            <methodname>suppressNotFoundWarnings($flag = null)</methodname>
+                        </entry>
+
                         <entry><code>boolean|Zend_Loader_Autoloader</code></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$flag</varname>, <emphasis>optional</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Set or retrieve the value of the flag used to
-                            indicate whether the default autoloader
-                            implementation should suppress "file not found"
-                            warnings. If no arguments or a <constant>NULL</constant> value is
-                            passed, returns a boolean indicating the status of the flag;
-                            if a boolean is passed, the flag is set to that
-                            value and the autoloader instance is returned (to
-                            allow method chaining).
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$flag</varname>, <emphasis>optional</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Set or retrieve the value of the flag used to
+                                indicate whether the default autoloader
+                                implementation should suppress "file not found"
+                                warnings. If no arguments or a <constant>NULL</constant> value is
+                                passed, returns a boolean indicating the status of the flag;
+                                if a boolean is passed, the flag is set to that
+                                value and the autoloader instance is returned (to
+                                allow method chaining).
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>setFallbackAutoloader($flag)</methodname></entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$flag</varname>, <emphasis>required</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Set the value of the flag used to indicate whether
-                            or not the default autoloader should be used as a
-                            fallback or catch-all autoloader for all namespaces.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$flag</varname>, <emphasis>required</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Set the value of the flag used to indicate whether
+                                or not the default autoloader should be used as a
+                                fallback or catch-all autoloader for all namespaces.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>isFallbackAutoloader()</methodname></entry>
                         <entry><type>Boolean</type></entry>
                         <entry>N/A</entry>
-                        <entry><para>
-                            Retrieve the value of the flag used to indicate whether
-                            or not the default autoloader should be used as a
-                            fallback or catch-all autoloader for all namespaces.
-                            By default, this is <constant>FALSE</constant>.
-                        </para></entry>
+                        <entry>
+                            <para>
+                                Retrieve the value of the flag used to indicate whether
+                                or not the default autoloader should be used as a
+                                fallback or catch-all autoloader for all namespaces.
+                                By default, this is <constant>FALSE</constant>.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
                         <entry><methodname>getClassAutoloaders($class)</methodname></entry>
                         <entry><type>Array</type></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$class</varname>, <emphasis>required</emphasis>.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Get the list of namespaced autoloaders that could
-                            potentially match the provided class. If none match,
-                            all global (non-namespaced) autoloaders are
-                            returned.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$class</varname>, <emphasis>required</emphasis>.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Get the list of namespaced autoloaders that could
+                                potentially match the provided class. If none match,
+                                all global (non-namespaced) autoloaders are returned.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
-                        <entry><methodname>unshiftAutoloader($callback, $namespace = '')</methodname></entry>
+                        <entry>
+                            <methodname>unshiftAutoloader($callback, $namespace = '')</methodname>
+                        </entry>
+
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$callback</varname>, <emphasis>required</emphasis>.
-                                A valid <acronym>PHP</acronym> callback
-                            </para></listitem>
-
-                            <listitem><para>
-                                <varname>$namespace</varname>, <emphasis>optional</emphasis>.
-                                A string representing a class prefix namespace.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Add a concrete autoloader implementation to the
-                            beginning of the internal autoloader stack. If a
-                            namespace is provided, that namespace will be used
-                            to match optimistically; otherwise, the autoloader
-                            will be considered a global autoloader.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$callback</varname>, <emphasis>required</emphasis>.
+                                        A valid <acronym>PHP</acronym> callback
+                                    </para>
+                                </listitem>
+
+                                <listitem>
+                                    <para>
+                                        <varname>$namespace</varname>,
+                                        <emphasis>optional</emphasis>. A string representing a class
+                                        prefix namespace.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Add a concrete autoloader implementation to the
+                                beginning of the internal autoloader stack. If a
+                                namespace is provided, that namespace will be used
+                                to match optimistically; otherwise, the autoloader
+                                will be considered a global autoloader.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
-                        <entry><methodname>pushAutoloader($callback, $namespace = '')</methodname></entry>
+                        <entry>
+                            <methodname>pushAutoloader($callback, $namespace = '')</methodname>
+                        </entry>
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$callback</varname>, <emphasis>required</emphasis>.
-                                A valid <acronym>PHP</acronym> callback
-                            </para></listitem>
-
-                            <listitem><para>
-                                <varname>$namespace</varname>, <emphasis>optional</emphasis>.
-                                A string representing a class prefix namespace.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Add a concrete autoloader implementation to the
-                            end of the internal autoloader stack. If a
-                            namespace is provided, that namespace will be used
-                            to match optimistically; otherwise, the autoloader
-                            will be considered a global autoloader.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$callback</varname>, <emphasis>required</emphasis>.
+                                        A valid <acronym>PHP</acronym> callback
+                                    </para>
+                                </listitem>
+
+                                <listitem>
+                                    <para>
+                                        <varname>$namespace</varname>,
+                                        <emphasis>optional</emphasis>. A string representing a class
+                                        prefix namespace.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Add a concrete autoloader implementation to the
+                                end of the internal autoloader stack. If a
+                                namespace is provided, that namespace will be used
+                                to match optimistically; otherwise, the autoloader
+                                will be considered a global autoloader.
+                            </para>
+                        </entry>
                     </row>
 
                     <row>
-                        <entry><methodname>removeAutoloader($callback, $namespace = '')</methodname></entry>
+                        <entry>
+                            <methodname>removeAutoloader($callback, $namespace = '')</methodname>
+                        </entry>
+
                         <entry><classname>Zend_Loader_Autoloader</classname></entry>
-                        <entry><itemizedlist>
-                            <listitem><para>
-                                <varname>$callback</varname>, <emphasis>required</emphasis>.
-                                A valid <acronym>PHP</acronym> callback
-                            </para></listitem>
-
-                            <listitem><para>
-                                <varname>$namespace</varname>, <emphasis>optional</emphasis>.
-                                A string representing a class prefix namespace,
-                                or an array of namespace strings.
-                            </para></listitem>
-                        </itemizedlist></entry>
-                        <entry><para>
-                            Remove a concrete autoloader implementation from
-                            the internal autoloader stack. If a namespace or
-                            namespaces are provided, the callback will be
-                            removed from that namespace or namespaces only.
-                        </para></entry>
+
+                        <entry>
+                            <itemizedlist>
+                                <listitem>
+                                    <para>
+                                        <varname>$callback</varname>, <emphasis>required</emphasis>.
+                                        A valid <acronym>PHP</acronym> callback
+                                    </para>
+                                </listitem>
+
+                                <listitem>
+                                    <para>
+                                        <varname>$namespace</varname>,
+                                        <emphasis>optional</emphasis>. A string representing a class
+                                        prefix namespace, or an array of namespace strings.
+                                    </para>
+                                </listitem>
+                            </itemizedlist>
+                        </entry>
+
+                        <entry>
+                            <para>
+                                Remove a concrete autoloader implementation from
+                                the internal autoloader stack. If a namespace or
+                                namespaces are provided, the callback will be
+                                removed from that namespace or namespaces only.
+                            </para>
+                        </entry>
                     </row>
                 </tbody>
             </tgroup>

documentation/manual/en/module_specs/Zend_Loader-PluginLoader.xml

@@ -144,28 +144,34 @@ $loader = new Zend_Loader_PluginLoader(array(), 'foobar');
         </para>
 
         <itemizedlist>
-            <listitem><para>
+            <listitem>
+                <para>
                     <methodname>getPaths($prefix = null)</methodname> returns all paths as
                     prefix / path pairs if no <varname>$prefix</varname> is provided,
                     or just the paths registered for a given prefix if a
                     <varname>$prefix</varname> is present.
-            </para></listitem>
+                </para>
+            </listitem>
 
-            <listitem><para>
+            <listitem>
+                <para>
                     <methodname>clearPaths($prefix = null)</methodname> will clear all
                     registered paths by default, or only those associated with a
                     given prefix, if the <varname>$prefix</varname> is provided and
                     present in the stack.
-            </para></listitem>
+                </para>
+            </listitem>
 
-            <listitem><para>
+            <listitem>
+                <para>
                     <methodname>removePrefixPath($prefix, $path = null)</methodname> allows
                     you to selectively remove a specific path associated with a
                     given prefix. If no <varname>$path</varname> is provided, all
                     paths for that prefix are removed. If a <varname>$path</varname>
                     is provided and exists for that prefix, only that path will
                     be removed.
-            </para></listitem>
+                </para>
+            </listitem>
         </itemizedlist>
     </sect2>
 

documentation/manual/en/module_specs/Zend_Loader.xml

@@ -1,33 +1,34 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.loader.load">
-
     <title>Loading Files and Classes Dynamically</title>
 
     <para>
-        The <classname>Zend_Loader</classname> class includes methods to help you load files dynamically.
+        The <classname>Zend_Loader</classname> class includes methods to help you load files
+        dynamically.
     </para>
 
     <tip>
         <title>Zend_Loader vs. require_once()</title>
+
         <para>
             The <classname>Zend_Loader</classname> methods are best used if the filename you need to
             load is variable. For example, if it is based on a parameter from
             user input or method argument. If you are loading a file or a
             class whose name is constant, there is no benefit to using
-            <classname>Zend_Loader</classname> over using traditional <acronym>PHP</acronym> functions such as
-            <ulink url="http://php.net/require_once"><methodname>require_once()</methodname></ulink>.
+            <classname>Zend_Loader</classname> over using traditional <acronym>PHP</acronym>
+            functions such as <ulink
+                url="http://php.net/require_once"><methodname>require_once()</methodname></ulink>.
         </para>
     </tip>
 
     <sect2 id="zend.loader.load.file">
-
         <title>Loading Files</title>
 
         <para>
-            The static method <methodname>Zend_Loader::loadFile()</methodname> loads a <acronym>PHP</acronym>
-            file. The file loaded may contain any <acronym>PHP</acronym> code.
-            The method is a wrapper for the <acronym>PHP</acronym> function
+            The static method <methodname>Zend_Loader::loadFile()</methodname> loads a
+            <acronym>PHP</acronym> file. The file loaded may contain any <acronym>PHP</acronym>
+            code. The method is a wrapper for the <acronym>PHP</acronym> function
             <ulink url="http://php.net/include"><methodname>include()</methodname></ulink>.
             This method returns boolean <constant>FALSE</constant> on failure, for example
             if the specified file does not exist.
@@ -35,6 +36,7 @@
 
         <example id="zend.loader.load.file.example">
             <title>Example of the loadFile() Method</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Loader::loadFile($filename, $dirs=null, $once=false);
 ]]></programlisting>
@@ -50,25 +52,24 @@ Zend_Loader::loadFile($filename, $dirs=null, $once=false);
         </para>
 
         <para>
-            The <varname>$dirs</varname> argument specifies which directories to search for
-            the file in. If the value is <constant>NULL</constant>, only the <code>include_path</code>
+            The <varname>$dirs</varname> argument specifies which directories to search for 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>
 
         <para>
             The <varname>$once</varname> argument is a boolean. If <constant>TRUE</constant>,
-            <methodname>Zend_Loader::loadFile()</methodname> uses the <acronym>PHP</acronym> function
-            <ulink url="http://php.net/include"><methodname>include_once()</methodname></ulink>
+            <methodname>Zend_Loader::loadFile()</methodname> uses the <acronym>PHP</acronym>
+            function <ulink
+                url="http://php.net/include"><methodname>include_once()</methodname></ulink>
             for loading the file, otherwise the <acronym>PHP</acronym> function
             <ulink url="http://php.net/include_once"><methodname>include()</methodname></ulink>
             is used.
         </para>
-
     </sect2>
 
     <sect2 id="zend.loader.load.class">
-
         <title>Loading Classes</title>
 
         <para>
@@ -78,6 +79,7 @@ Zend_Loader::loadFile($filename, $dirs=null, $once=false);
 
         <example id="zend.loader.load.class.example">
             <title>Example of the loadClass() Method</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Loader::loadClass('Container_Tree',
     array(
@@ -104,7 +106,8 @@ Zend_Loader::loadClass('Container_Tree',
 
         <para>
             If the file is not found or the class does not exist after the load,
-            <methodname>Zend_Loader::loadClass()</methodname> throws a <classname>Zend_Exception</classname>.
+            <methodname>Zend_Loader::loadClass()</methodname> throws a
+            <classname>Zend_Exception</classname>.
         </para>
 
         <para>
@@ -182,7 +185,6 @@ Zend_Loader::loadClass('Container_Tree',
     </sect2>
 
     <sect2 id="zend.loader.load.isreadable">
-
         <title>Testing if a File is Readable</title>
 
         <para>
@@ -193,6 +195,7 @@ Zend_Loader::loadClass('Container_Tree',
 
         <example id="zend.loader.load.isreadable.example">
             <title>Example of isReadable() method</title>
+
             <programlisting language="php"><![CDATA[
 if (Zend_Loader::isReadable($filename)) {
     // do something with $filename
@@ -208,25 +211,25 @@ if (Zend_Loader::isReadable($filename)) {
             The <acronym>PHP</acronym> function does not search the <code>include_path</code>,
             while <methodname>Zend_Loader::isReadable()</methodname> does.
         </para>
-
     </sect2>
 
     <sect2 id="zend.loader.load.autoload">
-
         <title>Using the Autoloader</title>
 
         <para>
             The <classname>Zend_Loader</classname> class contains a method you can register with the
-            <acronym>PHP</acronym> SPL autoloader. <methodname>Zend_Loader::autoload()</methodname> is the
-            callback method. As a convenience, <classname>Zend_Loader</classname> provides the
-            <methodname>registerAutoload()</methodname> function to register its
+            <acronym>PHP</acronym> SPL autoloader. <methodname>Zend_Loader::autoload()</methodname>
+            is the callback method. As a convenience, <classname>Zend_Loader</classname> provides
+            the <methodname>registerAutoload()</methodname> function to register its
             <methodname>autoload()</methodname> method. If the <code>spl_autoload</code>
             extension is not present in your <acronym>PHP</acronym> environment, then the
-            <methodname>registerAutoload()</methodname> method throws a <classname>Zend_Exception</classname>.
+            <methodname>registerAutoload()</methodname> method throws a
+            <classname>Zend_Exception</classname>.
         </para>
 
         <example id="zend.loader.load.autoload.example">
             <title>Example of registering the autoloader callback method</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Loader::registerAutoload();
 ]]></programlisting>
@@ -249,6 +252,7 @@ Zend_Loader::registerAutoload();
         <example id="zend.loader.load.autoload.example-extended">
             <title>Example of registering the autoload callback method from an
                 extended class</title>
+
             <para>
                 Because of the semantics of static function references in <acronym>PHP</acronym>,
                 you must implement code for both <methodname>loadClass()</methodname>
@@ -258,6 +262,7 @@ Zend_Loader::registerAutoload();
                 call <methodname>self::loadClass()</methodname>, then it calls the
                 method of that name in the parent class, not the subclass.
             </para>
+
             <programlisting language="php"><![CDATA[
 class My_Loader extends Zend_Loader
 {
@@ -288,9 +293,7 @@ Zend_Loader::registerAutoload('My_Loader');
             <constant>FALSE</constant>, the autoload callback is unregistered from the
             SPL autoload stack.
         </para>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

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

@@ -1,43 +1,46 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.locale.date.datesandtimes">
-
     <title>Working with Dates and Times</title>
 
     <para>
-        <classname>Zend_Locale_Format</classname> provides several methods for working with dates and times to help convert and
-        normalize between different formats for different locales. Use <classname>Zend_Date</classname> for manipulating dates,
-        and working with date strings that already conform to
-        <link linkend="zend.date.constants">one of the many internationally recognized standard formats, or one of the localized date formats supported by <classname>Zend_Date</classname>
-        </link>
-        . Using an existing, pre-defined format offers advantages, including the use of well-tested code, and the
-        assurance of some degree of portability and interoperability (depending on the standard used). The examples
-        below do not follow these recommendations, since using non-standard date formats would needlessly increase the
-        difficulty of understanding these examples.
+        <classname>Zend_Locale_Format</classname> provides several methods for working with dates
+        and times to help convert and normalize between different formats for different locales. Use
+        <classname>Zend_Date</classname> for manipulating dates, and working with date strings that
+        already conform to <link linkend="zend.date.constants">one of the many internationally
+            recognized standard formats, or one of the localized date formats supported by
+            <classname>Zend_Date</classname></link>. Using an existing, pre-defined format offers
+        advantages, including the use of well-tested code, and the assurance of some degree of
+        portability and interoperability (depending on the standard used). The examples below do not
+        follow these recommendations, since using non-standard date formats would needlessly
+        increase the difficulty of understanding these examples.
     </para>
 
     <sect2 id="zend.locale.date.normalize">
-
         <title>Normalizing Dates and Times</title>
 
         <para>
-            The <methodname>getDate()</methodname> method parses strings containing dates in localized formats. The results are
-            returned in a structured array, with well-defined keys for each part of the date. In addition, the array
-            will contain a key 'date_format' showing the format string used to parse the input date string. Since a
-            localized date string may not contain all parts of a date/time, the key-value pairs are optional. For
-            example, if only the year, month, and day is given, then all time values are suppressed from the returned
-            array, and vice-versa if only hour, minute, and second were given as input. If no date or time can be found
-            within the given input, an exception will be thrown.
+            The <methodname>getDate()</methodname> method parses strings containing dates in
+            localized formats. The results are returned in a structured array, with well-defined
+            keys for each part of the date. In addition, the array will contain a key 'date_format'
+            showing the format string used to parse the input date string. Since a localized date
+            string may not contain all parts of a date/time, the key-value pairs are optional. for
+            example, if only the year, month, and day is given, then all time values are suppressed
+            from the returned array, and vice-versa if only hour, minute, and second were given as
+            input. If no date or time can be found within the given input, an exception will be
+            thrown.
         </para>
 
         <para>
-            If <methodname>setOption(array('fix_date' => true))</methodname> is set the <methodname>getDate()</methodname> method adds a key 'fixed'
-            with a whole number value indicating if the input date string required "fixing" by rearranging the day,
-            month, or year in the input to fit the format used.
+            If <methodname>setOption(array('fix_date' => true))</methodname> is set the
+            <methodname>getDate()</methodname> method adds a key 'fixed' with a whole number value
+            indicating if the input date string required "fixing" by rearranging the day, month, or
+            year in the input to fit the format used.
         </para>
 
         <table id="zend.locale.date.normalize.table-1">
             <title>Key values for getDate() with option 'fix_date'</title>
+
             <tgroup cols='2'>
                 <thead>
                     <row>
@@ -45,23 +48,28 @@
                         <entry>meaning</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>0</entry>
                         <entry>nothing to fix</entry>
                     </row>
+
                     <row>
                         <entry>1</entry>
                         <entry>fixed false month</entry>
                     </row>
+
                     <row>
                         <entry>2</entry>
                         <entry>swapped day and year</entry>
                     </row>
+
                     <row>
                         <entry>3</entry>
                         <entry>swapped month and year</entry>
                     </row>
+
                     <row>
                         <entry>4</entry>
                         <entry>swapped month and day</entry>
@@ -71,22 +79,28 @@
         </table>
 
         <para>
-            For those needing to specify explicitly the format of the date string, the following format token specifiers
-            are supported. If an invalid format specifier is used, such as the <acronym>PHP</acronym> 'i' specifier when in <acronym>ISO</acronym> format
-            mode, then an error will be thrown by the methods in <classname>Zend_Locale_Format</classname> that support user-defined formats.
+            For those needing to specify explicitly the format of the date string, the following
+            format token specifiers are supported. If an invalid format specifier is used, such as
+            the <acronym>PHP</acronym> 'i' specifier when in <acronym>ISO</acronym> format mode,
+            then an error will be thrown by the methods in <classname>Zend_Locale_Format</classname>
+            that support user-defined formats.
         </para>
 
         <para>
-            These specifiers (below) are a small subset of the full "ISO" set supported by <classname>Zend_Date</classname>'s
-            <methodname>toString()</methodname>. If you need to use <acronym>PHP</acronym> <methodname>date()</methodname> compatible format specifiers, then first
-            call <methodname>setOptions(array('format_type' => 'php'))</methodname>. And if you want to convert only one special format
-            string from <acronym>PHP</acronym> <methodname>date()</methodname> compatible format to "ISO" format use <methodname>convertPhpToIsoFormat()</methodname>.
-            Currently, the only practical difference relates to the specifier for minutes ('m' using the <acronym>ISO</acronym> default,
-            and 'i' using the <acronym>PHP</acronym> date format).
+            These specifiers (below) are a small subset of the full "ISO" set supported by
+            <classname>Zend_Date</classname>'s <methodname>toString()</methodname>. If you need to
+            use <acronym>PHP</acronym> <methodname>date()</methodname> compatible format specifiers,
+            then first call <methodname>setOptions(array('format_type' => 'php'))</methodname>. And
+            if you want to convert only one special format string from <acronym>PHP</acronym>
+            <methodname>date()</methodname> compatible format to "ISO" format use
+            <methodname>convertPhpToIsoFormat()</methodname>. Currently, the only practical
+            difference relates to the specifier for minutes ('m' using the <acronym>ISO</acronym>
+            default, and 'i' using the <acronym>PHP</acronym> date format).
         </para>
 
         <table id="zend.locale.date.normalize.table-2">
             <title>Return values</title>
+
             <tgroup cols='5'>
                 <thead>
                     <row>
@@ -97,6 +111,7 @@
                         <entry>Maximum</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>d</entry>
@@ -105,6 +120,7 @@
                         <entry>1</entry>
                         <entry>31</entry>
                     </row>
+
                     <row>
                         <entry>M</entry>
                         <entry>month</entry>
@@ -112,6 +128,7 @@
                         <entry>1</entry>
                         <entry>12</entry>
                     </row>
+
                     <row>
                         <entry>y</entry>
                         <entry>year</entry>
@@ -119,6 +136,7 @@
                         <entry>no limit</entry>
                         <entry>PHP integer's maximum</entry>
                     </row>
+
                     <row>
                         <entry>h</entry>
                         <entry>hour</entry>
@@ -126,6 +144,7 @@
                         <entry>0</entry>
                         <entry>PHP integer's maximum</entry>
                     </row>
+
                     <row>
                         <entry>m</entry>
                         <entry>minute</entry>
@@ -133,6 +152,7 @@
                         <entry>0</entry>
                         <entry>PHP integer's maximum</entry>
                     </row>
+
                     <row>
                         <entry>s</entry>
                         <entry>second</entry>
@@ -146,6 +166,7 @@
 
         <example id="zend.locale.date.normalize.example-1">
             <title>Normalizing a date</title>
+
             <programlisting language="php"><![CDATA[
 $dateString = Zend_Locale_Format::getDate('13.04.2006',
                                           array('date_format' =>
@@ -187,16 +208,19 @@ Array
         </example>
 
         <para>
-            Since <methodname>getDate()</methodname> is "locale-aware", specifying the <varname>$locale</varname> is sufficient for date
-            strings adhering to that locale's format. The option '<code>fix_date</code>' uses simple tests to
-            determine if the day or month is not valid, and then applies heuristics to try and correct any detected
-            problems. Note the use of '<constant>Zend_Locale_Format::STANDARD</constant>' as the value for
-            '<code>date_format</code>' to prevent the use of a class-wide default date format set using
-            <methodname>setOptions()</methodname>. This forces getDate to use the default date format for <varname>$locale</varname>.
+            Since <methodname>getDate()</methodname> is "locale-aware", specifying the
+            <varname>$locale</varname> is sufficient for date strings adhering to that locale's
+            format. The option '<code>fix_date</code>' uses simple tests to determine if the day or
+            month is not valid, and then applies heuristics to try and correct any detected
+            problems. Note the use of '<constant>Zend_Locale_Format::STANDARD</constant>' as the
+            value for '<code>date_format</code>' to prevent the use of a class-wide default date
+            format set using <methodname>setOptions()</methodname>. This forces getDate to use the
+            default date format for <varname>$locale</varname>.
         </para>
 
         <example id="zend.locale.date.normalize.example-2">
             <title>Normalizing a date by locale</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $date = Zend_Locale_Format::getDate('13.04.2006',
@@ -210,11 +234,13 @@ print_r ($date);
         </example>
 
         <para>
-            A complete date and time is returned when the input contains both a date and time in the expected format.
+            A complete date and time is returned when the input contains both a date and time in the
+            expected format.
         </para>
 
         <example id="zend.locale.date.normalize.example-3">
             <title>Normalizing a date with time</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $date = Zend_Locale_Format::getDate('13.04.2005 22:14:55',
@@ -228,13 +254,14 @@ print_r ($date);
         </example>
 
         <para>
-            If a specific format is desired, specify the <varname>$format</varname> argument, without giving a
-            <varname>$locale</varname>. Only single-letter codes (H, m, s, y, M, d), and MMMM and EEEE are supported in the
-            <varname>$format</varname>.
+            If a specific format is desired, specify the <varname>$format</varname> argument,
+            without giving a <varname>$locale</varname>. Only single-letter codes
+            (H, m, s, y, M, d), and MMMM and EEEE are supported in the <varname>$format</varname>.
         </para>
 
         <example id="zend.locale.date.normalize.example-4">
             <title>Normalizing a userdefined date</title>
+
             <programlisting language="php"><![CDATA[
 $date = Zend_Locale_Format::getDate('13200504T551422',
                                     array('date_format' =>
@@ -251,6 +278,7 @@ print_r ($date);
 
         <table id="zend.locale.date.normalize.table-3">
             <title>Format definition</title>
+
             <tgroup cols='2'>
                 <thead>
                     <row>
@@ -258,31 +286,38 @@ print_r ($date);
                         <entry>Description</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>d or dd</entry>
                         <entry>1 or 2 digit day</entry>
                     </row>
+
                     <row>
                         <entry>M or MM</entry>
                         <entry>1 or 2 digit month</entry>
                     </row>
+
                     <row>
                         <entry>y or yy</entry>
                         <entry>1 or 2 digit year</entry>
                     </row>
+
                     <row>
                         <entry>yyyy</entry>
                         <entry>4 digit year</entry>
                     </row>
+
                     <row>
                         <entry>h</entry>
                         <entry>1 or 2 digit hour</entry>
                     </row>
+
                     <row>
                         <entry>m</entry>
                         <entry>1 or 2 digit minute</entry>
                     </row>
+
                     <row>
                         <entry>s</entry>
                         <entry>1 or 2 digit second</entry>
@@ -297,6 +332,7 @@ print_r ($date);
 
         <table id="zend.locale.date.normalize.table-4">
             <title>Example formats</title>
+
             <tgroup cols='3'>
                 <thead>
                     <row>
@@ -305,19 +341,20 @@ print_r ($date);
                         <entry>Output</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>dd.MM.yy</entry>
                         <entry>1.4.6</entry>
-                        <entry>['day'] => 1,
-                                   ['month'] => 4,
-                                   ['year'] => 6</entry>
+                        <entry>['day'] => 1, ['month'] => 4, ['year'] => 6</entry>
                     </row>
+
                     <row>
                         <entry>dd.MM.yy</entry>
                         <entry>01.04.2006</entry>
                         <entry>['day'] => 1, ['month'] => 4, ['year'] => 2006</entry>
                     </row>
+
                     <row>
                         <entry>yyyyMMdd</entry>
                         <entry>1.4.6</entry>
@@ -329,20 +366,23 @@ print_r ($date);
 
         <note>
             <title>Database date format</title>
+
             <para>
-                To parse a database date value (f.e. MySql or MsSql), use <classname>Zend_Date</classname>'s ISO_8601 format instead of
-                getDate().
+                To parse a database date value (f.e. MySql or MsSql), use
+                <classname>Zend_Date</classname>'s ISO_8601 format instead of getDate().
             </para>
         </note>
 
         <para>
-            The option '<code>fix_date</code>' uses simple tests to determine if the day or month is not
-            valid, and then applies heuristics to try and correct any detected problems. <methodname>getDate()</methodname>
-            automatically detects and corrects some kinds of problems with input, such as misplacing the year:
+            The option '<code>fix_date</code>' uses simple tests to determine if the day or month is
+            not valid, and then applies heuristics to try and correct any detected problems.
+            <methodname>getDate()</methodname> automatically detects and corrects some kinds of
+            problems with input, such as misplacing the year:
         </para>
 
         <example id="zend.locale.date.normalize.example-5">
             <title>Automatic correction of input dates</title>
+
             <programlisting language="php"><![CDATA[
 $date = Zend_Locale_Format::getDate('41.10.20',
                                     array('date_format' => 'ddMMyy',
@@ -353,11 +393,9 @@ $date = Zend_Locale_Format::getDate('41.10.20',
 print_r ($date);
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.date.test">
-
         <title>Testing Dates</title>
 
         <para>
@@ -373,6 +411,7 @@ print_r ($date);
 
         <example id="zend.locale.date.test.example-1">
             <title>Date testing</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 // using the default date format for 'de_AT', is this a valid date?
@@ -387,21 +426,21 @@ if (Zend_Locale_Format::checkDateFormat('13.Apr.2006',
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.time.normalizing">
-
         <title>Normalizing a Time</title>
 
         <para>
-            Normally, a time will be returned with a date, if the input contains both. If the proper format is not
-            known, but the locale relevant to the user input is known, then <methodname>getTime()</methodname> should be used,
-            because it uses the default time format for the selected locale.
+            Normally, a time will be returned with a date, if the input contains both. If the proper
+            format is not known, but the locale relevant to the user input is known, then
+            <methodname>getTime()</methodname> should be used, because it uses the default time
+            format for the selected locale.
         </para>
 
         <example id="zend.locale.time.normalizing.example-1">
             <title>Normalize an unknown time</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 if (Zend_Locale_Format::getTime('13:44:42',
@@ -414,21 +453,20 @@ if (Zend_Locale_Format::getTime('13:44:42',
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.time.test">
-
         <title>Testing Times</title>
 
         <para>
-            Use <methodname>checkDateFormat()</methodname> to check if a given string contains a proper time.
-            The usage is exact the same as with checking Dates, only <code>date_format</code>
-            should contain the parts which you expect to have.
+            Use <methodname>checkDateFormat()</methodname> to check if a given string contains a
+            proper time. The usage is exact the same as with checking Dates, only
+            <code>date_format</code> should contain the parts which you expect to have.
         </para>
 
         <example id="zend.locale.time.test.example-1">
             <title>Testing a time</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 if (Zend_Locale_Format::checkDateFormat('13:44:42',
@@ -440,9 +478,7 @@ if (Zend_Locale_Format::checkDateFormat('13:44:42',
 }
 ]]></programlisting>
         </example>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

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

@@ -1,55 +1,59 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.locale.introduction">
-
     <title>Introduction</title>
 
     <para>
-        <classname>Zend_Locale</classname> is the Frameworks answer to the question, "How can the same application be used around
-        the whole world?" Most people will say, "That's easy. Let's translate all our output to several languages."
-        However, using simple translation tables to map phrases from one language to another is not sufficient.
-        Different regions will have different conventions for first names, surnames, salutory titles, formatting of
-        numbers, dates, times, currencies, etc.
+        <classname>Zend_Locale</classname> is the Frameworks answer to the question, "How can the
+        same application be used around the whole world?" Most people will say, "That's easy. Let's
+        translate all our output to several languages." However, using simple translation tables to
+        map phrases from one language to another is not sufficient. Different regions will have
+        different conventions for first names, surnames, salutory titles, formatting of numbers,
+        dates, times, currencies, etc.
     </para>
 
     <para>
-        We need
-        <ulink url="http://en.wikipedia.org/wiki/L10n">Localization</ulink>
-        and complementary
-        <ulink url="http://en.wikipedia.org/wiki/L10n">Internationalization</ulink>
-        . Both are often abbreviated to <code>L10n</code> and <code>I18n</code>. Internationalization refers more to
-        support for use of systems, regardless of special needs unique to groups of users related by language, region,
-        number format conventions, financial conventions, time and date conventions, etc. Localization involves adding
-        explicit support to systems for special needs of these unique groups, such as language translation, and support
-        for local customs or conventions for communicating plurals, dates, times, currencies, names, symbols, sorting
-        and ordering, etc. <code>L10n</code> and <code>I18n</code> compliment each other. Zend Framework provides
-        support for these through a combination of components, including <classname>Zend_Locale</classname>, <classname>Zend_Date</classname>, <classname>Zend_Measure</classname>,
-        <classname>Zend_Translate</classname>, <classname>Zend_Currency</classname>, and <classname>Zend_TimeSync</classname>.
+        We need <ulink url="http://en.wikipedia.org/wiki/L10n">Localization</ulink> and
+        complementary <ulink url="http://en.wikipedia.org/wiki/L10n">Internationalization</ulink>.
+        Both are often abbreviated to <code>L10n</code> and <code>I18n</code>. Internationalization
+        refers more to support for use of systems, regardless of special needs unique to groups of
+        users related by language, region, number format conventions, financial conventions, time
+        and date conventions, etc. Localization involves adding explicit support to systems for
+        special needs of these unique groups, such as language translation, and support for local
+        customs or conventions for communicating plurals, dates, times, currencies, names, symbols,
+        sorting and ordering, etc. <code>L10n</code> and <code>I18n</code> compliment each other.
+        Zend Framework provides support for these through a combination of components, including
+        <classname>Zend_Locale</classname>, <classname>Zend_Date</classname>,
+        <classname>Zend_Measure</classname>, <classname>Zend_Translate</classname>,
+        <classname>Zend_Currency</classname>, and <classname>Zend_TimeSync</classname>.
     </para>
 
     <tip>
         <title>Zend_Locale and setLocale()</title>
+
         <para>
-            <ulink url="http://php.net/setlocale">PHP's documentation</ulink> states that <methodname>setlocale()</methodname>
-            is not threadsave because it is maintained per process and not per thread. This means that, in
-            multithreaded environments, you can have the problem that the locale changes while the script
-            never has changed the locale itself. This can lead to unexpected behaviour when you use
+            <ulink url="http://php.net/setlocale">PHP's documentation</ulink> states that
+            <methodname>setlocale()</methodname> is not threadsave because it is maintained per
+            process and not per thread. This means that, in multithreaded environments, you can have
+            the problem that the locale changes while the script never has changed the locale
+            itself. This can lead to unexpected behaviour when you use
             <methodname>setlocale()</methodname> in your scripts.
         </para>
+
         <para>
-            When you are using <classname>Zend_Locale</classname> you will not have this limitations, because
-            <classname>Zend_Locale</classname> is not related to or coupled with <acronym>PHP</acronym>'s <methodname>setlocale()</methodname>.
+            When you are using <classname>Zend_Locale</classname> you will not have this
+            limitations, because <classname>Zend_Locale</classname> is not related to or coupled
+            with <acronym>PHP</acronym>'s <methodname>setlocale()</methodname>.
         </para>
     </tip>
 
     <sect2 id="zend.locale.whatislocalization">
-
         <title>What is Localization</title>
 
         <para>
-            Localization means that an application (or homepage) can be used from different users which speak different
-            languages. But as you already have expected Localization means more than only translating strings. It
-            includes
+            Localization means that an application (or homepage) can be used from different users
+            which speak different languages. But as you already have expected Localization means
+            more than only translating strings. It includes
         </para>
 
         <itemizedlist mark='opencircle'>
@@ -59,113 +63,128 @@
                     localization support within other Zend Framework components.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <classname>Zend_Translate</classname> - Translating of strings.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <classname>Zend_Date</classname> - Localization of dates, times.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <classname>Zend_Calendar</classname> - Localization of calendars (support for non-Gregorian calendar systems)
+                    <classname>Zend_Calendar</classname> - Localization of calendars (support for
+                    non-Gregorian calendar systems)
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <classname>Zend_Currency</classname> - Localization of currencies.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <classname>Zend_Locale_Format</classname> - Parsing and generating localized numbers.
+                    <classname>Zend_Locale_Format</classname> - Parsing and generating localized
+                    numbers.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
-                    <classname>Zend_Locale_Data</classname> - Retrieve localized standard strings as country names, language names
-                    and
-                    <ulink url="http://unicode.org/cldr/">more from the <acronym>CLDR</acronym></ulink>
-                    .
+                    <classname>Zend_Locale_Data</classname> - Retrieve localized standard strings
+                    as country names, language names and <ulink
+                        url="http://unicode.org/cldr/">more from the
+                        <acronym>CLDR</acronym></ulink>.
                 </para>
             </listitem>
+
             <listitem>
                 <para>
                     <code>TODO</code> - Localization of collations
                 </para>
             </listitem>
         </itemizedlist>
-
     </sect2>
 
     <sect2 id="zend.locale.whatis">
-
         <title>What is a Locale?</title>
 
         <para>
-            Each computer user makes use of Locales, even when they don't know it. Applications lacking localization
-            support, normally have implicit support for one particular locale (the locale of the author). When a class
-            or function makes use of localization, we say it is <code>locale-aware</code>. How does the code know which
-            localization the user is expecting?
+            Each computer user makes use of Locales, even when they don't know it. Applications
+            lacking localization support, normally have implicit support for one particular locale
+            (the locale of the author). When a class or function makes use of localization, we say
+            it is <code>locale-aware</code>. How does the code know which localization the user is
+            expecting?
         </para>
 
         <para>
-            A locale string or object identifying a supported locale gives <classname>Zend_Locale</classname> and its subclasses
-            access to information about the language and region expected by the user. Correct formatting, normalization,
-            and conversions are made based on this information.
+            A locale string or object identifying a supported locale gives
+            <classname>Zend_Locale</classname> and its subclasses access to information about the
+            language and region expected by the user. Correct formatting, normalization, and
+            conversions are made based on this information.
         </para>
-
     </sect2>
 
     <sect2 id="zend.locale.representation">
-
         <title>How are Locales Represented?</title>
 
         <para>
-            Locale identifiers consist of information about the user's language and preferred/primary geographic region
-            (e.g. state or province of home or workplace). The locale identifier strings used in Zend Framework are
-            internationally defined standard abbreviations of language and region, written as
-            <code>language_REGION</code>. Both the language and region parts are abbreviated to alphabetic, <acronym>ASCII</acronym>
+            Locale identifiers consist of information about the user's language and
+            preferred/primary geographic region (e.g. state or province of home or workplace). The
+            locale identifier strings used in Zend Framework are internationally defined standard
+            abbreviations of language and region, written as <code>language_REGION</code>. Both the
+            language and region parts are abbreviated to alphabetic, <acronym>ASCII</acronym>
             characters.
         </para>
 
         <note>
             <para>
-                Be aware that there exist not only locales with 2 characters as most people think. Also there
-                are languages and regions which are not only abbreviated with 2 characters. Therefor you should
-                NOT strip the region and language yourself, but use <classname>Zend_Locale</classname> when you want to strip language
-                or region from a locale string. Otherwise you could have unexpected behaviour within your code
-                when you do this yourself.
+                Be aware that there exist not only locales with 2 characters as most people think.
+                Also there are languages and regions which are not only abbreviated with 2
+                characters. Therefor you should NOT strip the region and language yourself, but use
+                <classname>Zend_Locale</classname> when you want to strip language or region from a
+                locale string. Otherwise you could have unexpected behaviour within your code when
+                you do this yourself.
             </para>
         </note>
 
         <para>
-            A user from USA would expect the language <code>English</code> and the region <constant>USA</constant>, yielding the
-            locale identifier "en_US". A user in Germany would expect the language <code>German</code> and the region
-            <code>Germany</code>, yielding the locale identifier "de_DE". See the
-            <ulink url="http://unicode.org/cldr/data/diff/supplemental/languages_and_territories.html">list of pre-defined locale and region combinations</ulink>, if you need to select a specific locale within Zend Framework.
+            A user from USA would expect the language <code>English</code> and the region
+            <constant>USA</constant>, yielding the locale identifier "en_US". A user in Germany
+            would expect the language <code>German</code> and the region <code>Germany</code>,
+            yielding the locale identifier "de_DE". See the <ulink
+                url="http://unicode.org/cldr/data/diff/supplemental/languages_and_territories.html">list
+                of pre-defined locale and region combinations</ulink>, if you need to select a
+            specific locale within Zend Framework.
         </para>
 
         <example id="zend.locale.representation.example-1">
             <title>Choosing a specific locale</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_DE'); // German language _ Germany
 ]]></programlisting>
         </example>
 
         <para>
-            A German user in America might expect the language <code>German</code> and the region <constant>USA</constant>, but
-            these non-standard mixes are not supported directly as recognized "locales". Instead, if an invalid
-            combination is used, then it will automatically be truncated by dropping the region code. For example,
-            "de_IS" would be truncated to "de", and "xh_RU" would be truncated to "xh", because neither of these
-            combinations are valid. Additionally, if the base language code is not supported (e.g. "zz_US") or does not
-            exist, then a default "root" locale will be used. The "root" locale has default definitions for
-            internationally recognized representations of dates, times, numbers, currencies, etc. The truncation process
-            depends on the requested information, since some combinations of language and region might be valid for one
-            type of data (e.g. dates), but not for another (e.g. currency format).
+            A German user in America might expect the language <code>German</code> and the region
+            <constant>USA</constant>, but these non-standard mixes are not supported directly as
+            recognized "locales". Instead, if an invalid combination is used, then it will
+            automatically be truncated by dropping the region code. For example, "de_IS" would be
+            truncated to "de", and "xh_RU" would be truncated to "xh", because neither of these
+            combinations are valid. Additionally, if the base language code is not supported (e.g.
+            "zz_US") or does not exist, then a default "root" locale will be used. The "root" locale
+            has default definitions for internationally recognized representations of dates, times,
+            numbers, currencies, etc. The truncation process depends on the requested information,
+            since some combinations of language and region might be valid for one type of data (e.g.
+            dates), but not for another (e.g. currency format).
         </para>
 
         <para>
@@ -176,25 +195,25 @@ $locale = new Zend_Locale('de_DE'); // German language _ Germany
             particular region observes Daylight Savings Time, and even which timezone a particular
             geographic area belongs. Thus, when performing date math, the math performed by Zend
             Framework components will not adjust for these changes, but instead will give the
-            correct time for the timezone using current, modern rules for <acronym>DST</acronym> and timezone
-            assignment for geographic regions.
+            correct time for the timezone using current, modern rules for <acronym>DST</acronym> and
+            timezone assignment for geographic regions.
         </para>
-
     </sect2>
 
     <sect2 id="zend.locale.selection">
-
         <title>Selecting the Right Locale</title>
 
         <para>
-            For most situations, <code>new Zend_Locale()</code> will automatically select the correct locale, with
-            preference given to information provided by the user's web browser. However, if <code>new
-            Zend_Locale(Zend_Locale::ENVIRONMENT)</code> is used, then preference will be given to using the host
-            server's environment configuration, as described below.
+            For most situations, <code>new Zend_Locale()</code> will automatically select the
+            correct locale, with preference given to information provided by the user's web browser.
+            However, if <code>new Zend_Locale(Zend_Locale::ENVIRONMENT)</code> is used, then
+            preference will be given to using the host server's environment configuration, as
+            described below.
         </para>
 
         <example id="zend.locale.selection.example-1">
             <title>Automatically selecting a locale</title>
+
             <programlisting language="php"><![CDATA[
 $locale  = new Zend_Locale();
 
@@ -210,49 +229,56 @@ $locale3 = new Zend_Locale(Zend_Locale::FRAMEWORK);
         </example>
 
         <para>
-            The search algorithm used by <classname>Zend_Locale</classname> for automatic selection of a locale uses three sources
-            of information:
+            The search algorithm used by <classname>Zend_Locale</classname> for automatic selection
+            of a locale uses three sources of information:
+
             <orderedlist>
                 <listitem>
                     <para>
-                        const <constant>Zend_Locale::BROWSER</constant> - The user's Web browser provides information with each
-                        request, which is published by <acronym>PHP</acronym> in the global variable <constant>HTTP_ACCEPT_LANGUAGE</constant>. If
-                        no matching locale can be found, then preference is given to <constant>ENVIRONMENT</constant> and lastly
-                        <constant>FRAMEWORK</constant>.
+                        const <constant>Zend_Locale::BROWSER</constant> - The user's Web browser
+                        provides information with each request, which is published by
+                        <acronym>PHP</acronym> in the global variable
+                        <constant>HTTP_ACCEPT_LANGUAGE</constant>. if no matching locale can be
+                        found, then preference is given to <constant>ENVIRONMENT</constant> and
+                        lastly <constant>FRAMEWORK</constant>.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        const <constant>Zend_Locale::ENVIRONMENT</constant> - <acronym>PHP</acronym> publishes the host server's locale via the <acronym>PHP</acronym>
-                        internal function <methodname>setlocale()</methodname>. If no matching locale can be found, then preference
-                        is given to <constant>FRAMEWORK</constant> and lastly <constant>BROWSER</constant>.
+                        const <constant>Zend_Locale::ENVIRONMENT</constant> - <acronym>PHP</acronym>
+                        publishes the host server's locale via the <acronym>PHP</acronym> internal
+                        function <methodname>setlocale()</methodname>. If no matching locale can be
+                        found, then preference is given to <constant>FRAMEWORK</constant> and lastly
+                        <constant>BROWSER</constant>.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        const <constant>Zend_Locale::FRAMEWORK</constant> - When Zend Framework has a standardized way of
-                        specifying component defaults (planned, but not yet available), then using this constant during
-                        instantiation will give preference to choosing a locale based on these defaults. If no matching
-                        locale can be found, then preference is given to <constant>ENVIRONMENT</constant> and lastly
-                        <constant>BROWSER</constant>.
+                        const <constant>Zend_Locale::FRAMEWORK</constant> - When Zend Framework has
+                        a standardized way of specifying component defaults (planned, but not yet
+                        available), then using this constant during instantiation will give
+                        preference to choosing a locale based on these defaults. If no matching
+                        locale can be found, then preference is given to
+                        <constant>ENVIRONMENT</constant> and lastly <constant>BROWSER</constant>.
                     </para>
                 </listitem>
             </orderedlist>
         </para>
-
     </sect2>
 
     <sect2 id="zend.locale.selection.automatic">
-
         <title>Usage of automatic Locales</title>
 
         <para>
-            <classname>Zend_Locale</classname> provides three additionally locales. These locales do not belong to
-            any language or region. They are "automatic" locales which means that they have the same effect
-            as the method <methodname>getDefault()</methodname> but without the negative effects like creating an instance.
-            These "automatic" locales can be used anywhere, where also a standard locale and also the
-            definition of a locale, its string representation, can be used. This offers simplicity for
-            situations like working with locales which are provided by a browser.
+            <classname>Zend_Locale</classname> provides three additionally locales. These locales do
+            not belong to any language or region. They are "automatic" locales which means that they
+            have the same effect as the method <methodname>getDefault()</methodname> but without the
+            negative effects like creating an instance. These "automatic" locales can be used
+            anywhere, where also a standard locale and also the definition of a locale, its string
+            representation, can be used. This offers simplicity for situations like working with
+            locales which are provided by a browser.
         </para>
 
         <para>
@@ -261,38 +287,48 @@ $locale3 = new Zend_Locale(Zend_Locale::FRAMEWORK);
             <orderedlist>
                 <listitem>
                     <para>
-                        <code>'browser'</code> - <classname>Zend_Locale</classname> should work with the information
-                        which is provided by the user's Web browser. It is published by <acronym>PHP</acronym> in the global
-                        variable <constant>HTTP_ACCEPT_LANGUAGE</constant>.
+                        <code>'browser'</code> - <classname>Zend_Locale</classname> should work with
+                        the information which is provided by the user's Web browser. It is published
+                        by <acronym>PHP</acronym> in the global variable
+                        <constant>HTTP_ACCEPT_LANGUAGE</constant>.
                     </para>
+
                     <para>
-                        If a user provides more than one locale within his browser, <classname>Zend_Locale</classname>
-                        will use the first found locale. If the user does not provide a locale or the script is
-                        being called from the command line the automatic locale <code>'environment'</code>
-                        will automatically be used and returned.
+                        If a user provides more than one locale within his browser,
+                        <classname>Zend_Locale</classname> will use the first found locale. If the
+                        user does not provide a locale or the script is being called from the
+                        command line the automatic locale <code>'environment'</code> will
+                        automatically be used and returned.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <code>'environment'</code> - <classname>Zend_Locale</classname> should work with the information
-                        which is provided by the host server. It is published by <acronym>PHP</acronym> via the internal function
+                        <code>'environment'</code> - <classname>Zend_Locale</classname> should work
+                        with the information which is provided by the host server. It is published
+                        by <acronym>PHP</acronym> via the internal function
                         <methodname>setlocale()</methodname>.
                     </para>
+
                     <para>
-                        If a environment provides more than one locale, <classname>Zend_Locale</classname> will use the
-                        first found locale. If the host does not provide a locale the automatic locale
-                        <code>'browser'</code> will automatically be used and returned.
+                        If a environment provides more than one locale,
+                        <classname>Zend_Locale</classname> will use the first found locale. If the
+                        host does not provide a locale the automatic locale <code>'browser'</code>
+                        will automatically be used and returned.
                     </para>
                 </listitem>
+
                 <listitem>
                     <para>
-                        <code>'auto'</code> - <classname>Zend_Locale</classname> should automatically detect any locale
-                        which can be worked with. It will first search for a users locale and then, if not
-                        successful, search for the host locale.
+                        <code>'auto'</code> - <classname>Zend_Locale</classname> should
+                        automatically detect any locale which can be worked with. It will first
+                        search for a users locale and then, if not successful, search for the host
+                        locale.
                     </para>
+
                     <para>
-                        If no locale can be detected, it will throw an exception and tell you that the
-                        automatic detection has been failed.
+                        If no locale can be detected, it will throw an exception and tell you that
+                        the automatic detection has been failed.
                     </para>
                 </listitem>
             </orderedlist>
@@ -300,6 +336,7 @@ $locale3 = new Zend_Locale(Zend_Locale::FRAMEWORK);
 
         <example id="zend.locale.selection.automatic.example-1">
             <title>Using automatic locales</title>
+
             <programlisting language="php"><![CDATA[
 // without automatic detection
 //$locale = new Zend_Locale(Zend_Locale::BROWSER);
@@ -309,27 +346,28 @@ $locale3 = new Zend_Locale(Zend_Locale::FRAMEWORK);
 $date = new Zend_Date('auto');
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.defaultlocale">
-
         <title>Using a default Locale</title>
 
         <para>
-            In some environments it is not possible to detect a locale automatically. You can expect this
-            behaviour when you get an request from command line or the requesting browser has no language tag
-            set and additionally your server has the default locale 'C' set or another proprietary locale.
+            In some environments it is not possible to detect a locale automatically. You can expect
+            this behaviour when you get an request from command line or the requesting browser has
+            no language tag set and additionally your server has the default locale 'C' set or
+            another proprietary locale.
         </para>
 
         <para>
-            In such cases <classname>Zend_Locale</classname> will normally throw an exception with a message that
-            the automatic detection of any locale was not successful. You have two options to handle such
-            a situation. Either through setting a new locale per hand, or defining a default locale.
+            In such cases <classname>Zend_Locale</classname> will normally throw an exception with a
+            message that the automatic detection of any locale was not successful. You have two
+            options to handle such a situation. Either through setting a new locale per hand, or
+            defining a default locale.
         </para>
 
         <example id="zend.locale.defaultlocale.example-1">
             <title>Handling locale exceptions</title>
+
             <programlisting language="php"><![CDATA[
 // within the bootstrap file
 try {
@@ -345,20 +383,21 @@ $date = new Zend_Date($locale);
 
         <para>
             But this has one big negative effect. You will have to set your locale object within
-            every class using <classname>Zend_Locale</classname>. This could become very unhandy if you are using
-            multiple classes.
+            every class using <classname>Zend_Locale</classname>. This could become very unhandy if
+            you are using multiple classes.
         </para>
 
         <para>
-            Since Zend Framework Release 1.5 there is a much better way to handle this. You can set a
-            default locale which the static <methodname>setDefault()</methodname> method. Of course, every unknown
-            or not full qualified locale will also throw an exception. <methodname>setDefault()</methodname> should
-            be the first call before you initiate any class using <classname>Zend_Locale</classname>. See the
-            following example for details:
+            Since Zend Framework Release 1.5 there is a much better way to handle this. You can set
+            a default locale which the static <methodname>setDefault()</methodname> method. Of
+            course, every unknown or not full qualified locale will also throw an exception.
+            <methodname>setDefault()</methodname> should be the first call before you initiate any
+            class using <classname>Zend_Locale</classname>. See the following example for details:
         </para>
 
         <example id="zend.locale.defaultlocale.example-2">
             <title>Setting a default locale</title>
+
             <programlisting language="php"><![CDATA[
 // within the bootstrap file
 Zend_Locale::setDefault('de');
@@ -372,23 +411,22 @@ $date = new Zend_Date();
             In the case that no locale can be detected, automatically the locale
             <emphasis>de</emphasis> will be used. Otherwise, the detected locale will be used.
         </para>
-
     </sect2>
 
     <sect2 id="zend.locale.interoperate">
-
         <title>ZF Locale-Aware Classes</title>
 
         <para>
-            In the Zend Framework, locale-aware classes rely on <classname>Zend_Locale</classname> to
-            automatically select a locale, as explained above. For example, in a Zend Framework web
-            application, constructing a date using <classname>Zend_Date</classname> without
+            In the Zend Framework, locale-aware classes rely on <classname>Zend_Locale</classname>
+            to automatically select a locale, as explained above. For example, in a Zend Framework
+            web application, constructing a date using <classname>Zend_Date</classname> without
             specifying a locale results in an object with a locale based on information provided by
             the current user's web browser.
         </para>
 
         <example id="zend.locale.interoperate.example-1">
             <title>Dates default to correct locale of web users</title>
+
             <programlisting language="php"><![CDATA[
 $date = new Zend_Date('2006',Zend_Date::YEAR);
 ]]></programlisting>
@@ -402,6 +440,7 @@ $date = new Zend_Date('2006',Zend_Date::YEAR);
 
         <example id="zend.locale.interoperate.example-2">
             <title>Overriding default locale selection</title>
+
             <programlisting language="php"><![CDATA[
 $usLocale = new Zend_Locale('en_US');
 $date = new Zend_Date('2006', Zend_Date::YEAR, $usLocale);
@@ -412,12 +451,13 @@ $temp = new Zend_Measure_Temperature('100,10',
         </example>
 
         <para>
-            If you know many objects should all use the same default locale, explicitly specify the default locale to
-            avoid the overhead of each object determining the default locale.
+            If you know many objects should all use the same default locale, explicitly specify the
+            default locale to avoid the overhead of each object determining the default locale.
         </para>
 
         <example id="zend.locale.interoperate.example-3">
             <title>Performance optimization when using a default locale</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale();
 $date = new Zend_Date('2006', Zend_Date::YEAR, $locale);
@@ -426,23 +466,23 @@ $temp = new Zend_Measure_Temperature('100,10',
                                      $locale);
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.frameworkwidelocale">
-
         <title>Application wide locale</title>
 
         <para>
-            Zend Framework allows the usage of an application wide locale. You simply set an instance of
-            <classname>Zend_Locale</classname> to the registry with the key 'Zend_Locale'. Then this instance will
-            be used within all locale aware classes of Zend Framework. This way you set one locale within
-            your registry and then you can forget about setting it again. It will automatically be used
-            in all other classes. See the below example for the right usage:
+            Zend Framework allows the usage of an application wide locale. You simply set an
+            instance of <classname>Zend_Locale</classname> to the registry with the key
+            'Zend_Locale'. Then this instance will be used within all locale aware classes of
+            Zend Framework. This way you set one locale within your registry and then you can forget
+            about setting it again. It will automatically be used in all other classes. See the
+            below example for the right usage:
         </para>
 
         <example id="zend.locale.frameworkwidelocale.example">
             <title>Usage of an application wide locale</title>
+
             <programlisting language="php"><![CDATA[
 // within your bootstrap
 $locale = new Zend_Locale('de_AT');
@@ -454,34 +494,33 @@ $date = new Zend_Date();
 echo $date->getDate();
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.formatoptions">
-
         <title>Zend_Locale_Format::setOptions(array $options)</title>
 
         <para>
-            The 'precision' option of a value is used to truncate or stretch extra digits. A value of '-1' disables
-            modification of the number of digits in the fractional part of the value. The 'locale' option helps when
-            parsing numbers and dates using separators and month names. The date format 'format_type' option selects between
-            <acronym>CLDR</acronym>/ISO date format specifier tokens and <acronym>PHP</acronym>'s date() tokens. The 'fix_date' option enables or disables
-            heuristics that attempt to correct invalid dates. The 'number_format' option specifies a default number
-            format for use with <methodname>toNumber()</methodname> (see
-            <xref
-                linkend= "zend.locale.number.localize"/>
-            ).
+            The 'precision' option of a value is used to truncate or stretch extra digits. A value
+            of '-1' disables modification of the number of digits in the fractional part of the
+            value. The 'locale' option helps when parsing numbers and dates using separators and
+            month names. The date format 'format_type' option selects between
+            <acronym>CLDR</acronym>/ISO date format specifier tokens and <acronym>PHP</acronym>'s
+            date() tokens. The 'fix_date' option enables or disables heuristics that attempt to
+            correct invalid dates. The 'number_format' option specifies a default number format for
+            use with <methodname>toNumber()</methodname> (see <xref
+                linkend= "zend.locale.number.localize"/>).
         </para>
 
         <para>
-            The 'date_format' option can be used to specify a default date format string, but beware of using getDate(),
-            checkdateFormat() and getTime() after using setOptions() with a 'date_format'. To use these four methods
-            with the default date format for a locale, use array('date_format' => null, 'locale' => $locale) for their
-            options.
+            The 'date_format' option can be used to specify a default date format string, but beware
+            of using getDate(), checkdateFormat() and getTime() after using setOptions() with a
+            'date_format'. To use these four methods with the default date format for a locale, use
+            array('date_format' => null, 'locale' => $locale) for their options.
         </para>
 
         <example id="zend.locale.formatoptions.example-1">
             <title>Dates default to correct locale of web users</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Locale_Format::setOptions(array('locale' => 'en_US',
                                      'fix_date' => true,
@@ -490,14 +529,17 @@ Zend_Locale_Format::setOptions(array('locale' => 'en_US',
         </example>
 
         <para>
-            For working with the standard definitions of a locale the option <constant>Zend_Locale_Format::STANDARD</constant> can be used.
-            Setting the option <constant>Zend_Locale_Format::STANDARD</constant> for <code>date_format</code> uses the standard definitions from the actual
-            set locale. Setting it for number_format uses the standard number format for this locale.
-            And setting it for locale uses the standard locale for this environment or browser.
+            For working with the standard definitions of a locale the option
+            <constant>Zend_Locale_Format::STANDARD</constant> can be used. Setting the option
+            <constant>Zend_Locale_Format::STANDARD</constant> for <code>date_format</code> uses the
+            standard definitions from the actual set locale. Setting it for number_format uses the
+            standard number format for this locale. And setting it for locale uses the standard
+            locale for this environment or browser.
         </para>
 
         <example id="zend.locale.formatoptions.example-2">
             <title>Using STANDARD definitions for setOptions()</title>
+
             <programlisting language="php"><![CDATA[
 Zend_Locale_Format::setOptions(array('locale' => 'en_US',
                                      'date_format' => 'dd.MMMM.YYYY'));
@@ -511,11 +553,9 @@ Zend_Locale_Format::setOptions(array('locale' => Zend_Locale_Format::STANDARD,
                                      'date_format' => 'dd.MMMM.YYYY'));
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.cache">
-
         <title>Speed up Zend_Locale and its subclasses</title>
 
         <para>
@@ -540,9 +580,7 @@ Zend_Locale_Format::setOptions(array('locale' => Zend_Locale_Format::STANDARD,
             disable the actual set cache, without erasing it, but also prevents that a cache is
             automatically generated when no cache is set.
         </para>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

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

@@ -1,49 +1,54 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.locale.parsing">
-
     <title>Normalization and Localization</title>
 
     <para>
-        <classname>Zend_Locale_Format</classname> is a internal component used by <classname>Zend_Locale</classname>. All locale aware classes use
-        <classname>Zend_Locale_Format</classname> for normalization and localization of numbers and dates. Normalization involves
-        parsing input from a variety of data representations, like dates, into a standardized, structured
-        representation, such as a <acronym>PHP</acronym> array with year, month, and day elements.
+        <classname>Zend_Locale_Format</classname> is a internal component used by
+        <classname>Zend_Locale</classname>. All locale aware classes use
+        <classname>Zend_Locale_Format</classname> for normalization and localization of numbers and
+        dates. Normalization involves parsing input from a variety of data representations, like
+        dates, into a standardized, structured representation, such as a <acronym>PHP</acronym>
+        array with year, month, and day elements.
     </para>
 
     <para>
-        The exact same string containing a number or a date might mean different things to people with different customs
-        and conventions. Disambiguation of numbers and dates requires rules about how to interpret these strings and
-        normalize the values into a standardized data structure. Thus, all methods in <classname>Zend_Locale_Format</classname>
-        require a locale in order to parse the input data.
+        The exact same string containing a number or a date might mean different things to people
+        with different customs and conventions. Disambiguation of numbers and dates requires rules
+        about how to interpret these strings and normalize the values into a standardized data
+        structure. Thus, all methods in <classname>Zend_Locale_Format</classname> require a locale
+        in order to parse the input data.
+
         <note>
             <title>Default "root" Locale</title>
+
             <para>
-                If no locale is specified, then normalization and localization will use the standard "root" locale,
-                which might yield unexpected behavior, if the input originated in a different locale, or output for a
-                specific locale was expected.
+                If no locale is specified, then normalization and localization will use the standard
+                "root" locale, which might yield unexpected behavior, if the input originated in a
+                different locale, or output for a specific locale was expected.
             </para>
         </note>
     </para>
 
     <sect2 id="zend.locale.number.normalize">
-
         <title>Number normalization: getNumber($input, Array $options)</title>
 
         <para>
-            There are many
-            <ulink url="http://en.wikipedia.org/wiki/Numeral">number systems</ulink>
-            different from the common
-            <ulink url="http://en.wikipedia.org/wiki/Decimal">decimal system</ulink>
-            (e.g. "3.14"). Numbers can be normalized with the <methodname>getNumber()</methodname> function to obtain the standard
-            decimal representation. for all number-related discussions in this manual,
-            <ulink url="http://en.wikipedia.org/wiki/Arabic_numerals">Arabic/European numerals (0,1,2,3,4,5,6,7,8,9)</ulink>
-            are implied, unless explicitly stated otherwise. The options array may contain a 'locale' to define grouping
-            and decimal characters. The array may also have a 'precision' to truncate excess digits from the result.
+            There are many <ulink url="http://en.wikipedia.org/wiki/Numeral">number systems</ulink>
+            different from the common <ulink
+                url="http://en.wikipedia.org/wiki/Decimal">decimal system</ulink> (e.g. "3.14").
+            Numbers can be normalized with the <methodname>getNumber()</methodname> function to
+            obtain the standard decimal representation. for all number-related discussions in this
+            manual, <ulink
+                url="http://en.wikipedia.org/wiki/Arabic_numerals">Arabic/European numerals
+                (0,1,2,3,4,5,6,7,8,9)</ulink> are implied, unless explicitly stated otherwise. The
+            options array may contain a 'locale' to define grouping and decimal characters. The
+            array may also have a 'precision' to truncate excess digits from the result.
         </para>
 
         <example id="zend.locale.number.normalize.example-1">
             <title>Number normalization</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::getNumber('13.524,678',
@@ -56,35 +61,37 @@ print $number; // will return 13524.678
         </example>
 
         <sect3 id="zend.locale.number.normalize.precision">
-
             <title>Precision and Calculations</title>
 
             <para>
-                Since <methodname>getNumber($value, array $options = array())</methodname> can normalize extremely large numbers,
-                check the result carefully before using finite precision calculations, such as ordinary <acronym>PHP</acronym> math
-                operations. For example, <code>if ((string)int_val($number) != $number) { use
-                <ulink url="http://www.php.net/bc">BCMath</ulink>
-                or
-                <ulink url="http://www.php.net/gmp">GMP</ulink>
-                </code>. Most <acronym>PHP</acronym> installations support the BCMath extension.
+                Since <methodname>getNumber($value, array $options = array())</methodname> can
+                normalize extremely large numbers, check the result carefully before using finite
+                precision calculations, such as ordinary <acronym>PHP</acronym> math operations. For
+                example, <code>if ((string)int_val($number) != $number) { use <ulink
+                    url="http://www.php.net/bc">BCMath</ulink> or <ulink
+                    url="http://www.php.net/gmp">GMP</ulink></code>. Most <acronym>PHP</acronym>
+                installations support the BCMath extension.
             </para>
 
             <para>
-                Also, the precision of the resulting decimal representation can be rounded to a desired length with
-                <methodname>getNumber()</methodname> with the option <code>'precision'</code>. If no precision is given,
-                no rounding occurs. Use only <acronym>PHP</acronym> integers to specify the precision.
+                Also, the precision of the resulting decimal representation can be rounded to a
+                desired length with <methodname>getNumber()</methodname> with the option
+                <code>'precision'</code>. If no precision is given, no rounding occurs. Use only
+                <acronym>PHP</acronym> integers to specify the precision.
             </para>
 
             <para>
-                If the resulting decimal representation should be truncated to a desired length instead of rounded
-                the option <code>'number_format'</code> can be used instead. Define the length of the decimal
-                representation with the desired length of zeros. The result will then not be rounded.
-                So if the defined precision within <code>number_format</code> is zero the value "1.6" will
-                return "1", not "2. See the example nearby:
+                If the resulting decimal representation should be truncated to a desired length
+                instead of rounded the option <code>'number_format'</code> can be used instead.
+                Define the length of the decimal representation with the desired length of zeros.
+                The result will then not be rounded. So if the defined precision within
+                <code>number_format</code> is zero the value "1.6" will return "1", not "2. See the
+                example nearby:
             </para>
 
             <example id="zend.locale.number.normalize.precision.example-1">
                 <title>Number normalization with precision</title>
+
                 <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::getNumber('13.524,678',
@@ -100,25 +107,23 @@ $number = Zend_Locale_Format::getNumber('13.524,678',
 print $number; // will return 13524.67
 ]]></programlisting>
             </example>
-
         </sect3>
-
     </sect2>
 
     <sect2 id="zend.locale.number.localize">
-
         <title>Number localization</title>
 
         <para>
-            <methodname>toNumber($value, array $options = array())</methodname> can localize numbers to the following
-            <link linkend="zend.locale.appendix">supported locales</link>
-            . This function will return a localized string of the given number in a conventional format for a specific
-            locale. The 'number_format' option explicitly specifies a non-default number format for use with
-            <methodname>toNumber()</methodname>.
+            <methodname>toNumber($value, array $options = array())</methodname> can localize numbers
+            to the following <link linkend="zend.locale.appendix">supported locales</link>. This
+            function will return a localized string of the given number in a conventional format for
+            a specific locale. The 'number_format' option explicitly specifies a non-default number
+            format for use with <methodname>toNumber()</methodname>.
         </para>
 
         <example id="zend.locale.number.localize.example-1">
             <title>Number localization</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::toNumber(13547.36,
@@ -132,20 +137,23 @@ print $number;
         <para>
             <note>
                 <title>Unlimited length</title>
+
                 <para>
-                    <methodname>toNumber()</methodname> can localize numbers with unlimited length. It is not related to integer or
-                    float limitations.
+                    <methodname>toNumber()</methodname> can localize numbers with unlimited length.
+                    It is not related to integer or float limitations.
                 </para>
             </note>
         </para>
 
         <para>
-            The same way as within <methodname>getNumber()</methodname>, <methodname>toNumber()</methodname> handles precision. If no precision
-            is given, the complete localized number will be returned.
+            The same way as within <methodname>getNumber()</methodname>,
+            <methodname>toNumber()</methodname> handles precision. If no precision is given, the
+            complete localized number will be returned.
         </para>
 
         <example id="zend.locale.number.localize.example-2">
             <title>Number localization with precision</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::toNumber(13547.3678,
@@ -158,15 +166,16 @@ print $number;
         </example>
 
         <para>
-            Using the option 'number_format' a self defined format for generating a number can be defined.
-            The format itself has to be given in <acronym>CLDR</acronym> format as described below. The locale is used to get
-            separation, precision and other number formatting signs from it. German for example defines
-            ',' as precision separation and in English the '.' sign is used.
+            Using the option 'number_format' a self defined format for generating a number can be
+            defined. The format itself has to be given in <acronym>CLDR</acronym> format as
+            described below. The locale is used to get separation, precision and other number
+            formatting signs from it. German for example defines ',' as precision separation and in
+            English the '.' sign is used.
         </para>
 
         <table id="zend.locale.number.localize.table-1">
-            <title>Format tokens for self generated number formats
-            </title>
+            <title>Format tokens for self generated number formats</title>
+
             <tgroup cols="4">
                 <thead>
                     <row>
@@ -176,6 +185,7 @@ print $number;
                         <entry>Generated output</entry>
                     </row>
                 </thead>
+
                 <tbody>
                     <row>
                         <entry>#0</entry>
@@ -183,24 +193,38 @@ print $number;
                         <entry>#0</entry>
                         <entry>1234567</entry>
                     </row>
+
                     <row>
                         <entry>,</entry>
-                        <entry>Generates a separation with the length from separation to next separation or to 0</entry>
+
+                        <entry>
+                            Generates a separation with the length from separation to next
+                            separation or to 0
+                        </entry>
+
                         <entry>#,##0</entry>
                         <entry>1,234,567</entry>
                     </row>
+
                     <row>
                         <entry>#,##,##0</entry>
-                        <entry>Generates a standard separation of 3 and all following separations with 2</entry>
+
+                        <entry>
+                            Generates a standard separation of 3 and all following separations with
+                            2
+                        </entry>
+
                         <entry>#,##,##0</entry>
                         <entry>12,34,567</entry>
                     </row>
+
                     <row>
                         <entry>.</entry>
                         <entry>Generates a precision</entry>
                         <entry>#0.#</entry>
                         <entry>1234567.1234</entry>
                     </row>
+
                     <row>
                         <entry>0</entry>
                         <entry>Generates a precision with a defined length</entry>
@@ -213,6 +237,7 @@ print $number;
 
         <example id="zend.locale.number.localize.example-3">
             <title>Using a self defined number format</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::toNumber(13547.3678,
@@ -232,11 +257,9 @@ $number = Zend_Locale_Format::toNumber(13547.3,
 print $number;
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.number.test">
-
         <title>Number testing</title>
 
         <para>
@@ -246,6 +269,7 @@ print $number;
 
         <example id="zend.locale.number.test.example-1">
             <title>Number testing</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale();
 if (Zend_Locale_Format::isNumber('13.445,36', array('locale' => 'de_AT')) {
@@ -255,20 +279,20 @@ if (Zend_Locale_Format::isNumber('13.445,36', array('locale' => 'de_AT')) {
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.float.normalize">
-
         <title>Float value normalization</title>
 
         <para>
-            Floating point values can be parsed with the <methodname>getFloat($value, array $options = array())</methodname>
-            function. A floating point value will be returned.
+            Floating point values can be parsed with the
+            <methodname>getFloat($value, array $options = array())</methodname> function. A floating
+            point value will be returned.
         </para>
 
         <example id="zend.locale.float.normalize.example-1">
             <title>Floating point value normalization</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::getFloat('13.524,678',
@@ -280,20 +304,19 @@ $number = Zend_Locale_Format::getFloat('13.524,678',
 print $number;
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.float.localize">
-
         <title>Floating point value localization</title>
 
         <para>
-            <methodname>toFloat()</methodname> can localize floating point values. This function will return a localized string of
-            the given number.
+            <methodname>toFloat()</methodname> can localize floating point values. This function
+            will return a localized string of the given number.
         </para>
 
         <example id="zend.locale.float.localize.example-1">
             <title>Floating point value localization</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::toFloat(13547.3655,
@@ -305,11 +328,9 @@ $number = Zend_Locale_Format::toFloat(13547.3655,
 print $number;
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.float.test">
-
         <title>Floating point value testing</title>
 
         <para>
@@ -320,6 +341,7 @@ print $number;
 
         <example id="zend.locale.float.test.example-1">
             <title>Floating point value testing</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 if (Zend_Locale_Format::isFloat('13.445,36', array('locale' => $locale)) {
@@ -329,19 +351,19 @@ if (Zend_Locale_Format::isFloat('13.445,36', array('locale' => $locale)) {
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.integer.normalize">
-
         <title>Integer value normalization</title>
 
         <para>
-            Integer values can be parsed with the <methodname>getInteger()</methodname> function. A integer value will be returned.
+            Integer values can be parsed with the <methodname>getInteger()</methodname> function. A
+            integer value will be returned.
         </para>
 
         <example id="zend.locale.integer.normalize.example-1">
             <title>Integer value normalization</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::getInteger('13.524,678',
@@ -351,20 +373,19 @@ $number = Zend_Locale_Format::getInteger('13.524,678',
 print $number;
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.integer.localize">
-
         <title>Integer point value localization</title>
 
         <para>
-            <methodname>toInteger($value, array $options = array())</methodname> can localize integer values. This function will
-            return a localized string of the given number.
+            <methodname>toInteger($value, array $options = array())</methodname> can localize
+            integer values. This function will return a localized string of the given number.
         </para>
 
         <example id="zend.locale.integer.localize.example-1">
             <title>Integer value localization</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 $number = Zend_Locale_Format::toInteger(13547.3655,
@@ -374,7 +395,6 @@ $number = Zend_Locale_Format::toInteger(13547.3655,
 print $number;
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.integer.test">
@@ -388,6 +408,7 @@ print $number;
 
         <example id="zend.locale.integer.test.example-1">
             <title>Integer value testing</title>
+
             <programlisting language="php"><![CDATA[
 $locale = new Zend_Locale('de_AT');
 if (Zend_Locale_Format::isInteger('13.445', array('locale' => $locale)) {
@@ -397,25 +418,26 @@ if (Zend_Locale_Format::isInteger('13.445', array('locale' => $locale)) {
 }
 ]]></programlisting>
         </example>
-
     </sect2>
 
     <sect2 id="zend.locale.numbersystems">
-
         <title>Numeral System Conversion</title>
 
         <para>
-            <methodname>Zend_Locale_Format::convertNumerals()</methodname> converts digits between different
-            <ulink url="http://en.wikipedia.org/wiki/Arabic_numerals">numeral systems</ulink>
-            , including the standard Arabic/European/Latin numeral system (0,1,2,3,4,5,6,7,8,9), not to be confused with
-            <ulink url="http://en.wikipedia.org/wiki/Eastern_Arabic_numerals">Eastern Arabic numerals</ulink>
-            sometimes used with the Arabic language to express numerals. Attempts to use an unsupported numeral system
-            will result in an exception, to avoid accidentally performing an incorrect conversion due to a spelling
-            error. All characters in the input, which are not numerals for the selected numeral system, are copied to
-            the output with no conversion provided for unit separator characters. <classname>Zend_Locale</classname>* components
-            rely on the data provided by <acronym>CLDR</acronym> (see their
-            <ulink url="http://unicode.org/cldr/data/diff/supplemental/languages_and_scripts.html?sortby=date">
-                list of scripts grouped by language</ulink>).
+            <methodname>Zend_Locale_Format::convertNumerals()</methodname> converts digits between
+            different <ulink url="http://en.wikipedia.org/wiki/Arabic_numerals">numeral
+                systems</ulink>, including the standard Arabic/European/Latin numeral system
+            (0,1,2,3,4,5,6,7,8,9), not to be confused with <ulink
+                url="http://en.wikipedia.org/wiki/Eastern_Arabic_numerals">Eastern Arabic
+                numerals</ulink> sometimes used with the Arabic language to express numerals.
+            Attempts to use an unsupported numeral system will result in an exception, to avoid
+            accidentally performing an incorrect conversion due to a spelling error. All characters
+            in the input, which are not numerals for the selected numeral system, are copied to the
+            output with no conversion provided for unit separator characters.
+            <classname>Zend_Locale</classname>* components rely on the data provided by
+            <acronym>CLDR</acronym> (see their <ulink
+                url="http://unicode.org/cldr/data/diff/supplemental/languages_and_scripts.html?sortby=date">list
+                of scripts grouped by language</ulink>).
         </para>
 
         <para>
@@ -425,16 +447,19 @@ if (Zend_Locale_Format::isInteger('13.445', array('locale' => $locale)) {
         </para>
 
         <para>
-            Suppose a web form collected a numeric input expressed using Eastern Arabic digits "١‎٠٠".
-            Most software and <acronym>PHP</acronym> functions expect input using Arabic numerals. Fortunately, converting this input
-            to its equivalent Latin numerals "100" requires little effort using
-            <methodname>convertNumerals($inputNumeralString, $sourceNumeralSystem, $destNumeralSystem)</methodname>
-            , which returns the <varname>$input</varname> with numerals in the script <varname>$sourceNumeralSystem</varname>
-            converted to the script <varname>$destNumeralSystem</varname>.
+            Suppose a web form collected a numeric input expressed using Eastern Arabic digits
+            "١‎٠٠". Most software and <acronym>PHP</acronym> functions expect input using Arabic
+            numerals. Fortunately, converting this input to its equivalent Latin numerals "100"
+            requires little effort using <methodname>convertNumerals($inputNumeralString,
+                $sourceNumeralSystem, $destNumeralSystem)</methodname>, which returns the
+            <varname>$input</varname> with numerals in the script
+            <varname>$sourceNumeralSystem</varname> converted to the script
+            <varname>$destNumeralSystem</varname>.
         </para>
 
         <example id="zend.locale.numbersystems.example-1">
             <title>Converting numerals from Eastern Arabic scripts to European/Latin scripts</title>
+
             <programlisting language="php"><![CDATA[
 $arabicScript = "١‎٠٠";   // Arabic for "100" (one hundred)
 $latinScript = Zend_Locale_Format::convertNumerals($arabicScript,
@@ -447,11 +472,13 @@ print "\nNormalized: " . $latinScript;
         </example>
 
         <para>
-            Similarly, any of the supported numeral systems may be converted to any other supported numeral system.
+            Similarly, any of the supported numeral systems may be converted to any other supported
+            numeral system.
         </para>
 
         <example id="zend.locale.numbersystems.example-2">
             <title>Converting numerals from Latin script to Eastern Arabic script</title>
+
             <programlisting language="php"><![CDATA[
 $latinScript = '123';
 $arabicScript = Zend_Locale_Format::convertNumerals($latinScript,
@@ -464,7 +491,10 @@ print "\nLocalized: " . $arabicScript;
         </example>
 
         <example id="zend.locale.numbersystems.example-3">
-            <title>Getting 4 letter CLDR script code using a native-language name of the script</title>
+            <title>
+                Getting 4 letter CLDR script code using a native-language name of the script
+            </title>
+
             <programlisting language="php"><![CDATA[
 function getScriptCode($scriptName, $locale)
 {
@@ -482,9 +512,7 @@ echo getScriptCode('tamoul', 'fr'); // outputs "Taml"
             For a list of supported numeral systems call
             <methodname>Zend_Locale::getTranslationList('numberingsystem', 'en')</methodname>.
         </para>
-
     </sect2>
-
 </sect1>
 <!--
 vim:se ts=4 sw=4 et:

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

@@ -4,17 +4,17 @@
     <title>Filters</title>
 
     <para>
-      A Filter object blocks a message from being written to the log.
+        A Filter object blocks a message from being written to the log.
     </para>
 
     <sect2 id="zend.log.filters.all-writers">
-      <title>Filtering for All Writers</title>
+        <title>Filtering for All Writers</title>
 
-      <para>
-        To filter before all writers, you can add any number of Filters to a
-        Log object using the <methodname>addFilter()</methodname> method:
+        <para>
+            To filter before all writers, you can add any number of Filters to a
+            Log object using the <methodname>addFilter()</methodname> method:
 
-        <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger = new Zend_Log();
 
 $writer = new Zend_Log_Writer_Stream('php://output');
@@ -30,19 +30,19 @@ $logger->info('Informational message');
 $logger->emerg('Emergency message');
 ]]></programlisting>
 
-        When you add one or more Filters to the Log object, the message must pass
-        through all of the Filters before any Writers receives it.
-      </para>
+            When you add one or more Filters to the Log object, the message must pass
+            through all of the Filters before any Writers receives it.
+        </para>
     </sect2>
 
     <sect2 id="zend.log.filters.single-writer">
-      <title>Filtering for a Writer Instance</title>
+        <title>Filtering for a Writer Instance</title>
 
-      <para>
-        To filter only on a specific Writer instance, use the
-        <code>addFilter</code> method of that Writer:
+        <para>
+            To filter only on a specific Writer instance, use the
+            <code>addFilter</code> method of that Writer:
 
-        <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger = new Zend_Log();
 
 $writer1 = new Zend_Log_Writer_Stream('/path/to/first/logfile');
@@ -61,6 +61,6 @@ $logger->info('Informational message');
 // logged by both writers
 $logger->emerg('Emergency message');
 ]]></programlisting>
-    </para>
-  </sect2>
+        </para>
+    </sect2>
 </sect1>

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

@@ -1,37 +1,39 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.log.formatters">
-  <title>Formatters</title>
-  <para>
-    A Formatter is an object that is responsible for taking an <code>event</code> array
-    describing a log event and outputting a string with a formatted log line.
-  </para>
-
-  <para>
-    Some Writers are not line-oriented and cannot use a Formatter. An example is the
-    Database Writer, which inserts the event items directly into database columns. For
-    Writers that cannot support a Formatter, an exception is thrown if you attempt to
-    set a Formatter.
-  </para>
-
-  <sect2 id="zend.log.formatters.simple">
-    <title>Simple Formatting</title>
+    <title>Formatters</title>
+
+    <para>
+        A Formatter is an object that is responsible for taking an <code>event</code> array
+        describing a log event and outputting a string with a formatted log line.
+    </para>
+
     <para>
-      <classname>Zend_Log_Formatter_Simple</classname> is the default formatter. It is configured
-      automatically when you specify no formatter. The default configuration is equivalent
-      to the following:
+        Some Writers are not line-oriented and cannot use a Formatter. An example is the
+        Database Writer, which inserts the event items directly into database columns. For
+        Writers that cannot support a Formatter, an exception is thrown if you attempt to
+        set a Formatter.
+    </para>
+
+    <sect2 id="zend.log.formatters.simple">
+        <title>Simple Formatting</title>
 
-      <programlisting language="php"><![CDATA[
+        <para>
+            <classname>Zend_Log_Formatter_Simple</classname> is the default formatter. It is
+            configured automatically when you specify no formatter. The default configuration is
+            equivalent to the following:
+
+            <programlisting language="php"><![CDATA[
 $format = '%timestamp% %priorityName% (%priority%): %message%' . PHP_EOL;
 $formatter = new Zend_Log_Formatter_Simple($format);
 ]]></programlisting>
-    </para>
+        </para>
 
-    <para>
-      A formatter is set on an individual Writer object using the Writer's
-      <methodname>setFormatter()</methodname> method:
+        <para>
+            A formatter is set on an individual Writer object using the Writer's
+            <methodname>setFormatter()</methodname> method:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Stream('php://output');
 $formatter = new Zend_Log_Formatter_Simple('hello %message%' . PHP_EOL);
 $writer->setFormatter($formatter);
@@ -43,25 +45,26 @@ $logger->info('there');
 
 // outputs "hello there"
 ]]></programlisting>
-    </para>
-
-    <para>
-      The constructor of <classname>Zend_Log_Formatter_Simple</classname> accepts a single
-      parameter: the format string. This string contains keys surrounded by
-      percent signs (e.g. <code>%message%</code>). The format string may
-      contain any key from the event data array.
-      You can retrieve the default keys by using the DEFAULT_FORMAT constant from
-      <classname>Zend_Log_Formatter_Simple</classname>.
-    </para>
-  </sect2>
-
-  <sect2 id="zend.log.formatters.xml">
-    <title>Formatting to XML</title>
-    <para>
-      <classname>Zend_Log_Formatter_Xml</classname> formats log data into XML strings.
-      By default, it automatically logs all items in the event data array:
-
-      <programlisting language="php"><![CDATA[
+        </para>
+
+        <para>
+            The constructor of <classname>Zend_Log_Formatter_Simple</classname> accepts a single
+            parameter: the format string. This string contains keys surrounded by
+            percent signs (e.g. <code>%message%</code>). The format string may
+            contain any key from the event data array.
+            You can retrieve the default keys by using the DEFAULT_FORMAT constant from
+            <classname>Zend_Log_Formatter_Simple</classname>.
+        </para>
+    </sect2>
+
+    <sect2 id="zend.log.formatters.xml">
+        <title>Formatting to XML</title>
+
+        <para>
+            <classname>Zend_Log_Formatter_Xml</classname> formats log data into XML strings.
+            By default, it automatically logs all items in the event data array:
+
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Stream('php://output');
 $formatter = new Zend_Log_Formatter_Xml();
 $writer->setFormatter($formatter);
@@ -71,12 +74,12 @@ $logger->addWriter($writer);
 
 $logger->info('informational message');
 ]]></programlisting>
-    </para>
+        </para>
 
-    <para>
-      The code above outputs the following XML (space added for clarity):
+        <para>
+            The code above outputs the following XML (space added for clarity):
 
-      <programlisting language="xml"><![CDATA[
+            <programlisting language="xml"><![CDATA[
 <logEntry>
   <timestamp>2007-04-06T07:24:37-07:00</timestamp>
   <message>informational message</message>
@@ -84,16 +87,16 @@ $logger->info('informational message');
   <priorityName>INFO</priorityName>
 </logEntry>
 ]]></programlisting>
-    </para>
+        </para>
 
-    <para>
-      It's possible to customize the root element as well as specify a mapping
-      of XML elements to the items in the event data array. The constructor
-      of <classname>Zend_Log_Formatter_Xml</classname> accepts a string with the name of
-      the root element as the first parameter and an associative array with
-      the element mapping as the second parameter:
+        <para>
+            It's possible to customize the root element as well as specify a mapping
+            of XML elements to the items in the event data array. The constructor
+            of <classname>Zend_Log_Formatter_Xml</classname> accepts a string with the name of
+            the root element as the first parameter and an associative array with
+            the element mapping as the second parameter:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Stream('php://output');
 $formatter = new Zend_Log_Formatter_Xml('log',
                                         array('msg' => 'message',
@@ -107,18 +110,17 @@ $logger->addWriter($writer);
 $logger->info('informational message');
 ]]></programlisting>
 
-      The code above changes the root element from its default of
-      <code>logEntry</code> to <code>log</code>. It also maps the element
-      <code>msg</code> to the event data item <code>message</code>. This
-      results in the following output:
+            The code above changes the root element from its default of
+            <code>logEntry</code> to <code>log</code>. It also maps the element
+            <code>msg</code> to the event data item <code>message</code>. This
+            results in the following output:
 
-      <programlisting language="xml"><![CDATA[
+            <programlisting language="xml"><![CDATA[
 <log>
   <msg>informational message</msg>
   <level>INFO</level>
 </log>
 ]]></programlisting>
-    </para>
-
-  </sect2>
+        </para>
+    </sect2>
 </sect1>

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

@@ -4,125 +4,134 @@
     <title>Overview</title>
 
     <para>
-      <classname>Zend_Log</classname> is a component for general purpose logging.
-      It supports multiple log backends, formatting messages sent to the log,
-      and filtering messages from being logged. These functions are divided
-      into the following objects:
-
-      <itemizedlist>
-        <listitem>
-          <para>
-            A Log (instance of <classname>Zend_Log</classname>) is the object that your
-            application uses the most. You can have as many Log objects as you
-            like; they do not interact. A Log object must contain at
-            least one Writer, and can optionally contain one or more Filters.
-          </para>
-        </listitem><listitem>
-          <para>
-            A Writer (inherits from <classname>Zend_Log_Writer_Abstract</classname>) is
-            responsible for saving data to storage.
-          </para>
-        </listitem><listitem>
-          <para>
-            A Filter (implements <classname>Zend_Log_Filter_Interface</classname>)
-            blocks log data from being saved. A filter may be applied to an
-            individual Writer, or to a Log where it is applied before all
-            Writers. In either case, filters may be chained.
-          </para>
-        </listitem><listitem>
-          <para>
-            A Formatter (implements <classname>Zend_Log_Formatter_Interface</classname>)
-            can format the log data before it is written by a Writer. Each
-            Writer has exactly one Formatter.
-          </para>
-        </listitem>
-      </itemizedlist>
+        <classname>Zend_Log</classname> is a component for general purpose logging.
+        It supports multiple log backends, formatting messages sent to the log,
+        and filtering messages from being logged. These functions are divided
+        into the following objects:
+
+        <itemizedlist>
+            <listitem>
+                <para>
+                    A Log (instance of <classname>Zend_Log</classname>) is the object that your
+                    application uses the most. You can have as many Log objects as you
+                    like; they do not interact. A Log object must contain at
+                    least one Writer, and can optionally contain one or more Filters.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    A Writer (inherits from <classname>Zend_Log_Writer_Abstract</classname>) is
+                    responsible for saving data to storage.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    A Filter (implements <classname>Zend_Log_Filter_Interface</classname>)
+                    blocks log data from being saved. A filter may be applied to an
+                    individual Writer, or to a Log where it is applied before all
+                    Writers. In either case, filters may be chained.
+                </para>
+            </listitem>
+
+            <listitem>
+                <para>
+                    A Formatter (implements <classname>Zend_Log_Formatter_Interface</classname>)
+                    can format the log data before it is written by a Writer. Each
+                    Writer has exactly one Formatter.
+                </para>
+            </listitem>
+        </itemizedlist>
     </para>
 
     <sect2 id="zend.log.overview.creating-a-logger">
-      <title>Creating a Log</title>
-      <para>
-        To get started logging, instantiate a Writer and then pass it to a Log
-        instance:
+        <title>Creating a Log</title>
 
-        <programlisting language="php"><![CDATA[
+        <para>
+            To get started logging, instantiate a Writer and then pass it to a Log instance:
+
+            <programlisting language="php"><![CDATA[
 $logger = new Zend_Log();
 $writer = new Zend_Log_Writer_Stream('php://output');
 
 $logger->addWriter($writer);
 ]]></programlisting>
 
-        It is important to note that the Log must
-        have at least one Writer. You can add any number of Writers using the
-        Log's <methodname>addWriter()</methodname> method.
-      </para>
+            It is important to note that the Log must
+            have at least one Writer. You can add any number of Writers using the
+            Log's <methodname>addWriter()</methodname> method.
+        </para>
 
-      <para>
-        Alternatively, you can pass a Writer directly to constructor of Log as
-        a shortcut:
+        <para>
+            Alternatively, you can pass a Writer directly to constructor of Log as
+            a shortcut:
 
-        <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Stream('php://output');
 $logger = new Zend_Log($writer);
 ]]></programlisting>
 
-        The Log is now ready to use.
-      </para>
+            The Log is now ready to use.
+        </para>
     </sect2>
 
     <sect2 id="zend.log.overview.logging-messages">
-      <title>Logging Messages</title>
+        <title>Logging Messages</title>
 
-      <para>
-        To log a message, call the <methodname>log()</methodname> method of a Log instance
-        and pass it the message with a corresponding priority:
+        <para>
+            To log a message, call the <methodname>log()</methodname> method of a Log instance
+            and pass it the message with a corresponding priority:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger->log('Informational message', Zend_Log::INFO);
 ]]></programlisting>
 
-      The first parameter of the <methodname>log()</methodname> method is a string <code>message</code> and the second
-      parameter is an integer <code>priority</code>. The priority must be one of the priorities recognized
-      by the Log instance. This is explained in the next section.
-    </para>
+            The first parameter of the <methodname>log()</methodname> method is a string
+            <code>message</code> and the second parameter is an integer <code>priority</code>. The
+            priority must be one of the priorities recognized by the Log instance. This is explained
+            in the next section.
+        </para>
 
-    <para>
-      A shortcut is also available. Instead of calling the <methodname>log()</methodname> method, you can
-      call a method by the same name as the priority:
+        <para>
+            A shortcut is also available. Instead of calling the <methodname>log()</methodname>
+            method, you can call a method by the same name as the priority:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger->log('Informational message', Zend_Log::INFO);
 $logger->info('Informational message');
 
 $logger->log('Emergency message', Zend_Log::EMERG);
 $logger->emerg('Emergency message');
 ]]></programlisting>
-    </para>
-  </sect2>
+        </para>
+    </sect2>
 
-  <sect2 id="zend.log.overview.destroying-a-logger">
-    <title>Destroying a Log</title>
-    <para>
-      If the Log object is no longer needed, set the variable containing it to
-      <constant>NULL</constant> to destroy it. This will automatically call the
-      <methodname>shutdown()</methodname> instance method of each attached Writer before
-      the Log object is destroyed:
+    <sect2 id="zend.log.overview.destroying-a-logger">
+        <title>Destroying a Log</title>
+
+        <para>
+            If the Log object is no longer needed, set the variable containing it to
+            <constant>NULL</constant> to destroy it. This will automatically call the
+            <methodname>shutdown()</methodname> instance method of each attached Writer before
+            the Log object is destroyed:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger = null;
 ]]></programlisting>
 
-      Explicitly destroying the log in this way is optional and is performed
-      automatically at PHP shutdown.
-    </para>
-  </sect2>
+            Explicitly destroying the log in this way is optional and is performed
+            automatically at PHP shutdown.
+        </para>
+    </sect2>
 
-  <sect2 id="zend.log.overview.builtin-priorities">
-    <title>Using Built-in Priorities</title>
-    <para>
-      The <classname>Zend_Log</classname> class defines the following priorities:
+    <sect2 id="zend.log.overview.builtin-priorities">
+        <title>Using Built-in Priorities</title>
+
+        <para>
+            The <classname>Zend_Log</classname> class defines the following priorities:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 EMERG   = 0;  // Emergency: system is unusable
 ALERT   = 1;  // Alert: action must be taken immediately
 CRIT    = 2;  // Critical: critical conditions
@@ -133,92 +142,92 @@ INFO    = 6;  // Informational: informational messages
 DEBUG   = 7;  // Debug: debug messages
 ]]></programlisting>
 
-      These priorities are always available, and a convenience method of the same name
-      is available for each one.
-    </para>
-
-    <para>
-      The priorities are not arbitrary. They come from the BSD <code>syslog</code> protocol,
-      which is described in <ulink url="http://tools.ietf.org/html/rfc3164">RFC-3164</ulink>.
-      The names and corresponding priority numbers are also
-      compatible with another <acronym>PHP</acronym> logging system,
-      <ulink url="http://pear.php.net/package/log">PEAR Log</ulink>,
-      which perhaps promotes interoperability between it and <classname>Zend_Log</classname>.
-    </para>
-
-    <para>
-      Priority numbers descend in order of importance. <constant>EMERG</constant> (0)
-      is the most important priority. <constant>DEBUG</constant> (7) is the least
-      important priority of the built-in priorities. You may define priorities
-      of lower importance than <constant>DEBUG</constant>. When
-      selecting the priority for your log message, be aware of this priority
-      hierarchy and choose appropriately.
-    </para>
-  </sect2>
+            These priorities are always available, and a convenience method of the same name
+            is available for each one.
+        </para>
+
+        <para>
+            The priorities are not arbitrary. They come from the BSD <code>syslog</code> protocol,
+            which is described in <ulink url="http://tools.ietf.org/html/rfc3164">RFC-3164</ulink>.
+            The names and corresponding priority numbers are also
+            compatible with another <acronym>PHP</acronym> logging system,
+            <ulink url="http://pear.php.net/package/log">PEAR Log</ulink>,
+            which perhaps promotes interoperability between it and <classname>Zend_Log</classname>.
+        </para>
+
+        <para>
+            Priority numbers descend in order of importance. <constant>EMERG</constant> (0)
+            is the most important priority. <constant>DEBUG</constant> (7) is the least
+            important priority of the built-in priorities. You may define priorities
+            of lower importance than <constant>DEBUG</constant>. When
+            selecting the priority for your log message, be aware of this priority
+            hierarchy and choose appropriately.
+        </para>
+    </sect2>
 
-  <sect2 id="zend.log.overview.user-defined-priorities">
-    <title>Adding User-defined Priorities</title>
+    <sect2 id="zend.log.overview.user-defined-priorities">
+        <title>Adding User-defined Priorities</title>
 
-    <para>
-      User-defined priorities can be added at runtime using the Log's
-      <methodname>addPriority()</methodname> method:
+        <para>
+            User-defined priorities can be added at runtime using the Log's
+            <methodname>addPriority()</methodname> method:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger->addPriority('FOO', 8);
 ]]></programlisting>
 
-      The snippet above creates a new priority, <constant>FOO</constant>, whose
-      value is <code>8</code>. The new priority is then available for logging:
+            The snippet above creates a new priority, <constant>FOO</constant>, whose
+            value is <code>8</code>. The new priority is then available for logging:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $logger->log('Foo message', 8);
 $logger->foo('Foo Message');
 ]]></programlisting>
 
-      New priorities cannot overwrite existing ones.
-    </para>
-  </sect2>
-
-  <sect2 id="zend.log.overview.understanding-fields">
-    <title>Understanding Log Events</title>
-
-    <para>
-      When you call the <methodname>log()</methodname> method or one of its shortcuts, a
-      log event is created. This is simply an associative array with data
-      describing the event that is passed to the writers. The following keys
-      are always created in this array: <code>timestamp</code>,
-      <code>message</code>, <code>priority</code>, and
-      <code>priorityName</code>.
-    </para>
-
-    <para>
-      The creation of the <code>event</code> array is completely transparent.
-      However, knowledge of the <code>event</code> array is required for adding an
-      item that does not exist in the default set above.
-    </para>
-
-    <para>
-      To add a new item to every future event, call the <methodname>setEventItem()</methodname>
-      method giving a key and a value:
+            New priorities cannot overwrite existing ones.
+        </para>
+    </sect2>
 
-      <programlisting language="php"><![CDATA[
+    <sect2 id="zend.log.overview.understanding-fields">
+        <title>Understanding Log Events</title>
+
+        <para>
+            When you call the <methodname>log()</methodname> method or one of its shortcuts, a
+            log event is created. This is simply an associative array with data
+            describing the event that is passed to the writers. The following keys
+            are always created in this array: <code>timestamp</code>,
+            <code>message</code>, <code>priority</code>, and
+            <code>priorityName</code>.
+        </para>
+
+        <para>
+            The creation of the <code>event</code> array is completely transparent.
+            However, knowledge of the <code>event</code> array is required for adding an
+            item that does not exist in the default set above.
+        </para>
+
+        <para>
+            To add a new item to every future event, call the <methodname>setEventItem()</methodname>
+            method giving a key and a value:
+
+            <programlisting language="php"><![CDATA[
 $logger->setEventItem('pid', getmypid());
 ]]></programlisting>
 
-      The example above sets a new item named <code>pid</code> and populates
-      it with the PID of the current process. Once a new item has been
-      set, it is available automatically to all writers along with all of the
-      other data event data during logging. An item can be overwritten at any
-      time by calling the <methodname>setEventItem()</methodname> method again.
-    </para>
-
-    <para>
-      Setting a new event item with <methodname>setEventItem()</methodname> causes the
-      new item to be sent to all writers of the logger. However, this does
-      not guarantee that the writers actually record the item. This is
-      because the writers won't know what to do with it unless a formatter
-      object is informed of the new item. Please see the section on Formatters
-      to learn more.
-    </para>
-  </sect2>
+            The example above sets a new item named <code>pid</code> and populates
+            it with the PID of the current process. Once a new item has been
+            set, it is available automatically to all writers along with all of the
+            other data event data during logging. An item can be overwritten at any
+            time by calling the <methodname>setEventItem()</methodname> method again.
+        </para>
+
+        <para>
+            Setting a new event item with <methodname>setEventItem()</methodname> causes the
+            new item to be sent to all writers of the logger. However, this does
+            not guarantee that the writers actually record the item. This is
+            because the writers won't know what to do with it unless a formatter
+            object is informed of the new item. Please see the section on Formatters
+            to learn more.
+        </para>
+    </sect2>
 </sect1>

documentation/manual/en/module_specs/Zend_Log-Writers-Firebug.xml

@@ -2,46 +2,55 @@
 <!-- Reviewed: no -->
 <sect2 id="zend.log.writers.firebug">
     <title>Writing to Firebug</title>
+
     <para>
-      <classname>Zend_Log_Writer_Firebug</classname> sends log
-      data to the <ulink url="http://www.getfirebug.com/">Firebug</ulink>
-      <ulink url="http://getfirebug.com/logging.html">Console</ulink>.
+        <classname>Zend_Log_Writer_Firebug</classname> sends log
+        data to the <ulink url="http://www.getfirebug.com/">Firebug</ulink>
+        <ulink url="http://getfirebug.com/logging.html">Console</ulink>.
     </para>
+
     <para>
-      <inlinegraphic fileref="figures/zend.wildfire.firebug.console.png" format="PNG" scale="100" width="310" />
+        <inlinegraphic fileref="figures/zend.wildfire.firebug.console.png" format="PNG"
+            scale="100" width="310" />
     </para>
+
     <para>
-      All data is sent via the <classname>Zend_Wildfire_Channel_HttpHeaders</classname> component
-      which uses <acronym>HTTP</acronym> headers to ensure the page content is not disturbed.
-      Debugging <acronym>AJAX</acronym> requests that require clean <acronym>JSON</acronym> and <acronym>XML</acronym> responses is possible with this approach.
+        All data is sent via the <classname>Zend_Wildfire_Channel_HttpHeaders</classname> component
+        which uses <acronym>HTTP</acronym> headers to ensure the page content is not disturbed.
+        Debugging <acronym>AJAX</acronym> requests that require clean <acronym>JSON</acronym> and
+        <acronym>XML</acronym> responses is possible with this approach.
     </para>
+
     <para>
-      Requirements:
+        Requirements:
     </para>
+
     <itemizedlist>
-      <listitem>
-        <para>
-          Firefox Browser ideally version 3 but version 2 is also supported.
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          Firebug Firefox Extension which you can download from
-          <ulink url="https://addons.mozilla.org/en-US/firefox/addon/1843">https://addons.mozilla.org/en-US/firefox/addon/1843</ulink>.
-        </para>
-      </listitem>
-      <listitem>
-        <para>
-          FirePHP Firefox Extension which you can download from
-          <ulink url="https://addons.mozilla.org/en-US/firefox/addon/6149">https://addons.mozilla.org/en-US/firefox/addon/6149</ulink>.
-        </para>
-      </listitem>
+        <listitem>
+            <para>
+                Firefox Browser ideally version 3 but version 2 is also supported.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                Firebug Firefox Extension which you can download from <ulink
+                    url="https://addons.mozilla.org/en-US/firefox/addon/1843">https://addons.mozilla.org/en-US/firefox/addon/1843</ulink>.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                FirePHP Firefox Extension which you can download from <ulink
+                    url="https://addons.mozilla.org/en-US/firefox/addon/6149">https://addons.mozilla.org/en-US/firefox/addon/6149</ulink>.
+            </para>
+        </listitem>
     </itemizedlist>
 
     <example id="zend.log.writers.firebug.example.with_front_controller">
-      <title>Logging with Zend_Controller_Front</title>
+        <title>Logging with Zend_Controller_Front</title>
 
-      <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 // Place this in your bootstrap file before dispatching your front controller
 $writer = new Zend_Log_Writer_Firebug();
 $logger = new Zend_Log($writer);
@@ -52,9 +61,9 @@ $logger->log('This is a log message!', Zend_Log::INFO);
     </example>
 
     <example id="zend.log.writers.firebug.example.without_front_controller">
-      <title>Logging without Zend_Controller_Front</title>
+        <title>Logging without Zend_Controller_Front</title>
 
-      <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Firebug();
 $logger = new Zend_Log($writer);
 
@@ -78,107 +87,127 @@ $response->sendHeaders();
     </example>
 
     <sect3 id="zend.log.writers.firebug.priority-styles">
+        <title>Setting Styles for Priorities</title>
 
-      <title>Setting Styles for Priorities</title>
+        <para>
+            Built-in and user-defined priorities can be styled with the
+            <methodname>setPriorityStyle()</methodname> method.
+        </para>
 
-      <para>
-        Built-in and user-defined priorities can be styled with the <methodname>setPriorityStyle()</methodname> method.
-      </para>
-      <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $logger->addPriority('FOO', 8);
 $writer->setPriorityStyle(8, 'TRACE');
 $logger->foo('Foo Message');
 ]]></programlisting>
-      <para>
-        The default style for user-defined priorities can be set with the <methodname>setDefaultPriorityStyle()</methodname> method.
-      </para>
-      <programlisting language="php"><![CDATA[
+
+        <para>
+            The default style for user-defined priorities can be set with the
+            <methodname>setDefaultPriorityStyle()</methodname> method.
+        </para>
+
+        <programlisting language="php"><![CDATA[
 $writer->setDefaultPriorityStyle('TRACE');
 ]]></programlisting>
-      <para>
-        The supported styles are as follows:
-        <table id="zend.log.writers.firebug.priority-styles.table">
-            <title>Firebug Logging Styles</title>
-            <tgroup cols="2">
-                <thead>
-                    <row>
-                        <entry>Style</entry>
-                        <entry>Description</entry>
-                    </row>
-                </thead>
-                <tbody>
-                    <row>
-                        <entry><constant>LOG</constant></entry>
-                        <entry>Displays a plain log message</entry>
-                    </row>
-                    <row>
-                        <entry><constant>INFO</constant></entry>
-                        <entry>Displays an info log message</entry>
-                    </row>
-                    <row>
-                        <entry><constant>WARN</constant></entry>
-                        <entry>Displays a warning log message</entry>
-                    </row>
-                    <row>
-                        <entry><constant>ERROR</constant></entry>
-                        <entry>Displays an error log message that increments Firebug's error count</entry>
-                    </row>
-                    <row>
-                        <entry><constant>TRACE</constant></entry>
-                        <entry>Displays a log message with an expandable stack trace</entry>
-                    </row>
-                    <row>
-                        <entry><constant>EXCEPTION</constant></entry>
-                        <entry>Displays an error long message with an expandable stack trace</entry>
-                    </row>
-                    <row>
-                        <entry><constant>TABLE</constant></entry>
-                        <entry>Displays a log message with an expandable table</entry>
-                    </row>
-                </tbody>
-            </tgroup>
-        </table>
-      </para>
+
+        <para>
+            The supported styles are as follows:
+
+            <table id="zend.log.writers.firebug.priority-styles.table">
+                <title>Firebug Logging Styles</title>
+
+                <tgroup cols="2">
+                    <thead>
+                        <row>
+                            <entry>Style</entry>
+                            <entry>Description</entry>
+                        </row>
+                    </thead>
+
+                    <tbody>
+                        <row>
+                            <entry><constant>LOG</constant></entry>
+                            <entry>Displays a plain log message</entry>
+                        </row>
+
+                        <row>
+                            <entry><constant>INFO</constant></entry>
+                            <entry>Displays an info log message</entry>
+                        </row>
+
+                        <row>
+                            <entry><constant>WARN</constant></entry>
+                            <entry>Displays a warning log message</entry>
+                        </row>
+
+                        <row>
+                            <entry><constant>ERROR</constant></entry>
+
+                            <entry>
+                                Displays an error log message that increments Firebug's error count
+                            </entry>
+                        </row>
+
+                        <row>
+                            <entry><constant>TRACE</constant></entry>
+                            <entry>Displays a log message with an expandable stack trace</entry>
+                        </row>
+
+                        <row>
+                            <entry><constant>EXCEPTION</constant></entry>
+                            <entry>
+                                Displays an error long message with an expandable stack trace
+                            </entry>
+                        </row>
+
+                        <row>
+                            <entry><constant>TABLE</constant></entry>
+                            <entry>Displays a log message with an expandable table</entry>
+                        </row>
+                    </tbody>
+                </tgroup>
+            </table>
+        </para>
     </sect3>
 
     <sect3 id="zend.log.writers.firebug.preparing-data">
+        <title>Preparing data for Logging</title>
 
-      <title>Preparing data for Logging</title>
+        <para>
+            While any <acronym>PHP</acronym> variable can be logged with the built-in priorities,
+            some special formatting is required if using some of the more specialized log styles.
+        </para>
 
-      <para>
-        While any <acronym>PHP</acronym> variable can be logged with the built-in priorities, some special formatting
-        is required if using some of the more specialized log styles.
-      </para>
-      <para>
-        The <constant>LOG</constant>, <constant>INFO</constant>, <constant>WARN</constant>, <constant>ERROR</constant>
-        and <constant>TRACE</constant> styles require no special formatting.
-      </para>
+        <para>
+            The <constant>LOG</constant>, <constant>INFO</constant>, <constant>WARN</constant>,
+            <constant>ERROR</constant> and <constant>TRACE</constant> styles require no special
+            formatting.
+        </para>
     </sect3>
 
     <sect3 id="zend.log.writers.firebug.preparing-data.exception">
+        <title>Exception Logging</title>
 
-      <title>Exception Logging</title>
+        <para>
+            To log a <classname>Zend_Exception</classname> simply pass the exception object to the
+            logger. It does not matter which priority or style you have set as the exception is
+            automatically recognized.
+        </para>
 
-      <para>
-        To log a <classname>Zend_Exception</classname> simply pass the exception object to the logger.
-        It does not matter which priority or style you have set as the exception is automatically
-        recognized.
-      </para>
-      <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $exception = new Zend_Exception('Test exception');
 $logger->err($exception);
 ]]></programlisting>
     </sect3>
 
     <sect3 id="zend.log.writers.firebug.preparing-data.table">
+        <title>Table Logging</title>
 
-      <title>Table Logging</title>
+        <para>
+            You can also log data and format it in a table style. Columns are automatically
+            recognized and the first row of data automatically becomes the header.
+        </para>
 
-      <para>
-        You can also log data and format it in a table style. Columns are automatically recognized and
-        the first row of data automatically becomes the header.
-      </para>
-      <programlisting language="php"><![CDATA[
+        <programlisting language="php"><![CDATA[
 $writer->setPriorityStyle(8, 'TABLE');
 $logger->addPriority('TABLE', 8);
 

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

@@ -1,53 +1,56 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- Reviewed: no -->
 <sect1 id="zend.log.writers" xmlns:xi="http://www.w3.org/2001/XInclude">
-  <title>Writers</title>
-  <para>
-    A Writer is an object that inherits from <classname>Zend_Log_Writer_Abstract</classname>. A Writer's
-    responsibility is to record log data to a storage backend.
-  </para>
-
-  <sect2 id="zend.log.writers.stream">
-    <title>Writing to Streams</title>
+    <title>Writers</title>
+
     <para>
-      <classname>Zend_Log_Writer_Stream</classname> sends log
-      data to a <ulink url="http://www.php.net/stream">PHP stream</ulink>.
+        A Writer is an object that inherits from <classname>Zend_Log_Writer_Abstract</classname>.
+        A Writer's responsibility is to record log data to a storage backend.
     </para>
 
-    <para>
-      To write log data to the PHP output buffer, use the URL <code>php://output</code>. Alternatively,
-      you can send log data directly to a stream like <constant>STDERR</constant>
-      (<code>php://stderr</code>).
+    <sect2 id="zend.log.writers.stream">
+        <title>Writing to Streams</title>
+
+        <para>
+            <classname>Zend_Log_Writer_Stream</classname> sends log
+            data to a <ulink url="http://www.php.net/stream">PHP stream</ulink>.
+        </para>
 
-      <programlisting language="php"><![CDATA[
+        <para>
+            To write log data to the PHP output buffer, use the URL <code>php://output</code>.
+            Alternatively, you can send log data directly to a stream like
+            <constant>STDERR</constant> (<code>php://stderr</code>).
+
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Stream('php://output');
 $logger = new Zend_Log($writer);
 
 $logger->info('Informational message');
 ]]></programlisting>
-    </para>
+        </para>
 
-    <para>
-      To write data to a file, use one of the
-      <ulink url="http://www.php.net/manual/en/wrappers.php#wrappers.file">Filesystem
-      URLs</ulink>:
+        <para>
+            To write data to a file, use one of the
+            <ulink url="http://www.php.net/manual/en/wrappers.php#wrappers.file">Filesystem
+            URLs</ulink>:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Stream('/path/to/logfile');
 $logger = new Zend_Log($writer);
 
 $logger->info('Informational message');
 ]]></programlisting>
 
-      By default, the stream opens in the append mode (<code>"a"</code>).
-      To open it with a different mode, the <classname>Zend_Log_Writer_Stream</classname> constructor
-      accepts an optional second parameter for the mode.
-    </para>
+            By default, the stream opens in the append mode (<code>"a"</code>).
+            To open it with a different mode, the <classname>Zend_Log_Writer_Stream</classname>
+            constructor accepts an optional second parameter for the mode.
+        </para>
 
-    <para>
-      The constructor of <classname>Zend_Log_Writer_Stream</classname> also accepts an existing stream resource:
+        <para>
+            The constructor of <classname>Zend_Log_Writer_Stream</classname> also accepts an
+            existing stream resource:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $stream = @fopen('/path/to/logfile', 'a', false);
 if (! $stream) {
     throw new Exception('Failed to open stream');
@@ -59,20 +62,22 @@ $logger = new Zend_Log($writer);
 $logger->info('Informational message');
 ]]></programlisting>
 
-      You cannot specify the mode for existing stream resources. Doing so
-      causes a <classname>Zend_Log_Exception</classname> to be thrown.
-    </para>
-  </sect2>
+            You cannot specify the mode for existing stream resources. Doing so
+            causes a <classname>Zend_Log_Exception</classname> to be thrown.
+        </para>
+    </sect2>
 
-  <sect2 id="zend.log.writers.database">
-    <title>Writing to Databases</title>
-    <para>
-      <classname>Zend_Log_Writer_Db</classname> writes log information to a database table using
-      <classname>Zend_Db</classname>. The constructor of <classname>Zend_Log_Writer_Db</classname> receives
-      a <classname>Zend_Db_Adapter</classname> instance, a table name, and a mapping of database
-      columns to event data items:
+    <sect2 id="zend.log.writers.database">
+        <title>Writing to Databases</title>
+
+        <para>
+            <classname>Zend_Log_Writer_Db</classname> writes log information to a database table
+            using <classname>Zend_Db</classname>. The constructor of
+            <classname>Zend_Log_Writer_Db</classname> receives a
+            <classname>Zend_Db_Adapter</classname> instance, a table name, and a mapping of database
+            columns to event data items:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $params = array ('host'     => '127.0.0.1',
                  'username' => 'malory',
                  'password' => '******',
@@ -87,42 +92,43 @@ $logger = new Zend_Log($writer);
 $logger->info('Informational message');
 ]]></programlisting>
 
-      The example above writes a single row of log data to the database table named
-      <code>log_table_name</code> table. The database column named <code>lvl</code>
-      receives the priority number and the column named <code>msg</code> receives the
-      log message.
-    </para>
+            The example above writes a single row of log data to the database table named
+            <code>log_table_name</code> table. The database column named <code>lvl</code>
+            receives the priority number and the column named <code>msg</code> receives the
+            log message.
+        </para>
+    </sect2>
 
-  </sect2>
+    <xi:include href="Zend_Log-Writers-Firebug.xml" />
+    <xi:include href="Zend_Log-Writers-Mail.xml" />
+    <xi:include href="Zend_Log-Writers-Syslog.xml" />
+    <xi:include href="Zend_Log-Writers-ZendMonitor.xml" />
 
-  <xi:include href="Zend_Log-Writers-Firebug.xml" />
-  <xi:include href="Zend_Log-Writers-Mail.xml" />
-  <xi:include href="Zend_Log-Writers-Syslog.xml" />
-  <xi:include href="Zend_Log-Writers-ZendMonitor.xml" />
+    <sect2 id="zend.log.writers.null">
+        <title>Stubbing Out the Writer</title>
 
-  <sect2 id="zend.log.writers.null">
-    <title>Stubbing Out the Writer</title>
-    <para>
-      The <classname>Zend_Log_Writer_Null</classname> is a stub that does not write log data to anything.
-      It is useful for disabling logging or stubbing out logging during tests:
+        <para>
+            The <classname>Zend_Log_Writer_Null</classname> is a stub that does not write log data
+            to anything. It is useful for disabling logging or stubbing out logging during tests:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $writer = new Zend_Log_Writer_Null;
 $logger = new Zend_Log($writer);
 
 // goes nowhere
 $logger->info('Informational message');
 ]]></programlisting>
-    </para>
-  </sect2>
+        </para>
+    </sect2>
 
-  <sect2 id="zend.log.writers.mock">
-    <title>Testing with the Mock</title>
-    <para>
-      The <classname>Zend_Log_Writer_Mock</classname> is a very simple writer that records
-      the raw data it receives in an array exposed as a public property.
+    <sect2 id="zend.log.writers.mock">
+        <title>Testing with the Mock</title>
+
+        <para>
+            The <classname>Zend_Log_Writer_Mock</classname> is a very simple writer that records
+            the raw data it receives in an array exposed as a public property.
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $mock = new Zend_Log_Writer_Mock;
 $logger = new Zend_Log($mock);
 
@@ -138,22 +144,22 @@ var_dump($mock->events[0]);
 //    [priorityName] => INFO
 // )
 ]]></programlisting>
-    </para>
+        </para>
 
-    <para>
-      To clear the events logged by the mock, simply set <code>$mock->events = array()</code>.
-    </para>
-  </sect2>
+        <para>
+            To clear the events logged by the mock, simply set <code>$mock->events = array()</code>.
+        </para>
+    </sect2>
 
-  <sect2 id="zend.log.writers.compositing">
-    <title>Compositing Writers</title>
+    <sect2 id="zend.log.writers.compositing">
+        <title>Compositing Writers</title>
 
-    <para>
-      There is no composite Writer object. However, a Log instance can write
-      to any number of Writers. To do this, use the <methodname>addWriter()</methodname>
-      method:
+        <para>
+            There is no composite Writer object. However, a Log instance can write
+            to any number of Writers. To do this, use the <methodname>addWriter()</methodname>
+            method:
 
-      <programlisting language="php"><![CDATA[
+            <programlisting language="php"><![CDATA[
 $writer1 = new Zend_Log_Writer_Stream('/path/to/first/logfile');
 $writer2 = new Zend_Log_Writer_Stream('/path/to/second/logfile');
 
@@ -164,6 +170,6 @@ $logger->addWriter($writer2);
 // goes to both writers
 $logger->info('Informational message');
 ]]></programlisting>
-    </para>
-  </sect2>
+        </para>
+    </sect2>
 </sect1>