В реляционной БД таблицы имеют связи друг с другом. Запись в таблице может быть связана с одной или более записей в другой таблице с использованием ограничений ссылочной целостности, определенных в конкретной БД.

Класс Zend_Db_Table_Row имеет методы для запрашивания связанных строк в другой таблице.

В этом разделе мы будем использовать для примера базу данных, которая служит для отслеживания ошибок в проекте разработки ПО. Эта база данных содержит три таблицы:

Следующий псевдокод для определения данных SQL описывает таблицу в этой БД.

CREATE TABLE accounts ( 
  account_id        PRIMARY KEY, 
  name              VARCHAR
);
 
CREATE TABLE products ( 
  product_id        PRIMARY KEY,
  product_name      VARCHAR
);
 
CREATE TABLE bugs ( 
  bug_id            PRIMARY KEY,
  product_id        FOREIGN KEY REFERENCES products(product_id),
  reported_by       FOREIGN KEY REFERENCES accounts(account_id),
  assigned_to       FOREIGN KEY REFERENCES accounts(account_id),
  verified_by       FOREIGN KEY REFERENCES accounts(account_id),
  bug_description   VARCHAR,
  bug_status        VARCHAR
);
        

Таблица products имеет связь "один-ко-многим" с таблицей bugs. Таблица accounts также имеет связь "один-ко-многим" с таблицей bugs. Таблица products имеет связь "многие-ко-многим" с таблицей accounts.

Также обратите внимание, что таблица bugs содержит несколько внешних ключей, ссылающихся на таблицу accounts. Для данной ошибки эти внешние ключи могут ссылаться на разные строки в таблице accounts.

Определите классы для каждой из этих таблиц, расширяя абстрактный класс Zend_Db_Table_Abstract, как описано в Раздел 9.4.2, «Определение класса таблицы». В классах объявите связи между таблицами в массивах protected $_referenceMap и protected $_dependentTables.

Ниже приведено определение классов для этих таблиц:

<?php

class Accounts extends Zend_Db_Table_Abstract
{
    protected $_name            = 'accounts';
    protected $_primary         = array('account_id');
    protected $_dependentTables = array('Bugs');
}

class Products extends Zend_Db_Table_Abstract
{
    protected $_name            = 'products';
    protected $_primary         = array('product_id');
    protected $_dependentTables = array('Bugs');
}

class Bugs extends Zend_Db_Table_Abstract
{
    protected $_name            = 'bugs';
    protected $_referenceMap    = array(
        'Reporter' => array(
            'columns'           => 'reported_by',
            'refTableClass'     => 'Accounts',
            'refColumns'        => 'account_id'
        ),
        'Engineer' => array(
            'columns'           => 'assigned_to',
            'refTableClass'     => 'Accounts',
            'refColumns'        => 'account_id'
        ),
        'Verifier' => array(
            'columns'           => array('verified_by'),
            'refTableClass'     => 'Accounts',
            'refColumns'        => array('account_id')
        ),
        'Product' => array(
            'columns'           => array('product_id'),
            'refTableClass'     => 'Products',
            'refColumns'        => array('product_id')
        )
    );
}

?>
        

Объявите массив $_dependentTables в классе для родительской таблицы. Перечислите имена классов всех зависимых таблиц. Используйте имена классов, а не таблиц в БД.

Объявите массив $_referenceMap во всех классах зависимых таблиц. Это ассоциативный массив правил связей. Правило связи определяет, какая таблица является родительской в связи и какие столбцы в зависимой таблице ссылаются на какие столбцы в родительской таблице.

Ключом правила является строка, используемая как индекс массива $_referenceMap. Этот ключ правила используется для идентификации каждой связи. Выбирайте для него описательное имя. Лучше всего использовать строку, которая может быть частью имени метода, как вы увидите позднее.

В примере PHP-кода выше ключами правил являются: 'Reporter', 'Engineer', 'Verifier', и 'Product'.

Значением каждого правила в массиве $_referenceMap является также ассоциативный массив. Элементы этого массива описаны ниже:

Если вы имеете объект Row (строка) в результате запроса к родительской таблице, то вы можете извлечь строки из зависимых таблиц, ссылающихся на текущую строку. Используйте этот метод:

$row->findDependentRowset($table, [$rule])

        

Этот метод возвращает объект Zend_Db_Table_Rowset_Abstract, содержащий набор строк из зависимой таблицы $table, ссылающихся на строку, представленную объектом $row.

Первый аргумент $table может быть строкой с именем класса зависимой таблицы. Вы можете также определить зависимую таблицу, используя объект класса этой таблицы.

<?php

$accountsTable      = new Accounts();
$accountsRowset     = $accountsTable->find(1234);
$user1234           = $accountsRowset->current();

$bugsReportedByUser = $user1234->findDependentRowset('Bugs');

?>
            

Втрой аргумент $rule является опциональным. Это строка с ключом правила в массиве $_referenceMap класса зависимой таблицы. Если вы не определите правило, то будет использоваться первое правило в массиве, ссылающееся на родительскую таблицу. Для того, чтобы использовать правило, отличное от первого, необходимо указать ключ.

