Zend_Db_Table_Row
Introduction
Zend_Db_Table_Row est la classe qui donne accès à chacun des résultats issus d'un objet
Zend_Db_Table. Lorsque vous exécutez une requête via une classe de Table, alors les résultats sont
des objets Zend_Db_Table_Row. Vous pouvez aussi utiliser ces objets comme résultats vides : pour
créer des nouveaux résultats à ajouter à la base de données.
Zend_Db_Table_Row est une implémentation du design pattern Row Data Gateway
Récupérer un résultat (un "Row")
Zend_Db_Table_Abstract possède des méthodes find() et fetchAll(),
qui retournent un objet de type Zend_Db_Table_Rowset, et une méthode fetchRow(), qui
retourne un objet de type Zend_Db_Table_Row.
Exemple de récupération d'un Row
fetchRow($bugs->select()
->where('bug_id = ?', 1));
]]>
Un objet Zend_Db_Table_Rowset contient une collection d'objets
Zend_Db_Table_Row. Voyez .
Exemple de lecture d'un Row dans un Rowset
fetchAll($bugs->select()
->where('bug_status = ?', 1));
$row = $rowset->current();
]]>
Lecture des valeurs des colonnes, dans un Row
Zend_Db_Table_Row_Abstract possède des accesseurs. Les colonnes SQL du résultat sont
disponibles en lecture et écriture, via des propriétés de classe.
Lecture d'une colonne dans un Row
fetchRow($bugs->select()
->where('bug_id = ?', 1));
// Affiche la valeur de la colonne bug_description
echo $row->bug_description;
]]>
Les versions antérieures de Zend_Db_Table_Row utilisaient un processus de
transformation nommé inflexion pour récupérer les valeurs des colonnes dans un
résultat.
Actuellement, Zend_Db_Table_Row n'utilise pas d'inflexion. Les noms des propriétés de
l'objet doivent correspondre à l'orthographe des noms des colonnes dans la base de données
sous-jacente
Récupérer les valeurs des colonnes comme un tableau
Vous pouvez accéder aux données d'un row sous forme de tableau grâce à la méthode
toArray(). Celle-ci retourne un tableau associatif.
Exemple avec toArray()
fetchRow($bugs->select()
->where('bug_id = ?', 1));
// Récupère un tableau associatif column/value
$rowArray = $row->toArray();
// Utilisation comme un tableau normal
foreach ($rowArray as $column => $value) {
echo "Column: $column\n";
echo "Value: $value\n";
}
]]>
Le tableau retourné par toArray() n'est pas une référence. Vous pouvez modifier ses
valeurs, cela n'aura aucune répercussion dans la base de données.
Récupérer des données des tables liées
Zend_Db_Table_Row_Abstract possède des méthodes permettant de récupérer des données des
tables liées à la table interrogée. Voyez pour plus
d'informations sur les relations entre les tables.
Sauvegarde un Row en base de données
Changement des valeurs des colonnes d'un Row
Vous pouvez changer les valeurs de chaque colonne du résultat Row, simplement avec les accesseurs,
comme en lecture. Effectuez une banale affectation.
Utiliser l'accesseur pour spécifier une valeur à une colonne d'un résultat Row ne répercute pas le
comportement immédiatement en base de données. Vous devez utiliser explicitement la méthode
save() pour ceci.
Exemple de changement de la valeur d'une colonne dans un Row
fetchRow($bugs->select()
->where('bug_id = ?', 1));
// Change la valeur d'une ou plusieurs colonnes
$row->bug_status = 'FIXED';
// MET A JOUR l'enregistrement dans la base de données
$row->save();
]]>
Créer un Row vierge
Vous pouvez créer un nouvel enregistrement vierge (Row) pour une table avec la méthode
createRow() issue de la classe de cette Table. Vous pouvez alors affecter des valeurs à ses
colonnes grâce aux accesseurs, comme déjà vu, puis enregistrer le Row en base de données avec sa méthode
save().
Exemple de création d'un Row vierge pour une table
createRow();
// affecte des valeurs aux colonnes
$newRow->bug_description = '...description...';
$newRow->bug_status = 'NEW';
// INSERT le nouvel enregistrement dans la base de données
$newRow->save();
]]>
L'argument optionnel de createRow() est un tableau associatif qui sert à peupler tout de
suite l'objet de valeurs.
Exemple de remplissage des valeurs d'un nouveau Row vierge
'...description...',
'bug_status' => 'NEW'
);
$bugs = new Bugs();
$newRow = $bugs->createRow($data);
// INSERT l'enregistrement en base de données
$newRow->save();
]]>
La méthode createRow() était nommée fetchNew() dans les anciennes
version de Zend_Db_Table. Il est recommandé de ne plus utiliser cette ancienne appellation,
même si celle-ci fonctionne toujours actuellement.
Changement en masse des valeurs dans un Row
Zend_Db_Table_Row_Abstract possède une méthode setFromArray() qui permet de
lui peupler ses valeurs avec celles issues d'un tableau associatif nom de la colonne / valeur..
Exemple d'utilisation de setFromArray() avec un enregistrement (Row) vierge
createRow();
// Les données sont dans un tableau associatif
$data = array(
'bug_description' => '...description...',
'bug_status' => 'NEW'
);
// Affecte toutes les valeurs des colonnes en une seule fois
$newRow->setFromArray($data);
// INSERT l'enregistrement en base de données
$newRow->save();
]]>
Supprimer un Row
Vous pouvez appeler la méthode delete() d'un objet Row. Ceci supprime les lignes dans la
base de données qui correspondent à la clé primaire de l'objet Row.
Effacer un Row
fetchRow('bug_id = 1');
// EFFACE cet enregistrement de la base de données
$row->delete();
]]>
Notez qu'il n'est pas nécessaire d'appeler save() pour un effacement. Celui-ci est à
effet immédiat.
Sérialisation et désérialisation d'un Row
Il peut être utile de sauvegarder le contenu d'un enregistrement (Row) sur un support quelconque, pour une
utilisation ultérieure. La sérialisation est le nom de l'opération qui consiste à
transformer un objet en une forme facilement stockable (dans un fichier par exemple). Les objets du type
Zend_Db_Table_Row_Abstract sont sérialisables.
Sérialiser un Row
Utilisez simplement la fonction PHP serialize() pour créer une chaîne de caractères
représentant votre objet Row.
Exemple de sérialisation d'un Row
fetchRow('bug_id = 1');
// Convertit l'objet en une forme sérialisée
$serializedRow = serialize($row);
// Maintenant vous pouvez utiliser $serializedRow
// pour l'écrire dans un fichier, etc.
]]>
Désérialiser les données d'un Row
Utilisez simplement la fonction PHP unserialize(). L'objet Row originel est alors
recréé.
Notez que l'objet retourné fonctionne alors en mode déconnecté. Vous pouvez lire
les valeurs des colonnes, mais pas les modifier ni enregistrer l'objet en base de données
(save()).
Exemple de désérialisation d'un objet Row sérialisé.
bug_description;
]]>
Pourquoi ce mode déconnecté imposé ?
Un objet sérialisé est une chaîne de caractère, humainement visible. Il est donc peu sécurisé d'y
laisser un mot de passe vers un serveur de base de données. Le lecteur d'un objet Row sérialisé ne
devrait pas pouvoir accéder à la base de données. De plus, une connexion à une base de données est un
type non sérialisable par PHP (ressource).
Reconnecter l'objet Row à la Table
Il est bien entendu possible de reconnecter l'objet Row à la base de données, et plus précisément à la
Table dont il fut issu. Utilisez la méthode setTable() et passez lui une instance héritant de
Zend_Db_Table_Abstract. Une fois reconnecté, l'objet Row possède de nouveau un accès à la base
de données, et n'est donc plus en mode lecture seule.
Exemple de réactivation d'un Row
setTable($bugs);
// Maintenant il est possible de l'utiliser en mode écriture
$rowClone->bug_status = 'FIXED';
$rowClone->save();
]]>
Étendre la classe Row
Vous pouvez utilisez votre propre classe étendant Zend_Db_Table_Row_Abstract. Spécifiez votre
classe dans la propriété protégée $_rowClass de la classe de votre Table, ou dans le tableau du
constructeur de l'objet Table.
Spécification d'une classe Row personnalisée
'MyRow'));
]]>
Initialisation et pré-traitements d'un Row
Si vous avez un besoin spécifique d'implémenter une logique spéciale après la création d'une instance
de Row, vous pouvez utiliser sa méthode init(), qui est appelée dans son constructeur, mais
après que les méta données aient été calculées.
Exemple d'utilisation de la méthode init()
_role = new MyRoleClass();
}
}
]]>
Définir sa propre logique pour Insert, Update, et Delete dans Zend_Db_Table_Row
La classe des Rows appelle les méthodes protégées _insert(), _update(), et
_delete() avant d'effectuer chacune des opérations respectives INSERT,
UPDATE, et DELETE. Il est donc possible de définir sa propre logique dans votre
sous-classe de Row.
Ci-dessous vous trouverez des exemples d'utilisation d'une logique personnalisée dans les classes de
Row :
Exemple de logique personnalisée dans une classe de Row
La logique personnelle peut donc être déportée dans une classe de Row qui ne s'appliquera qu'à
certaines tables, et pas à d'autres. Sinon, la classe de Table utilise le Row par défaut.
Par exemple, vous souhaitez historiser toutes les insertions sur une Table spécifique, mais
uniquement si la configuration du site le permet :
info(Zend_Debug::dump($this->_data,
"INSERT: $this->_tableClass",
false));
}
}
// $loggingEnabled est une variable d'exemple qui définit si
// l'historisation est activée ou pas
if ($loggingEnabled) {
$bugs = new Bugs(array('rowClass' => 'MyLoggingRow'));
} else {
$bugs = new Bugs();
}
]]>
Exemple d'une classe de Row qui historise les insertions de plusieurs tables
En passant l'objet Row personnalisé à chacune des Tables concernées, alors vous n'aurez pas besoin
de définir cette logique dans chacune des classes des Tables.
Dans cet exemple, le code qui effectue l'historisation est identique à celui de l'exemple
précédent.
info(Zend_Debug::dump($this->_data,
"INSERT: $this->_tableClass",
false));
}
}
class Bugs extends Zend_Db_Table_Abstract
{
protected $_name = 'bugs';
protected $_rowClass = 'MyLoggingRow';
}
class Products extends Zend_Db_Table_Abstract
{
protected $_name = 'products';
protected $_rowClass = 'MyLoggingRow';
}
]]>
Définir l'inflexion dans Zend_Db_Table_Row
Il peut être intéressant de personnaliser l'accès aux colonnes de la table représentée par un résultat
Row, plutôt que d'utiliser le nom des colonnes telles que définies dans le SGBDR sous-jacent. La
transformation de l'un vers l'autre est appelée inflexion.
Les classes Zend_Db n'utilisent pas l'inflexion par défaut. Voyez pour plus de détails sur ce procédé.
Ainsi si vous voulez utiliser l'inflexion, vous devez implémenter vous-même la transformation à
effectuer en redéfinissant la méthode _transformColumn() dans votre classe de Row, et bien
entendu utiliser cette classe de Row pour votre Table.
Exemple d'utilisation de l'inflexion
Ceci vous permet d'utiliser les accesseurs de votre Row de manière transformée. La classe de votre
Row utilisera _transformColumn() pour changer le nom de la colonne appelée, avant de le
faire correspondre à un nom dans la table réelle de la base de données.
fetchNew();
// Utilisez des nom de colonnes CamelCase, l'inflecteur les
// transformera alors pour vous afin d'établir la correspondance
// avec les noms natifs des colonnes.
$row->bugDescription = 'New description';
]]>
En revanche, c'est à vous d'écrire votre mécanisme d'inflexion.