Projet

Général

Profil

Propel crud » Historique » Version 2

Anonyme, 01/01/2009 14:03

1 1
''Ceci est une traduction libre de la page officielle de la documentation de Propel [http://propel.phpdb.org/trac/wiki/Users/Documentation/1.3/BasicCRUD /ICI]''
2
3
 = Base C.R.U.D. Opérations = 
4
5
 Ce guide va vous montrer comment effectuer les opérations de base CRUD (Créer, récupérer, UPDATE, DELETE) sur votre base de données en utilisant Propel. Par souci de cohérence, nous allons utiliser la librairie simplifié exemple modèle de données du Guide de démarrage rapide. 
6
7
 Les exemples dans ce guide suppose que vous avez déjà installé et paramétré Propel. 
8
9
 == CREATE == 
10
11
 Pour ajouter de nouvelles données dans la base de données, il faut instancier un des objets générés par Propel et ensuite appeler la méthode setChamp() appropriée. Propel générera le SQL qui va bien pour faire l'insertion. 
12
13
 === Simple INSERT ===
14
15
 Dans sa forme la plus simple, on crée un nouveau tuple de cette façon : 
16
17
18
{{{
19
# php 
20
 / * Initialiser Propel, etc * / 
21
22
 $ author = new Author (); 
23
 $ author-> setFirstName ( "Jack"); 
24
 $ author-> setLastName ( "London"); 
25
 $ author-> save ();
26
}}}
27
 
28
Propel va traduire ces lignes de code par :
29
30
{{{
31
#! sql 
32
 INSERT INTO auteur (prenom, nom) VALUES ( 'Jack', 'London');
33
}}}
34
35
36 2
 === Gérer les insertions connexes === 
37 1
38
 De plus, Propel sait si un objet a été sauvegardé ou pas. Donc on peut créer plusiers tuples de plusieurs tables différents et tout sauvegarder une seule fois :
39
40
{{{
41
 #! php 
42
 / * Initialiser Propel, etc * / 
43
44
 / / 1) Créer un Auteur (rangée de 'auteur' tableau) 
45
46
 include_once 'librairie / Author.php'; 
47
48
 $ author = new Author (); 
49
 $ author-> setFirstName ( "Leo"); 
50
 $ author-> setLastName ( "Tolstoï"); 
51
 / / Note: ce tuple n'est pas encore dans la base
52
53
 / / 2) Créer un Editeur (ligne de "éditeur" tableau) 
54
55
 include_once 'librairie / Publisher.php'; 
56
57
 $ pub = new Editeur (); 
58
 $ pub-> setName ( "Viking Press"); 
59
 / / Note: ce tuple n'est pas encore dans la base 
60
61
 / / 3) Créer un livre (ligne de "livre" tableau) 
62
63
 include_once 'librairie / Book.php'; 
64
65
 $ livre = new livre (); 
66
 $ livre-> setTitle ( "Guerre et Paix"); 
67
 $ livre-> setIsbn ( "0140444173"); 
68
 $ livre-> setPublisher ($ pub); 
69
 $ livre-> setAuthor ($ author); 
70
 $ livre-> save (); / / enregistre l'ensemble des 3 objets dans la base avec les dépendances (clés étrangères) qui vont bien ! 
71
}}}
72
73
 Parce que Propel sait si un objet a été enregistré ou non, il est capable avec save () d'analyser tous les objets avant de les ajouter en gérant les relations à l'objet livre. (Plus d'info à ce sujet sur le site de Propel : [http://propel.phpdb.org/trac/wiki/Users/Documentation/1.3/Relationships Relationships]) .
74
75
 == RETRIEVE ==
76
77 2
 Récupérer des objets de la base de données, également dénommé''objets''hydratant, comme quand on effectue une requête SELECT pour peupler toutes les propriétés de l'objet peut se faire à l'aide des méthodes statiques PEER pour vérifier si ces enregistrements existent dans la table. CEs classes PEER ne contiennent que des méthodes statiques qui permettent d'effectuer des opérations sur la table.
78
Il existe plusieurs méthodes pour vous aider à choisir un seul ou plusieurs objets de la base de données. 
79 1
80 2
 === Récupération par la clé primaire === 
81 1
82 2
 La façon la plus simple pour récupérer un objet (ligne) de la base de données, est d'utiliser la méthode ''retrieveByPK()''. Comme d'habitude, il faut fournir la valeur de la clé primaire en argument à cette méthode.
83 1
84
 ==== Unique PK-colonel ==== 
85
86 2
 Habituellement, votre table aura une seule clé primaire, ce qui signifie que la méthode ''retrieveByPK()'' accepte un seul paramètre. 
87 1
88 2
{{{
89 1
 #! php 
90
91
92 2
 $firstBook = BookPeer::retrieveByPK (1); 
93
 // $firstBook est maintenant est un objet livre, ou NULL si aucune correspondance n'a été trouvée. 
94
}}}
95
96 1
 ==== Multi-colonel PK ==== 
97
98 2
 Dans certains cas, votre clé primaire est composée de plusieurs colonnes. Dans ce cas, ''retrieveByPK()'' sera créé pour accepter des paramètres multiples, un pour chaque colonne de clé primaire. 
99 1
100
 Par exemple, si nous avions un tableau, avec un multi-colonne de clé primaire, définie comme ceci: 
101 2
{{{
102 1
 #! xml 
103
    <table name="multicolpk_example" phpName="MultiColPKExample"> 
104
       <column name="id1" type="INTEGER" primaryKey="true"/> 
105
       <column name="id2" type="INTEGER" primaryKey="true"/> 
106
       <! - Les autres colonnes ... -> 
107
    </ table> 
108 2
}}}
109 1
110 2
 ... alors votre méthode retrieveByPK()'' serait invoquée comme ceci: 
111 1
112 2
{{{
113 1
 #! php 
114
115 2
 $myObject = MultiColPKExamplePeer::retrieveByPK (1,2); 
116
}}}
117 1
118
 ==== Obtenir plusieurs objets par PK ==== 
119
120
 Vous pouvez également sélectionner plusieurs objets en fonction de leurs clés primaires, en appelant le généré retrieveByPKs''()''méthode, qui prend en paramètre un tableau de clés primaires: 
121
122 2
{{{
123 1
 #! php 
124
125 2
 $selectedBooks = BookPeer::retrieveByPKs(array (1,2,3,4,5,6,7));
126
 // $ SelectedBooks est un tableau d'objets Réservez 
127
}}}
128 1
129
 ''Il est à noter que ceci ne fonctionne que pour les tables avec une seule colonne de clés primaires.'' 
130
131
 === Interrogation de la base de données === 
132
133 2
 Pour sélectionner plusieurs lignes par des critères autres que la clé primaire, nous avons deux choix:[[BR]]
134
 1) d'utiliser la classe Criteria, ou[[BR]]
