0 follower

Data Access Objects (DAO)

Etablir une connexion à une base
Exécution de requêtes SQL
Parcourir les résultats
Utilisation des transactions
Paramètres liés
Colonnes liées
Utilisation des préfixes de table

Data Access Objects (DAO) permet l'accès aux données stockées dans divers SGBD au travers d'une API générique. Ainsi, le SGBD sous jacent peut être changé sans avoir à modifier le code utilisant DAO pour accéder aux données.

Yii DAO est basé sur les PHP Data Objects (PDO), une extension fournissant un accès unifié aux données de multiples SGBD, tels que MySQL, PostgreSQL. C'est pour cela que l'utilisation de Yii DAO requiert la présence de l'extension PDO et du pilote PDO spécifique pour le SGBD utilisé (par exemple PDO_MYSQL).

Yii DAO est constitué des quatres classes suivantes:

CDbConnection: représente une connexion à une base.
CDbCommand: représente une requête SQL.
CDbDataReader: représente un flux de données résultant d'une requête.
CDbTransaction: représente une transaction.

L'utilisation de Yii DAO dans différents cas de figure va maintenant être présenté.

1. Etablir une connexion à une base ¶

Pour établir une connexion à une base, il est nécessaire de créer une instance de CDbConnection et de l'activer. Pour cela un DSN (Data Source Name) contenant les informations de connexion devra être spécifié. Un nom d'utilisateur et un mot de passe, optionnels, peuvent aussi être renseignés ici. Une exception sera levée si une erreur se produit durant la connexion (par exemple en cas de mauvais DSN ou un utilisateur/mot de passe invalide).

$connection=new CDbConnection($dsn,$username,$password);
// établit une connexion. try...catch pour récupérer les éventuelles exceptions
$connection->active=true;
......
$connection->active=false;  // fermeture de la connexion

Le format du DSN varie selon le pilote PDO choisi. De manière générale, un DSN est constitué du nom du pilote PDO, suivi d'un point virgule, suivi d'une chaîne de caractères dont la syntaxe dépend du pilote. Voir la documentation PDO pour plus d'information.

Ci-dessous une liste avec les formats couramment utilisés:

SQLite: sqlite:/path/to/dbfile
MySQL: mysql:host=localhost;dbname=testdb
PostgreSQL: pgsql:host=localhost;port=5432;dbname=testdb
SQL Server: mssql:host=localhost;dbname=testdb
Oracle: oci:dbname=//localhost:1521/testdb

Comme CDbConnection hérite de CApplicationComponent, il est aussi possible de l'utiliser comme un application component. Pour cela, il faut configurer l'application component db (ou un autre nom) dans l'application configuration selon le modèle suivant:

array(
    ......
    'components'=>array(
        ......
        'db'=>array(
            'class'=>'CDbConnection',
            'connectionString'=>'mysql:host=localhost;dbname=testdb',
            'username'=>'root',
            'password'=>'password',
            'emulatePrepare'=>true,  // requis pour certaines installations MySQL
        ),
    ),
)

Il est dès lors possible d'accéder à la connexion au travers de Yii::app()->db qui est activé automatiquement, à moins que CDbConnection::autoConnect ne soit explicitement fixé à false. Grâce à cette méthode, cette connexion unique sera accessible partout où que l'on soit dans le code.

2. Exécution de requêtes SQL ¶

Une fois qu'une connexion à été établie, les requêtes SQL peuvent être exécutées grâce à la classe CDbCommand. Il faut pour cela créer une instance CDbCommand en appelant CDbConnection::createCommand() et en spécifiant la requête SQL.

$connection=Yii::app()->db;   // vous devez avoir une connexion "db"
// Sinon il est possible de créer cette connexion explicitement:
// $connection=new CDbConnection($dsn,$username,$password);
$command=$connection->createCommand($sql);
// Si besoin, la requête peut être mise à jour comme suit:
// $command->text=$newSQL;

Une requete SQL est exécutée au travers de CDbCommand selon l'une des 2 méthodes suivantes:

execute(): Exécute une requête SQL sans retour de données, telles que les requêtes INSERT, UPDATE ou DELETE. Si la requête se déroule sans erreur, cette fonction retournera le nombre de lignes affectées.
query(): Exécute une requête SQL retournant des données telle que SELECT. Si la requête se déroule sans erreur, cette fonction retournera une instance de CDbDataReader dans laquelle on pourra parcourir les lignes. Dans un soucis de simplicité, plusieurs méthodes queryXXX() ont aussi été implémentées retournant directement les résultats.

Une exception sera levée si une erreur se produit durant l'exécution de la requête SQL.

$rowCount=$command->execute();   // exécute une requête SQL sans retour de données
$dataReader=$command->query();   // exécute une requête SQL
$rows=$command->queryAll();      // exécute et retourne toutes les lignes
$row=$command->queryRow();       // exécute et retourne la première ligne
$column=$command->queryColumn(); // exécute et retourne la première colonne
$value=$command->queryScalar();  // exécute et retourne le premier champ de la première ligne

3. Parcourir les résultats ¶

Une fois que CDbCommand::query() à généré l'instance CDbDataReader, il est possible de récupérer les lignes en appelant successivement la méthode CDbDataReader::read(). Il est aussi possible d'utiliser CDbDataReader directement dans une boucle foreach pour récupérer les données ligne par ligne.

