Табличные объекты¶

Настройка класса Entity для использования таблиц¶

По умолчанию, табличные объекты используют класс Entity, основываясь на соглашение об именование моделей. Например, если ваш класс таблицы называется ArticlesTable, то класс Entity должен называться Article. Если класс таблицы с именем PurchaseOrdersTable, то Entity класс PurchaseOrder. Если, однако, вы хотите использовать имя класса Entity идущее вразрез с соглашением, вы можете воспользоваться методом setEntityClass() для смены имени:

class PurchaseOrdersTable extends Table
{
    public function initialize(array $config)
    {
        $this->setEntityClass('App\Model\Entity\PO');

        // До 3.4.0
        $this->entityClass('App\Model\Entity\PO');
    }
}

Как видно из приведенных выше примеров, табличные объекты имеют метод initialize(), который вызывается после метода конструктора. Рекомендуется использовать этот метод для выполнения логики инициализации, вместо переопределения конструктора.

Получение экземпляров класса таблицы¶

Для взаимодействия с таблицами вашей базы данных, необходимо получить экземпляр таблицы. Этого можно добиться, используя класс TableRegistry:

// В контроллере и методе.
use Cake\ORM\TableRegistry;

// Prior to 3.6 use TableRegistry::get('Articles')
$articles = TableRegistry::getTableLocator()->get('Articles');

Класс TableRegistry предоставляет различные зависимости для построения таблицы и ведёт реестр всех созданных экземпляров таблиц, что упрощает построение отношений и настройку ORM. Смотрите раздел Использование TableRegistry, для получения дополнительной информации.

Если ваш класс таблицы находится в плагине, необходимо использовать корректное имя класса. Не соблюдение этого правила может привезти к ошибкам. Чтобы этого не допустить, следуйте следующим примерам:

// Таблица плагина
// Prior to 3.6 use TableRegistry::get('PluginName.Articles')
$articlesTable = TableRegistry::getTableLocator()->get('PluginName.Articles');

// Таблица плагина с префиксом vendor'а
// Prior to 3.6 use TableRegistry::get('VendorName/PluginName.Articles')
$articlesTable = TableRegistry::getTableLocator()->get('VendorName/PluginName.Articles');

Список событий¶

• Model.initialize

• Model.beforeMarshal

• Model.beforeFind

• Model.buildValidator

• Model.buildRules

• Model.beforeRules

• Model.afterRules

• Model.beforeSave

• Model.afterSave

• Model.afterSaveCommit

• Model.beforeDelete

• Model.afterDelete

• Model.afterDeleteCommit

initialize¶

Cake\ORM\Table::initialize(Event $event, ArrayObject $data, ArrayObject $options)¶

Событие Model.initialize запускается после вызова методов конструктора и инициализации. Классы Table, по умолчанию, не слушают это событие, используя вместо этого метод initialize.

Для прослушивания и ответа на событие Model.initialize, вы можете создать класс слушателя, реализующий интерфейс EventListenerInterface:

use Cake\Event\EventListenerInterface;
class ModelInitializeListener implements EventListenerInterface
{
    public function implementedEvents()
    {
        return array(
            'Model.initialize' => 'initializeEvent',
        );
    }
    public function initializeEvent($event)
    {
        $table = $event->getSubject();
        // сделаем что-нибудь здесь
    }
}

и присоединить слушателя к глобальному диспетчеру EventManager:

use Cake\Event\EventManager;
$listener = new ModelInitializeListener();
EventManager::instance()->attach($listener);

Это вызовет вызов initializeEvent любого класса Table.

beforeMarshal¶

Cake\ORM\Table::beforeMarshal(Event $event, ArrayObject $data, ArrayObject $options)¶

Событие Model.beforeMarshal запускается до преобразования данных запроса в объекты. Дополнительная информация, об модификации данных запроса перед преобразованием в объекты, доступна в документации.

beforeFind¶

Cake\ORM\Table::beforeFind(Event $event, Query $query, ArrayObject $options, $primary)¶

Событие Model.beforeFind запускается перед каждой операцией поиска. Остановив событие и предоставив возвращаемое значение, вы можете полностью обойти операцию поиска. Любые изменения, сделанные для экземпляра $query, будут сохранены для остальной части поиска. Параметр $primary служит признаком корневого запроса, либо связанного с ним запроса. Все ассоциации, участвующие в запросе, будут запускать событие Model.beforeFind. Для ассоциаций, которые используют объединения, будет предоставлен mock-запрос. В вашем слушателе событий вы можете установить дополнительные поля, условия, или объединения. Эти параметры/функции будут скопированы в корневой запрос.

Вы можете использовать Model.beforeFind для ограничения операций поиска, на основе прав пользователя, или принимать решение о кэширование, на основе текущей нагрузки.