135
 2) d'écrire du SQL personnalisé. La classe ''Criteria'' offre une approche relativement simple à la construction d'une requête. C'est la base de données logique de neutralité et de simplicité en faire un bon choix pour l'expression d'un grand nombre de requêtes, mais pour une requête très complexe, elle mai s'avérer plus efficace (et moins douloureuses) à simplement utiliser une requête SQL personnalisée à hydrater votre Propel objets. 
136 1
137 2
 ==== Critères simples ==== 
138 1
139
 Voici quelques exemples de critères simples être utilisé pour renvoyer plusieurs objets. 
140
141 2
 '' 'Exemple 1:''' Trouver tous les auteurs dont le  prenom est Karl, mais dont le nom n'est pas Marx. 
142 1
143 2
{{{
144 1
 #! php 
145
146 2
 $c = new Criteria(); 
147
 $c->add(AuthorPeer::FIRST_NAME, "Karl"); 
148
 $c->add(AuthorPeer::LAST_NAME, "Marx", Criteria::NOT_EQUAL); 
149 1
150 2
 $auteurs = AuthorPeer::doSelect($c); 
151
 // $auteurs contient un tableau des auteurs de l'auteur objets 
152
}}}
153 1
154 2
 ... on obtient les mêmes résultats qu'avec la requête SQL suivante: 
155
{{{ 
156 1
 #! sql 
157 2
 SELECT ... FROM author WHERE author.FIRST_NAME = 'Karl' AND author.LAST_NAME <> 'Marx';
158 1
159 2
}}}
160 1
161 2
 '' 'Exemple 2:''' Trouver tous les auteurs dont le nom est Tolstoy, Dostoevsky, ou Bakhtin
162
163
{{{
164 1
 #! php 
165
166 2
$c = new Criteria();
167
$c->add(AuthorPeer::LAST_NAME, array("Tolstoy", "Dostoevsky", "Bakhtin"), Criteria::IN);
168 1
169 2
$authors = AuthorPeer::doSelect($c);
170 1
171 2
 // $authors contient un tableau des objets auteurs
172
}}}
173
174
 ... on obtient les mêmes résultats qu'avec la requête SQL suivante: 
