Propel crud » Historique » Révision 2
Révision 1 (Anonyme, 31/12/2008 11:18) → Révision 2/6 (Anonyme, 01/01/2009 14:03)
''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]''
= Base C.R.U.D. Opérations =
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.
Les exemples dans ce guide suppose que vous avez déjà installé et paramétré Propel.
== CREATE ==
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.
=== Simple INSERT ===
Dans sa forme la plus simple, on crée un nouveau tuple de cette façon :
{{{
# php
/ * Initialiser Propel, etc * /
$ author = new Author ();
$ author-> setFirstName ( "Jack");
$ author-> setLastName ( "London");
$ author-> save ();
}}}
Propel va traduire ces lignes de code par :
{{{
#! sql
INSERT INTO auteur (prenom, nom) VALUES ( 'Jack', 'London');
}}}
=== Gérer les insertions Rangée Insérer connexes ===
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 :
{{{
#! php
/ * Initialiser Propel, etc * /
/ / 1) Créer un Auteur (rangée de 'auteur' tableau)
include_once 'librairie / Author.php';
$ author = new Author ();
$ author-> setFirstName ( "Leo");
$ author-> setLastName ( "Tolstoï");
/ / Note: ce tuple n'est pas encore dans la base
/ / 2) Créer un Editeur (ligne de "éditeur" tableau)
include_once 'librairie / Publisher.php';
$ pub = new Editeur ();
$ pub-> setName ( "Viking Press");
/ / Note: ce tuple n'est pas encore dans la base
/ / 3) Créer un livre (ligne de "livre" tableau)
include_once 'librairie / Book.php';
$ livre = new livre ();
$ livre-> setTitle ( "Guerre et Paix");
$ livre-> setIsbn ( "0140444173");
$ livre-> setPublisher ($ pub);
$ livre-> setAuthor ($ author);
$ livre-> save (); / / enregistre l'ensemble des 3 objets dans la base avec les dépendances (clés étrangères) qui vont bien !
}}}
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]) .
== RETRIEVE ==
Récupérer des objets de la base de données, également dénommé''objets''hydratant, comme quand on effectue une est essentiellement le processus d'exécution d'une requête SELECT sur la base de données pour peupler toutes les propriétés une nouvelle instance de l'objet peut se faire à l'aide des méthodes statiques PEER avec le contenu de chaque ligne retournée.
Dans Propel, vous utilisez la générés par les pairs''''classes existantes pour vérifier si ces enregistrements existent dans sélectionner les lignes de la table. CEs base de données. Les classes PEER ne contiennent que Peer sont des classes exclusivement avec des méthodes statiques qui permettent d'effectuer pour effectuer des opérations sur la table.
une table particulière. Il existe plusieurs méthodes produites pour vous aider à choisir un seul objet ou d'interrogation pour plusieurs objets de la base de données.
=== Récupération par de la clé primaire ===
La façon la plus simple pour récupérer un objet (ligne) de la base de données, est d'utiliser la les produits retrieveByPK''()''méthode. Cette méthode ''retrieveByPK()''. Comme d'habitude, il faut fournir doit être la valeur de la clé primaire en argument à cette méthode.
pour l'objet que vous souhaitez récupérer.
==== Unique PK-colonel ====
Habituellement, votre table aura une seule colonne comme une clé primaire, ce qui signifie que la méthode ''retrieveByPK()'' retrieveByPK''()''méthode accepte un seul paramètre.
{{{
(((
#! php
$firstBook
<? php
firstBook $ = BookPeer::retrieveByPK BookPeer:: retrieveByPK (1);
// $firstBook est / / $ FirstBook maintenant est un objet livre, livre objet, ou NULL si aucune correspondance n'a été trouvée.
}}}
)))
==== Multi-colonel PK ====
Dans certains cas, votre clé primaire est composée mai composé de plusieurs colonnes. plus d'une colonne. Dans ce cas, ''retrieveByPK()'' la retrieveByPK''()''méthode sera créé pour accepter des paramètres multiples, un pour chaque colonne de clé primaire.
Par exemple, si nous avions un tableau, avec un multi-colonne de clé primaire, définie comme ceci:
{{{
(((
#! xml
<table name="multicolpk_example" phpName="MultiColPKExample">
<column name="id1" type="INTEGER" primaryKey="true"/>
<column name="id2" type="INTEGER" primaryKey="true"/>
<! - Les autres colonnes ... ->
</ table>
}}}
)))
... alors votre méthode retrieveByPK()'' retrieveByPK''()''méthode serait invoquée comme ceci:
{{{
(((
#! php
<? php
$myObject myObject $ = MultiColPKExamplePeer::retrieveByPK MultiColPKExamplePeer:: retrieveByPK (1,2);
}}}
)))
==== Obtenir plusieurs objets par PK ====
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:
{{{
(((
#! php
<? php
$selectedBooks selectedBooks $ = BookPeer::retrieveByPKs(array BookPeer:: retrieveByPKs (array (1,2,3,4,5,6,7));
//
/ / $ SelectedBooks est un tableau d'objets Réservez
}}}
)))
''Il est à noter que ceci ne fonctionne que pour les tables avec une seule colonne de clés primaires.''
=== Interrogation de la base de données ===
Pour sélectionner plusieurs lignes par des critères autres que la clé primaire, nous avons deux choix:[[BR]]
choix: 1) d'utiliser la classe Criteria, ou[[BR]]
Propel la''classe''de critères, ou 2) d'écrire du SQL personnalisé. La classe ''Criteria'' offre Les critères de''classe''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.
==== ==== Critères simples ====
Voici quelques exemples de critères simples être utilisé pour renvoyer plusieurs objets.
'' 'Exemple 1:''' Trouver tous les auteurs dont avec le prenom est premier nom de Karl, mais dont le nom n'est pas est _pas_ Marx.
{{{
(((
#! php
<? php
$c $ c = new Criteria(); de nouveaux critères ();
$c->add(AuthorPeer::FIRST_NAME, $ c-> ajouter (AuthorPeer:: first_name, "Karl");
$c->add(AuthorPeer::LAST_NAME, $ c-> ajouter (AuthorPeer:: nom, "Marx", Criteria::NOT_EQUAL); Critères:: NOT_EQUAL);
$auteurs = AuthorPeer::doSelect($c); $ auteurs AuthorPeer:: doSelect ($ c);
// $auteurs / / $ Array contient un tableau des auteurs de l'auteur objets
}}}
)))
... on obtient les mêmes résultats qu'avec dans la requête SQL suivante:
{{{ comme:
(((
#! sql
SELECT ... FROM author WHERE De l'auteur OÙ author.FIRST_NAME = 'Karl' AND ET author.LAST_NAME <> 'Marx';
}}}
)))
'' 'Exemple 2:''' Trouver tous les auteurs dont avec le dernier nom est Tolstoy, Dostoevsky, de Tolstoï, Dostoïevski, ou Bakhtin
{{{
Bakhtine
(((
#! php
$c
<? php
$ c = new Criteria();
$c->add(AuthorPeer::LAST_NAME, array("Tolstoy", "Dostoevsky", "Bakhtin"), Criteria::IN);
$authors de nouveaux critères ();
$ c-> ajouter (AuthorPeer:: nom, array ( "Tolstoï", "Dostoïevski", "Bakhtine"), Critères:: IN);
= AuthorPeer::doSelect($c);
// $authors $ auteurs AuthorPeer:: doSelect ($ c);
/ / $ Array contient un tableau des auteurs de l'auteur objets auteurs
}}}
)))
... on obtient les mêmes résultats qu'avec dans la requête SQL suivante:
{{{
comme:
(((
#! sql
SELECT ... FROM author WHERE De l'auteur OU DANS author.LAST_NAME IN ('Tolstoy', 'Dostoevsky', 'Bakhtin');
}}}
= J'en suis ICI, IL FAUT ENCORE FINIR DE TRADUIRE VRAIMENT =
( «Tolstoï», «Dostoïevski», «Bakhtine ');
)))
Logiquement ==== ==== Complexe Critères
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.
'' 'Exemple 1:''' Trouver tous les auteurs avec le premier nom de "Leo" ou le dernier nom de "Tolstoï", "Dostoïevski", ou "Bakhtine"
(((
#! php
<? php
$ c = de nouveaux critères ();
cton1 $ = $ c-> getNewCriterion (AuthorPeer:: first_name, "Léon");
cton2 $ = $ c-> getNewCriterion (AuthorPeer:: nom, array ( "Tolstoï", "Dostoïevski", "Bakhtine"), Critères:: IN);
/ / Les combiner
$ cton1-> Addor ($ cton2);
/ / Ajouter les critères
$ c-> add ($ cton1);
)))
... résultats dans la requête SQL comme:
(((
#! sql
SELECT ... De l'auteur WHERE (author.FIRST_NAME = 'Leo' OU DANS author.LAST_NAME ( «Tolstoï», «Dostoïevski», «Bakhtine '));
)))
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''.
'' 'Exemple 2:''' Trouver tous les auteurs avec le premier nom de «Leo» ou «Karl»
Utiliser Critère verbose''approche'', cela ressemble à:
(((
#! php
<? php
$ c = de nouveaux critères ();
cton1 $ = $ c-> getNewCriterion (AuthorPeer:: first_name, "Léon");
cton2 $ = $ c-> getNewCriterion (AuthorPeer:: first_name, "Karl");
/ / Les combiner
$ cton1-> Addor ($ cton2);
/ / Ajouter les critères
$ c-> add ($ cton1);
)))
En utilisant un raccourci''''méthodes Critères:
(((
#! php
<? php
$ c = de nouveaux critères ();
$ c-> ajouter (AuthorPeer:: first_name, "Léon");
$ c-> Addor (AuthorPeer:: first_name, "Karl");
)))
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).
Utiliser ==== ==== SQL personnalisé
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.
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 ()'').
'' 'Exemple 1:''' Utilisez des sous-sélectionne pour peupler la base de données
(((
#! php
<? php
$ con = Propel:: getConnection (database_name);
$ sql = "SELECT .* livres des livres lorsqu'ils ne sont pas EXISTS (SELECT id de l'examen OÙ book_id = book.id)";
$ stmt = $ con-> prepare ($ sql);
$ stmt-> execute ();
$ livres = BookPeer:: populateObjects ($ stmt);
)))
Des choses importantes à retenir lorsque vous utilisez SQL personnalisé pour remplir Propel:
*! ResultSet colonne doit être indexé numériquement
*! ResultSet doit contenir toutes les colonnes de l'objet
*! ResultSet doit avoir les colonnes''dans le même ordre'', telles qu'elles sont définies dans le (((schema.xml))) fichier
MISE À JOUR == ==
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.
(((
#! php
<? php
/ / 1) Récupère un objet de clé primaire
= $ myBook BookPeer:: retrieveByPK (1);
/ / 2) de mettre à jour les valeurs et save ().
myBook $ -> setTitle ( "Guerre et Paix");
$ myBook-> save ();
)))
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.
(((
#! php
<? php
/ * Initialiser Propel, etc * /
/ / 1) Auteur de récupérer une
$ auteur = AuthorPeer:: retrieveByPK (1);
/ / 2) récupérer un livre
$ livre = BookPeer:: retrieveByPK (1);
/ / 3) maintenant aveuglément set $ auteur que l'auteur de livre $!
$ livre-> setAuthor ($ author);
$ livre-> save ();
)))
== == DELETE
Suppression d'objets peut être accompli en utilisant les classes Peer ou l'objet classes.
=== === L'aide par les pairs
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).
'' 'Exemple 1:''' Supprimer l'aide de la clé primaire
(((
#! php
<? php
BookPeer:: doDelete (1);
)))
'' 'Exemple 2:''' Supprimer l'aide de l'objet instancié
(((
#! php
<? php
$ livre = BookPeer:: retrieveByPK (1);
BookPeer:: doDelete ($ livre);
)))
L'aide d'objets === ===
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:)
(((
#! php
$ livre = BookPeer:: retrieveByPK (1);
$ livre-> delete ();
/ / (Et maintenant vous devez vous rappeler que vous ne pouvez plus utiliser l'objet $ livre)
)))