В предыдущих версиях CakePHP присутствовало событие afterFind, заменённое с помощью изменения результатов с помощью Map/Reduce и конструкторов объекта.

buildValidator¶

Cake\ORM\Table::buildValidator(Event $event, Validator $validator, $name)¶

Событие Model.buildValidator срабатывает после вызова именованных правил проверки $name, например, validationDefault. Можно использовать эту функцию для добавления методов проверки.

buildRules¶

Cake\ORM\Table::buildRules(Event $event, RulesChecker $rules)¶

Событие Model.buildRules срабатывает после создания экземпляра правил проверки и после вызова табличного метода buildRules().

beforeRules¶

Cake\ORM\Table::beforeRules(Event $event, EntityInterface $entity, ArrayObject $options, $operation)¶

Событие Model.beforeRules вызывается до применения правил проверки. Остановив событие, вы можете завершить проверку и вернуть результат применения правил.

afterRules¶

Cake\ORM\Table::afterRules(Event $event, EntityInterface $entity, ArrayObject $options, $result, $operation)¶

Событие Model.afterRules вызывается после применения правил проверки. Остановив это событие, вы можете вернуть итоговый результат проверки правил.

beforeSave¶

Cake\ORM\Table::beforeSave(Event $event, EntityInterface $entity, ArrayObject $options)¶

Событие Model.beforeSave вызывается перед каждым сохранением объекта. Остановка данной функции прервёт операцию сохранения, вернув результат события. Остановка событий описано в соответствующем разделе книги.

afterSave¶

Cake\ORM\Table::afterSave(Event $event, EntityInterface $entity, ArrayObject $options)¶

Событие Model.afterSave запускается после сохранения объекта.

afterSaveCommit¶

Cake\ORM\Table::afterSaveCommit(Event $event, EntityInterface $entity, ArrayObject $options)¶

Событие Model.afterSaveCommit запускается после транзакции, в которой прошла операция сохранения. Оно также срабатывает для неатомарных сохранений, где операции с базой данных неявно совершены. Событие запускается только для первичной таблицы, для которой непосредственно вызывается метод save(). Событие не запускается, если транзакция началась до вызова сохранения.

beforeDelete¶

Cake\ORM\Table::beforeDelete(Event $event, EntityInterface $entity, ArrayObject $options)¶

Событие запускается перед удалением объекта. Остановка этого события прервёт операцию удаления. Когда событие остановлено, возвратится её результат выполнения. Остановка событий описано в соответствующем разделе книги.

afterDelete¶

Cake\ORM\Table::afterDelete(Event $event, EntityInterface $entity, ArrayObject $options)¶

Событие Model.afterDelete запускается после удаления объекта.

afterDeleteCommit¶

Cake\ORM\Table::afterDeleteCommit(Event $event, EntityInterface $entity, ArrayObject $options)¶

Событие Model.afterDeleteCommit запускается после транзакции, в которой прошла операция удаления. Оно также срабатывает для неатомарных удаления, где операции с базой данных неявно совершены. Событие запускается только для первичной таблицы, для которой непосредственно вызывается метод delete(). Событие не запускается, если транзакция началась до вызова удаления.

Настройка объектов таблицы¶

static Cake\ORM\TableRegistry::get($alias, $config)¶

При загрузке таблиц из реестра, вы можете изменить их зависимости или использовать mock-объекты, предоставляя массив $options:

$articles = TableRegistry::getTableLocator()->get('Articles', [
    'className' => 'App\Custom\ArticlesTable',
    'table' => 'my_articles',
    'connection' => $connectionObject,
    'schema' => $schemaObject,
    'entityClass' => 'Custom\EntityClass',
    'eventManager' => $eventManager,
    'behaviors' => $behaviorRegistry
]);

Обратите внимание на параметры конфигурации connection и schema. Они принимают не строковые значения, а объекты. Соединение будет принимать объект Cake\Database\Connection и схему Cake\Database\Schema\Collection.

Вы также можете предварительно настроить реестр с помощью метода config(). Данные конфигурации сохраняются для каждого псевдонима и могут быть переопределены методом объекта initialize():

TableRegistry::config('Users', ['table' => 'my_users']);

Очистка реестра¶

static Cake\ORM\TableRegistry::clear¶

Во время тестов вам может понадобиться очистить реестр. Это часто полезно, когда вы используете mock-объекты или изменяете зависимости таблиц:

TableRegistry::clear();

Настройка пространства имён для расположения ORM классов¶

Если вы не соблюдали соглашения, вероятней всего CakePHP не сможет найти ваши классы Table и Entity. Чтобы исправить это, вы можете установить пространство имён с помощью метода Cake\Core\Configure::write. Например:

/src
    /App
        /My
            /Namespace
                /Model
                    /Entity
                    /Table

Для схемы выше будет следующая настройка:

Cake\Core\Configure::write('App.namespace', 'App\My\Namespace');