175
{{{
176 1
 #! sql 
177 2
 SELECT ... FROM author WHERE author.LAST_NAME IN ('Tolstoy', 'Dostoevsky', 'Bakhtin');
178
 
179
}}}
180
181
= J'en suis ICI, IL FAUT ENCORE FINIR DE TRADUIRE VRAIMENT =
182 1
183
184
 Logiquement ==== ==== Complexe Critères 
185
186
 Quand vous avez besoin d'exprimer relations logiques (ET, OU, etc) entre les différents critères de clauses, vous devez combiner manuellement chaque Critère''''objets ensemble. Le critère''''les objets sont les composants qui sont assemblés en toute transparence les critères''''objet lorsque vous utilisez les critères''-> ajouter ()''méthode. 
187
188
 '' 'Exemple 1:''' Trouver tous les auteurs avec le premier nom de "Leo" ou le dernier nom de "Tolstoï", "Dostoïevski", ou "Bakhtine" 
189
190
 ((( 
191
 #! php 
192
 <? php 
193
194
 $ c = de nouveaux critères (); 
195
 cton1 $ = $ c-> getNewCriterion (AuthorPeer:: first_name, "Léon"); 
196
 cton2 $ = $ c-> getNewCriterion (AuthorPeer:: nom, array ( "Tolstoï", "Dostoïevski", "Bakhtine"), Critères:: IN); 
197
 
198
 / / Les combiner 
199
 $ cton1-> Addor ($ cton2); 
200
 
201
 / / Ajouter les critères 
202
 $ c-> add ($ cton1); 
203
 ))) 
204
205
 ... résultats dans la requête SQL comme: 
206
 ((( 
207
 #! sql 
208
 SELECT ... De l'auteur WHERE (author.FIRST_NAME = 'Leo' OU DANS author.LAST_NAME ( «Tolstoï», «Dostoïevski», «Bakhtine ')); 
209
 ))) 
210
211
 Il ya aussi des''critères''raccourcis si vous souhaitez effectuer une requête avec les relations logiques entre les clauses de référence que''la même colonne''. 
212
213
 '' 'Exemple 2:''' Trouver tous les auteurs avec le premier nom de «Leo» ou «Karl» 
214
215
 Utiliser Critère verbose''approche'', cela ressemble à: 
216
 ((( 
217
 #! php 
218
 <? php 
219
220
 $ c = de nouveaux critères (); 
221
 cton1 $ = $ c-> getNewCriterion (AuthorPeer:: first_name, "Léon"); 
222
 cton2 $ = $ c-> getNewCriterion (AuthorPeer:: first_name, "Karl"); 
223
 
224
 / / Les combiner 
225
 $ cton1-> Addor ($ cton2); 
226
 
227
 / / Ajouter les critères 
228
 $ c-> add ($ cton1); 
229
 ))) 
230
231
 En utilisant un raccourci''''méthodes Critères: 
232
 ((( 
233
 #! php 
234
 <? php 
235
236
 $ c = de nouveaux critères (); 
237
 $ c-> ajouter (AuthorPeer:: first_name, "Léon"); 
238
 $ c-> Addor (AuthorPeer:: first_name, "Karl"); 
239
 ))) 
240
241
 Il est important de noter que ces critères sténographie''''méthodes ont un certain nombre de limites - surtout qu'ils ne fonctionne que pour les relations seule colonne. De l'auteur, il est conseillé de ne pas utiliser ces méthodes lorsque vous avez besoin d'exprimer les relations entre logique clause car ils masquent le réel entre les relationsihps Critère''et''objets peuvent facilement conduire à difficiles à déboguer les problèmes de génération de requête. (Ces méthodes vont probablement changer ou disparaître dans Propel 2). 
242
243
 Utiliser ==== ==== SQL personnalisé 
244
245
 Propel est conçu pour travailler avec vous plutôt que contre vous. Dans de nombreux cas, la rédaction d'un complexe requête en utilisant les critères''''finit par être vraiment désordre et encore moins intelligible ou à maintenir un niveau de requête SQL. Propel a été créé pour travailler les limites inhérentes d'une base de données''neutre''système de critères en la rendant facile pour vous d'utiliser vos propres requêtes SQL pour les ensembles de résultats hydrate. 
246
247
 Ainsi, avec seulement un peu plus de travail, vous pouvez également obtenir des objets de votre base de données en utilisant SQL. Utiliser SQL pour interroger la base de données nous introduit à la populateObjects généré''()''méthode dans notre classes Peer - qui est appelé dans les coulisses par la doSelect''()''méthode. Cette méthode attend d'être adopté une créole''!''Objet ResultSet, indexé numériquement (c'est-à-dire qui a été créé à l'aide! ResultSet:: FETCHMODE_NUM option''à executeQuery ()''). 
248
249
 '' 'Exemple 1:''' Utilisez des sous-sélectionne pour peupler la base de données 
