Déclarez le nom de la table pour laquelle la classe va agir, en utilisant la propriété protégée $_name. C'est une chaîne, elle doit contenir le nom de la table tel qu'il apparaît dans la base de données.

class Bugs extends Zend_Db_Table_Abstract
{
    protected $_name = 'bugs';
}

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.

class bugs extends Zend_Db_Table_Abstract
{
    // le nom de la table est ici supposé être le nom de la classe
}

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 : $_schema, ou avec le nom de la base précédant le nom de la table dans la propriété $_name. Si vous choisissez de définir le nom de la base de données dans la propriété $_name, alors ce choix sera prioritaire sur celui utilisant $_schema.

// 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';
}

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 $_name et $_schema).

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'));

Si vous n'indiquez pas de base de données, c'est celle utilisée par l'adaptateur qui sera utilisée.

Toute table doit posséder une clé primaire. Zend_Db_Table 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 $_primary. 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).

class Bugs extends Zend_Db_Table_Abstract
{
    protected $_name = 'bugs';
    protected $_primary = 'bug_id';
}

Si vous ne spécifiez pas explicitement de clé primaire, alors Zend_Db_Table_Abstract va essayer de la trouver lui-même en utilisant les informations renvoyées par describeTable().

Lorsque vous créez votre instance de classe Zend_Db_Table, 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.

class Bugs extends Zend_Db_Table_Abstract
{
    protected function _setupTableName()
    {
        $this->_name = 'bugs';
        parent::_setupTableName();
    }
}

Les méthodes de configuration que vous pouvez redéfinir sont :

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 init(), qui est appelée juste après le constructeur, donc une fois la table correctement créée.

class Bugs extends Zend_Db_Table_Abstract
{
    protected $_observer;

    public function init()
    {
        $this->_observer = new MyObserverClass();
    }
}

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 "db".

$db = Zend_Db::factory('PDO_MYSQL', $options);

$table = new Bugs(array('db' => $db));

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 Zend_Db_Table_Abstract::setDefaultAdapter(). Son argument est un objet de type Zend_Db_Adapter_Abstract.

$db = Zend_Db::factory('PDO_MYSQL', $options);
Zend_Db_Table_Abstract::setDefaultAdapter($db);

// Plus tard...

$table = new Bugs();

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 Zend_Db_Table_Abstract).

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é "db" 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.

$db = Zend_Db::factory('PDO_MYSQL', $options);
Zend_Registry::set('my_db', $db);

// Plus tard...

$table = new Bugs(array('db' => 'my_db'));

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.

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 SQL de type INSERT.

Dans Zend_Db_Table_Abstract, si vous définissez la variable protégée $_sequence à un booléen TRUE (défaut), alors la classe va supposer que la table qu'elle représente possède une clé primaire auto-incrémentée.

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;
}

MySQL, MSSQL, et SQLite sont des exemples de SGBD supportant les clé primaires auto-incrémentées.

PostgreSQL a une propriété SERIAL 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é IDENTITY qui fonctionne de la même manière. Si vous utilisez ces propriétés d'automatisme, considérez votre classe de Table (Zend_Db_Table) comme si elle avait une clé primaire auto-incrémentée. Déclarez ainsi $_sequence à TRUE.

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.

Si vous définissez $_sequence avec une chaîne de caractères, Zend_Db_Table_Abstract 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 INSERT le nécessitant.

class Bugs extends Zend_Db_Table_Abstract
{
    protected $_name = 'bugs';

    protected $_sequence = 'bug_sequence';
}

Oracle, PostgreSQL, et IBM DB2 sont des SGBDs qui supportent les séquences.

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é.

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.

Si vous utilisez $_sequence avec la valeur booléenne FALSE, alors Zend_Db_Table_Abstract se comportera comme si une clé naturelle est utilisée. Ainsi, lors de l'appel de la méthode insert(), vous devrez spécifier la valeur de la clé primaire vous même, autrement une Zend_Db_Table_Exception sera levée.

class BugStatus extends Zend_Db_Table_Abstract
{
    protected $_name = 'bug_status';

    protected $_sequence = false;
}

// 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')
    );

L'objet Zend_Db_Table_Select est une extension de Zend_Db_Select mais qui applique des restrictions particulières à la requête. Les restrictions sont :

