Zend_Db_Table.xml 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271
  1. <!-- EN-Revision: 14084 -->
  2. <sect1 id="zend.db.table">
  3. <title>Zend_Db_Table</title>
  4. <sect2 id="zend.db.table.introduction">
  5. <title>Introduction</title>
  6. <para>La classe <classname>Zend_Db_Table</classname> est une interface orientée objet vers les tables d'une base de
  7. données. Elle fournit des méthodes pour la gestion de la plupart des opérations concernant une table. Bien
  8. entendu, vous pouvez étendre la classe de base pour ajouter une logique personnalisée.</para>
  9. <para>La solution que représente <classname>Zend_Db_Table</classname> est basée sur le motif de conception <ulink
  10. url="http://www.martinfowler.com/eaaCatalog/tableDataGateway.html">Table Data Gateway</ulink>. Cette solution
  11. inclut aussi une classe implémentant le motif <ulink
  12. url="http://www.martinfowler.com/eaaCatalog/rowDataGateway.html">Row Data Gateway</ulink>.</para>
  13. </sect2>
  14. <sect2 id="zend.db.table.defining">
  15. <title>Définir une classe de Table</title>
  16. <para>Pour chaque table de la base de données envers laquelle vous souhaitez un accès, définissez une classe
  17. étendant <classname>Zend_Db_Table_Abstract</classname>.</para>
  18. <sect3 id="zend.db.table.defining.table-schema">
  19. <title>Définir le nom de la table, et de la base de données</title>
  20. <para>Déclarez le nom de la table pour laquelle la classe va agir, en utilisant la propriété protégée
  21. <code>$_name</code>. C'est une chaîne, elle doit contenir le nom de la table tel qu'il apparaît dans la base
  22. de données.</para>
  23. <example id="zend.db.table.defining.table-schema.example1">
  24. <title>Déclarer une classe de Table avec un nom de table spécifique</title>
  25. <programlisting role="php"><![CDATA[
  26. class Bugs extends Zend_Db_Table_Abstract
  27. {
  28. protected $_name = 'bugs';
  29. }
  30. ]]></programlisting>
  31. </example>
  32. <para>Si vous ne spécifiez pas le nom de la table, le nom de la classe sera alors utilisé comme nom de table
  33. par défaut.</para>
  34. <example id="zend.db.table.defining.table-schema.example">
  35. <title>Déclarer une classe de Table sans nom de table spécifique</title>
  36. <programlisting role="php"><![CDATA[
  37. class bugs extends Zend_Db_Table_Abstract
  38. {
  39. // le nom de la table est ici supposé être le nom de la classe
  40. }
  41. ]]></programlisting>
  42. </example>
  43. <para>Vous pouvez aussi déclarer le nom de la base de données contenant la table, toujours au moyen d'une
  44. propriété protégée de la classe : <code>$_schema</code>, ou avec le nom de la base précédant le nom de la
  45. table dans la propriété <code>$_name</code>. Si vous choisissez de définir le nom de la base de données dans
  46. la propriété <code>$_name</code>, alors ce choix sera prioritaire sur celui utilisant
  47. <code>$_schema</code>.</para>
  48. <example id="zend.db.table.defining.table-schema.example3">
  49. <title>Déclarer une classe de Table avec un nom de base de données</title>
  50. <programlisting role="php"><![CDATA[
  51. // Première alternative :
  52. class Bugs extends Zend_Db_Table_Abstract
  53. {
  54. protected $_schema = 'bug_db';
  55. protected $_name = 'bugs';
  56. }
  57. // Seconde alternative :
  58. class Bugs extends Zend_Db_Table_Abstract
  59. {
  60. protected $_name = 'bug_db.bugs';
  61. }
  62. // Si le nom de la base est spécifiée dans $_name ET $_schema,
  63. // alors c'est celui spécifié dans $_name qui prime :
  64. class Bugs extends Zend_Db_Table_Abstract
  65. {
  66. protected $_name = 'bug_db.bugs';
  67. protected $_schema = 'ignored';
  68. }
  69. ]]></programlisting>
  70. </example>
  71. <para>Les noms de la base de données et de la table peuvent aussi être définis via le constructeur de la
  72. classe de Table. Ils écrasent alors ceux éventuellement définis dans les propriétés de la classe (avec
  73. <code>$_name</code> et <code>$_schema</code>).</para>
  74. <example id="zend.db.table.defining.table-schema.example.constructor">
  75. <title>Déclarer les noms de table et base de donnée à l'instanciation</title>
  76. <programlisting role="php"><![CDATA[
  77. class Bugs extends Zend_Db_Table_Abstract
  78. {
  79. }
  80. // Première alternative :
  81. $tableBugs = new Bugs(array('name' => 'bugs', 'schema' => 'bug_db'));
  82. // Seconde alternative :
  83. $tableBugs = new Bugs(array('name' => 'bug_db.bugs'));
  84. // Si le nom de la base est spécifié dans name ET schema, alors c'est
  85. // celui spécifié dans name qui prime :
  86. $tableBugs = new Bugs(array('name' => 'bug_db.bugs',
  87. 'schema' => 'ignored'));
  88. ]]></programlisting>
  89. </example>
  90. <para>Si vous n'indiquez pas de base de données, c'est celle utilisée par l'adaptateur qui sera
  91. utilisée.</para>
  92. </sect3>
  93. <sect3 id="zend.db.table.defining.primary-key">
  94. <title>Définir la clé primaire d'une table</title>
  95. <para>Toute table doit posséder une clé primaire. <classname>Zend_Db_Table</classname> ne fonctionne pas avec les
  96. tables sans clé primaire. Vous pouvez les déclarer la(les) colonne servant de clé primaire grâce à la
  97. propriété protégée de la classe <code>$_primary</code>. Celle-ci peut être soit une chaîne, dans le cas
  98. d'une clé sur une colonne, ou un tableau de chaînes pour une clé sur plusieurs colonnes (clé primaire
  99. composée).</para>
  100. <example id="zend.db.table.defining.primary-key.example">
  101. <title>Exemple de spécification de la clé primaire</title>
  102. <programlisting role="php"><![CDATA[
  103. class Bugs extends Zend_Db_Table_Abstract
  104. {
  105. protected $_name = 'bugs';
  106. protected $_primary = 'bug_id';
  107. }
  108. ]]></programlisting>
  109. </example>
  110. <para>Si vous ne spécifiez pas explicitement de clé primaire, alors <classname>Zend_Db_Table_Abstract</classname> va
  111. essayer de la trouver lui-même en utilisant les informations renvoyées par
  112. <code>describeTable()</code>.</para>
  113. <note>
  114. <para>Toute classe de table doit, par un moyen ou un autre, connaître la clé primaire de la table
  115. ciblée. Si la clé primaire ne peut être trouvée ( spécifiée dans la classe, ou découverte par
  116. <code>describeTable()</code>), alors la table ne va pas pouvoir être utilisée avec
  117. <classname>Zend_Db_Table</classname>.</para>
  118. </note>
  119. </sect3>
  120. <sect3 id="zend.db.table.defining.setup">
  121. <title>Redéfinir les méthodes de configuration de la classe de Table</title>
  122. <para>Lorsque vous créez votre instance de classe <classname>Zend_Db_Table</classname>, le constructeur décompose le
  123. processus via plusieurs méthodes permettant l'initialisation des métadonnées de la table. Chacune de ces
  124. étapes est matérialisée par une méthode de la classe, surchargeable. N'oubliez cependant pas d'appeler la
  125. méthode parente respective à la fin de votre traitement.</para>
  126. <example id="zend.db.table.defining.setup.example">
  127. <title>Exemple de redéfinition de la méthode <code>_setupTableName()</code></title>
  128. <programlisting role="php"><![CDATA[
  129. class Bugs extends Zend_Db_Table_Abstract
  130. {
  131. protected function _setupTableName()
  132. {
  133. $this->_name = 'bugs';
  134. parent::_setupTableName();
  135. }
  136. }
  137. ]]></programlisting>
  138. </example>
  139. <para>Les méthodes de configuration que vous pouvez redéfinir sont :</para>
  140. <itemizedlist>
  141. <listitem>
  142. <para><code>_setupDatabaseAdapter()</code> vérifie si un adaptateur a été passé à la classe,
  143. éventuellement en récupère un depuis le registre. En redéfinissant cette méthode, vous pouvez
  144. ajouter une source de recherche pour l'adaptateur.</para>
  145. </listitem>
  146. <listitem>
  147. <para><code>_setupTableName()</code> donne le nom de la table par défaut comme étant le nom de la
  148. classe. En redéfinissant cette méthode, vous pouvez spécifier le nom de la table avant son
  149. intervention.</para>
  150. </listitem>
  151. <listitem>
  152. <para><code>_setupMetadata()</code> définit le nom de la base de données si le nom de la table est
  153. de la forme "base.table"; appelle <code>describeTable()</code> pour récupérer les méta-données;
  154. remplir le tableau <code>$_cols</code> avec les noms des colonnes reçus via
  155. <code>describeTable()</code>. La redéfinition de cette méthode permet de spécifier soi-même les noms
  156. des colonnes de la table.</para>
  157. </listitem>
  158. <listitem>
  159. <para><code>_setupPrimaryKey()</code> donne le nom de la clé primaire par défaut en cherchant dans
  160. <code>describeTable()</code>; vérifie que la clé primaire fait bien partie du tableau
  161. <code>$_cols</code>. En redéfinissant cette méthode, vous pouvez spécifier une clé primaire
  162. manuellement.</para>
  163. </listitem>
  164. </itemizedlist>
  165. </sect3>
  166. <sect3 id="zend.db.table.initialization">
  167. <title>Initialisation de la Table</title>
  168. <para>Si lors de la construction de l'objet représentant votre Table, vous avez besoin d'implémenter une
  169. logique spécifique, vous devriez utiliser la méthode <code>init()</code>, qui est appelée juste après le
  170. constructeur, donc une fois la table correctement créée. <example
  171. id="zend.db.table.defining.init.usage.example">
  172. <title>Exemple d'utilisation de la méthode <code>init()</code></title>
  173. <programlisting role="php"><![CDATA[
  174. class Bugs extends Zend_Db_Table_Abstract
  175. {
  176. protected $_observer;
  177. public function init()
  178. {
  179. $this->_observer = new MyObserverClass();
  180. }
  181. }
  182. ]]></programlisting>
  183. </example></para>
  184. </sect3>
  185. </sect2>
  186. <sect2 id="zend.db.table.constructing">
  187. <title>Créer une instance de la classe de Table</title>
  188. <para>Avant d'utiliser votre classe de Table, il faut en créer une instance, via son constructeur. Celui-ci
  189. accepte un tableau d'options. La plus importante d'entre elles est l'adaptateur de base de données, qui
  190. représente la connexion au SGBD. Il y a trois façon de le spécifier :</para>
  191. <sect3 id="zend.db.table.constructing.adapter">
  192. <title>Spécifier l'adaptateur de base de données</title>
  193. <para>La première manière de spécifier l'objet d'adaptateur à la classe de Table, est de le passer dans le
  194. tableau d'options, à l'index <code>"db"</code>.</para>
  195. <example id="zend.db.table.constructing.adapter.example">
  196. <title>Exemple de construction d'un objet Table avec l'objet adaptateur</title>
  197. <programlisting role="php"><![CDATA[
  198. $db = Zend_Db::factory('PDO_MYSQL', $options);
  199. $table = new Bugs(array('db' => $db));
  200. ]]></programlisting>
  201. </example>
  202. </sect3>
  203. <sect3 id="zend.db.table.constructing.default-adapter">
  204. <title>Spécifier un adaptateur par défaut</title>
  205. <para>La deuxième manière de donner un objet adaptateur à la classe de Table est de le déclarer comme étant
  206. l'objet adaptateur par défaut pour toutes les classes de Table. Vous pouvez faire ceci en utilisant la
  207. méthode statique <classname>Zend_Db_Table_Abstract::setDefaultAdapter()</classname>. Son argument est un objet de type
  208. <classname>Zend_Db_Adapter_Abstract</classname>.</para>
  209. <example id="zend.db.table.constructing.default-adapter.example">
  210. <title>Exemple de construction d'un objet Table en utilisant l'adaptateur par défaut</title>
  211. <programlisting role="php"><![CDATA[
  212. $db = Zend_Db::factory('PDO_MYSQL', $options);
  213. Zend_Db_Table_Abstract::setDefaultAdapter($db);
  214. // Plus tard...
  215. $table = new Bugs();
  216. ]]></programlisting>
  217. </example>
  218. <para>Il peut être intéressant de créer son objet adaptateur de base de données en un lieu approprié, comme
  219. le fichier d'amorçage ("bootstrap"), et ensuite de le spécifier comme adaptateur par défaut pour toutes les
  220. tables, à travers toute l'application. Attention toutefois, ce procédé fixe un et un seul adaptateur, pour
  221. toutes les classes de table (héritant de <classname>Zend_Db_Table_Abstract</classname>).</para>
  222. </sect3>
  223. <sect3 id="zend.db.table.constructing.registry">
  224. <title>Stocker l'objet adaptateur dans le registre</title>
  225. <para>La troisième manière de passer l'objet adaptateur de base de données à votre classe de Table, est de
  226. passer une chaîne de caractères dans la clé <code>"db"</code> du tableau de configuration accepté par le
  227. constructeur. Cette chaîne représente alors l'index auquel est stocké l'adaptateur, dans le registre
  228. statique.</para>
  229. <example id="zend.db.table.constructing.registry.example">
  230. <title>Exemple de construction de l'objet Table avec le registre</title>
  231. <programlisting role="php"><![CDATA[
  232. $db = Zend_Db::factory('PDO_MYSQL', $options);
  233. Zend_Registry::set('my_db', $db);
  234. // Plus tard...
  235. $table = new Bugs(array('db' => 'my_db'));
  236. ]]></programlisting>
  237. </example>
  238. <para>Cette option est très semblable à celle qui consiste à définir un adaptateur par défaut à toutes les
  239. classes. Le registre est en revanche plus flexible, car vous pouvez y stocker plusieurs adaptateurs,
  240. correspondants à plusieurs SGBD différents. Changer de SGBD pour ses classes de Table est alors aussi simple
  241. que de changer de valeur de registre.</para>
  242. </sect3>
  243. </sect2>
  244. <sect2 id="zend.db.table.insert">
  245. <title>Insérer des enregistrement dans une table</title>
  246. <para>Vous pouvez utiliser votre objet de Table pour insérer des données dans la table sur laquelle l'objet se
  247. base. Utilisez sa méthode <code>insert()</code> qui accepte un seul paramètre : c'est un tableau dont les clés
  248. sont les noms des colonnes de la table, et les valeurs les valeurs souhaitées pour insertions.</para>
  249. <example id="zend.db.table.insert.example">
  250. <title>Exemple d'insertion de données dans la table</title>
  251. <programlisting role="php"><![CDATA[
  252. $table = new Bugs();
  253. $data = array(
  254. 'created_on' => '2007-03-22',
  255. 'bug_description' => 'Something wrong',
  256. 'bug_status' => 'NEW'
  257. );
  258. $table->insert($data);
  259. ]]></programlisting>
  260. </example>
  261. <para>Par défaut les paramètres sont traités comme des valeurs littérales. Si vous souhaitez utiliser une
  262. expression SQL à la place, manipulez un objet <classname>Zend_Db_Expr</classname> plutôt.</para>
  263. <example id="zend.db.table.insert.example-expr">
  264. <title>Exemple d'insertion d'expressions dans une table</title>
  265. <programlisting role="php"><![CDATA[
  266. $table = new Bugs();
  267. $data = array(
  268. 'created_on' => new Zend_Db_Expr('CURDATE()'),
  269. 'bug_description' => 'Something wrong',
  270. 'bug_status' => 'NEW'
  271. );
  272. ]]></programlisting>
  273. </example>
  274. <para>Dans les exemples ci-dessus, il est supposé que la table possède une clé primaire auto-incrémentée. C'est
  275. le comportement par défaut que gère <classname>Zend_Db_Table_Abstract</classname>, mais il y a d'autres comportements
  276. valides, qui sont détaillés ci-dessous.</para>
  277. <sect3 id="zend.db.table.insert.key-auto">
  278. <title>Utiliser une table avec une clé primaire auto-incrémentée</title>
  279. <para>Une clé primaire auto-incrémentée génère une valeur entière unique si vous omettez la colonne de la
  280. clé primaire dans une requête SQL de type <code>INSERT</code>.</para>
  281. <para>Dans <classname>Zend_Db_Table_Abstract</classname>, si vous définissez la variable protégée
  282. <code>$_sequence</code> à un booléen <code>true</code> (défaut), alors la classe va supposer que la table
  283. qu'elle représente possède une clé primaire auto-incrémentée.</para>
  284. <example id="zend.db.table.insert.key-auto.example">
  285. <title>Exemple de déclaration d'une clé primaire auto-incrémentée</title>
  286. <programlisting role="php"><![CDATA[
  287. class Bugs extends Zend_Db_Table_Abstract
  288. {
  289. protected $_name = 'bugs';
  290. // Ce comportement est celui par défaut, il est noté ici
  291. // uniquement pour l'exemple, mais non necéssaire
  292. protected $_sequence = true;
  293. }
  294. ]]></programlisting>
  295. </example>
  296. <para>MySQL, MSSQL, et SQLite sont des exemples de SGBD supportant les clé primaires
  297. auto-incrémentées.</para>
  298. <para>PostgreSQL a une propriété <code>SERIAL</code> qui définit une séquence automatiquement, basée sur le
  299. nom de la table et d'une colonne, et utilise cette séquence pour générer des valeurs de clés pour les
  300. nouveaux enregistrements. IBM DB2 a une propriété <code>IDENTITY</code> qui fonctionne de la même manière.
  301. Si vous utilisez ces propriétés d'automatisme, considérez votre classe de Table (<classname>Zend_Db_Table</classname>)
  302. comme si elle avait une clé primaire auto-incrémentée. Déclarez ainsi <code>$_sequence</code> à
  303. <code>true</code>.</para>
  304. </sect3>
  305. <sect3 id="zend.db.table.insert.key-sequence">
  306. <title>Utiliser une Table avec une séquence</title>
  307. <para>Une séquence est un objet de base de données qui génère des valeurs uniques pouvant être utilisées
  308. comme clés primaires dans une ou plusieurs tables de la base de données.</para>
  309. <para>Si vous définissez <code>$_sequence</code> avec une chaîne de caractères,
  310. <classname>Zend_Db_Table_Abstract</classname> va alors supposer que cette chaîne représente le nom de l'objet de
  311. séquence. Elle sera donc utilisée pour générer une valeur lors de requêtes <code>INSERT</code> le
  312. nécessitant.</para>
  313. <example id="zend.db.table.insert.key-sequence.example">
  314. <title>Exemple de déclaration d'une séquence dans une classe de Table</title>
  315. <programlisting role="php"><![CDATA[
  316. class Bugs extends Zend_Db_Table_Abstract
  317. {
  318. protected $_name = 'bugs';
  319. protected $_sequence = 'bug_sequence';
  320. }
  321. ]]></programlisting>
  322. </example>
  323. <para>Oracle, PostgreSQL, et IBM DB2 sont des SGBDs qui supportent les séquences.</para>
  324. <para>PostgreSQL et IBM DB2 ont aussi des mécanismes définissant implicitement la séquence et les colonnes
  325. associées. Si vous utilisez un de ces procédés, considérez votre classe de table comme ayant une clé
  326. primaire auto-incrémentée. N'utilisez la chaîne de la séquence dans $_sequence que si vous voulez
  327. explicitement utiliser cette séquence pour générer la valeur suivante de clé.</para>
  328. </sect3>
  329. <sect3 id="zend.db.table.insert.key-natural">
  330. <title>Utiliser une classe de Table avec une clé naturelle</title>
  331. <para>Certaines tables ont des clé naturelles, c'est à dire que vous devez fournir vous même, manuellement,
  332. la valeur de la clé concernée. Aucun mécanisme automatique (auto-incrémentation ou séquence) ne le fait pour
  333. vous.</para>
  334. <para>Si vous utilisez <code>$_sequence</code> avec la valeur booléenne <code>false</code>, alors
  335. <classname>Zend_Db_Table_Abstract</classname> se comportera comme si une clé naturelle est utilisée. Ainsi, lors de
  336. l'appel de la méthode <code>insert()</code>, vous devrez spécifier la valeur de la clé primaire vous même,
  337. autrement une <classname>Zend_Db_Table_Exception</classname> sera levée.</para>
  338. <example id="zend.db.table.insert.key-natural.example">
  339. <title>Exemple de déclaration d'une clé naturelle</title>
  340. <programlisting role="php"><![CDATA[
  341. class BugStatus extends Zend_Db_Table_Abstract
  342. {
  343. protected $_name = 'bug_status';
  344. protected $_sequence = false;
  345. }
  346. ]]></programlisting>
  347. </example>
  348. <note>
  349. <para>Tous les SGBDs gère ce cas. Les tables d'intersection dans les relations de type "plusieurs à
  350. plusieurs" sont de bons exemples de clés naturelles, souvent composées d'autres clés étrangères.</para>
  351. </note>
  352. </sect3>
  353. </sect2>
  354. <sect2 id="zend.db.table.update">
  355. <title>Mettre à jour des enregistrements dans une table</title>
  356. <para>Vous pouvez mettre à jour des enregistrements de votre table en utilisant la méthode <code>update</code>
  357. de votre classe de Table. Elle accepte deux paramètres. Le premier est un tableau associatifs des colonnes
  358. concernées, et de leurs valeurs respectives. Le deuxième est une expression SQL qui sera utiliser comme clause
  359. <code>WHERE</code> dans la requête <code>UPDATE</code>.</para>
  360. <example id="zend.db.table.update.example">
  361. <title>Exemple de mise à jour d'enregistrements dans une table</title>
  362. <programlisting role="php"><![CDATA[
  363. $table = new Bugs();
  364. $data = array(
  365. 'updated_on' => '2007-03-23',
  366. 'bug_status' => 'FIXED'
  367. );
  368. $where = $table->getAdapter()->quoteInto('bug_id = ?', 1234);
  369. $table->update($data, $where);
  370. ]]></programlisting>
  371. </example>
  372. <para>La méthode de la classe de Table <code>update()</code> est proxiées vers la méthode <link
  373. linkend="zend.db.adapter.write.update"><code>update()</code></link> de l'adaptateur. Le deuxième paramètre peut
  374. donc être un tableau d'arguments pour la clause WHERE. Chaque élément du tableau sera joint au suivant avec une
  375. opération <code>AND</code>.</para>
  376. <note>
  377. <para>Les valeurs et les identifiants SQL ne sont pas échappés automatiquement. Si vous voulez échapper des
  378. valeurs, vous devrez utiliser <code>quote()</code>, <code>quoteInto()</code>, et
  379. <code>quoteIdentifier()</code> de l'adaptateur.</para>
  380. </note>
  381. </sect2>
  382. <sect2 id="zend.db.table.delete">
  383. <title>Supprimer des enregistrements d'une Table</title>
  384. <para>Pour effacer des enregistrements de votre table en utilisant sa classe de Table, utilisez sa méthode
  385. <code>delete()</code>. Son seul paramètre est une chaîne ou un tableau définissant la clause <code>WHERE</code>
  386. à utiliser lors de la requête <code>DELETE</code>.</para>
  387. <example id="zend.db.table.delete.example">
  388. <title>Exemple de suppression d'enregistrements</title>
  389. <programlisting role="php"><![CDATA[
  390. $table = new Bugs();
  391. $where = $table->getAdapter()->quoteInto('bug_id = ?', 1235);
  392. $table->delete($where);
  393. ]]></programlisting>
  394. </example>
  395. <para>Cette méthode est proxiée vers <link linkend="zend.db.adapter.write.delete"><code>delete()</code></link>
  396. de l'adaptateur. Si le paramètre est un tableau, chacun des éléments du tableau sera joint au suivant avec
  397. l'opération <code>AND</code> pour former la clause WHERE.</para>
  398. <note>
  399. <para>Les valeurs et les identifiants SQL ne sont pas échappés automatiquement. Si vous voulez échapper des
  400. valeurs, vous devrez utiliser <code>quote()</code>, <code>quoteInto()</code>, et
  401. <code>quoteIdentifier()</code> de l'adaptateur.</para>
  402. </note>
  403. </sect2>
  404. <sect2 id="zend.db.table.find">
  405. <title>Récupérer des enregistrements par clé primaire</title>
  406. <para>Vous pouvez interroger votre table afin de récupérer des enregistrements en spécifiant une ou plusieurs
  407. valeurs de clé primaire. La méthode <code>find()</code> permet ceci, elle prend comme premier paramètre une
  408. valeur ou un tableau de valeurs de clé primaire.</para>
  409. <example id="zend.db.table.find.example">
  410. <title>Exemple de récupération d'enregistrements par clé primaire</title>
  411. <programlisting role="php"><![CDATA[
  412. $table = new Bugs();
  413. // Récupère un enregistrement, mais
  414. // retourne un Rowset
  415. $rows = $table->find(1234);
  416. // Récupère plusieurs enregistrement
  417. // retourne un Rowset
  418. $rows = $table->find(array(1234, 5678));
  419. ]]></programlisting>
  420. </example>
  421. <para>Si une seule clé est passée en paramètre, la méthode retournera au plus un résultat (car par définition,
  422. une clé primaire assure l'unicité d'un enregistrement). Si vous passez plusieurs valeurs de clés, alors la
  423. méthode pourra retourner plusieurs enregistrements. Cette méthode pourra aussi retourner zéro enregistrement.
  424. Quoiqu'il en soit, l'objet de retour est bien un <classname>Zend_Db_Table_Rowset_Abstract</classname></para>
  425. <para>Si votre clé primaire est une clé composée de plusieurs colonnes, passez alors les autres valeurs de
  426. colonne comme paramètres à la méthode <code>find()</code>. Il doit y avoir autant de paramètres passés à la
  427. méthode, que de colonnes composant la clé.</para>
  428. <para>Ainsi, pour trouver plusieurs enregistrements en passant plusieurs valeurs de clés primaires composées,
  429. passez autant de tableaux composés, que de colonnes représentant les clés. Les tableaux doivent donc, comporter
  430. le même nombre de valeurs. Celles-ci vont ainsi fonctionner par tuples : tous les premiers éléments des tableaux
  431. seront évalués pour la première recherche, et chacun représentera une colonne composant la clé primaire. Puis
  432. ainsi de suite, jusqu'à la fin des tableaux.</para>
  433. <example id="zend.db.table.find.example-compound">
  434. <title>Exemple de recherche avec une clé primaire composée</title>
  435. <para>L'exemple suivant appelle <code>find()</code> pour récupérer deux enregistrements en se basant sur une
  436. clé à deux colonnes. Le premier enregistrement aura une clé primaire (1234, 'ABC'), et le second une valeur
  437. de clé primaire (5678, 'DEF').</para>
  438. <programlisting role="php"><![CDATA[
  439. class BugsProducts extends Zend_Db_Table_Abstract
  440. {
  441. protected $_name = 'bugs_products';
  442. protected $_primary = array('bug_id', 'product_id');
  443. }
  444. $table = new BugsProducts();
  445. // Retourne un enregistrement unique, basé sur une clé
  446. // primaire à deux colonnes
  447. $rows = $table->find(1234, 'ABC');
  448. // Retourne deux enregistrements, basés sur une clé
  449. // primaire à deux colonnes
  450. $rows = $table->find(array(1234, 5678), array('ABC', 'DEF'));
  451. ]]></programlisting>
  452. </example>
  453. </sect2>
  454. <sect2 id="zend.db.table.fetch-all">
  455. <title>Requêter pour plusieurs enregistrements</title>
  456. <sect3 id="zend.db.table.fetch-all.select">
  457. <title>API de l'objet Select</title>
  458. <para><warning>
  459. <para>L'API pour les opérations de récupération d'enregistrements a été améliorée afin d'autoriser
  460. un objet <classname>Zend_Db_Table_Select</classname> à modifier la requête. Les anciens comportements de
  461. <code>fetchRow()</code> et <code>fetchAll()</code> sont désormais dépréciés, mais toujours
  462. fonctionnels à ce jour.</para>
  463. <para>Les requêtes suivantes sont sémantiquement identiques et fonctionnent. Il est conseillé
  464. cependant d'utiliser l'implémentation avec l'objet select.</para>
  465. <para><programlisting role="php"><![CDATA[
  466. // Récupérer un rowset
  467. $rows = $table->fetchAll('bug_status = "NEW"', 'bug_id ASC', 10, 0);
  468. $rows = $table->fetchAll($table->select()->where('bug_status = ?', 'NEW')
  469. ->order('bug_id ASC')
  470. ->limit(10, 0));
  471. // Récupérer un row
  472. $row = $table->fetchRow('bug_status = "NEW"', 'bug_id ASC');
  473. $row = $table->fetchRow($table->select()->where('bug_status = ?', 'NEW')
  474. ->order('bug_id ASC'));
  475. ]]></programlisting></para>
  476. </warning></para>
  477. <para>L'objet <classname>Zend_Db_Table_Select</classname> est une extension de
  478. <classname>Zend_Db_Select</classname> mais qui applique des restrictions particulières à la requête. Les
  479. restrictions sont :</para>
  480. <itemizedlist>
  481. <listitem>
  482. <para>Vous <emphasis>pouvez</emphasis> utiliser l'objet pour ne sélectionner que certaines colonnes
  483. de l'enregistrement à retourner. Ceci est pratique dans le cas où vous n'avez pas besoin
  484. spécifiquement de toutes les colonnes d'une table.</para>
  485. </listitem>
  486. <listitem>
  487. <para>Vous <emphasis>pouvez</emphasis> spécifier des colonnes avec des évaluations envers des
  488. expressions SQL. Cependant, l'enregistrement résultant sera alors en mode lecture seule
  489. (<property>readOnly</property>) et ne pourra pas être propagé en base de données
  490. (<code>save()</code>). Un appel à <code>save()</code> lèvera une exception.</para>
  491. </listitem>
  492. <listitem>
  493. <para>Vous <emphasis>pouvez</emphasis> utiliser des jointures JOIN vers d'autres tables, mais
  494. uniquement pour des critères de jointure, et non sélectionner des colonnes jointes.</para>
  495. </listitem>
  496. <listitem>
  497. <para>Vous <emphasis>ne pouvez pas</emphasis> spécifier de colonnes JOINtes comme faisant partie du
  498. résultat de la requête. L'objet row/rowset serait alors corrompu, et contiendrait des données d'une
  499. table étrangère à sa table originale. Une erreur sera renvoyée dans un tel cas.</para>
  500. </listitem>
  501. </itemizedlist>
  502. <para><example id="zend.db.table.qry.rows.set.simple.usage.example">
  503. <title>Utilisation simple</title>
  504. <programlisting role="php"><![CDATA[
  505. $table = new Bugs();
  506. $select = $table->select();
  507. $select->where('bug_status = ?', 'NEW');
  508. $rows = $table->fetchAll($select);
  509. ]]></programlisting>
  510. </example></para>
  511. <para>L'objet <code>Select</code> utilise une interface fluide (fluent interface), permettant le chaînage
  512. des méthodes.</para>
  513. <para><example id="zend.db.table.qry.rows.set.fluent.interface.example">
  514. <title>Exemple d'interface fluide</title>
  515. <programlisting role="php"><![CDATA[
  516. $table = new Bugs();
  517. $rows = $table->fetchAll($table->select()
  518. ->where('bug_status = ?', 'NEW'));
  519. ]]></programlisting>
  520. </example></para>
  521. </sect3>
  522. <sect3 id="zend.db.table.fetch-all.usage">
  523. <title>Récupérer un jeu d'enregistrements :</title>
  524. <para>Vous pouvez demander une requête qui retourne plusieurs enregistrements. La méthode
  525. <code>fetchAll()</code> de votre classe de Table permet ceci. Elle retourne un objet de type
  526. <classname>Zend_Db_Table_Rowset_Abstract</classname>, même si aucun enregistrement ne correspond à la requête.</para>
  527. <example id="zend.db.table.qry.rows.set.finding.row.example">
  528. <title>Exemple de récupération d'enregistrements</title>
  529. <programlisting role="php"><![CDATA[
  530. $table = new Bugs();
  531. $select = $table->select()->where('bug_status = ?', 'NEW');
  532. $rows = $table->fetchAll($select);
  533. ]]></programlisting>
  534. </example>
  535. <para>Vous pouvez aussi définir les clauses SQL <code>ORDER BY</code> ou encore <code>LIMIT</code> (ou autre
  536. équivalent comme OFFSET).</para>
  537. <example id="zend.db.table.fetch-all.example2">
  538. <title>Exemple de récupération d'enregistrements avec des clauses SQL</title>
  539. <programlisting role="php"><![CDATA[
  540. $table = new Bugs();
  541. $order = 'bug_id';
  542. // Retourne les enregistrements du 21ème au 30ème
  543. $count = 10;
  544. $offset = 20;
  545. $select = $table->select()->where(array('bug_status = ?' => 'NEW'))
  546. ->order($order)
  547. ->limit($count, $offset);
  548. $rows = $table->fetchAll($select);
  549. ]]></programlisting>
  550. </example>
  551. <para>Tous les arguments de requêtes sont optionnels. Vous pouvez écrire une requête sans clause WHERE ni
  552. LIMIT ou encore ORDER.</para>
  553. </sect3>
  554. <sect3 id="zend.db.table.advanced.usage">
  555. <title>Utilisation avancée</title>
  556. <para>Pour une utilisation plus avancée, vous pourriez vouloir spécifier une à une les colonnes que les
  557. enregistrements trouvés doivent comporter. Ceci se fait au moyen de la clause FROM de l'objet select. Le
  558. premier paramètre dans la clause FROM est le même que celui d'un objet Zend_Db_Select, cependant l'objet
  559. Zend_Db_Table_Select admet une instance de Zend_Db_Table_Abstract pour définir le nom de la table.</para>
  560. <para><example id="zend.db.table.qry.rows.set.retrieving.a.example">
  561. <title>Récupérer des colonnes spécifiques sur les enregistrements</title>
  562. <programlisting role="php"><![CDATA[
  563. $table = new Bugs();
  564. $select = $table->select();
  565. $select->from($table, array('bug_id', 'bug_description'))
  566. ->where('bug_status = ?', 'NEW');
  567. $rows = $table->fetchAll($select);
  568. ]]></programlisting>
  569. </example></para>
  570. <para><important>
  571. <para>Le jeu de résultats retourné est tout de même valide. Il ne possède en revanche que certaines
  572. colonnes de la table. La méthode <code>save()</code> est appelable, mais elle ne mettre à jour que
  573. ces colonnes.</para>
  574. </important> Il est aussi possible de spécifier des expressions dans une clause FROM, et donc récupérer
  575. un objet row/rowset en lecture seule. Dans l'exemple ci-après, nous retournons un enregistrement de la table
  576. "bugs" qui représente un agrégat du nombre de nouveaux bugs reportés. Regardez la clause GROUP. L'alias SQL
  577. "count" sera accessible dans le row/rowset résultant, comme si il faisait parti de la table en tant que
  578. colonne.</para>
  579. <para><example id="zend.db.table.qry.rows.set.retrieving.b.example">
  580. <title>Récupérer des enregistrements avec des requêtes incluant des expressions</title>
  581. <programlisting role="php"><![CDATA[
  582. $table = new Bugs();
  583. $select = $table->select();
  584. $select->from($table,
  585. array('COUNT(reported_by) as `count`', 'reported_by'))
  586. ->where('bug_status = ?', 'NEW')
  587. ->group('reported_by');
  588. $rows = $table->fetchAll($select);
  589. ]]></programlisting>
  590. </example> Vous pouvez aussi utiliser une table de jointure comme partie de votre requête. Dans
  591. l'exemple ci-dessous, nous utilisons la table "accounts" comme partie de la recherche, pour tous les bugs
  592. reportés par "Bob".</para>
  593. <para><example id="zend.db.table.qry.rows.set.refine.example">
  594. <title>Utiliser une table intermédiaire par jointure avec <code>fetchAll()</code></title>
  595. <programlisting role="php"><![CDATA[
  596. $table = new Bugs();
  597. $select = $table->select();
  598. $select->where('bug_status = ?', 'NEW')
  599. ->join('accounts', 'accounts.account_name = bugs.reported_by')
  600. ->where('accounts.account_name = ?', 'Bob');
  601. $rows = $table->fetchAll($select);
  602. ]]></programlisting>
  603. </example></para>
  604. <para>L'objet <classname>Zend_Db_Table_Select</classname> est destiné à sélectionner des données sur une
  605. table précise. Des jointures peuvent être faites, mais il n'est pas possible de sélectionner des colonnes ne
  606. faisant pas partie de la table sous-jacente. Cependant, ceci aurait pu être utile dans certains cas, et
  607. l'objet <classname>Zend_Db_Table_Select</classname> possède une clause spéciale déverrouillant cette
  608. limitation. Passez la valeur <code>false</code> à sa méthode <code>setIntegrityCheck</code>. Il est alors
  609. possible de sélectionner des colonnes hors table. Attention toutefois, l'objet row/rowset résultant sera
  610. verrouillé. Impossible d'y appeler <code>save()</code>, <code>delete()</code> ou même d'affecter une valeur
  611. à certains de ses champs. Une exception sera systématiquement levée.</para>
  612. <example id="zend.db.table.qry.rows.set.integrity.example">
  613. <title>Déverrouiller un objet Zend_Db_Table_Select pour récupérer des colonnes JOINtes</title>
  614. <programlisting><![CDATA[
  615. $table = new Bugs();
  616. $select = $table->select()->setIntegrityCheck(false);
  617. $select->where('bug_status = ?', 'NEW')
  618. ->join('accounts',
  619. 'accounts.account_name = bugs.reported_by',
  620. 'account_name')
  621. ->where('accounts.account_name = ?', 'Bob');
  622. $rows = $table->fetchAll($select);
  623. ]]></programlisting>
  624. </example>
  625. </sect3>
  626. </sect2>
  627. <sect2 id="zend.db.table.fetch-row">
  628. <title>Récupérer un seul enregistrement</title>
  629. <para>Vous pouvez demander à ne récupérer qu'un seul résultat, en requêtant de manière similaire à la méthode
  630. <code>fetchAll()</code>.</para>
  631. <example id="zend.db.table.fetch-row.example1">
  632. <title>Exemple de récupération d'un seul enregistrement</title>
  633. <programlisting role="php"><![CDATA[
  634. $table = new Bugs();
  635. $select = $table->select()->where('bug_status = ?', 'NEW')
  636. ->order('bug_id');
  637. $row = $table->fetchRow($select);
  638. ]]></programlisting>
  639. </example>
  640. <para>Cette méthode retourne un objet de type Zend_Db_Table_Row_Abstract. Si la requête ne trouve aucun
  641. enregistrement, alors <code>fetchRow()</code> retournera <code>null</code>.</para>
  642. </sect2>
  643. <sect2 id="zend.db.table.info">
  644. <title>Récupérer les méta données d'une Table</title>
  645. <para>La classe Zend_Db_Table_Abstract propose des informations concernant ses méta données.La méthode
  646. <code>info()</code> retourne un tableau d'informations sur les colonnes, la clé primaire, etc. de la
  647. table.</para>
  648. <example id="zend.db.table.info.example">
  649. <title>Exemple de récupération du nom de la table</title>
  650. <programlisting role="php"><![CDATA[
  651. $table = new Bugs();
  652. $info = $table->info();
  653. echo "The table name is " . $info['name'] . "\n";
  654. ]]></programlisting>
  655. </example>
  656. <para>Les clés du tableau retourné par <code>info()</code> sont les suivantes :</para>
  657. <itemizedlist>
  658. <listitem>
  659. <para><emphasis role="strong">name</emphasis> =&gt; nom de la table.</para>
  660. </listitem>
  661. <listitem>
  662. <para><emphasis role="strong">cols</emphasis> =&gt; un tableau contenant les colonnes de la
  663. table.</para>
  664. </listitem>
  665. <listitem>
  666. <para><emphasis role="strong">primary</emphasis> =&gt; un tableau contenant la(les) colonnes utilisée(s)
  667. pour définir la clé primaire de la table.</para>
  668. </listitem>
  669. <listitem>
  670. <para><emphasis role="strong">metadata</emphasis> =&gt; un tableau associatif, associant les noms des
  671. colonnes de la tables, à leurs informations intrinsèques. Les données sont les mêmes que celles
  672. retournée par <code>describeTable()</code>.</para>
  673. </listitem>
  674. <listitem>
  675. <para><emphasis role="strong">rowClass</emphasis> =&gt; le nom de la classe concrète servant les objets
  676. représentants les enregistrements de la table. Par défaut : Zend_Db_Table_Row.</para>
  677. </listitem>
  678. <listitem>
  679. <para><emphasis role="strong">rowsetClass</emphasis> =&gt; le nom de la classe concrète servant de
  680. conteneur d'objets représentants les enregistrements de la table. Par défaut :
  681. Zend_Db_Table_Rowset.</para>
  682. </listitem>
  683. <listitem>
  684. <para><emphasis role="strong">referenceMap</emphasis> =&gt; un tableau associatif. Il représente les
  685. références de cette table vers ses parents éventuelles. Voyez <xref
  686. linkend="zend.db.table.relationships.defining" />.</para>
  687. </listitem>
  688. <listitem>
  689. <para><emphasis role="strong">dependentTables</emphasis> =&gt; un tableau de noms de classes de tables
  690. qui référencent cette table. Voyez <xref linkend="zend.db.table.relationships.defining" />.</para>
  691. </listitem>
  692. <listitem>
  693. <para><emphasis role="strong">schema</emphasis> =&gt; Le nom de la base de données comportant cette
  694. table.</para>
  695. </listitem>
  696. </itemizedlist>
  697. </sect2>
  698. <sect2 id="zend.db.table.metadata.caching">
  699. <title>Cacher les méta données de la table</title>
  700. <para>Par défaut, <classname>Zend_Db_Table_Abstract</classname> demande à la base de données les <link
  701. linkend="zend.db.table.info">méta données de table</link>, à chaque instanciation d'objet de table. L'objet de
  702. table analyse les métadonnées de la table dans le SGDB en utilisant la méthode <code>describeTable()</code> de
  703. l'adaptateur. Les opérations nécessitant cette introspection incluent :</para>
  704. <itemizedlist>
  705. <listitem>
  706. <para><code>insert()</code></para>
  707. </listitem>
  708. <listitem>
  709. <para><code>find()</code></para>
  710. </listitem>
  711. <listitem>
  712. <para><code>info()</code></para>
  713. </listitem>
  714. </itemizedlist>
  715. <para>Cependant, il peut être dégradant pour les performances du SGBD de lui demander ces informations à chaque
  716. instanciation de chaque objet de chaque table. Ainsi, un système de cache pour les méta données a été mis en
  717. place.</para>
  718. <para>La mise en cache des méta données des tables peut être contrôlée de deux manières: <itemizedlist>
  719. <listitem>
  720. <para><emphasis role="strong">Un appel à la méthode statique
  721. Zend_Db_Table_Abstract::setDefaultMetadataCache()</emphasis> - Ceci permet d'enregistrer une fois
  722. pour toutes l'objet de cache que toutes les tables devront utiliser.</para>
  723. </listitem>
  724. <listitem>
  725. <para><emphasis role="strong">L'appel au constructeur
  726. Zend_Db_Table_Abstract::__construct()</emphasis> - Il va permettre de spécifier l'objet de cache
  727. pour une table en particulier.</para>
  728. </listitem>
  729. </itemizedlist> Dans tous les cas, vous devrez passer soit <code>null</code> (et ainsi désactiver le cache
  730. des méta données des tables), soit une instance de <link
  731. linkend="zend.cache.frontends.core"><classname>Zend_Cache_Core</classname></link>. Il est possible d'utiliser à la fois
  732. <code>setDefaultMetadataCache</code> et le constructeur afin d'avoir un objet de cache par défaut, puis un
  733. spécifique pour certaines classes.</para>
  734. <example id="zend.db.table.metadata.caching-default">
  735. <title>Utiliser un objet de cache de méta données pour toutes les classes</title>
  736. <para>L'exemple qui suit illustre la manière de passer un objet de cache de méta données général, pour
  737. toutes les classes de table :</para>
  738. <programlisting role="php"><![CDATA[
  739. // D'abord, configurons le cache
  740. $frontendOptions = array(
  741. 'automatic_serialization' => true
  742. );
  743. $backendOptions = array(
  744. 'cache_dir' => 'cacheDir'
  745. );
  746. $cache = Zend_Cache::factory('Core',
  747. 'File',
  748. $frontendOptions,
  749. $backendOptions);
  750. // Puis passons le comme objet de cache par défaut
  751. Zend_Db_Table_Abstract::setDefaultMetadataCache($cache);
  752. // Testons avec une classe
  753. class Bugs extends Zend_Db_Table_Abstract
  754. {
  755. // ...
  756. }
  757. // Chaque instance utilise l'objet par défaut
  758. $bugs = new Bugs();
  759. ]]></programlisting>
  760. </example>
  761. <example id="zend.db.table.metadata.caching-instance">
  762. <title>Utiliser un objet de cache de métadonnées pour une instance précise</title>
  763. <para>L'exemple qui suit illustre la manière de passer un objet de cache de méta données spécifique, pour
  764. une instance précise :</para>
  765. <programlisting role="php"><![CDATA[
  766. // D'abord, configurons le cache
  767. $frontendOptions = array(
  768. 'automatic_serialization' => true
  769. );
  770. $backendOptions = array(
  771. 'cache_dir' => 'cacheDir'
  772. );
  773. $cache = Zend_Cache::factory('Core',
  774. 'File',
  775. $frontendOptions,
  776. $backendOptions);
  777. // Testons avec une classe
  778. class Bugs extends Zend_Db_Table_Abstract
  779. {
  780. // ...
  781. }
  782. // Lors de son instanciation, il est possible
  783. // de lui passer l'objet de cache
  784. $bugs = new Bugs(array('metadataCache' => $cache));
  785. ]]></programlisting>
  786. </example>
  787. <note>
  788. <title>Sérialisation automatique avec Cache Frontend</title>
  789. <para>Étant donné que les informations retournées par <classname>describeTable()</classname> le sont sous
  790. forme de tableau, assurez vous que le paramètre <code>automatic_serialization</code> est à <code>true</code>
  791. pour l'objet de la classe <classname>Zend_Cache_Core</classname>.</para>
  792. </note>
  793. <para>Dans nos exemples, nous utilisons <classname>Zend_Cache_Backend_File</classname>, mais vous pouvez utiliser le
  794. backend que vous souhaitez, voyez <link linkend="zend.cache">Zend_Cache</link> pour plus d'informations.</para>
  795. <sect3 id="zend.db.table.metadata.caching.hardcoding">
  796. <title>Coder en dur les métadonnées de tables</title>
  797. <para>Pour cacher les métadonnées une étape plus avant, vous pouvez aussi choisir de coder en dur ces
  798. métadonnées. Dans ce cas particulier, cependant, tout changement au schéma de la table requerra un
  799. changement dans votre code. Ainsi, il est seulement recommandé pour ceux qui sont dans la phase
  800. d'optimisation pour un usage en production.</para>
  801. <para>La structure des métadonnées est comme ceci :</para>
  802. <programlisting role="php"><![CDATA[
  803. protected $_metadata = array(
  804. '<column_name>' => array(
  805. 'SCHEMA_NAME' => <string>,
  806. 'TABLE_NAME' => <string>,
  807. 'COLUMN_NAME' => <string>,
  808. 'COLUMN_POSITION' => <int>,
  809. 'DATA_TYPE' => <string>,
  810. 'DEFAULT' => NULL|<value>,
  811. 'NULLABLE' => <bool>,
  812. 'LENGTH' => <string - length>,
  813. 'SCALE' => NULL|<value>,
  814. 'PRECISION' => NULL|<value>,
  815. 'UNSIGNED' => NULL|<bool>,
  816. 'PRIMARY' => <bool>,
  817. 'PRIMARY_POSITION' => <int>,
  818. 'IDENTITY' => <bool>,
  819. ),
  820. // additional columns...
  821. );
  822. ]]></programlisting>
  823. <para>Une manière simple de récupérer les valeurs appropriées est d'activer le cache des métadonnées et
  824. d'utiliser celles présentes dans votre cache.</para>
  825. <para>Vous pouvez désactiver cette optimisation en mettant à <code>false</code> le paramètre
  826. <code>metadataCacheInClass</code> :</para>
  827. <programlisting role="php"><![CDATA[
  828. // Lors de l'instanciation :
  829. $bugs = new Bugs(array('metadataCacheInClass' => false));
  830. // Ou plus tard :
  831. $bugs->setMetadataCacheInClass(false);
  832. ]]></programlisting>
  833. <para>Ce paramètre est activé par défaut, ce qui assure que le tableau <code>$_metadata</code> n'est chargé
  834. qu'une seule fois par instance</para>
  835. </sect3>
  836. </sect2>
  837. <sect2 id="zend.db.table.extending">
  838. <title>Personnaliser et étendre une classe de Table</title>
  839. <sect3 id="zend.db.table.extending.row-rowset">
  840. <title>Utiliser des objets Row ou Rowset personnalisés</title>
  841. <para>Par défaut, les méthodes de la classe de Table retourne des jeux d'enregistrements comme étant des
  842. instances de la classe <classname>Zend_Db_Table_Rowset</classname>, ces "Rowsets" contiennent des enregistrements de
  843. la table, représentés par des objets instances de <classname>Zend_Db_Table_Row</classname>. Vous pouvez spécifier vos
  844. propres classes pour row/rowset, mais elles doivent étendre <classname>Zend_Db_Table_Rowset_Abstract</classname> ou
  845. <classname>Zend_Db_Table_Row_Abstract</classname>, respectivement.</para>
  846. <para>Vous pouvez spécifier vos classes row/rowset en utilisant le constructeur de la classe de Table, via
  847. le tableau d'options, aux clés <code>"rowClass"</code> et <code>"rowsetClass"</code>. Indiquez les noms des
  848. classes sous forme de chaînes de caractères.</para>
  849. <example id="zend.db.table.extending.row-rowset.example">
  850. <title>Exemple de spécification de ses propres classes Row et Rowset</title>
  851. <programlisting role="php"><![CDATA[
  852. class My_Row extends Zend_Db_Table_Row_Abstract
  853. {
  854. ...
  855. }
  856. class My_Rowset extends Zend_Db_Table_Rowset_Abstract
  857. {
  858. ...
  859. }
  860. $table = new Bugs(
  861. array(
  862. 'rowClass' => 'My_Row',
  863. 'rowsetClass' => 'My_Rowset'
  864. )
  865. );
  866. $where = $table->getAdapter()->quoteInto('bug_status = ?', 'NEW')
  867. // Retourne un objet de type My_Rowset,
  868. // contenant des objets de type My_Row.
  869. $rows = $table->fetchAll($where);
  870. ]]></programlisting>
  871. </example>
  872. <para>Vous pouvez aussi utiliser les méthodes <code>setRowClass()</code> et <code>setRowsetClass()</code>.
  873. Ceci s'applique alors de manière ponctuelle, et non plus globale pour toute la classe de Table en tout
  874. point.</para>
  875. <example id="zend.db.table.extending.row-rowset.example2">
  876. <title>Exemple de changement ponctuel des classes de Row et Rowset</title>
  877. <programlisting role="php"><![CDATA[
  878. $table = new Bugs();
  879. $where = $table->getAdapter()->quoteInto('bug_status = ?', 'NEW')
  880. // Retourne un objet de type Zend_Db_Table_Rowset
  881. // contenant des objets de type Zend_Db_Table_Row.
  882. $rowsStandard = $table->fetchAll($where);
  883. $table->setRowClass('My_Row');
  884. $table->setRowsetClass('My_Rowset');
  885. // Retourne un objet de type My_Rowset,
  886. // contenant des objets de type My_Row.
  887. $rowsCustom = $table->fetchAll($where);
  888. // L'objet $rowsStandard existe toujours et n'a pas changé d'état.
  889. ]]></programlisting>
  890. </example>
  891. <para>Pour des informations détaillées concernant les classes Row et Rowset, voyez <xref
  892. linkend="zend.db.table.row" /> et <xref linkend="zend.db.table.rowset" />.</para>
  893. </sect3>
  894. <sect3 id="zend.db.table.extending.insert-update">
  895. <title>Personnaliser les logiques Insert, Update, et Delete</title>
  896. <para>Vous pouvez redéfinir les méthodes <code>insert()</code> et <code>update()</code> afin d'y ajouter
  897. votre propre logique. Assurez vous d'appeler les méthodes parentes une fois votre code écrit.</para>
  898. <example id="zend.db.table.extending.insert-update.example">
  899. <title>Exemple d'implémentation d'une logique personnalisée gérant des timestamps</title>
  900. <programlisting role="php"><![CDATA[
  901. class Bugs extends Zend_Db_Table_Abstract
  902. {
  903. protected $_name = 'bugs';
  904. public function insert(array $data)
  905. {
  906. // Ajout d'un timestamp
  907. if (empty($data['created_on'])) {
  908. $data['created_on'] = time();
  909. }
  910. return parent::insert($data);
  911. }
  912. public function update(array $data, $where)
  913. {
  914. // Ajout d'un timestamp
  915. if (empty($data['updated_on'])) {
  916. $data['updated_on'] = time();
  917. }
  918. return parent::update($data, $where);
  919. }
  920. }
  921. ]]></programlisting>
  922. </example>
  923. <para>Il est aussi possible de redéfinir la méthode <code>delete()</code>.</para>
  924. </sect3>
  925. <sect3 id="zend.db.table.extending.finders">
  926. <title>Définir des méthodes de recherches personnalisées dans Zend_Db_Table</title>
  927. <para>Bien que <code>fetchAll()</code> fonctionne très bien, si vous avez plusieurs appels similaires à
  928. cette méthode (ou une autre), il peut être intéressant de factoriser du code en créant votre propre méthode
  929. de récupération d'enregistrements, utilisant <code>fetchAll()</code> ou une autre méthode.</para>
  930. <example id="zend.db.table.extending.finders.example">
  931. <title>Méthode personnalisée de récupération d'enregistrements "bugs" par critère "status"</title>
  932. <programlisting role="php"><![CDATA[
  933. class Bugs extends Zend_Db_Table_Abstract
  934. {
  935. protected $_name = 'bugs';
  936. public function findByStatus($status)
  937. {
  938. $where = $this->getAdapter()->quoteInto('bug_status = ?',
  939. $status);
  940. return $this->fetchAll($where, 'bug_id');
  941. }
  942. }
  943. ]]></programlisting>
  944. </example>
  945. </sect3>
  946. <sect3 id="zend.db.table.extending.inflection">
  947. <title>Utiliser l'inflexion dans Zend_Db_Table</title>
  948. <para>L'<emphasis>inflexion</emphasis> est un processus de transformations de caractères. Par défaut, si
  949. vous ne définissez pas de nom à votre table via la propriété protégée <code>$_name</code>,
  950. <classname>Zend_Db_Table_Abstract</classname> va utiliser le nom de la classe comme nom de table, sans effectuer
  951. aucune transformation.</para>
  952. <para>Certaines personnes peuvent vouloir utiliser un mécanisme d'inflexion pour transformer le nom de la
  953. classe d'une manière bien spécifique, afin de retrouver le nom de la table.</para>
  954. <para>Par exemple, une classe nommée "<code>BugsProducts</code>", peut vouloir refléter une table s'appelant
  955. "<code>bugs_products</code>," sans utiliser la propriété de classe <code>$_name</code>. Dans cette règle
  956. d'inflexion, les mots composant le nom de la classe sont écrits en "CamelCase", et seraient transformés en
  957. mots en minuscules, et séparés par des tirets bas.</para>
  958. <para>Vous pouvez aussi spécifier le nom de la table indépendamment du nom de la classe. Utilisez pour cela
  959. la propriété <code>$_name</code> de la classe de Table.</para>
  960. <para>Si vous voulez utiliser l'inflexion, vous devrez créer une classe (abstraite) étendant
  961. <classname>Zend_Db_Table_Abstract</classname>, et redéfinissant sa méthode protégée <code>_setupTableName()</code>.
  962. Toutes les classes de Table devront alors hériter de cette nouvelle classe abstraite.</para>
  963. <example id="zend.db.table.extending.inflection.example">
  964. <title>Exemple d'une classe abstraite utilisant l'inflexion</title>
  965. <programlisting role="php"><![CDATA[
  966. abstract class MyAbstractTable extends Zend_Db_Table_Abstract
  967. {
  968. protected function _setupTableName()
  969. {
  970. if (!$this->_name) {
  971. $this->_name = myCustomInflector(get_class($this));
  972. }
  973. parent::_setupTableName();
  974. }
  975. }
  976. class BugsProducts extends MyAbstractTable
  977. {
  978. }
  979. ]]></programlisting>
  980. </example>
  981. <para>C'est à vous d'écrire les fonctions qui vont établir le mécanisme d'inflexion.</para>
  982. </sect3>
  983. </sect2>
  984. </sect1>