250
251
 ((( 
252
 #! php 
253
 <? php 
254
255
 $ con = Propel:: getConnection (database_name); 
256
257
 $ sql = "SELECT .* livres des livres lorsqu'ils ne sont pas EXISTS (SELECT id de l'examen OÙ book_id = book.id)"; 
258
 $ stmt = $ con-> prepare ($ sql); 
259
 $ stmt-> execute (); 
260
261
 $ livres = BookPeer:: populateObjects ($ stmt); 
262
 ))) 
263
264
 Des choses importantes à retenir lorsque vous utilisez SQL personnalisé pour remplir Propel: 
265
   *! ResultSet colonne doit être indexé numériquement 
266
   *! ResultSet doit contenir toutes les colonnes de l'objet 
267
   *! ResultSet doit avoir les colonnes''dans le même ordre'', telles qu'elles sont définies dans le (((schema.xml))) fichier 
268
269
 MISE À JOUR == == 
270
271
 Mise à jour de la base de données comporte essentiellement des lignes de récupérer des objets, de modifier le contenu, puis les enregistrer. Dans la pratique, pour Propel, il s'agit d'une combinaison de ce que nous avons déjà vu dans le récupérer et créer des sections. 
272
273
 ((( 
274
 #! php 
275
 <? php 
276
277
 / / 1) Récupère un objet de clé primaire 
278
279
 = $ myBook BookPeer:: retrieveByPK (1); 
280
281
 / / 2) de mettre à jour les valeurs et save (). 
282
283
 myBook $ -> setTitle ( "Guerre et Paix"); 
284
 $ myBook-> save (); 
285
 ))) 
286
287
 Il n'y a vraiment pas grand-chose de bien plus que cela. Bien sûr, vous pouvez également mettre à jour les relations d'une manière similaire à ce qui a déjà été démontré dans la section CREATE. 
288
289
 ((( 
290
 #! php 
291
 <? php 
292
 / * Initialiser Propel, etc * / 
293
294
 / / 1) Auteur de récupérer une 
295
 $ auteur = AuthorPeer:: retrieveByPK (1); 
296
297
 / / 2) récupérer un livre 
298
 $ livre = BookPeer:: retrieveByPK (1); 
299
300
 / / 3) maintenant aveuglément set $ auteur que l'auteur de livre $! 
301
302
 $ livre-> setAuthor ($ author); 
303
 $ livre-> save (); 
304
 ))) 
305
306
 == == DELETE 
307
308
 Suppression d'objets peut être accompli en utilisant les classes Peer ou l'objet classes. 
309
310
 === === L'aide par les pairs 
311
312
 Vous pouvez utiliser les produits doDelete''()''de la méthode générée par les pairs des classes à supprimer des lignes de vos tables. Vous pouvez passer cette méthode une clé primaire, une instance de l'objet, ou même un objet de critères (mais ce n'est pas très utile, puisque vous ne pouvez supprimer que par la clé primaire). 
313
314
 '' 'Exemple 1:''' Supprimer l'aide de la clé primaire 
315
316
 ((( 
317
 #! php 
318
 <? php 
319
320
 BookPeer:: doDelete (1); 
321
 ))) 
322
323
 '' 'Exemple 2:''' Supprimer l'aide de l'objet instancié 
324
325
 ((( 
326
 #! php 
327
 <? php 
328
329
 $ livre = BookPeer:: retrieveByPK (1); 
330
 BookPeer:: doDelete ($ livre); 
331
 ))) 
332
333
 L'aide d'objets === === 
334
335
 Par souci de cohérence avec d'autres C.R.U.D. opérations, vous pouvez également supprimer la ligne d'une base de données à l'aide de la classe d'objets. Certaines personnes préfèrent le faire de cette façon, l'instanciation d'un objet, puis appeler la''delete ()''méthode sur celle-ci. D'autres estiment que cela est "bizarre", car alors vous êtes à gauche avec un objet qui ne fait point à la ligne une base de données. Quel que soit - vous êtes libre de choisir:) 
336
337
 ((( 
338
 #! php 
339
 $ livre = BookPeer:: retrieveByPK (1); 
340
 $ livre-> delete (); 
341
 / / (Et maintenant vous devez vous rappeler que vous ne pouvez plus utiliser l'objet $ livre) 
342
 )))