$table = new Bugs();

$select = $table->select();
$select->where('bug_status = ?', 'NEW');

$rows = $table->fetchAll($select);

L'objet Select utilise une interface fluide (fluent interface), permettant le chaînage des méthodes.

$table = new Bugs();

$rows = $table->fetchAll($table->select()
                               ->where('bug_status = ?', 'NEW'));

Vous pouvez demander une requête qui retourne plusieurs enregistrements. La méthode fetchAll() de votre classe de Table permet ceci. Elle retourne un objet de type Zend_Db_Table_Rowset_Abstract, même si aucun enregistrement ne correspond à la requête.

$table = new Bugs();

$select = $table->select()->where('bug_status = ?', 'NEW');

$rows = $table->fetchAll($select);

Vous pouvez aussi définir les clauses SQL ORDER BY ou encore LIMIT (ou autre équivalent comme OFFSET).

$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);

Tous les arguments de requêtes sont optionnels. Vous pouvez écrire une requête sans clause WHERE ni LIMIT ou encore ORDER.

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.

$table = new Bugs();

$select = $table->select();
$select->from($table, array('bug_id', 'bug_description'))
       ->where('bug_status = ?', 'NEW');

$rows = $table->fetchAll($select);

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.

$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);

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".

$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);

L'objet Zend_Db_Table_Select 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 Zend_Db_Table_Select possède une clause spéciale déverrouillant cette limitation. Passez la valeur FALSE à sa méthode setIntegrityCheck. 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 save(), delete() ou même d'affecter une valeur à certains de ses champs. Une exception sera systématiquement levée.

$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);

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.

La structure des métadonnées est comme ceci :

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...
);

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.

Vous pouvez désactiver cette optimisation en mettant à FALSE le paramètre metadataCacheInClass :

// Lors de l'instanciation :
$bugs = new Bugs(array('metadataCacheInClass' => false));

// Ou plus tard :
$bugs->setMetadataCacheInClass(false);

Ce paramètre est activé par défaut, ce qui assure que le tableau $_metadata n'est chargé qu'une seule fois par instance

Par défaut, les méthodes de la classe de Table retourne des jeux d'enregistrements comme étant des instances de la classe Zend_Db_Table_Rowset, ces "Rowsets" contiennent des enregistrements de la table, représentés par des objets instances de Zend_Db_Table_Row. Vous pouvez spécifier vos propres classes pour row/rowset, mais elles doivent étendre Zend_Db_Table_Rowset_Abstract ou Zend_Db_Table_Row_Abstract, respectivement.

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 "rowClass" et "rowsetClass". Indiquez les noms des classes sous forme de chaînes de caractères.

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);

Vous pouvez aussi utiliser les méthodes setRowClass() et setRowsetClass(). Ceci s'applique alors de manière ponctuelle, et non plus globale pour toute la classe de Table en tout point.

$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.

Pour des informations détaillées concernant les classes Row et Rowset, voyez la section intitulée « Zend_Db_Table_Row » et la section intitulée « Zend_Db_Table_Rowset ».

Vous pouvez redéfinir les méthodes insert() et update() afin d'y ajouter votre propre logique. Assurez vous d'appeler les méthodes parentes une fois votre code écrit.

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);
    }
}

Il est aussi possible de redéfinir la méthode delete().

Bien que fetchAll() 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 fetchAll() ou une autre méthode.

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');
    }
}

L'inflexion 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 $_name, Zend_Db_Table_Abstract va utiliser le nom de la classe comme nom de table, sans effectuer aucune transformation.

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.

Par exemple, une classe nommée "BugsProducts", peut vouloir refléter une table s'appelant "bugs_products," sans utiliser la propriété de classe $_name. 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.

Vous pouvez aussi spécifier le nom de la table indépendamment du nom de la classe. Utilisez pour cela la propriété $_name de la classe de Table.

Si vous voulez utiliser l'inflexion, vous devrez créer une classe (abstraite) étendant Zend_Db_Table_Abstract, et redéfinissant sa méthode protégée _setupTableName(). Toutes les classes de Table devront alors hériter de cette nouvelle classe abstraite.

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
{
}

C'est à vous d'écrire les fonctions qui vont établir le mécanisme d'inflexion.