Browse Source

[DOCUMENTATION] English:

- manual fixes (only line length)

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@17618 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 16 years ago
parent
commit
49435410a9

+ 22 - 13
documentation/manual/en/module_specs/Zend_Feed-ConsumingAtom.xml

@@ -7,10 +7,10 @@
         <classname>Zend_Feed_Atom</classname> is used in much the same way as
         <classname>Zend_Feed_Rss</classname>. It provides the same access to feed-level properties
         and iteration over entries in the feed. The main difference is in the structure of the Atom
-        protocol itself. Atom is a successor to <acronym>RSS</acronym>; it is more generalized protocol and it is
-        designed to deal more easily with feeds that provide their full content inside the feed,
-        splitting <acronym>RSS</acronym>' <code>description</code> tag into two elements, <code>summary</code> and
-        <code>content</code>, for that purpose.
+        protocol itself. Atom is a successor to <acronym>RSS</acronym>; it is more generalized
+        protocol and it is designed to deal more easily with feeds that provide their full content
+        inside the feed, splitting <acronym>RSS</acronym>' <code>description</code> tag into two
+        elements, <code>summary</code> and <code>content</code>, for that purpose.
     </para>
 
     <example id="zend.feed.consuming-atom.example.usage">
@@ -36,7 +36,10 @@ foreach ($feed as $entry) {
     <para>
         <itemizedlist>
             <listitem>
-                <para><code>title</code> - The feed's title, same as <acronym>RSS</acronym>'s channel title</para>
+                <para>
+                    <code>title</code> - The feed's title, same as <acronym>RSS</acronym>'s channel
+                    title
+                </para>
             </listitem>
             <listitem>
                 <para><code>id</code> - Every feed and entry in Atom has a unique identifier</para>
@@ -47,15 +50,16 @@ foreach ($feed as $entry) {
                     <code>type</code> attribute
                 </para>
                 <para>
-                    The equivalent to <acronym>RSS</acronym>'s channel link would be <code>type="text/html"</code>. If
-                    the link is to an alternate version of the same content that's in the feed, it
-                    would have a <code>rel="alternate"</code> attribute.
+                    The equivalent to <acronym>RSS</acronym>'s channel link would be
+                    <code>type="text/html"</code>. if the link is to an alternate version of the
+                    same content that's in the feed, it would have a <code>rel="alternate"</code>
+                    attribute.
                 </para>
             </listitem>
             <listitem>
                 <para>
-                    <code>subtitle</code> - The feed's description, equivalent to <acronym>RSS</acronym>' channel
-                    description
+                    <code>subtitle</code> - The feed's description, equivalent to
+                    <acronym>RSS</acronym>' channel description
                 </para>
                 <para><code>author->name()</code> - The feed author's name</para>
                 <para><code>author->email()</code> - The feed author's email address</para>
@@ -73,7 +77,10 @@ foreach ($feed as $entry) {
                 <para><code>id</code> - The entry's unique identifier</para>
             </listitem>
             <listitem>
-                <para><code>title</code> - The entry's title, same as <acronym>RSS</acronym> item titles</para>
+                <para>
+                    <code>title</code> - The entry's title, same as <acronym>RSS</acronym> item
+                    titles
+                </para>
             </listitem>
             <listitem>
                 <para>
@@ -97,12 +104,14 @@ foreach ($feed as $entry) {
             </listitem>
             <listitem>
                 <para>
-                    <code>published</code> - the date the entry was published, in <acronym>RFC</acronym> 3339 format
+                    <code>published</code> - the date the entry was published, in
+                    <acronym>RFC</acronym> 3339 format
                 </para>
             </listitem>
             <listitem>
                 <para>
-                    <code>updated</code> - the date the entry was last updated, in <acronym>RFC</acronym> 3339 format
+                    <code>updated</code> - the date the entry was last updated, in
+                    <acronym>RFC</acronym> 3339 format
                 </para>
             </listitem>
         </itemizedlist>

+ 3 - 2
documentation/manual/en/module_specs/Zend_Feed-ConsumingAtomSingle.xml

@@ -5,8 +5,9 @@
 
     <para>
         Single Atom <code>&lt;entry&gt;</code> elements are also valid by themselves. Usually the
-        <acronym>URL</acronym> for an entry is the feed's <acronym>URL</acronym> followed by <code>/&lt;entryId&gt;</code>, such as
-        <code>http://atom.example.com/feed/1</code>, using the example <acronym>URL</acronym> we used above.
+        <acronym>URL</acronym> for an entry is the feed's <acronym>URL</acronym> followed by
+        <code>/&lt;entryId&gt;</code>, such as <code>http://atom.example.com/feed/1</code>, using
+        the example <acronym>URL</acronym> we used above.
     </para>
 
     <para>

+ 29 - 21
documentation/manual/en/module_specs/Zend_Feed-ConsumingRss.xml

@@ -3,8 +3,8 @@
 <sect1 id="zend.feed.consuming-rss">
     <title>Consuming an RSS Feed</title>
     <para>
-        Reading an <acronym>RSS</acronym> feed is as simple as instantiating a <classname>Zend_Feed_Rss</classname>
-        object with the <acronym>URL</acronym> of the feed:
+        Reading an <acronym>RSS</acronym> feed is as simple as instantiating a
+        <classname>Zend_Feed_Rss</classname> object with the <acronym>URL</acronym> of the feed:
     </para>
     <programlisting language="php"><![CDATA[
 $channel = new Zend_Feed_Rss('http://rss.example.com/channelName');
@@ -15,35 +15,37 @@ $channel = new Zend_Feed_Rss('http://rss.example.com/channelName');
     </para>
 
     <para>
-        Once you have a feed object, you can access any of the standard <acronym>RSS</acronym> "channel" properties
-        directly on the object:
+        Once you have a feed object, you can access any of the standard <acronym>RSS</acronym>
+        "channel" properties directly on the object:
     </para>
     <programlisting language="php"><![CDATA[
 echo $channel->title();
 ]]></programlisting>
     <para>
         Note the function syntax. <classname>Zend_Feed</classname> uses a convention of treating
-        properties as <acronym>XML</acronym> object if they are requested with variable "getter" syntax
-        (<code>$obj->property</code>) and as strings if they are access with method syntax
+        properties as <acronym>XML</acronym> object if they are requested with variable "getter"
+        syntax (<code>$obj->property</code>) and as strings if they are access with method syntax
         (<code>$obj->property()</code>). This enables access to the full text of any individual node
         while still allowing full access to all children.
     </para>
 
     <para>
-        If channel properties have attributes, they are accessible using <acronym>PHP</acronym>'s array syntax:
+        If channel properties have attributes, they are accessible using <acronym>PHP</acronym>'s
+        array syntax:
     </para>
     <programlisting language="php"><![CDATA[
 echo $channel->category['domain'];
 ]]></programlisting>
     <para>
-        Since <acronym>XML</acronym> attributes cannot have children, method syntax is not necessary for accessing
-        attribute values.
+        Since <acronym>XML</acronym> attributes cannot have children, method syntax is not necessary
+        for accessing attribute values.
     </para>
 
     <para>
         Most commonly you'll want to loop through the feed and do something with its entries.
-        <classname>Zend_Feed_Abstract</classname> implements <acronym>PHP</acronym>'s <code>Iterator</code> interface,
-        so printing all titles of articles in a channel is just a matter of:
+        <classname>Zend_Feed_Abstract</classname> implements <acronym>PHP</acronym>'s
+        <code>Iterator</code> interface, so printing all titles of articles in a channel is just a
+        matter of:
     </para>
     <programlisting language="php"><![CDATA[
 foreach ($channel as $item) {
@@ -51,8 +53,9 @@ foreach ($channel as $item) {
 }
 ]]></programlisting>
     <para>
-        If you are not familiar with <acronym>RSS</acronym>, here are the standard elements you can expect to be
-        available in an <acronym>RSS</acronym> channel and in individual <acronym>RSS</acronym> items (entries).
+        If you are not familiar with <acronym>RSS</acronym>, here are the standard elements you can
+        expect to be available in an <acronym>RSS</acronym> channel and in individual
+        <acronym>RSS</acronym> items (entries).
     </para>
 
     <para>
@@ -66,7 +69,8 @@ foreach ($channel as $item) {
             </listitem>
             <listitem>
                 <para>
-                    <code>link</code> - The <acronym>URL</acronym> of the web site corresponding to the channel
+                    <code>link</code> - The <acronym>URL</acronym> of the web site corresponding to
+                    the channel
                 </para>
             </listitem>
             <listitem>
@@ -83,8 +87,8 @@ foreach ($channel as $item) {
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>pubDate</code> - The publication date of this set of content, in <acronym>RFC</acronym> 822
-                    date format
+                    <code>pubDate</code> - The publication date of this set of content, in
+                    <acronym>RFC</acronym> 822 date format
                 </para>
             </listitem>
             <listitem>
@@ -100,8 +104,8 @@ foreach ($channel as $item) {
     </para>
 
     <para>
-        <acronym>RSS</acronym> <code>&lt;item&gt;</code> elements do not have any strictly required elements. However,
-        either <code>title</code> or <code>description</code> must be present.
+        <acronym>RSS</acronym> <code>&lt;item&gt;</code> elements do not have any strictly required
+        elements. However, either <code>title</code> or <code>description</code> must be present.
     </para>
 
     <para>
@@ -128,11 +132,14 @@ foreach ($channel as $item) {
                 </para>
             </listitem>
             <listitem>
-                <para><code>comments</code> - <acronym>URL</acronym> of comments relating to this item</para>
+                <para>
+                    <code>comments</code> - <acronym>URL</acronym> of comments relating to this item
+                </para>
             </listitem>
             <listitem>
                 <para>
-                    <code>pubDate</code> - The date the item was published, in <acronym>RFC</acronym> 822 date format
+                    <code>pubDate</code> - The date the item was published, in
+                    <acronym>RFC</acronym> 822 date format
                 </para>
             </listitem>
         </itemizedlist>
@@ -153,7 +160,8 @@ if ($item->propname()) {
     </para>
 
     <para>
-        For further information, the official <acronym>RSS</acronym> 2.0 specification is available at: <ulink
+        For further information, the official <acronym>RSS</acronym> 2.0 specification is available
+        at: <ulink
             url="http://blogs.law.harvard.edu/tech/rss">http://blogs.law.harvard.edu/tech/rss</ulink>
     </para>
 </sect1>

+ 15 - 14
documentation/manual/en/module_specs/Zend_Feed-Introduction.xml

@@ -3,34 +3,35 @@
 <sect1 id="zend.feed.introduction">
     <title>Introduction</title>
     <para>
-        <classname>Zend_Feed</classname> provides functionality for consuming <acronym>RSS</acronym> and Atom feeds.
-        It provides a natural syntax for accessing elements of feeds, feed attributes, and entry
-        attributes. <classname>Zend_Feed</classname> also has extensive support for modifying feed
-        and entry structure with the same natural syntax, and turning the result back into <acronym>XML</acronym>. In
-        the future, this modification support could provide support for the Atom Publishing
-        Protocol.
+        <classname>Zend_Feed</classname> provides functionality for consuming <acronym>RSS</acronym>
+        and Atom feeds. It provides a natural syntax for accessing elements of feeds, feed
+        attributes, and entry attributes. <classname>Zend_Feed</classname> also has extensive
+        support for modifying feed and entry structure with the same natural syntax, and turning the
+        result back into <acronym>XML</acronym>. In the future, this modification support could
+        provide support for the Atom Publishing Protocol.
     </para>
 
     <para>
         Programmatically, <classname>Zend_Feed</classname> consists of a base
         <classname>Zend_Feed</classname> class, abstract <classname>Zend_Feed_Abstract</classname>
         and <classname>Zend_Feed_Entry_Abstract</classname> base classes for representing Feeds and
-        Entries, specific implementations of feeds and entries for <acronym>RSS</acronym> and Atom, and a
-        behind-the-scenes helper for making the natural syntax magic work.
+        Entries, specific implementations of feeds and entries for <acronym>RSS</acronym> and Atom,
+        and a behind-the-scenes helper for making the natural syntax magic work.
     </para>
 
     <para>
-        In the example below, we demonstrate a simple use case of retrieving an <acronym>RSS</acronym> feed and
-        saving relevant portions of the feed data to a simple <acronym>PHP</acronym> array, which could then be used
-        for printing the data, storing to a database, etc.
+        In the example below, we demonstrate a simple use case of retrieving an
+        <acronym>RSS</acronym> feed and saving relevant portions of the feed data to a simple
+        <acronym>PHP</acronym> array, which could then be used for printing the data, storing to a
+        database, etc.
     </para>
 
     <note>
         <title>Be aware</title>
         <para>
-            Many <acronym>RSS</acronym> feeds have different channel and item properties available. The <acronym>RSS</acronym>
-            specification provides for many optional properties, so be aware of this when writing
-            code to work with <acronym>RSS</acronym> data.
+            Many <acronym>RSS</acronym> feeds have different channel and item properties available.
+            The <acronym>RSS</acronym> specification provides for many optional properties, so be
+            aware of this when writing code to work with <acronym>RSS</acronym> data.
         </para>
     </note>
 

+ 3 - 2
documentation/manual/en/module_specs/Zend_Feed-ModifyingFeed.xml

@@ -21,8 +21,9 @@ $entry->author->email = 'my_email@example.com';
 echo $entry->saveXML();
 ]]></programlisting>
         <para>
-            This will output a full (includes <code>&lt;?xml ... &gt;</code> prologue) <acronym>XML</acronym>
-            representation of the new entry, including any necessary <acronym>XML</acronym> namespaces.
+            This will output a full (includes <code>&lt;?xml ... &gt;</code> prologue)
+            <acronym>XML</acronym> representation of the new entry, including any necessary
+            <acronym>XML</acronym> namespaces.
         </para>
         <para>
             Note that the above will work even if the existing entry does not already have an author

+ 17 - 8
documentation/manual/en/module_specs/Zend_Feed_Reader.xml

@@ -1085,7 +1085,9 @@ if(isset($links->atom)) {
                     <row>
                         <entry>Slash</entry>
 
-                        <entry>Implements support for the Slash <acronym>RSS</acronym> 1.0 module</entry>
+                        <entry>
+                            Implements support for the Slash <acronym>RSS</acronym> 1.0 module
+                        </entry>
                     </row>
 
                     <row>
@@ -1104,7 +1106,10 @@ if(isset($links->atom)) {
                     <row>
                         <entry>Podcast</entry>
 
-                        <entry>Implements support for the Podcast 1.0 <constant>DTD</constant> from Apple</entry>
+                        <entry>
+                            Implements support for the Podcast 1.0 <constant>DTD</constant> from
+                            Apple
+                        </entry>
                     </row>
                 </tbody>
             </tgroup>
@@ -1127,13 +1132,17 @@ if(isset($links->atom)) {
                 <tbody>
                     <row>
                         <entry>Syndication</entry>
-                        <entry>Implements Syndication 1.0 support for <acronym>RSS</acronym> feeds</entry>
+                        <entry>
+                            Implements Syndication 1.0 support for <acronym>RSS</acronym> feeds
+                        </entry>
                     </row>
                     <row>
                         <entry>CreativeCommons</entry>
-                        <entry>A <acronym>RSS</acronym> module that adds an element at the &lt;channel&gt;
-                        or &lt;item&gt; level that specifies which Creative Commons license
-                        applies.</entry>
+                        <entry>
+                            A <acronym>RSS</acronym> module that adds an element at the
+                            &lt;channel&gt; or &lt;item&gt; level that specifies which Creative
+                            Commons license applies.
+                        </entry>
                     </row>
                 </tbody>
             </tgroup>
@@ -1175,8 +1184,8 @@ $updatePeriod = $feed->current()->getUpdatePeriod();
 
         <para>
             As you can also notice, the new methods from Extensions are accessible from the main
-            <acronym>API</acronym> using <acronym>PHP</acronym>'s magic methods. As an alternative, you can also
-            directly access any Extension object for a similar result as seen below.
+            <acronym>API</acronym> using <acronym>PHP</acronym>'s magic methods. As an alternative,
+            you can also directly access any Extension object for a similar result as seen below.
         </para>
 
         <programlisting language="php"><![CDATA[

+ 21 - 19
documentation/manual/en/module_specs/Zend_File_Transfer-Filters.xml

@@ -158,18 +158,18 @@ $upload->addFilter('Rename', 'C:\picture\uploads', 'file2');
         </example>
 
         <para>
-            Generally you should simply use the <methodname>addFilters()</methodname> method, which can be
-            called multiple times.
+            Generally you should simply use the <methodname>addFilters()</methodname> method, which
+            can be called multiple times.
         </para>
 
         <example id="zend.file.transfer.filters.usage.examplemultiple">
             <title>Add multiple filters</title>
 
             <para>
-                Often it's simpler just to call <methodname>addFilter()</methodname> multiple times. One call
-                for each filter. This also increases the readability and makes your code more
-                maintainable. As all methods provide a fluent interface you can couple the calls as
-                shown below:
+                Often it's simpler just to call <methodname>addFilter()</methodname> multiple times.
+                One call for each filter. This also increases the readability and makes your code
+                more maintainable. As all methods provide a fluent interface you can couple the
+                calls as shown below:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -201,9 +201,9 @@ $upload->addFilter('Rename', 'C:\picture\newjpg', 'file1')
 
         <para>
             This filter makes use of <classname>Zend_Filter_Decrypt</classname>. It supports the
-            <code>Mcrypt</code> and <code>OpenSSL</code> extensions from <acronym>PHP</acronym>. Please read the
-            related section for details about how to set the options for decryption and which
-            options are supported.
+            <code>Mcrypt</code> and <code>OpenSSL</code> extensions from <acronym>PHP</acronym>.
+            Please read the related section for details about how to set the options for decryption
+            and which options are supported.
         </para>
 
         <para>
@@ -253,9 +253,9 @@ $upload->addFilter('Decrypt',
 
         <para>
             This filter makes use of <classname>Zend_Filter_Encrypt</classname>. It supports the
-            <code>Mcrypt</code> and <code>OpenSSL</code> extensions from <acronym>PHP</acronym>. Please read the
-            related section for details about how to set the options for encryption and which
-            options are supported.
+            <code>Mcrypt</code> and <code>OpenSSL</code> extensions from <acronym>PHP</acronym>.
+            Please read the related section for details about how to set the options for encryption
+            and which options are supported.
         </para>
 
         <para>
@@ -368,11 +368,11 @@ $upload->addFilter('LowerCase', 'ISO-8859-1');
         </itemizedlist>
 
         <para>
-            Additionally you can also use the method <methodname>setFile()</methodname> to set files, which
-            erases all previous set, <methodname>addFile()</methodname> to add a new file to existing ones, and
-            <methodname>getFile()</methodname> to get all actually set files. To simplify things, this filter
-            understands several notations and that methods and constructor understand the same
-            notations.
+            Additionally you can also use the method <methodname>setFile()</methodname> to set
+            files, which erases all previous set, <methodname>addFile()</methodname> to add a new
+            file to existing ones, and <methodname>getFile()</methodname> to get all actually set
+            files. To simplify things, this filter understands several notations and that methods
+            and constructor understand the same notations.
         </para>
 
         <example id="zend.file.transfer.filters.rename.example">
@@ -434,7 +434,8 @@ $upload->addFilter('Rename', 'C:\mypics\newgifs', 'uploadfile1');
                     </row>
                     <row>
                         <entry>
-                            <methodname>addFile(array('C:\uploads\file.ext', 'overwrite' => true)</methodname>)
+                            <methodname>addFile(array('C:\uploads\file.ext', 'overwrite' =>
+                                true)</methodname>)
                         </entry>
                         <entry>
                             Specifies a new location and filename for all files when the given
@@ -445,7 +446,8 @@ $upload->addFilter('Rename', 'C:\mypics\newgifs', 'uploadfile1');
                     </row>
                     <row>
                         <entry>
-                            <methodname>addFile(array('source' => 'C:\temp\uploads', 'target' => 'C:\uploads')</methodname>)
+                            <methodname>addFile(array('source' => 'C:\temp\uploads', 'target' =>
+                                'C:\uploads')</methodname>)
                         </entry>
                         <entry>
                             Specifies a new location for all files in the old location when the

+ 56 - 49
documentation/manual/en/module_specs/Zend_File_Transfer-Introduction.xml

@@ -8,16 +8,18 @@
         <classname>Zend_File_Transfer</classname> provides extensive support for file uploads and
         downloads. It comes with built-in validators for files plus functionality to change files
         with filters. Protocol adapters allow <classname>Zend_File_Transfer</classname> to expose
-        the same <acronym>API</acronym> for transport protocols like <acronym>HTTP</acronym>, FTP, WEBDAV and more.
+        the same <acronym>API</acronym> for transport protocols like <acronym>HTTP</acronym>, FTP,
+        WEBDAV and more.
     </para>
 
     <note>
         <title>Limitation</title>
         <para>
             The current implementation of <classname>Zend_File_Transfer</classname> is limited to
-            <acronym>HTTP</acronym> Post Uploads. Other adapters supporting downloads and other protocols will be added
-            in future releases. Unimplemented methods will throw an exception. For now, you should
-            use <classname>Zend_File_Transfer_Adapter_Http</classname> directly. As soon as
+            <acronym>HTTP</acronym> Post Uploads. Other adapters supporting downloads and other
+            protocols will be added in future releases. Unimplemented methods will throw an
+            exception. For now, you should use
+            <classname>Zend_File_Transfer_Adapter_Http</classname> directly. As soon as
             there are multiple adapters available you can use a common interface.
         </para>
     </note>
@@ -25,10 +27,11 @@
     <note>
         <title>Forms</title>
         <para>
-            When you are using <classname>Zend_Form</classname> you should use the <acronym>API</acronym>s provided by
-            <classname>Zend_Form</classname> and not <classname>Zend_File_Transfer</classname>
-            directly. The file transfer support in <classname>Zend_Form</classname> is implemented
-            with <classname>Zend_File_Transfer</classname>, so the information in this chapter may
+            When you are using <classname>Zend_Form</classname> you should use the
+            <acronym>API</acronym>s provided by <classname>Zend_Form</classname> and not
+            <classname>Zend_File_Transfer</classname> directly. The file transfer support in
+            <classname>Zend_Form</classname> is implemented with
+            <classname>Zend_File_Transfer</classname>, so the information in this chapter may
             be useful for advanced users of <classname>Zend_Form</classname>.
         </para>
     </note>
@@ -77,8 +80,8 @@ if (!$adapter->receive()) {
         <para>
             This code listing demonstrates the simplest usage of
             <classname>Zend_File_Transfer</classname>. A local destination is set with the
-            <code>setDestination</code> method, then the <methodname>receive()</methodname> method is called. If
-            there are any upload errors, an error will be returned.
+            <code>setDestination</code> method, then the <methodname>receive()</methodname> method
+            is called. if there are any upload errors, an error will be returned.
         </para>
 
     </example>
@@ -112,8 +115,9 @@ if (!$adapter->receive()) {
         <para>
             <classname>Zend_File_Transfer</classname> and its adapters support different options.
             You can set all options either by passing them to the constructor or by calling
-            <methodname>setOptions($options)</methodname>. <methodname>getOptions()</methodname> will return the options
-            that are currently set. The following is a list of all supported options.
+            <methodname>setOptions($options)</methodname>. <methodname>getOptions()</methodname>
+            will return the options that are currently set. The following is a list of all supported
+            options.
         </para>
 
         <itemizedlist>
@@ -143,9 +147,10 @@ if (!$adapter->receive()) {
                     <emphasis>isValid($files = null)</emphasis>: This method will check if the
                     given files are valid, based on the validators that are attached to the files.
                     If no files are specified, all files will be checked. You can call
-                    <methodname>isValid()</methodname> before calling <methodname>receive()</methodname>; in this case,
-                    <methodname>receive()</methodname> will not call <code>isValid</code> internally again when
-                    receiving the file.
+                    <methodname>isValid()</methodname> before calling
+                    <methodname>receive()</methodname>; in this case,
+                    <methodname>receive()</methodname> will not call <code>isValid</code> internally
+                    again when receiving the file.
                 </para>
             </listitem>
 
@@ -243,16 +248,16 @@ $upload->receive();
         </itemizedlist>
 
         <para>
-            <methodname>getFileName()</methodname> accepts the name of the element as first parameter. If no
-            name is given, all known filenames will be returned in an array. If the file is a
-            multifile, you will also get an array. If there is only a single file a string will be
-            returned.
+            <methodname>getFileName()</methodname> accepts the name of the element as first
+            parameter. If no name is given, all known filenames will be returned in an array. If the
+            file is a multifile, you will also get an array. If there is only a single file a string
+            will be returned.
         </para>
 
         <para>
             By default file names will be returned with the complete path. If you only need the file
-            name without path, you can set the second parameter, <varname>$path</varname>, which will
-            truncate the file path when set to false.
+            name without path, you can set the second parameter, <varname>$path</varname>, which
+            will truncate the file path when set to false.
         </para>
 
         <example id="zend.file.transfer.introduction.informations.example1">
@@ -280,9 +285,9 @@ $names = $upload->getFileName('foo');
         </note>
 
         <para>
-            <methodname>getFileSize()</methodname> returns per default the real filesize in SI notation which
-            means you will get <code>2kB</code> instead of <code>2048</code>. If you need only the
-            plain size set the <code>useByteString</code> option to false.
+            <methodname>getFileSize()</methodname> returns per default the real filesize in SI
+            notation which means you will get <code>2kB</code> instead of <code>2048</code>. If you
+            need only the plain size set the <code>useByteString</code> option to false.
         </para>
 
         <example id="zend.file.transfer.introduction.informations.example.getfilesize">
@@ -303,8 +308,8 @@ $size = $upload->getFileSize();
         </example>
 
         <para>
-            <methodname>getHash()</methodname> accepts the name of a hash algorithm as first parameter. For a
-            list of known algorithms refer to
+            <methodname>getHash()</methodname> accepts the name of a hash algorithm as first
+            parameter. For a list of known algorithms refer to
             <ulink url="http://php.net/hash_algos">PHP's hash_algos method</ulink>. If you don't
             specify an algorithm, the <code>crc32</code> algorithm will be used by default.
         </para>
@@ -333,8 +338,8 @@ $names = $upload->getHash('crc32', 'foo');
         </note>
 
         <para>
-            <methodname>getMimeType()</methodname> returns the mimetype of a file. If more than one file was
-            uploaded it returns an array, otherwise a string.
+            <methodname>getMimeType()</methodname> returns the mimetype of a file. If more than one
+            file was uploaded it returns an array, otherwise a string.
         </para>
 
         <example id="zend.file.transfer.introduction.informations.getmimetype">
@@ -367,15 +372,16 @@ $names = $upload->getMimeType('foo');
 
         <para>
             <classname>Zend_File_Transfer</classname> can give you the actual state of a fileupload
-            in progress. To use this feature you need either the <acronym>APC</acronym> extension which is
-            provided with most default <acronym>PHP</acronym> installations, or the <code>uploadprogress</code>
-            extension. Both extensions are detected and used automatically. To be able to get the
-            progress you need to meet some prerequisites.
+            in progress. To use this feature you need either the <acronym>APC</acronym> extension
+            which is provided with most default <acronym>PHP</acronym> installations, or the
+            <code>uploadprogress</code> extension. Both extensions are detected and used
+            automatically. To be able to get the progress you need to meet some prerequisites.
         </para>
 
         <para>
-            First, you need to have either <acronym>APC</acronym> or <code>uploadprogress</code> to be
-            enabled. Note that you can disable this feature of <acronym>APC</acronym> within your php.ini.
+            First, you need to have either <acronym>APC</acronym> or <code>uploadprogress</code> to
+            be enabled. Note that you can disable this feature of <acronym>APC</acronym> within your
+            php.ini.
         </para>
 
         <para>
@@ -401,10 +407,10 @@ $names = $upload->getMimeType('foo');
 
             <para>
                 To archive this, you have to add the wished
-                <emphasis>Zend_ProgressBar_Adapter</emphasis> to <methodname>getProgress()</methodname> when you
-                are calling it the first time. For details about the right adapter to use, look into
-                the chapter <link linkend="zend.progressbar.adapters">Zend_ProgressBar Standard
-                    Adapters</link>.
+                <emphasis>Zend_ProgressBar_Adapter</emphasis> to
+                <methodname>getProgress()</methodname> when you are calling it the first time. For
+                details about the right adapter to use, look into the chapter <link
+                    linkend="zend.progressbar.adapters">Zend_ProgressBar Standard Adapters</link>.
             </para>
 
             <example id="zend.file.transfer.introduction.uploadprogress.progressadapter.example1">
@@ -424,8 +430,8 @@ while (!$upload['done']) {
             </example>
 
             <para>
-                The complete handling is done by <methodname>getProgress()</methodname> for you in the
-                background.
+                The complete handling is done by <methodname>getProgress()</methodname> for you in
+                the background.
             </para>
 
         </sect3>
@@ -435,14 +441,14 @@ while (!$upload['done']) {
             <title>Using getProgress() manually</title>
 
             <para>
-                You can also work manually with <methodname>getProgress()</methodname> without the usage of
-                <classname>Zend_ProgressBar</classname>.
+                You can also work manually with <methodname>getProgress()</methodname> without the
+                usage of <classname>Zend_ProgressBar</classname>.
             </para>
 
             <para>
-                Call <methodname>getProgress()</methodname> without settings. It will return you an array with
-                several keys. They differ according to the used <acronym>PHP</acronym> extension. But the following
-                keys are given independently of the extension:
+                Call <methodname>getProgress()</methodname> without settings. It will return you an
+                array with several keys. They differ according to the used <acronym>PHP</acronym>
+                extension. But the following keys are given independently of the extension:
             </para>
 
             <itemizedlist>
@@ -495,16 +501,17 @@ while (!$upload['done']) {
                 <listitem>
                     <para>
                         <emphasis>progress</emphasis>: This optional key takes a instance of
-                        <classname>Zend_ProgressBar_Adapter</classname> or <classname>Zend_ProgressBar</classname> and allows to get the actual
-                        upload state within a progressbar.
+                        <classname>Zend_ProgressBar_Adapter</classname> or
+                        <classname>Zend_ProgressBar</classname> and allows to get the actual upload
+                        state within a progressbar.
                     </para>
                 </listitem>
 
                 <listitem>
                     <para>
                         <emphasis>session</emphasis>: This optional key takes the name of a session
-                        namespace which will be used within <classname>Zend_ProgressBar</classname>. When this key is not
-                        given it defaults to
+                        namespace which will be used within <classname>Zend_ProgressBar</classname>.
+                        When this key is not given it defaults to
                         <classname>Zend_File_Transfer_Adapter_Http_ProgressBar</classname>.
                     </para>
                 </listitem>

+ 41 - 36
documentation/manual/en/module_specs/Zend_File_Transfer-Migration.xml

@@ -5,9 +5,9 @@
     <title>Migrating from previous versions</title>
 
     <para>
-        The <acronym>API</acronym> of <classname>Zend_File_Transfer</classname> has changed from time to time.
-        If you started to use <classname>Zend_File_Transfer</classname> and it's subcomponents
-        in earlier versions follow the guidelines below to migrate your scripts to
+        The <acronym>API</acronym> of <classname>Zend_File_Transfer</classname> has changed from
+        time to time. If you started to use <classname>Zend_File_Transfer</classname> and it's
+        subcomponents in earlier versions follow the guidelines below to migrate your scripts to
         use the new <acronym>API</acronym>.
     </para>
 
@@ -39,15 +39,16 @@
 
                 <itemizedlist>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <classname>Zend_Filter_File_Rename($oldfile, $newfile,
+                        Old method <acronym>API</acronym>:
+                        <classname>Zend_Filter_File_Rename($oldfile, $newfile,
                             $overwrite)</classname>
                     </para></listitem>
 
                     <listitem><para>
-                        New method <acronym>API</acronym>: <methodname>Zend_Filter_File_Rename($options)</methodname>
-                        where $options accepts the following array keys:
-                        <emphasis>source</emphasis> equals to $oldfile,
-                        <emphasis>target</emphasis> equals to $newfile,
+                        New method <acronym>API</acronym>:
+                        <methodname>Zend_Filter_File_Rename($options)</methodname> where $options
+                        accepts the following array keys: <emphasis>source</emphasis> equals to
+                        $oldfile, <emphasis>target</emphasis> equals to $newfile,
                         <emphasis>overwrite</emphasis> equals to $overwrite
                     </para></listitem>
                 </itemizedlist>
@@ -76,13 +77,14 @@ $upload->addFilter('Rename',
 
                 <itemizedlist>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <methodname>Zend_Validate_File_Count($min, $max)</methodname>
+                        Old method <acronym>API</acronym>:
+                        <methodname>Zend_Validate_File_Count($min, $max)</methodname>
                     </para></listitem>
 
                     <listitem><para>
-                        New method <acronym>API</acronym>: <methodname>Zend_Validate_File_Count($options)</methodname>
-                        where $options accepts the following array keys:
-                        <emphasis>min</emphasis> equals to $min,
+                        New method <acronym>API</acronym>:
+                        <methodname>Zend_Validate_File_Count($options)</methodname> where $options
+                        accepts the following array keys: <emphasis>min</emphasis> equals to $min,
                         <emphasis>max</emphasis> equals to $max,
                     </para></listitem>
                 </itemizedlist>
@@ -111,14 +113,14 @@ $upload->addValidator('Count',
 
                 <itemizedlist>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <classname>Zend_Validate_File_Extension($extension,
-                            $case)</classname>
+                        Old method <acronym>API</acronym>:
+                        <classname>Zend_Validate_File_Extension($extension, $case)</classname>
                     </para></listitem>
 
                     <listitem><para>
                         New method <acronym>API</acronym>:
-                        <methodname>Zend_Validate_File_Extension($options)</methodname> where $options
-                        accepts the following array keys:
+                        <methodname>Zend_Validate_File_Extension($options)</methodname> where
+                        $options accepts the following array keys:
                         <emphasis>*</emphasis> equals to $extension and can have any other key,
                         <emphasis>case</emphasis> equals to $case,
                     </para></listitem>
@@ -148,14 +150,14 @@ $upload->addValidator('Extension',
 
                 <itemizedlist>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <classname>Zend_Validate_File_FilesSize($min, $max,
-                            $bytestring)</classname>
+                        Old method <acronym>API</acronym>:
+                        <classname>Zend_Validate_File_FilesSize($min, $max, $bytestring)</classname>
                     </para></listitem>
 
                     <listitem><para>
                         New method <acronym>API</acronym>:
-                        <methodname>Zend_Validate_File_FilesSize($options)</methodname> where $options
-                        accepts the following array keys:
+                        <methodname>Zend_Validate_File_FilesSize($options)</methodname> where
+                        $options accepts the following array keys:
                         <emphasis>min</emphasis> equals to $min,
                         <emphasis>max</emphasis> equals to $max,
                         <emphasis>bytestring</emphasis> equals to $bytestring
@@ -206,7 +208,8 @@ $upload->setUseByteSting(true); // set flag
                     </para></listitem>
 
                     <listitem><para>
-                        New method <acronym>API</acronym>: <methodname>Zend_Validate_File_Hash($options)</methodname>
+                        New method <acronym>API</acronym>:
+                        <methodname>Zend_Validate_File_Hash($options)</methodname>
                         where $options accepts the following array keys:
                         <emphasis>*</emphasis> equals to $hash and can have any other key,
                         <emphasis>algorithm</emphasis> equals to $algorithm,
@@ -237,15 +240,16 @@ $upload->addValidator('Hash',
 
                 <itemizedlist>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <classname>Zend_Validate_File_ImageSize($minwidth,
-                            $minheight, $maxwidth, $maxheight)</classname>
+                        Old method <acronym>API</acronym>:
+                        <classname>Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth,
+                            $maxheight)</classname>
                     </para></listitem>
 
                     <listitem><para>
                         New method <acronym>API</acronym>:
-                        <methodname>Zend_Validate_File_FilesSize($options)</methodname> where $options
-                        accepts the following array keys: <emphasis>minwidth</emphasis> equals to
-                        $minwidth, <emphasis>maxwidth</emphasis> equals to $maxwidth,
+                        <methodname>Zend_Validate_File_FilesSize($options)</methodname> where
+                        $options accepts the following array keys: <emphasis>minwidth</emphasis>
+                        equals to $minwidth, <emphasis>maxwidth</emphasis> equals to $maxwidth,
                         <emphasis>minheight</emphasis> equals to $minheight,
                         <emphasis>maxheight</emphasis> equals to $maxheight,
                     </para></listitem>
@@ -277,14 +281,14 @@ $upload->addValidator('ImageSize',
 
                 <itemizedlist>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <classname>Zend_Validate_File_Size($min, $max,
-                            $bytestring)</classname>
+                        Old method <acronym>API</acronym>: <classname>Zend_Validate_File_Size($min,
+                            $max, $bytestring)</classname>
                     </para></listitem>
 
                     <listitem><para>
-                        New method <acronym>API</acronym>: <methodname>Zend_Validate_File_Size($options)</methodname>
-                        where $options accepts the following array keys:
-                        <emphasis>min</emphasis> equals to $min,
+                        New method <acronym>API</acronym>:
+                        <methodname>Zend_Validate_File_Size($options)</methodname> where $options
+                        accepts the following array keys: <emphasis>min</emphasis> equals to $min,
                         <emphasis>max</emphasis> equals to $max,
                         <emphasis>bytestring</emphasis> equals to $bytestring
                     </para></listitem>
@@ -332,18 +336,19 @@ $upload->addValidator('Size',
 
             <itemizedlist>
                 <listitem><para>
-                    Old method <acronym>API</acronym>: <methodname>addValidator($validator, $options, $files)</methodname>.
+                    Old method <acronym>API</acronym>: <methodname>addValidator($validator,
+                        $options, $files)</methodname>.
                 </para></listitem>
 
                 <listitem><para>
-                    New method <acronym>API</acronym>: <code>addValidator($validator, $breakChainOnFailure, $options,
-                        $files)</code>.
+                    New method <acronym>API</acronym>: <code>addValidator($validator,
+                        $breakChainOnFailure, $options, $files)</code>.
                 </para></listitem>
             </itemizedlist>
 
             <para>
-                To migrate your scripts to the new <acronym>API</acronym>, simply add a <constant>FALSE</constant>
-                after defining the wished validator.
+                To migrate your scripts to the new <acronym>API</acronym>, simply add a
+                <constant>FALSE</constant> after defining the wished validator.
             </para>
 
             <example id="zend.file.transfer.migration.fromonesixonetoonesixtwo.example">

+ 85 - 75
documentation/manual/en/module_specs/Zend_File_Transfer-Validators.xml

@@ -39,9 +39,9 @@
 
         <listitem>
             <para>
-                <code>ExcludeMimeType</code>: This validator validates the <acronym>MIME</acronym> type of files. It
-                can also validate <acronym>MIME</acronym> types and will throw an error if the <acronym>MIME</acronym> type of specified
-                file matches.
+                <code>ExcludeMimeType</code>: This validator validates the <acronym>MIME</acronym>
+                type of files. It can also validate <acronym>MIME</acronym> types and will throw an
+                error if the <acronym>MIME</acronym> type of specified file matches.
             </para>
         </listitem>
 
@@ -108,9 +108,9 @@
 
         <listitem>
             <para>
-                <code>MimeType</code>: This validator validates the <acronym>MIME</acronym> type of files. It can also
-                validate <acronym>MIME</acronym> types and will throw an error if the <acronym>MIME</acronym> type of a specified
-                file does not match.
+                <code>MimeType</code>: This validator validates the <acronym>MIME</acronym> type of
+                files. It can also validate <acronym>MIME</acronym> types and will throw an error if
+                the <acronym>MIME</acronym> type of a specified file does not match.
             </para>
         </listitem>
 
@@ -436,8 +436,8 @@ $upload->addValidator('Count', false, array('min' =>1, 'max' => 5));
 
         <para>
             The <code>Crc32</code> validator checks the content of a transferred file by hashing it.
-            This validator uses the hash extension from <acronym>PHP</acronym> with the crc32 algorithm.
-            It supports the following options:
+            This validator uses the hash extension from <acronym>PHP</acronym> with the crc32
+            algorithm. It supports the following options:
         </para>
 
         <itemizedlist>
@@ -542,29 +542,30 @@ $upload->addValidator('ExcludeExtension',
         <title>ExcludeMimeType Validator</title>
 
         <para>
-            The <code>ExcludeMimeType</code> validator checks the <acronym>MIME</acronym> type of transferred files.
-            It supports the following options:
+            The <code>ExcludeMimeType</code> validator checks the <acronym>MIME</acronym> type of
+            transferred files. It supports the following options:
         </para>
 
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>*</code>: Sets any key individually or use a numeric array. Sets the <acronym>MIME</acronym>
-                    type to validate against.
+                    <code>*</code>: Sets any key individually or use a numeric array. Sets the
+                    <acronym>MIME</acronym> type to validate against.
                 </para>
 
                 <para>
-                    With this option you can define the <acronym>MIME</acronym> type of files that are not to be
-                    accepted.
+                    With this option you can define the <acronym>MIME</acronym> type of files that
+                    are not to be accepted.
                 </para>
             </listitem>
         </itemizedlist>
 
         <para>
-            This validator accepts multiple <acronym>MIME</acronym> types, either as a comma-delimited string, or as
-            an array. You may also use the methods <methodname>setMimeType()</methodname>,
-            <methodname>addMimeType()</methodname>, and <methodname>getMimeType()</methodname> to
-            set and retrieve the <acronym>MIME</acronym> types.
+            This validator accepts multiple <acronym>MIME</acronym> types, either as a
+            comma-delimited string, or as an array. You may also use the methods
+            <methodname>setMimeType()</methodname>, <methodname>addMimeType()</methodname>, and
+            <methodname>getMimeType()</methodname> to set and retrieve the <acronym>MIME</acronym>
+            types.
         </para>
 
         <example id="zend.file.transfer.validators.excludemimetype.example">
@@ -586,18 +587,19 @@ $upload->addValidator('ExcludeMimeType', false, 'image');
         </example>
 
         <para>
-            The above example shows that it is also possible to disallow groups of <acronym>MIME</acronym> types.
-            For example, to disallow all images, just use 'image' as the <acronym>MIME</acronym> type. This can be used
-            for all groups of <acronym>MIME</acronym> types like 'image', 'audio', 'video', 'text', etc.
+            The above example shows that it is also possible to disallow groups of
+            <acronym>MIME</acronym> types. For example, to disallow all images, just use 'image' as
+            the <acronym>MIME</acronym> type. This can be used for all groups of
+            <acronym>MIME</acronym> types like 'image', 'audio', 'video', 'text', etc.
         </para>
 
         <note>
             <para>
-                Note that disallowing groups of <acronym>MIME</acronym> types will disallow all members of this group
-                even if this is not intentional. When you disallow 'image' you will disallow all
-                types of images like 'image/jpeg' or 'image/vasa'. When you are not sure if you want
-                to disallow all types, you should disallow only specific <acronym>MIME</acronym> types instead of
-                complete groups.
+                Note that disallowing groups of <acronym>MIME</acronym> types will disallow all
+                members of this group even if this is not intentional. When you disallow 'image' you
+                will disallow all types of images like 'image/jpeg' or 'image/vasa'. When you are
+                not sure if you want to disallow all types, you should disallow only specific
+                <acronym>MIME</acronym> types instead of complete groups.
             </para>
         </note>
     </sect2>
@@ -840,16 +842,18 @@ $upload->addValidator('FilesSize',
         </itemizedlist>
 
         <para>
-            The methods <methodname>setImageMin()</methodname> and <methodname>setImageMax()</methodname> also set
-            both minimum and maximum values, while the methods <methodname>getMin()</methodname> and
-            <methodname>getMax()</methodname> return the currently set values.
+            The methods <methodname>setImageMin()</methodname> and
+            <methodname>setImageMax()</methodname> also set both minimum and maximum values, while
+            the methods <methodname>getMin()</methodname> and <methodname>getMax()</methodname>
+            return the currently set values.
         </para>
 
         <para>
             For your convenience there are also the <methodname>setImageWidth()</methodname> and
-            <methodname>setImageHeight()</methodname> methods, which set the minimum and maximum height and
-            width of the image file. They, too, have corresponding <methodname>getImageWidth()</methodname> and
-            <methodname>getImageHeight()</methodname> methods to retrieve the currently set values.
+            <methodname>setImageHeight()</methodname> methods, which set the minimum and maximum
+            height and width of the image file. They, too, have corresponding
+            <methodname>getImageWidth()</methodname> and <methodname>getImageHeight()</methodname>
+            methods to retrieve the currently set values.
         </para>
 
         <para>
@@ -907,10 +911,10 @@ $upload->addValidator('IsCompressed', false, 'zip');
 
         <note>
             <para>
-                Note that there is no check if you set a <acronym>MIME</acronym> type that is not a archive. For
-                example, it would be possible to define gif files to be accepted by this validator.
-                Using the 'MimeType' validator for files which are not archived will result in more
-                readable code.
+                Note that there is no check if you set a <acronym>MIME</acronym> type that is not a
+                archive. for example, it would be possible to define gif files to be accepted by
+                this validator. Using the 'MimeType' validator for files which are not archived will
+                result in more readable code.
             </para>
         </note>
     </sect2>
@@ -944,10 +948,10 @@ $upload->addValidator('IsImage', false, 'jpeg');
 
         <note>
             <para>
-                Note that there is no check if you set a <acronym>MIME</acronym> type that is not an image. For
-                example, it would be possible to define zip files to be accepted by this validator.
-                Using the 'MimeType' validator for files which are not images will result in more
-                readable code.
+                Note that there is no check if you set a <acronym>MIME</acronym> type that is not an
+                image. for example, it would be possible to define zip files to be accepted by this
+                validator. Using the 'MimeType' validator for files which are not images will result
+                in more readable code.
             </para>
         </note>
     </sect2>
@@ -957,7 +961,8 @@ $upload->addValidator('IsImage', false, 'jpeg');
 
         <para>
             The <code>Hash</code> validator checks the content of a transferred file by hashing it.
-            This validator uses the hash extension from <acronym>PHP</acronym>. It supports the following options:
+            This validator uses the hash extension from <acronym>PHP</acronym>. It supports the
+            following options:
         </para>
 
         <itemizedlist>
@@ -979,8 +984,8 @@ $upload->addValidator('IsImage', false, 'jpeg');
                 </para>
 
                 <para>
-                    You can set multiple algorithm by calling the <methodname>addHash()</methodname> method
-                    multiple times.
+                    You can set multiple algorithm by calling the <methodname>addHash()</methodname>
+                    method multiple times.
                 </para>
             </listitem>
         </itemizedlist>
@@ -1020,8 +1025,8 @@ $upload->addValidator('Hash',
 
         <para>
             The <code>Md5</code> validator checks the content of a transferred file by hashing it.
-            This validator uses the hash extension for <acronym>PHP</acronym> with the md5 algorithm.
-            It supports the following options:
+            This validator uses the hash extension for <acronym>PHP</acronym> with the md5
+            algorithm. It supports the following options:
         </para>
 
         <itemizedlist>
@@ -1059,15 +1064,15 @@ $upload->addValidator('Md5',
         <title>MimeType Validator</title>
 
         <para>
-            The <code>MimeType</code> validator checks the <acronym>MIME</acronym> type of transferred files.
-            It supports the following options:
+            The <code>MimeType</code> validator checks the <acronym>MIME</acronym> type of
+            transferred files. It supports the following options:
         </para>
 
         <itemizedlist>
             <listitem>
                 <para>
-                    <code>*</code>: Sets any key or use a numeric array. Sets the <acronym>MIME</acronym> type to
-                    validate against.
+                    <code>*</code>: Sets any key or use a numeric array. Sets the
+                    <acronym>MIME</acronym> type to validate against.
                 </para>
 
                 <para>
@@ -1089,17 +1094,18 @@ $upload->addValidator('Md5',
         </itemizedlist>
 
         <para>
-            This validator accepts multiple <acronym>MIME</acronym> type, either as a comma-delimited string, or as an
-            array. You may also use the methods <methodname>setMimeType()</methodname>,
-            <methodname>addMimeType()</methodname>, and <methodname>getMimeType()</methodname> to set and retrieve <acronym>MIME</acronym>
+            This validator accepts multiple <acronym>MIME</acronym> type, either as a
+            comma-delimited string, or as an array. You may also use the methods
+            <methodname>setMimeType()</methodname>, <methodname>addMimeType()</methodname>, and
+            <methodname>getMimeType()</methodname> to set and retrieve <acronym>MIME</acronym>
             type.
         </para>
 
         <para>
             You can also set the magicfile which shall be used by fileinfo with the 'magicfile'
             option. Additionally there are convenient <methodname>setMagicFile()</methodname> and
-            <methodname>getMagicFile()</methodname> methods which allow later setting and retrieving of the
-            magicfile parameter. This methods are available since Zend Framework 1.7.1.
+            <methodname>getMagicFile()</methodname> methods which allow later setting and retrieving
+            of the magicfile parameter. This methods are available since Zend Framework 1.7.1.
         </para>
 
         <example id="zend.file.transfer.validators.mimetype.example">
@@ -1126,18 +1132,19 @@ $upload->addValidator('MimeType',
         </example>
 
         <para>
-            The above example shows that it is also possible to limit the accepted <acronym>MIME</acronym> type to a
-            group of <acronym>MIME</acronym> types. To allow all images just use 'image' as <acronym>MIME</acronym> type. This can be used
-            for all groups of <acronym>MIME</acronym> types like 'image', 'audio', 'video', 'text, and so on.
+            The above example shows that it is also possible to limit the accepted
+            <acronym>MIME</acronym> type to a group of <acronym>MIME</acronym> types. To allow all
+            images just use 'image' as <acronym>MIME</acronym> type. This can be used for all groups
+            of <acronym>MIME</acronym> types like 'image', 'audio', 'video', 'text, and so on.
         </para>
 
         <note>
             <para>
-                Note that allowing groups of <acronym>MIME</acronym> types will accept all members of this group even
-                if your application does not support them. When you allow 'image' you will also get
-                'image/xpixmap' or 'image/vasa' which could be problematic. When you are not sure if
-                your application supports all types you should better allow only defined <acronym>MIME</acronym> types
-                instead of the complete group.
+                Note that allowing groups of <acronym>MIME</acronym> types will accept all members
+                of this group even if your application does not support them. When you allow 'image'
+                you will also get 'image/xpixmap' or 'image/vasa' which could be problematic. When
+                you are not sure if your application supports all types you should better allow only
+                defined <acronym>MIME</acronym> types instead of the complete group.
             </para>
         </note>
 
@@ -1145,13 +1152,15 @@ $upload->addValidator('MimeType',
             <para>
                 This component will use the <code>fileinfo</code> extension if it is available. If
                 it's not, it will degrade to the <code>mime_content_type</code> function. And if the
-                function call fails it will use the <acronym>MIME</acronym> type which is given by <acronym>HTTP</acronym>.
+                function call fails it will use the <acronym>MIME</acronym> type which is given by
+                <acronym>HTTP</acronym>.
             </para>
 
             <para>
                 You should be aware of possible security problems when you have whether
-                <code>fileinfo</code> nor <code>mime_content_type</code> available. The <acronym>MIME</acronym> type
-                given by <acronym>HTTP</acronym> is not secure and can be easily manipulated.
+                <code>fileinfo</code> nor <code>mime_content_type</code> available. The
+                <acronym>MIME</acronym> type given by <acronym>HTTP</acronym> is not secure and can
+                be easily manipulated.
             </para>
         </note>
     </sect2>
@@ -1176,8 +1185,8 @@ $upload->addValidator('MimeType',
         <para>
             This validator accepts multiple directories either as a comma-delimited string, or as an
             array. You may also use the methods <methodname>setDirectory()</methodname>,
-            <methodname>addDirectory()</methodname>, and <methodname>getDirectory()</methodname> to set and retrieve
-            directories.
+            <methodname>addDirectory()</methodname>, and <methodname>getDirectory()</methodname> to
+            set and retrieve directories.
         </para>
 
         <example id="zend.file.transfer.validators.notexists.example">
@@ -1211,8 +1220,8 @@ $upload->addValidator('NotExists', false,
 
         <para>
             The <code>Sha1</code> validator checks the content of a transferred file by hashing it.
-            This validator uses the hash extension for <acronym>PHP</acronym> with the sha1 algorithm.
-            It supports the following options:
+            This validator uses the hash extension for <acronym>PHP</acronym> with the sha1
+            algorithm. It supports the following options:
         </para>
 
         <itemizedlist>
@@ -1281,10 +1290,10 @@ $upload->addValidator('Sha1',
 
         <para>
             You can initialize this validator with a string, which will then be used to set the
-            <code>max</code> option. You can also use the methods <methodname>setMin()</methodname> and
-            <methodname>setMax()</methodname> to set both options after construction, along with
-            <methodname>getMin()</methodname> and <methodname>getMax()</methodname> to retrieve the values that have been
-            set previously.
+            <code>max</code> option. You can also use the methods <methodname>setMin()</methodname>
+            and <methodname>setMax()</methodname> to set both options after construction, along with
+            <methodname>getMin()</methodname> and <methodname>getMax()</methodname> to retrieve the
+            values that have been set previously.
         </para>
 
         <para>
@@ -1342,8 +1351,9 @@ $upload->addValidator('Size',
         <para>
             If you initiate this validator with a string or integer, the value will be used as
             <code>max</code>. Or you can also use the methods <methodname>setMin()</methodname> and
-            <methodname>setMax()</methodname> to set both options afterwards and <methodname>getMin()</methodname> and
-            <methodname>getMax()</methodname> to retrieve the actual set values.
+            <methodname>setMax()</methodname> to set both options afterwards and
+            <methodname>getMin()</methodname> and <methodname>getMax()</methodname> to retrieve the
+            actual set values.
         </para>
 
         <example id="zend.file.transfer.validators.wordcount.example">

+ 8 - 6
documentation/manual/en/module_specs/Zend_Filter-Set.xml

@@ -19,7 +19,8 @@
             <para>
                 The alphabetic characters mean characters that makes up words in each language.
                 However, the english alphabet is treated as the alphabetic characters in following
-                languages: Chinese, Japanese, Korean. The language is specified by <classname>Zend_Locale</classname>.
+                languages: Chinese, Japanese, Korean. The language is specified by
+                <classname>Zend_Locale</classname>.
             </para>
         </note>
 
@@ -114,11 +115,12 @@
     <sect2 id="zend.filter.set.striptags">
         <title>StripTags</title>
         <para>
-            This filter returns the input string, with all HTML and <acronym>PHP</acronym> tags stripped from it,
-            except those that have been explicitly allowed. In addition to the ability to specify
-            which tags are allowed, developers can specify which attributes are allowed across all
-            allowed tags and for specific tags only. Finally, this filter offers control over
-            whether comments (e.g., <code>&lt;!-- ... --&gt;</code>) are removed or allowed.
+            This filter returns the input string, with all HTML and <acronym>PHP</acronym> tags
+            stripped from it, except those that have been explicitly allowed. In addition to the
+            ability to specify which tags are allowed, developers can specify which attributes are
+            allowed across all allowed tags and for specific tags only. Finally, this filter offers
+            control over whether comments (e.g., <code>&lt;!-- ... --&gt;</code>) are removed or
+            allowed.
         </para>
     </sect2>
 

+ 3 - 3
documentation/manual/en/module_specs/Zend_Filter-WritingFilters.xml

@@ -5,9 +5,9 @@
     <title>Writing Filters</title>
 
     <para>
-        <classname>Zend_Filter</classname> supplies a set of commonly needed filters, but developers will often need to
-        write custom filters for their particular use cases. The task of writing a custom filter is
-        facilitated by implementing <classname>Zend_Filter_Interface</classname>.
+        <classname>Zend_Filter</classname> supplies a set of commonly needed filters, but developers
+        will often need to write custom filters for their particular use cases. The task of writing
+        a custom filter is facilitated by implementing <classname>Zend_Filter_Interface</classname>.
     </para>
 
     <para>

+ 4 - 3
documentation/manual/en/module_specs/Zend_Filter.xml

@@ -41,7 +41,8 @@
             (e.g., "<code>&amp;</code>" is transformed to
             "<code>&amp;amp;</code>"). Supporting such use cases for web
             developers is important, and "to filter," in the context of using
-            <classname>Zend_Filter</classname>, means to perform some transformations upon input data.
+            <classname>Zend_Filter</classname>, means to perform some transformations upon input
+            data.
         </para>
 
     </sect2>
@@ -114,8 +115,8 @@ echo Zend_Filter::filterStatic('"', 'HtmlEntities', array(ENT_QUOTES));
         </para>
 
         <para>
-            Also, the <classname>Zend_Filter_Input</classname> class allows you to instantiate and run
-            multiple filter and validator classes on demand to process
+            Also, the <classname>Zend_Filter_Input</classname> class allows you to instantiate and
+            run multiple filter and validator classes on demand to process
             sets of input data. See <xref linkend="zend.filter.input" />.
         </para>
 

+ 24 - 22
documentation/manual/en/module_specs/Zend_Filter_Input.xml

@@ -211,8 +211,8 @@ $filters = array(
 
         <para>
             After declaring the filters and validators arrays, use them as
-            arguments in the constructor of <classname>Zend_Filter_Input</classname>. This returns an
-            object that knows all your filtering and validating rules, and you
+            arguments in the constructor of <classname>Zend_Filter_Input</classname>. This returns
+            an object that knows all your filtering and validating rules, and you
             can use this object to process one or more sets of input data.
         </para>
 
@@ -224,8 +224,8 @@ $input = new Zend_Filter_Input($filters, $validators);
             You can specify input data as the third constructor argument. The
             data structure is an associative array. The keys are field names,
             and the values are data values. The standard <varname>$_GET</varname>
-            and <varname>$_POST</varname> superglobal variables in <acronym>PHP</acronym> are examples
-            of this format. You can use either of these variables as input
+            and <varname>$_POST</varname> superglobal variables in <acronym>PHP</acronym> are
+            examples of this format. You can use either of these variables as input
             data for <classname>Zend_Filter_Input</classname>.
         </para>
 
@@ -484,8 +484,8 @@ $input->setDefaultEscapeFilter(new Zend_Filter_StringTrim());
                 (although this filter can be a filter chain). If you need a
                 single instance of <classname>Zend_Filter_Input</classname> to return escaped output
                 using more than one filtering method, you should extend
-                <classname>Zend_Filter_Input</classname> and implement new methods in your subclass to
-                get values in different ways.
+                <classname>Zend_Filter_Input</classname> and implement new methods in your subclass
+                to get values in different ways.
             </para>
 
         </sect3>
@@ -711,8 +711,8 @@ $validators = array(
                 In the uncommon case that you declare a validation rule with
                 no validators, but the 'allowEmpty' metacommand is
                 <constant>FALSE</constant> (that is, the field is considered invalid if
-                it is empty), <classname>Zend_Filter_Input</classname> returns a default error message
-                that you can retrieve with <methodname>getMessages()</methodname>. You can
+                it is empty), <classname>Zend_Filter_Input</classname> returns a default error
+                message that you can retrieve with <methodname>getMessages()</methodname>. You can
                 specify this message using the 'notEmptyMessage' option, as an
                 argument to the <classname>Zend_Filter_Input</classname> constructor or using the
                 <methodname>setOptions()</methodname> method.
@@ -775,10 +775,10 @@ $input = new Zend_Filter_Input(null, $validators);
             </para>
 
             <para>
-                The validator chain class, <classname>Zend_Validate</classname>, is more flexible with
-                respect to breaking chain execution than <classname>Zend_Filter_Input</classname>.
-                With the former class, you can set the option to break the
-                chain on failure independently for each validator in the chain.
+                The validator chain class, <classname>Zend_Validate</classname>, is more flexible
+                with respect to breaking chain execution than
+                <classname>Zend_Filter_Input</classname>. With the former class, you can set the
+                option to break the chain on failure independently for each validator in the chain.
                 With the latter class, the defined value of the
                 'breakChainOnFailure' metacommand for a rule applies uniformly
                 for all validators in the rule. If you require the more
@@ -969,16 +969,17 @@ $input = new Zend_Filter_Input($filters, $validators, $data, $options);
         <para>
             By default, when you declare a filter or validator as a string,
             <classname>Zend_Filter_Input</classname> searches for the corresponding classes under
-            the <classname>Zend_Filter</classname> or <classname>Zend_Validate</classname> namespaces. For example,
-            a filter named by the string 'digits' is found in the class
+            the <classname>Zend_Filter</classname> or <classname>Zend_Validate</classname>
+            namespaces. For example, a filter named by the string 'digits' is found in the class
             <classname>Zend_Filter_Digits</classname>.
         </para>
 
         <para>
             If you write your own filter or validator classes, or use filters
             or validators provided by a third-party, the classes may exist in
-            different namespaces than <classname>Zend_Filter</classname> or <classname>Zend_Validate</classname>. You can
-            tell <classname>Zend_Filter_Input</classname> to search more namespaces. You can specify
+            different namespaces than <classname>Zend_Filter</classname> or
+            <classname>Zend_Validate</classname>. You can tell
+            <classname>Zend_Filter_Input</classname> to search more namespaces. You can specify
             namespaces in the constructor options:
         </para>
 
@@ -991,7 +992,8 @@ $input = new Zend_Filter_Input($filters, $validators, $data, $options);
         <para>
             Alternatively, you can use the <methodname>addValidatorPrefixPath($prefix,
                 $path)</methodname> or <methodname>addFilterPrefixPath($prefix, $path)</methodname>
-            methods, which directly proxy to the plugin loader that is used by <classname>Zend_Filter_Input</classname>:
+            methods, which directly proxy to the plugin loader that is used by
+            <classname>Zend_Filter_Input</classname>:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -1010,9 +1012,9 @@ $input->addFilterPrefixPath('Foo_Namespace', 'Foo/Namespace');
 ]]></programlisting>
 
         <para>
-            You cannot remove <classname>Zend_Filter</classname> and <classname>Zend_Validate</classname> as namespaces, you
-            only can add namespaces. User-defined namespaces are searched
-            first, Zend namespaces are searched last.
+            You cannot remove <classname>Zend_Filter</classname> and
+            <classname>Zend_Validate</classname> as namespaces, you only can add namespaces.
+            User-defined namespaces are searched first, Zend namespaces are searched last.
         </para>
 
         <note>
@@ -1033,8 +1035,8 @@ $input->addFilterPrefixPath('Foo_Namespace', 'Foo/Namespace');
                 As of version 1.0.4, <constant>Zend_Filter_Input::NAMESPACE</constant>, having
                 value <code>namespace</code>, was changed to
                 <constant>Zend_Filter_Input::INPUT_NAMESPACE</constant>, having value
-                <code>inputNamespace</code>, in order to comply with the <acronym>PHP</acronym> 5.3 reservation of the
-                keyword <code>namespace</code>.
+                <code>inputNamespace</code>, in order to comply with the <acronym>PHP</acronym> 5.3
+                reservation of the keyword <code>namespace</code>.
             </para>
         </note>
 

+ 2 - 2
documentation/manual/en/module_specs/Zend_Form-Elements.xml

@@ -422,8 +422,8 @@ $validator = new Zend_Validate_StringLength(6, 20);
             <para>
                 Some developers may wish to provide custom error messages for a
                 validator. The <varname>$options</varname> argument of the
-                <methodname>Zend_Form_Element::addValidator()</methodname> method allows you to do so
-                by providing the key 'messages' and mapping it to an array of key/value pairs
+                <methodname>Zend_Form_Element::addValidator()</methodname> method allows you to do
+                so by providing the key 'messages' and mapping it to an array of key/value pairs
                 for setting the message templates. You will need to know the
                 error codes of the various validation error types for the
                 particular validator.

+ 4 - 4
documentation/manual/en/module_specs/Zend_Form-Forms.xml

@@ -1405,8 +1405,8 @@ if (!$form->isValidPartial($data)) {
         <para>
             When validating elements or groups of elements for an <acronym>AJAX</acronym> request,
             you will typically be validating a subset of the form, and want the
-            response back in <acronym>JSON</acronym>. <methodname>processAjax()</methodname> does precisely
-            that:
+            response back in <acronym>JSON</acronym>. <methodname>processAjax()</methodname> does
+            precisely that:
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -1952,8 +1952,8 @@ decorators.form.decorator = "Form"
 ]]></programlisting>
 
         <para>
-            The above could easily be abstracted to an <acronym>XML</acronym> or <acronym>PHP</acronym> array-based
-            configuration file.
+            The above could easily be abstracted to an <acronym>XML</acronym> or
+            <acronym>PHP</acronym> array-based configuration file.
         </para>
     </sect2>
 

+ 50 - 31
documentation/manual/en/module_specs/Zend_Form-StandardElements.xml

@@ -142,11 +142,10 @@ $element = new Zend_Form_Element_Captcha('foo', array(
 
         <para>
             By default, the checked value is '1', and the unchecked value '0'.
-            You can specify the values to use using the
-            <methodname>setCheckedValue()</methodname> and <methodname>setUncheckedValue()</methodname>
-            accessors, respectively. Internally, any time you set the value, if
-            the provided value matches the checked value, then it is set, but
-            any other value causes the unchecked value to be set.
+            You can specify the values to use using the <methodname>setCheckedValue()</methodname>
+            and <methodname>setUncheckedValue()</methodname> accessors, respectively. Internally,
+            any time you set the value, if the provided value matches the checked value, then it is
+            set, but any other value causes the unchecked value to be set.
         </para>
 
         <para>
@@ -217,8 +216,9 @@ $form->setAttrib('enctype', 'multipart/form-data');
 
             <para>
                 After the form is validated successfully, you must receive the file
-                to store it in the final destination using <methodname>receive()</methodname>. Additionally you
-                can determinate the final location using <methodname>getFileName()</methodname>:
+                to store it in the final destination using <methodname>receive()</methodname>.
+                Additionally you can determinate the final location using
+                <methodname>getFileName()</methodname>:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -247,17 +247,18 @@ $location = $form->foo->getFileName();
             <title>File values</title>
 
             <para>
-                Within <acronym>HTTP</acronym> a file element has no value. For this reason and because of
-                security concerns <methodname>getValue()</methodname> returns only the uploaded filename
-                and not the complete path. If you need the file path, call
-                <methodname>getFileName()</methodname>, which returns both the path and the name of the file.
+                Within <acronym>HTTP</acronym> a file element has no value. For this reason and
+                because of security concerns <methodname>getValue()</methodname> returns only the
+                uploaded filename and not the complete path. If you need the file path, call
+                <methodname>getFileName()</methodname>, which returns both the path and the name of
+                the file.
             </para>
         </note>
 
         <para>
             Per default the file will automatically be received when you call
-            <methodname>getValues()</methodname> on the form. The reason behind this behaviour is, that the
-            file itself is the value of the file element.
+            <methodname>getValues()</methodname> on the form. The reason behind this behaviour is,
+            that the file itself is the value of the file element.
         </para>
 
         <programlisting language="php"><![CDATA[
@@ -267,16 +268,17 @@ $form->getValues();
         <note>
             <para>
                 Therefor another call of <methodname>receive()</methodname> after calling
-                <methodname>getValues()</methodname> will not have an effect. Also creating a instance of
-                <classname>Zend_File_Transfer</classname> will not have an effect as there no file
-                anymore to receive.
+                <methodname>getValues()</methodname> will not have an effect. Also creating a
+                instance of <classname>Zend_File_Transfer</classname> will not have an effect as
+                there no file anymore to receive.
             </para>
         </note>
 
         <para>
-            Still, sometimes you may want to call <methodname>getValues()</methodname> without receiving the
-            file. You can archive this by calling <methodname>setValueDisabled(true)</methodname>. To get the
-            actual value of this flag you can call <methodname>isValueDisabled()</methodname>.
+            Still, sometimes you may want to call <methodname>getValues()</methodname> without
+            receiving the file. You can archive this by calling
+            <methodname>setValueDisabled(true)</methodname>. To get the actual value of this flag
+            you can call <methodname>isValueDisabled()</methodname>.
         </para>
 
         <example id="zend.form.standardElements.file.retrievement">
@@ -294,8 +296,9 @@ $element->setLabel('Upload an image:')
 ]]></programlisting>
 
             <para>
-                Now the file will not be received when you call <methodname>getValues()</methodname>.
-                So you must call <methodname>receive()</methodname> on the file element, or an instance of
+                Now the file will not be received when you call
+                <methodname>getValues()</methodname>. So you must call
+                <methodname>receive()</methodname> on the file element, or an instance of
                 <classname>Zend_File_Transfer</classname> yourself.
             </para>
 
@@ -367,8 +370,8 @@ if ($form->foo->isUploaded()) {
             <title>Setting multiple files</title>
 
             <para>
-                Creating a multifile element is the same as setting a single
-                element. Just call <methodname>setMultiFile()</methodname> after the element is created:
+                Creating a multifile element is the same as setting a single element.
+                Just call <methodname>setMultiFile()</methodname> after the element is created:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -559,9 +562,13 @@ $form->addElement('hash', 'no_csrf_foo', array('salt' => 'unique'));
         </para>
 
         <itemizedlist>
-            <listitem><para><methodname>addMultiOption($option, $value)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOption($option, $value)</methodname></para>
+            </listitem>
 
-            <listitem><para><methodname>addMultiOptions(array $options)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOptions(array $options)</methodname></para>
+            </listitem>
 
             <listitem><para><methodname>setMultiOptions(array $options)</methodname>
                     (overwrites existing options)</para></listitem>
@@ -615,9 +622,13 @@ $element->setValue(array('bar', 'bat'));
         </para>
 
         <itemizedlist>
-            <listitem><para><methodname>addMultiOption($option, $value)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOption($option, $value)</methodname></para>
+            </listitem>
 
-            <listitem><para><methodname>addMultiOptions(array $options)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOptions(array $options)</methodname></para>
+            </listitem>
 
             <listitem><para><methodname>setMultiOptions(array $options)</methodname>
                     (overwrites existing options)</para></listitem>
@@ -691,9 +702,13 @@ $element->setValue(array('bar', 'bat'));
         </para>
 
         <itemizedlist>
-            <listitem><para><methodname>addMultiOption($option, $value)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOption($option, $value)</methodname></para>
+            </listitem>
 
-            <listitem><para><methodname>addMultiOptions(array $options)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOptions(array $options)</methodname></para>
+            </listitem>
 
             <listitem><para><methodname>setMultiOptions(array $options)</methodname>
                     (overwrites existing options)</para></listitem>
@@ -751,9 +766,13 @@ $element->setValue(array('bar', 'bat'));
         </para>
 
         <itemizedlist>
-            <listitem><para><methodname>addMultiOption($option, $value)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOption($option, $value)</methodname></para>
+            </listitem>
 
-            <listitem><para><methodname>addMultiOptions(array $options)</methodname></para></listitem>
+            <listitem>
+                <para><methodname>addMultiOptions(array $options)</methodname></para>
+            </listitem>
 
             <listitem><para><methodname>setMultiOptions(array $options)</methodname>
                     (overwrites existing options)</para></listitem>