Zend_Controller-Router-Route-Rest.xml 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- EN-Revision: 19753 -->
  3. <!-- Reviewed: no -->
  4. <sect3 id="zend.controller.router.routes.rest">
  5. <title>Zend_Rest_Route</title>
  6. <para>
  7. Le composant <classname>Zend_Rest</classname> contient une route RESTful pour
  8. <classname>Zend_Controller_Router_Rewrite</classname>. Cette route permet un
  9. schéma de routage fonction de la méthode <acronym>HTTP</acronym> et de
  10. l'<acronym>URI</acronym> afin d'y faire correspondre un module, contrôleur,
  11. et action. Le tableau suivant vous donne un aperçu du schéma de routage en
  12. fonction de l'<acronym>URI</acronym>.
  13. </para>
  14. <table frame="all">
  15. <title>Comportement de Zend_Rest_Route</title>
  16. <tgroup cols='3' align='left' colsep='1' rowsep='1'>
  17. <colspec colname='method' />
  18. <colspec colname='URI' />
  19. <colspec colname='route' />
  20. <thead>
  21. <row>
  22. <entry>Méthode</entry>
  23. <entry><acronym>URI</acronym></entry>
  24. <entry>Module_Controller::action</entry>
  25. </row>
  26. </thead>
  27. <tbody>
  28. <row>
  29. <entry><constant>GET</constant></entry>
  30. <entry><filename>/product/ratings/</filename></entry>
  31. <entry><methodname>Product_RatingsController::indexAction()</methodname></entry>
  32. </row>
  33. <row>
  34. <entry><constant>GET</constant></entry>
  35. <entry><filename>/product/ratings/:id</filename></entry>
  36. <entry><methodname>Product_RatingsController::getAction()</methodname></entry>
  37. </row>
  38. <row>
  39. <entry><constant>POST</constant></entry>
  40. <entry><filename>/product/ratings</filename></entry>
  41. <entry><methodname>Product_RatingsController::postAction()</methodname></entry>
  42. </row>
  43. <row>
  44. <entry><constant>PUT</constant></entry>
  45. <entry><filename>/product/ratings/:id</filename></entry>
  46. <entry><methodname>Product_RatingsController::putAction()</methodname></entry>
  47. </row>
  48. <row>
  49. <entry><constant>DELETE</constant></entry>
  50. <entry><filename>/product/ratings/:id</filename></entry>
  51. <entry>
  52. <methodname>Product_RatingsController::deleteAction()</methodname>
  53. </entry>
  54. </row>
  55. <row>
  56. <entry><constant>POST</constant></entry>
  57. <entry><filename>/product/ratings/:id?_method="PUT"</filename></entry>
  58. <entry><methodname>Product_RatingsController::putAction()</methodname></entry>
  59. </row>
  60. <row>
  61. <entry><constant>POST</constant></entry>
  62. <entry><filename>/product/ratings/:id?_method="DELETE"</filename></entry>
  63. <entry>
  64. <methodname>Product_RatingsController::deleteAction()</methodname>
  65. </entry>
  66. </row>
  67. </tbody>
  68. </tgroup>
  69. </table>
  70. <para>
  71. Pour activer <classname>Zend_Rest_Route</classname> pour une application entière,
  72. construisez en un objet sans paramètre spécifique et ajoutez le comme route par défaut dans
  73. le contrôleur frontal:
  74. </para>
  75. <programlisting language="php"><![CDATA[
  76. $front = Zend_Controller_Front::getInstance();
  77. $restRoute = new Zend_Rest_Route($front);
  78. $front->getRouter()->addRoute('default', $restRoute);
  79. ]]></programlisting>
  80. <note>
  81. <para>
  82. Si <classname>Zend_Rest_Route</classname> ne trouve aucun module, contrôleur, action
  83. valides, il retournera <constant>FALSE</constant> et la route suivante sera alors
  84. analysée par le routeur.
  85. </para>
  86. </note>
  87. <para>
  88. Pour activer <classname>Zend_Rest_Route</classname> pour des modules spécifiques,
  89. construisez l'objet avec comme troisième paramètre, un tableau de noms de modules&#160;:
  90. </para>
  91. <programlisting language="php"><![CDATA[
  92. $front = Zend_Controller_Front::getInstance();
  93. $restRoute = new Zend_Rest_Route($front, array(), array('product'));
  94. $front->getRouter()->addRoute('rest', $restRoute);
  95. ]]></programlisting>
  96. <para>
  97. Pour activer <classname>Zend_Rest_Route</classname> pour des contrôleurs spécifiques,
  98. construisez l'objet avec comme troisième paramètre, un tableau de noms de contrôleurs
  99. en correspondance avec des noms de modules.
  100. </para>
  101. <programlisting language="php"><![CDATA[
  102. $front = Zend_Controller_Front::getInstance();
  103. $restRoute = new Zend_Rest_Route($front, array(), array(
  104. 'product' => array('ratings')
  105. ));
  106. $front->getRouter()->addRoute('rest', $restRoute);
  107. ]]></programlisting>
  108. <sect4 id="zend.rest.controller">
  109. <title>Zend_Rest_Controller</title>
  110. <para>
  111. Pour vous aidez à utiliser des contrôleurs avec
  112. <classname>Zend_Rest_Route</classname>, faites les étendre
  113. <classname>Zend_Rest_Controller</classname>.
  114. <classname>Zend_Rest_Controller</classname> définit les 5 opérations RESTful les
  115. plus connues sous forme de méthodes abstraites.
  116. </para>
  117. <itemizedlist>
  118. <listitem>
  119. <para>
  120. <emphasis><methodname>indexAction()</methodname></emphasis> -
  121. Devrait récupérer un index des ressources et le passer à la vue.
  122. </para>
  123. </listitem>
  124. <listitem>
  125. <para>
  126. <emphasis><methodname>getAction()</methodname></emphasis> -
  127. Devrait récupérer des données d'une ressource définie par <acronym>URI</acronym>
  128. et les passer à la vue.
  129. </para>
  130. </listitem>
  131. <listitem>
  132. <para>
  133. <emphasis><methodname>postAction()</methodname></emphasis> -
  134. Devrait accepter une nouvelle ressource et la faire persister (la sauvegarder).
  135. </para>
  136. </listitem>
  137. <listitem>
  138. <para>
  139. <emphasis><methodname>putAction()</methodname></emphasis> -
  140. Devrait accepter une ressource indentifiée par <acronym>URI</acronym> et
  141. la faire persister (la sauvegarder).
  142. </para>
  143. </listitem>
  144. <listitem>
  145. <para>
  146. <emphasis><methodname>deleteAction()</methodname></emphasis> -
  147. Devrait supprimer la ressource identifiée par <acronym>URI</acronym>.
  148. </para>
  149. </listitem>
  150. </itemizedlist>
  151. </sect4>
  152. </sect3>