Zend_Db_Table.xml 63 KB

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