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