В примере выше ключ правила не определен, поэтому используется первое правило, соответствующее родительской таблице. Это правило 'Reporter'.

<?php

$accountsTable      = new Accounts();
$accountsRowset     = $accountsTable->find(1234);
$user1234           = $accountsRowset->current();

$bugsAssignedToUser = $user1234->findDependentRowset('Bugs', 'Engineer');

?>
            

Вы можете также запрашивать строки из зависимой таблицы, используя специальный механизм, называемый "магический метод". Zend_Db_Table_Row_Abstract вызывает метод: findDependentRowset('<TableClass>', '<Rule>'), если вы вызываете метод объекта строки, соответствующий одному из следующих шаблонов:

В этих шаблонах <TableClass> и <Rule> являются именем класса зависимой таблицы и ключом правила зависимой таблицы, ссылающегося на родительскую таблицу.

Замечание

Некоторые фреймворки приложений, такие, как Ruby on Rails, используют механизм, называемый "инфлексией" (inflection) и состоящий в изменении написания идентификаторов в зависимости от использования. Для простоты Zend_Db_Table_Row не предоставляет никакого механизма инфлексии. Имя таблицы и ключ правила в вызовах методов должны в точности соответствовать написанию имени класса таблицы и ключа правила при объявлении.

<?php

$accountsTable    = new Accounts();
$accountsRowset   = $accountsTable->find(1234);
$user1234         = $accountsRowset->current();

// Используется правило связи по умолчанию
$bugsReportedBy   = $user1234->findBugs();

// Задается правило связи
$bugsAssignedTo   = $user1234->findBugsByEngineer();

?>
            

Если вы имеете объект Row в результате запроса к зависимой таблице, то можете извлечь ту строку из родительской таблицы, на которую ссылается зависимая строка. Используйте метод:

$row->findParentRow($table, [$rule])

        

Зависимая строка всегда должна ссылаться только на одну строку в родительской таблице, поэтому этот метод возвращает объект Row, а не Rowset.

Первый аргумент $table может быть строкой с именем класса родительской таблицы. Вы можете также задавать родительскую таблицу, используя объект класса этой таблицы.

<?php

$bugsTable         = new Bugs();
$bugsRowset        = $bugsTable->fetchAll('bug_status = ?', 'NEW');
$bug1              = $bugsRowset->current();

$reporter          = $bug1->findParentRow('Accounts');

?>
            

Второй аргумент $rule является опциональным. Это строка с ключом правила в массиве $_referenceMap класса зависимой таблицы. Если вы не определите правило, то будет использоваться первое правило в массиве, ссылающееся на родительскую таблицу. Для того, чтобы использовать правило, отличное от первого, необходимо указать ключ.

В примере кода выше ключ правила не определен, поэтому используется первое правило, соответствующее родительской таблице. Это правило 'Reporter'.

<?php

$bugsTable         = new Bugs();
$bugsRowset        = $bugsTable->fetchAll('bug_status = ?', 'NEW');
$bug1              = $bugsRowset->current();

$engineer          = $bug1->findParentRow('Accounts', 'Engineer');

?>
            

Вы можете также запрашивать строки из родительской таблицы, используя "магический метод". Zend_Db_Table_Row_Abstract вызывает метод: findParentRow('<TableClass>', '<Rule>'), если вы вызываете метод объекта Row, соответствующий одному из следующих шаблонов:

В этих шаблонах <TableClass> и <Rule> - имя класса родительской таблицы и ключ правила зависимой таблицы, ссылающегося на родительскую таблицу.

	Замечание
	Имя таблицы и ключ правила в вызовах методов должны в точности соответствовать написанию имени класса таблицы и ключа правила при объявлении.

<?php

$bugsTable         = new Bugs();
$bugsRowset        = $bugsTable->fetchAll('bug_status = ?', 'NEW');
$bug1              = $bugsRowset->current();

// Используется правило связи по умолчанию
$reporter          = $bug1->findParentAccounts();

// Задается правило связи
$engineer          = $bug1->findParentAccountsByEngineer();

?>
            

Если вы имеете объект Row в результате выполнения запроса к одной из таблиц, находящихся в связи "многие-ко-многим" (в рамках данного примера будем называть эту таблицу "исходной"), вы можете извлечь соответствующие строки в другой таблице ("целевая" таблица) через таблицу пересечений. Используйте метод:

$row->findManyToManyRowset($table, $intersectionTable, [$rule1, [$rule2]])

        

Этот метод возвращает объект Zend_Db_Table_Rowset_Abstract, содержащий строки из таблицы $table, соответствующие связи "многие-ко-многим". Текущий объект строки $row исходной таблицы используется в поиске строк в таблице пересечений и производится объединение с целевой таблицей.

Первый аргумент $table может быть именем класса целевой таблицы в связи "многие-ко-многим". Вы можете также задавать целевую таблицу, используя объект класса этой таблицы.

Второй аргумент $intersectionTable может быть именем класса таблицы пересечений между двумя таблицами в связи "многие-ко многим". Вы можете также задавать таблицу пересечений, используя объект класса этой таблицы.