$dataReader=$command->query();
// appel de read() jusqu'a ce qu'il retourne false
while(($row=$dataReader->read())!==false) { ... }
// utilisation de foreach pour parcourir chaque ligne de données
foreach($dataReader as $row) { ... }
// récupération de toutes les lignes d'un coup dans un tableau
$rows=$dataReader->readAll();

Note: Contrairement à query(), les méthodes queryXXX() renvoient directement les données. Par exemple, queryRow() retourne un tableau représentant la première ligne du résultat.

4. Utilisation des transactions ¶

Lorsqu'une application exécute plusieurs requêtes de lecture et/ou d'écriture, il est important d'être certain que la base ne soit pas laissée dans un état où toutes les requêtes n'ont pas été achevées. Une transaction, représentée comme une instance de CDbTransaction dans Yii, pourra être utilisée selon le schéma suivant:

Début de la transaction.
Exécution des requêtes une à une. Aucune modification à la base ne sera visible en dehors du contexte.
Validation (Commit) de l'ensemble de la transaction. Toutes les modifications sont alors visibles si la transaction se déroule sans erreur.
Si une seule requête échoue, la transaction entière est annulée (roll back).

Le déroulement ci-dessus peut être implémenté comme suit:

$transaction=$connection->beginTransaction();
try
{
    $connection->createCommand($sql1)->execute();
    $connection->createCommand($sql2)->execute();
    //.... autres requêtes SQL
    $transaction->commit();
}
catch(Exception $e) // une exception est levée si une requête échoue
{
    $transaction->rollBack();
}

5. Paramètres liés ¶

Pour faire face aux attaques par injection SQL et pour améliorer les performances lors des exécutions répétées de requêtes SQL, il est possible de "préparer" les requêtes SQL, avec optionnellement des marques pour les paramètres, qui seront remplacées par les valeurs des vrais paramètres durant l'étape de "liaison" (binding) des paramètres.

Les marques pour ces paramètres peuvent être nommées (représentées comme des "tokens") ou non-nommées (représentées comme des points d'interrogation). Un appel à CDbCommand::bindParam() ou CDbCommand::bindValue() permettra de remplacer ces marques par les vraies valeurs. Ces paramètres n'ont pas besoin d'être entre parenthèses: Le pilote de la base le fera pour vous. La liaison des paramètres devra évidemment être faite avant l'exécution de la requête.

// requête SQL avec 2 marques ":username" et ":email"
$sql="INSERT INTO tbl_user (username, email) VALUES(:username,:email)";
$command=$connection->createCommand($sql);
// remplace la marque ":username" par la vraie valeur de username
$command->bindParam(":username",$username,PDO::PARAM_STR);
// remplace la marque ":email" par la vraie valeur email
$command->bindParam(":email",$email,PDO::PARAM_STR);
$command->execute();
// insertion d'une ligne avec les nouveaux paramètres
$command->bindParam(":username",$username2,PDO::PARAM_STR);
$command->bindParam(":email",$email2,PDO::PARAM_STR);
$command->execute();

Les méthodes bindParam() et bindValue() sont très similaires. La seule différence est que le premier lie un paramètre avec une référence de variable PHP alors que le deuxième le lie avec la valeur de cette variable. Pour les paramètres représentant de gros blocs mémoire, la premiere méthode est préférable pour des raisons de performances.

Pour plus de détails sur la liaison de paramètres, voir la documentation PHP en rapport.

6. Colonnes liées ¶

Lors du parcours des résultats d'une requête, il est aussi possible de lier des variables PHP afin qu'elles soient automatiquement mises à jour avec les données les plus récentes à chaque fois qu'une ligne est lue.

$sql="SELECT username, email FROM tbl_user";
$dataReader=$connection->createCommand($sql)->query();
// lie la 1ère colonne (username) avec la variable $username
$dataReader->bindColumn(1,$username);
// lie la 2ème colonne (email) avec la variable $email
$dataReader->bindColumn(2,$email);
while($dataReader->read()!==false)
{
    // $username et $email contiennent les username et email de la ligne courante
}

7. Utilisation des préfixes de table ¶

A partir de la version 1.1.0, Yii supporte les préfixes de tables. Un préfixe de table est une chaîne de caractères préfixant le nom d'une table. Cette technique est très utilisée dans des environnements d'hébergements mutualisés dans lesquels des applications partagent une même base de donnée et ainsi utilisent différents préfixes pour se différencier l'une de l'autre. Par exemple, une application pourrait utiliser un préfixe tbl_ et une autre yii_.

Pour utiliser les préfixes de table, il faut configurer la propriété CDbConnection::tablePrefix avec la valeur du préfixe souhaité. Puis, dans les requêtes SQL, il est possible d'utiliser {{TableName}} qui correspond au nom de la table sans le préfixe. Par exemple, si la base contient une table tbl_user pour laquelle tbl_ est défini comme le préfixe des tables, il est possible alors d'utiliser le code suivant pour accéder à la table des utilisateurs:

$sql='SELECT * FROM {{user}}';
$users=$connection->createCommand($sql)->queryAll();

Vue d'ensemble

Go to Top

Query Builder

Found a typo or you think this page needs improvement?
Edit it on github !