Bladeren bron

[DOCUMENTATION] English:
- reverted bad commit for this file (r16603)

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

mikaelkael 16 jaren geleden
bovenliggende
commit
12ad5730ec
1 gewijzigde bestanden met toevoegingen van 45 en 31 verwijderingen
  1. 45 31
      documentation/manual/en/module_specs/Zend_Controller-Router-Route-Rest.xml

+ 45 - 31
documentation/manual/en/module_specs/Zend_Controller-Router-Route-Rest.xml

@@ -5,11 +5,11 @@
 
     <para>
         The <classname>Zend_Rest</classname> component contains a RESTful route
-        for <classname>Zend_Controller_Router_Rewrite</classname>.  This route
+        for <classname>Zend_Controller_Router_Rewrite</classname>. This route
         offers a standardized routing scheme that routes requests by translating
-        the HTTP method and the URI to a module, controller, and action.  The
-        table below provides an overview of how request methods and URI's are
-        routed.
+        the <acronym>HTTP</acronym> method and the <acronym>URI</acronym>
+        to a module, controller, and action. The table below provides an overview
+        of how request methods and <acronym>URI</acronym>'s are routed.
     </para>
 
     <table frame="all">
@@ -22,45 +22,49 @@
             <thead>
                 <row>
                     <entry>Method</entry>
-                    <entry>URI</entry>
+                    <entry><acronym>URI</acronym></entry>
                     <entry>Module_Controller::action</entry>
                 </row>
             </thead>
             <tbody>
                 <row>
                     <entry>GET</entry>
-                    <entry>/product/ratings/</entry>
-                    <entry>Product_RatingsController::indexAction()</entry>
+                    <entry><filename>/product/ratings/</filename></entry>
+                    <entry><methodname>Product_RatingsController::indexAction()</methodname></entry>
                 </row>
                 <row>
                     <entry>GET</entry>
-                    <entry>/product/ratings/:id</entry>
-                    <entry>Product_RatingsController::getAction()</entry>
+                    <entry><filename>/product/ratings/:id</filename></entry>
+                    <entry><methodname>Product_RatingsController::getAction()</methodname></entry>
                 </row>
                 <row>
                     <entry>POST</entry>
-                    <entry>/product/ratings</entry>
-                    <entry>Product_RatingsController::postAction()</entry>
+                    <entry><filename>/product/ratings</filename></entry>
+                    <entry><methodname>Product_RatingsController::postAction()</methodname></entry>
                 </row>
                 <row>
                     <entry>PUT</entry>
-                    <entry>/product/ratings/:id</entry>
-                    <entry>Product_RatingsController::putAction()</entry>
+                    <entry><filename>/product/ratings/:id</filename></entry>
+                    <entry><methodname>Product_RatingsController::putAction()</methodname></entry>
                 </row>
                 <row>
                     <entry>DELETE</entry>
-                    <entry>/product/ratings/:id</entry>
-                    <entry>Product_RatingsController::deleteAction()</entry>
+                    <entry><filename>/product/ratings/:id</filename></entry>
+                    <entry>
+                        <methodname>Product_RatingsController::deleteAction()</methodname>
+                    </entry>
                 </row>
                 <row>
                     <entry>POST</entry>
-                    <entry><literallayout>/product/ratings/:id?_method="PUT"</literallayout></entry>
-                    <entry>Product_RatingsController::putAction()</entry>
+                    <entry><filename>/product/ratings/:id?_method="PUT"</filename></entry>
+                    <entry><methodname>Product_RatingsController::putAction()</methodname></entry>
                 </row>
                 <row>
                     <entry>POST</entry>
-                    <entry><literallayout>/product/ratings/:id?_method="DELETE"</literallayout></entry>
-                    <entry>Product_RatingsController::deleteAction()</entry>
+                    <entry><filename>/product/ratings/:id?_method="DELETE"</filename></entry>
+                    <entry>
+                        <methodname>Product_RatingsController::deleteAction()</methodname>
+                    </entry>
                 </row>
             </tbody>
         </tgroup>
@@ -126,26 +130,36 @@ $front->getRouter()->addRoute('rest', $restRoute);
 
         <itemizedlist>
             <listitem>
-                <emphasis><methodname>indexAction</methodname></emphasis> -
-                Should retrieve an index of resources and assign it to view.
+                <para>
+                    <emphasis><methodname>indexAction()</methodname></emphasis> -
+                    Should retrieve an index of resources and assign it to view.
+                </para>
             </listitem>
             <listitem>
-                <emphasis><methodname>getAction</methodname></emphasis> -
-                Should retrieve a single resource identified by URI and assign
-                it to view.
+                <para>
+                    <emphasis><methodname>getAction()</methodname></emphasis> -
+                    Should retrieve a single resource identified by <acronym>URI</acronym>
+                    and assign it to view.
+                </para>
             </listitem>
             <listitem>
-                <emphasis><methodname>postAction</methodname></emphasis> -
-                Should accept a new single resource and persist its state.
+                <para>
+                    <emphasis><methodname>postAction()</methodname></emphasis> -
+                    Should accept a new single resource and persist its state.
+                </para>
             </listitem>
             <listitem>
-                <emphasis><methodname>putAction</methodname></emphasis> -
-                Should accept a single resource identified by URI and persist
-                its state.
+                <para>
+                    <emphasis><methodname>putAction()</methodname></emphasis> -
+                    Should accept a single resource idenitifed by <acronym>URI</acronym>
+                    and persist its state.
+                </para>
             </listitem>
             <listitem>
-                <emphasis><methodname>deleteAction</methodname></emphasis> -
-                Should delete a single resource identified by URI.
+                <para>
+                    <emphasis><methodname>deleteAction()</methodname></emphasis> -
+                    Should delete a single resource identified by <acronym>URI</acronym>.
+                </para>
             </listitem>
         </itemizedlist>