<?php

$accountsTable    = new Accounts();
$accountsRowset   = $accountsTable->find(1234);
$user1234         = $accountsRowset->current();

$productsRowset   = $user1234->findManyToManyRowset('Products', 'Bugs');

?>
            

Третий и четвертый аргументы $rule1 и $rule2 являются опциональными. Это строки с ключами правил в массиве $_referenceMap класса таблицы пересечений.

$rule1 должен содержать ключ правила для ссылок таблицы пересечений на исходную таблицу. В данном примере это связь между таблицами Bugs и Accounts.

$rule2 должен содержать ключ правила для ссылок таблицы пересечений на целевую таблицу. В данном примере это связь между таблицами Bugs и Products

Как и в случае методов для извлечения родительских и зависимых строк, если вы не зададите правило, то метод использует первое правило в массиве $_referenceMap, соответствующее таблицам в связи. Если нужно использовать правило, отличное от первого, то необходимо указать ключ.

В примере кода выше ключ правила не указан, поэтому по умолчанию используются первые подходящие правила из массива. В данном случае для правила $rule1 будет использоваться 'Reporter', для правила $rule2 - 'Product'.

<?php

$accountsTable    = new Accounts();
$accountsRowset   = $accountsTable->find(1234);
$user1234         = $accountsRowset->current();

$productsRowset   = $user1234->findManyToManyRowset('Products', 'Bugs', 'Engineer');

?>
            

Вы можете также запрашивать строки из целевой таблицы в связи "многие-ко-многим", используя "магический метод". Zend_Db_Table_Row_Abstract вызывает метод findManyToManyRowset('<TableClass>', '<IntersectionTableClass>', '<Rule1>', '<Rule2>'), если вы вызываете метод, соотвествующий одному из следующих шаблонов:

В этих шаблонах <TableClass> и <IntersectionTableClass> являются именами классов целевой таблицы и таблицы пересечений соответственно. <Rule1> и <Rule2> являются ключами правил в таблице пересечений, соответствующими исходной таблице и целевой таблице соответственно.

	Замечание
	Имя таблицы и ключ правила в вызовах методов должны в точности соответствовать написанию имени класса таблицы и ключа правила при объявлении.

<?php

$accountsTable     = new Accounts();
$accountsRowset    = $accountsTable->find(1234);
$user1234          = $accountsRowset->current();

// Используется правило связи по умолчанию
$productsReporting = $user1234->findProductsViaBugs();

// Задается правило связи
$productsFixing    = $user1234->findProductsViaBugsByEngineer();

?>
            

Объявление DRI в БД

Объявление каскадных операций в Zend_Db_Table предназначено только для тех СУРБД, которые не поддерживают декларативной ссылочной целостности (declarative referential integrity - сокр. DRI). Например, если вы используете механизм хранения MyISAM в MySQL или SQLite, не поддерживающие DRI, то для вас может быть полезным объявить каскадные операции через Zend_Db_Table. Если ваша СУРБД реализует DRI и поддерживает предложения ON DELETE и ON UPDATE, то вам следует объявить эти предложения в вашей БД вместо использования каскадных возможностей Zend_Db_Table. Объявление каскадных правил DRI в СУРБД лучше в плане производительности, стабильности работы с БД и целостности данных. Что еще более важно, не объявляйте каскадные операции одновременно в СУРБД и в классе Zend_Db_Table.

Вы можете объявить каскадные операции для их выполнения в зависимой таблице при применении операций UPDATE и DELETE к строкам в родительской таблице.

<?php

$productsTable  = new Products();
$productsRowset = $productsTable->find(1234);
$product1234    = $productsRowset->current();

$product1234->delete();
// Автоматически выполняется каскадное
// удаление зависимых строк в таблице Bugs

?>
            

Аналогично, если вы используете UPDATE для изменения значения первичного ключа в родительской таблице, то при этом часто требуется, чтобы значение внешнего ключа в зависимой таблице также изменялось на новое, и таким образом поддерживалась ссылочная целостность.

Обычно нет необходимости в том, чтобы изменять значение первичного ключа, которое генерируется последовательностью (sequence) или другим механизмом. Но если вы используете естетственные ключи, которые иногда могут изменять свое значение, то, скорее всего, нужно будет использовать каскадное обновление зависимых таблиц.

Для объявления каскадных связей в Zend_Db_Table, отредактируйте правила в массиве $_referenceMap. Установите в ассоциативного массиве под ключами 'onDelete' и 'onUpdate' значение 'cascade' (или константу self::CASCADE). До того, как строка будет удалена из родительской таблицы или изменится значение ее первичного ключа, будут удалены или обновлены любые строки в зависимой таблице, ссылающиеся на эту строку родительской таблицы.

<?php

class Bugs extends Zend_Db_Table_Abstract
{
    ...
    protected $_referenceMap    = array(
        'Product' => array(
            'columns'           => array('product_id'),
            'refTableClass'     => 'Products',
            'refColumns'        => array('product_id'),
            'onDelete'          => self::CASCADE,
            'onUpdate'          => self::RESTRICT
        ),
        ...
    );
}

?>