Browse Source

[MANUAL] English:

- manual fixes

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

+ 23 - 22
documentation/manual/en/ref/migration-17.xml

@@ -66,13 +66,13 @@
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
                         Old method <acronym>API</acronym>:
                         Old method <acronym>API</acronym>:
-                        <command>Zend_Filter_File_Rename($oldfile, $newfile,
-                        $overwrite)</command>
+                        <methodname>Zend_Filter_File_Rename($oldfile, $newfile,
+                            $overwrite)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Filter_File_Rename($options)</command>
+                        <methodname>Zend_Filter_File_Rename($options)</methodname>
                         where <varname>$options</varname> accepts the following array keys:
                         where <varname>$options</varname> accepts the following array keys:
                         <emphasis>source</emphasis> equals to <varname>$oldfile</varname>,
                         <emphasis>source</emphasis> equals to <varname>$oldfile</varname>,
                         <emphasis>target</emphasis> equals to <varname>$newfile</varname>,
                         <emphasis>target</emphasis> equals to <varname>$newfile</varname>,
@@ -105,12 +105,12 @@ $upload->addFilter('Rename',
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
                         Old method <acronym>API</acronym>:
                         Old method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_Count($min, $max)</command>
+                        <methodname>Zend_Validate_File_Count($min, $max)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_Count($options)</command>
+                        <methodname>Zend_Validate_File_Count($options)</methodname>
                         where <varname>$options</varname> accepts the following array keys:
                         where <varname>$options</varname> accepts the following array keys:
                         <emphasis>min</emphasis> equals to <varname>$min</varname>,
                         <emphasis>min</emphasis> equals to <varname>$min</varname>,
                         <emphasis>max</emphasis> equals to <varname>$max</varname>.
                         <emphasis>max</emphasis> equals to <varname>$max</varname>.
@@ -142,12 +142,12 @@ $upload->addValidator('Count',
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
                         Old method <acronym>API</acronym>:
                         Old method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_Extension($extension, $case)</command>
+                        <methodname>Zend_Validate_File_Extension($extension, $case)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_Extension($options)</command> where
+                        <methodname>Zend_Validate_File_Extension($options)</methodname> where
                         <varname>$options</varname> accepts the following array keys:
                         <varname>$options</varname> accepts the following array keys:
                         <emphasis>*</emphasis> equals to <varname>$extension</varname> and can have
                         <emphasis>*</emphasis> equals to <varname>$extension</varname> and can have
                         any other key, <emphasis>case</emphasis> equals to <varname>$case</varname>.
                         any other key, <emphasis>case</emphasis> equals to <varname>$case</varname>.
@@ -179,12 +179,13 @@ $upload->addValidator('Extension',
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
                         Old method <acronym>API</acronym>:
                         Old method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_FilesSize($min, $max, $bytestring)</command>
+                        <methodname>Zend_Validate_File_FilesSize($min, $max,
+                            $bytestring)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_FilesSize($options)</command> where
+                        <methodname>Zend_Validate_File_FilesSize($options)</methodname> where
                         <varname>$options</varname> accepts the following array keys:
                         <varname>$options</varname> accepts the following array keys:
                         <emphasis>min</emphasis> equals to <varname>$min</varname>,
                         <emphasis>min</emphasis> equals to <varname>$min</varname>,
                         <emphasis>max</emphasis> equals to <varname>$max</varname>,
                         <emphasis>max</emphasis> equals to <varname>$max</varname>,
@@ -231,13 +232,13 @@ $upload->setUseByteSting(true); // set flag
 
 
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <command>Zend_Validate_File_Hash($hash,
-                            $algorithm)</command>
+                        Old method <acronym>API</acronym>:
+                        <methodname>Zend_Validate_File_Hash($hash, $algorithm)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_Hash($options)</command>
+                        <methodname>Zend_Validate_File_Hash($options)</methodname>
                         where <varname>$options</varname> accepts the following array keys:
                         where <varname>$options</varname> accepts the following array keys:
                         <emphasis>*</emphasis> equals to <varname>$hash</varname> and can have any
                         <emphasis>*</emphasis> equals to <varname>$hash</varname> and can have any
                         other key, <emphasis>algorithm</emphasis> equals to
                         other key, <emphasis>algorithm</emphasis> equals to
@@ -270,13 +271,13 @@ $upload->addValidator('Hash',
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
                         Old method <acronym>API</acronym>:
                         Old method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth,
-                            $maxheight)</command>
+                        <methodname>Zend_Validate_File_ImageSize($minwidth, $minheight, $maxwidth,
+                            $maxheight)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_FilesSize($options)</command> where
+                        <methodname>Zend_Validate_File_FilesSize($options)</methodname> where
                         <varname>$options</varname> accepts the following array keys:
                         <varname>$options</varname> accepts the following array keys:
                         <emphasis>minwidth</emphasis> equals to <varname>$minwidth</varname>,
                         <emphasis>minwidth</emphasis> equals to <varname>$minwidth</varname>,
                         <emphasis>maxwidth</emphasis> equals to <varname>$maxwidth</varname>,
                         <emphasis>maxwidth</emphasis> equals to <varname>$maxwidth</varname>,
@@ -311,13 +312,13 @@ $upload->addValidator('ImageSize',
 
 
                 <itemizedlist>
                 <itemizedlist>
                     <listitem><para>
                     <listitem><para>
-                        Old method <acronym>API</acronym>: <command>Zend_Validate_File_Size($min,
-                            $max, $bytestring)</command>
+                        Old method <acronym>API</acronym>: <methodname>Zend_Validate_File_Size($min,
+                            $max, $bytestring)</methodname>
                     </para></listitem>
                     </para></listitem>
 
 
                     <listitem><para>
                     <listitem><para>
                         New method <acronym>API</acronym>:
                         New method <acronym>API</acronym>:
-                        <command>Zend_Validate_File_Size($options)</command>
+                        <methodname>Zend_Validate_File_Size($options)</methodname>
                         where <varname>$options</varname> accepts the following array keys:
                         where <varname>$options</varname> accepts the following array keys:
                         <emphasis>min</emphasis> equals to <varname>$min</varname>,
                         <emphasis>min</emphasis> equals to <varname>$min</varname>,
                         <emphasis>max</emphasis> equals to <varname>$max</varname>,
                         <emphasis>max</emphasis> equals to <varname>$max</varname>,
@@ -360,7 +361,7 @@ $upload->addValidator('Size',
                 old behaviour of a returned string, but it triggers a user warning to
                 old behaviour of a returned string, but it triggers a user warning to
                 mention you to change to the new behaviour. The rerouting which the old
                 mention you to change to the new behaviour. The rerouting which the old
                 behaviour of <methodname>isLocale()</methodname> could have done is no longer
                 behaviour of <methodname>isLocale()</methodname> could have done is no longer
-                neccessary as all I18N will now process a rerouting themself.
+                neccessary as all I18n will now process a rerouting themself.
             </para>
             </para>
 
 
             <para>
             <para>
@@ -531,18 +532,18 @@ $language = new Zend_Translate('gettext',
 
 
         <note>
         <note>
             <para>
             <para>
-                The API changes within <classname>Zend_View</classname> are only
+                The <acronym>API</acronym> changes within <classname>Zend_View</classname> are only
                 notable for you when you are upgrading to release 1.7.5 or higher.
                 notable for you when you are upgrading to release 1.7.5 or higher.
             </para>
             </para>
         </note>
         </note>
 
 
         <para>
         <para>
             Prior to the 1.7.5 release, the Zend Framework team was notified of
             Prior to the 1.7.5 release, the Zend Framework team was notified of
-            a potential Local File Inclusion (LFI) vulnerability in the
+            a potential Local File Inclusion (<acronym>LFI</acronym>) vulnerability in the
             <methodname>Zend_View::render()</methodname> method. Prior to 1.7.5, the method
             <methodname>Zend_View::render()</methodname> method. Prior to 1.7.5, the method
             allowed, by default, the ability to specify view scripts that
             allowed, by default, the ability to specify view scripts that
             included parent directory notation (e.g., "../" or "..\"). This
             included parent directory notation (e.g., "../" or "..\"). This
-            opens the possibility for an LFI attack if unfiltered user input is
+            opens the possibility for an <acronym>LFI</acronym> attack if unfiltered user input is
             passed to the <methodname>render()</methodname> method:
             passed to the <methodname>render()</methodname> method:
         </para>
         </para>
 
 

+ 56 - 23
documentation/manual/en/ref/migration-19.xml

@@ -140,7 +140,7 @@ $client->setFileUpload('file2.txt',
                 Starting from version 1.9, the protected method
                 Starting from version 1.9, the protected method
                 <methodname>_getParametersRecursive()</methodname> is no longer used by
                 <methodname>_getParametersRecursive()</methodname> is no longer used by
                 <classname>Zend_Http_Client</classname> and is deprecated. Using it will cause an
                 <classname>Zend_Http_Client</classname> and is deprecated. Using it will cause an
-                E_NOTICE message to be emitted by <acronym>PHP</acronym>.
+                <constant>E_NOTICE</constant> message to be emitted by <acronym>PHP</acronym>.
             </para>
             </para>
 
 
             <para>
             <para>
@@ -151,7 +151,7 @@ $client->setFileUpload('file2.txt',
             </para>
             </para>
 
 
             <para>
             <para>
-                Again, since this <classname>_getParametersRecursive</classname> is a protected
+                Again, since this <methodname>_getParametersRecursive()</methodname> is a protected
                 method, this change will only affect users who subclass
                 method, this change will only affect users who subclass
                 <classname>Zend_Http_Client</classname>.
                 <classname>Zend_Http_Client</classname>.
             </para>
             </para>
@@ -183,36 +183,69 @@ $client->setFileUpload('file2.txt',
                     </thead>
                     </thead>
                     <tbody>
                     <tbody>
                         <row>
                         <row>
-                            <entry>getLanguageTranslationList($locale)</entry>
-                            <entry>getTranslationList('language', $locale)</entry>
+                            <entry>
+                                <methodname>getLanguageTranslationList($locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslationList('language', $locale)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getScriptTranslationList($locale)</entry>
-                            <entry>getTranslationList('script', $locale)</entry>
+                            <entry>
+                                <methodname>getScriptTranslationList($locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslationList('script', $locale)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getCountryTranslationList($locale)</entry>
-                            <entry>getTranslationList('territory', $locale, 2)</entry>
+                            <entry>
+                                <methodname>getCountryTranslationList($locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslationList('territory', $locale, 2)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getTerritoryTranslationList($locale)</entry>
-                            <entry>getTranslationList('territory', $locale, 1)</entry>
+                            <entry>
+                                <methodname>getTerritoryTranslationList($locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslationList('territory', $locale, 1)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getLanguageTranslation($value, $locale)</entry>
-                            <entry>getTranslation($value, 'language', $locale)</entry>
+                            <entry>
+                                <methodname>getLanguageTranslation($value, $locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslation($value, 'language', $locale)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getScriptTranslation($value, $locale)</entry>
-                            <entry>getTranslation($value, 'script', $locale)</entry>
+                            <entry>
+                                <methodname>getScriptTranslation($value, $locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslation($value, 'script', $locale)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getCountryTranslation($value, $locale)</entry>
-                            <entry>getTranslation($value, 'country', $locale)</entry>
+                            <entry>
+                                <methodname>getCountryTranslation($value, $locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslation($value, 'country', $locale)</methodname>
+                            </entry>
                         </row>
                         </row>
                         <row>
                         <row>
-                            <entry>getTerritoryTranslation($value, $locale)</entry>
-                            <entry>getTranslation($value, 'territory', $locale)</entry>
+                            <entry>
+                                <methodname>getTerritoryTranslation($value, $locale)</methodname>
+                            </entry>
+                            <entry>
+                                <methodname>getTranslation($value, 'territory',
+                                    $locale)</methodname>
+                            </entry>
                         </row>
                         </row>
                     </tbody>
                     </tbody>
                 </tgroup>
                 </tgroup>
@@ -226,14 +259,14 @@ $client->setFileUpload('file2.txt',
         <para>
         <para>
             Prior to the 1.9 release, the menu helper
             Prior to the 1.9 release, the menu helper
             (<classname>Zend_View_Helper_Navigation_Menu</classname>) did not
             (<classname>Zend_View_Helper_Navigation_Menu</classname>) did not
-            render sub menus correctly. When the <code>onlyActiveBranch</code>
-            was <constant>TRUE</constant> and the option <code>renderParents</code>
+            render sub menus correctly. When <property>onlyActiveBranch</property>
+            was <constant>TRUE</constant> and the option <property>renderParents</property>
             <constant>FALSE</constant>, nothing would be rendered if the deepest active
             <constant>FALSE</constant>, nothing would be rendered if the deepest active
-            page was at a depth lower than the <code>minDepth</code> option.
+            page was at a depth lower than the <property>minDepth</property> option.
         </para>
         </para>
 
 
         <para>
         <para>
-            In simpler words; if <code>minDepth</code> was set to <code>1</code>
+            In simpler words; if <property>minDepth</property> was set to '1'
             and the active page was at one of the first level pages, nothing
             and the active page was at one of the first level pages, nothing
             would be rendered, as the following example shows.
             would be rendered, as the following example shows.
         </para>
         </para>
@@ -290,7 +323,7 @@ $container = new Zend_Navigation(array(
         <para>
         <para>
             Since release 1.9, the <methodname>_renderDeepestMenu()</methodname> method in
             Since release 1.9, the <methodname>_renderDeepestMenu()</methodname> method in
             <classname>Zend_View_Helper_Navigation_Menu</classname> will accept
             <classname>Zend_View_Helper_Navigation_Menu</classname> will accept
-            active pages at one level below <code>minDepth</code>, as long as
+            active pages at one level below <property>minDepth</property>, as long as
             the page has children.
             the page has children.
         </para>
         </para>