Класс Таблица

Обработка делегирования поведения + динамических методов поиска.

Если ваша таблица использует какое-либо поведение, вы можете вызвать его, как если бы он был в объекте таблицы.

Параметры

Возвращает

Исключения

Инициализирует новый экземпляр

Массив $config понимает следующие ключи:

• table: Имя таблицы базы данных для представления
• alias: Псевдоним, который будет назначен этой таблице (по умолчанию - имя таблицы)
• connection: Экземпляр подключения, который нужно использовать
• entityClass: Полное имя класса сущности, который будет представлять строки в этой таблице.
• schema: Объект \Cake\Database\Schema\TableSchemaInterface или массив, который можно передать в него.
• eventManager: Экземпляр менеджера событий для использования для внутренних событий
• behaviors: Объект BehaviorRegistry. Обычно не используется вне тестов.
• associations: Экземпляр AssociationCollection.
• validator: Экземпляр Validator, который назначается как набор валидации «по умолчанию», или ассоциативный массив, где ключ — имя набора валидации, а значение — экземпляр Validator.

Параметры

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

Возвращает

Возвращает ассоциацию, названную по переданному значению, если она существует, в противном случае генерирует исключение.

Параметры

Возвращает

Исключения

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

Параметры

Возвращает

Параметры

Возвращает

Предоставляет динамические методы findBy и findAllBy.

Параметры

Возвращает

Исключения

Обрабатывает логику выполнения работника внутри транзакции.

Параметры

Возвращает

Возвращает объект запроса для findOrCreate().

Параметры

Возвращает

Переопределите эту функцию для изменения схемы, используемой этой таблицей. Эта функция вызывается только после извлечения схемы из базы данных. Если вы хотите предоставить свою собственную схему этой таблице, не затрагивая базу данных, вы можете переопределить schema() или внедрить определения через этот метод.

Пример:

protected function _initializeSchema(\Cake\Database\Schema\TableSchemaInterface $schema) {
 $schema->setColumnType('preferences', 'json');
 return $schema;
}

Параметры

Возвращает

Вспомогательная функция для обработки вставки данных сущности в таблицу

Параметры

Возвращает

Исключения

Генерирует значение первичного ключа для новой записи.

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

Примечание. СУОБ не будет генерировать значения первичного ключа для составных первичных ключей. Вы можете переопределить _newId() в вашем классе таблицы.

Параметры

Возвращает

Обрабатывает сохранение связанных ассоциаций дочерних элементов и выполнение логики afterSave после успешного сохранения сущности этой таблицы.

Параметры

Возвращает

Исключения

Выполняет операцию удаления.

Удалить предоставленную сущность. Удалить строки из любых зависимых ассоциаций и очистить таблицы соединений для ассоциаций BelongsToMany.

Параметры

Возвращает

Исключения

Выполняет фактический поиск и/или создание сущности на основе переданных параметров.

Параметры

Возвращает

Исключения

Выполняет фактическое сохранение сущности на основе переданных параметров.

Параметры

Возвращает

Вызывает исключения

Параметры

Возвращает

Вызывает исключения

Из массива параметров проверяет, являются ли ключи, описанные в $keys, массивами, и изменяет значения на замыкания, которые будут конкатенировать каждую из свойств в массиве значений при передаче строки.

Это вспомогательная функция, используемая для форматеров результатов, которые могут принимать составные ключи при сравнении значений.

Параметры

Возвращает

Проверяет, выполнил ли вызывающий объект операцию коммита транзакции.

Параметры

Возвращает

Вспомогательная функция для обработки обновления данных сущности в таблице

Параметры

Возвращает

Вызывает исключения

Настройка нескольких ассоциаций.

В качестве аргумента передается массив, содержащий набор имен таблиц, индексированных по типу ассоциации:

$this->Posts->addAssociations([
  'belongsTo' => [
    'Users' => ['className' => 'App\Model\Table\UsersTable']
  ],
  'hasMany' => ['Comments'],
  'belongsToMany' => ['Tags']
]);

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

Параметры

Возвращает

См. также

Добавление поведения.

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

Пример:

Загрузка поведения с некоторыми настройками.

$this->addBehavior('Tree', ['parent' => 'parentId']);

Поведения обычно загружаются во время Table::initialize().

Параметры

Возвращает

Вызывает исключения

См. также

Добавляет массив поведений в коллекцию поведений таблицы.

Пример:

$this->addBehaviors([
     'Timestamp',
     'Tree' => ['level' => 'level'],
]);

Параметры

Возвращает

Вызывает исключения

Присваивает псевдоним полю с текущим псевдонимом таблицы.

Если поле уже имеет псевдоним, результатом будет no-op.

Параметры

Возвращает

Получение коллекции ассоциаций для этой таблицы.

Возвращает

Возвращает реестр поведений для этой таблицы.

Возвращает

Создает новую ассоциацию BelongsTo между этой таблицей и целевой таблицей. Ассоциация "belongs to" — это отношение N-1, где эта таблица — сторона N, а для каждого запии в этой таблице существует единственная связанная запись в целевой таблице.

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

Массив параметров может содержать следующие ключи:

• className: Имя класса объекта целевой таблицы
• targetTable: Экземпляр объекта таблицы, используемый в качестве целевой таблицы
• foreignKey: Имя поля, используемого в качестве внешнего ключа; если ложно, внешний ключ не используется
• conditions: массив с списком условий для фильтрации объединения
• joinType: Тип объединения (например, INNER)
• strategy: Стратегия загрузки. Поддерживаются 'join' и 'select'.
• finder: Метод поиска для загрузки записей из этой ассоциации. По умолчанию 'all'. Когда стратегия 'join', только поля, включения и условия where будут использоваться из поиска.

Этот метод вернет объект ассоциации, который был создан.

Параметры

Возвращает

Создаёт новую ассоциацию BelongsToMany между этой таблицей и целевой таблицей. Ассоциация «belongs to many» — это отношение М-К.

Целевую таблицу можно определить по её имени, которое указывается в первом аргументе, или можно передать имя класса для создания экземпляра, или непосредственно экземпляр класса.

Массив параметров принимает следующие ключи:

• className: Имя класса объекта целевой таблицы.
• targetTable: Экземпляр объекта таблицы, используемый в качестве целевой таблицы.
• foreignKey: Название поля, используемого в качестве внешнего ключа.
• targetForeignKey: Название поля, используемого в качестве внешнего ключа целевой таблицы.
• joinTable: Название таблицы, представляющей связь между двумя таблицами.
• through: Если вы решили использовать уже созданную таблицу связи, установите этот ключ на экземпляр Table, содержащий ассоциации с исходной и целевой таблицами в данной ассоциации.
• dependent: Установите в значение false, если вы не хотите удалять записи таблицы соединения при удалении записи владельца.
• cascadeCallbacks: Установите в значение true, если вы хотите, чтобы CakePHP запускал обратные вызовы при каскадных удалениях. Если false, ORM будет использовать deleteAll() для удаления данных. При значении true, записи таблицы соединения будут загружены, а затем удалены.
• conditions: массив с перечнем условий для фильтрации соединения.
• sort: Порядок, в котором должны возвращаться результаты этой ассоциации.
• strategy: Стратегия, используемая для выбора результатов. Доступны 'select' и 'subquery'. Если выбрана стратегия 'subquery', запрос, используемый для возврата результатов в исходной таблице, будет использован как условия для получения строк в целевой таблице.
• saveStrategy: 'append' или 'replace'. Указывает режим, используемый для сохранения связанных сущностей. Первый вариант создаст только новые ссылки между обеими сторонами отношения, а второй — очистит и перезапишет, чтобы создать ссылки между переданными сущностями при сохранении.
• strategy: Стратегия загрузки. Поддерживаются 'select' и 'subquery'.
• finder: Метод поиска, используемый при загрузке записей из этой ассоциации. По умолчанию — 'all'.

Этот метод возвращает объект ассоциации, который был создан.

Параметры

Возвращает

Возвращает объект RulesChecker после модификации объекта, переданного в качестве аргумента.

Подклассы должны переопределять этот метод, чтобы инициализировать правила, которые будут применяться к сущностям, сохранённым этим экземпляром.

Параметры

Возвращает

Вызывает метод поиска и применяет его к переданному запросу.

Параметры

Возвращает

Выбрасывает

Проверяет, помещаются ли все сочетания имен таблиц и столбцов, используемые в запросах, в максимальную длину, разрешённую драйвером базы данных.

Возвращает

Выбрасывает

Возвращает, соответствует ли переданная сущность всем правилам, хранящимся в проверяющем объекте правил.

Параметры

Возвращает

Создаёт валидатор с использованием пользовательского метода внутри вашего класса.

Этот метод используется только для создания нового валидатора и не сохраняет его в вашем объекте. Если вы хотите создать и повторно использовать валидаторы, используйте метод getValidator().

Параметры

Возвращает

Выбрасывает

Получить имя соединения по умолчанию.

Этот метод используется для получения имени соединения по умолчанию, если экземпляр создаётся через TableLocator без указания соединения.

Возвращает

См. также

Удалить одну сущность.

Для ассоциаций HasMany и HasOne записи будут удалены в зависимости от параметра dependent. Записи таблицы соединения в ассоциациях BelongsToMany всегда будут удалены. Вы можете использовать параметр cascadeCallbacks при определении ассоциаций, чтобы изменить способ удаления связанных данных.

Параметры

• atomic По умолчанию true. При значении true удаление происходит в транзакции.
• checkRules По умолчанию true. Проверка правил удаления перед удалением записи.

События

• Model.beforeDelete Срабатывает перед выполнением удаления. Если остановлено, удаление будет прервано. Принимает событие, сущность и параметры.
• Model.afterDelete Срабатывает после успешного выполнения удаления. Принимает событие, сущность и параметры.
• Model.afterDeleteCommit Срабатывает после подтверждения транзакции при атомарном удалении. Принимает событие, сущность и параметры.

Аргумент options будет преобразован в экземпляр \ArrayObject на период обработки обратных вызовов. Это позволяет слушателям изменять параметры, используемые в операции удаления.

Параметры

Возвращает

Удаляет все записи, соответствующие заданным условиям.

Этот метод не вызовет события beforeDelete/afterDelete. Если вам нужны эти события, сначала загрузите коллекцию записей и удалите их.

Этот метод не будет выполняться для атрибута cascade ассоциаций. Если вам нужно каскадное удаление вместе с этим методом, используйте внешние ключи базы данных + правила ON CASCADE.

Параметры

Возвращает

Удаляет несколько сущностей таблицы.

Записи будут удалены в транзакции, которая будет откачена, если удаление одной из записей завершится неудачей из-за несоответствия валидации или ошибки базы данных.

Параметры

Возвращает

См. также

Удаляет несколько сущностей таблицы.

Записи будут удалены в транзакции, которая будет откачена, если удаление одной из записей завершится неудачей из-за несоответствия валидации или ошибки базы данных.

Параметры

Возвращает

Выбрасывает

См. также

Попытка удалить сущность или выбросить PersistenceFailedException, если сущность новая, не имеет значения первичного ключа, проверки правил приложения завершились неудачно или удаление было прервано обратным вызовом.

Параметры

Возвращает

Выбрасывает

См. также

Обёртка для создания и отправки событий.

Возвращает отправленное событие.

Параметры

Возвращает

Возвращает true, если в этом репозитории есть запись, соответствующая указанным условиям.

Параметры

Возвращает

Создаёт новый запрос для этого репозитория и применяет некоторые значения по умолчанию, основанные на типе выбранного поиска.

Событие Model.beforeFind

Каждый find() вызовет событие Model.beforeFind для всех присоединённых слушателей. Любой слушатель может установить корректный результат запроса, используя $query

По умолчанию, $options распознает следующие ключи:

• fields
• conditions
• order
• limit
• offset
• page
• group
• having
• contain
• join

Использование

Использование массива опций:

$query = $articles->find('all', [
  'conditions' => ['published' => 1],
  'limit' => 10,
  'contain' => ['Users', 'Comments']
]);

Использование интерфейса билдера:

$query = $articles->find()
  ->where(['published' => 1])
  ->limit(10)
  ->contain(['Users', 'Comments']);

Вызов находок

Метод find() — точка входа для пользовательских методов поиска. Вы можете вызвать поиск, указав тип:

$query = $articles->find('published');

Вызовет метод findPublished.

Параметры

Возвращает

Возвращает запрос, как он был передан.

По умолчанию findAll() не применяет никаких условий, вы можете переопределить этот метод в подклассах, чтобы изменить работу find('all').

Параметры

Возвращает

Возвращает объект ассоциации, настроенный для указанного псевдонима, если таковой имеется.

Аргумент name также поддерживает синтаксис точек для доступа к более глубоким ассоциациям.

$users = $this->getAssociation('Articles.Comments.Users');

Параметры

Возвращает

Настраивает объект запроса так, чтобы результаты отображались как индексированный массив, что полезно в тех случаях, когда вам нужен список, например, для заполнения выпадающих списков.

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

Результаты этого поиска будут иметь следующий вид:

[
 1 => 'value for id 1',
 2 => 'value for id 2',
 4 => 'value for id 4'
]

Вы можете указать, какое свойство будет использоваться в качестве ключа, а какое в качестве значения, используя массив $options. Если не указано, он будет использовать результат вызова primaryKey и displayField соответственно в этой таблице:

$table->find('list', [
 'keyField' => 'name',
 'valueField' => 'age'
]);

valueField также может быть массивом, в этом случае вы также можете указать опцию valueSeparator, чтобы управлять тем, как значения будут конкатенироваться:

$table->find('list', [
 'valueField' => ['first_name', 'last_name'],
 'valueSeparator' => ' | ',
]);

Результаты этого поиска будут иметь следующий вид:

[
 1 => 'John | Doe',
 2 => 'Steve | Smith'
]

Результаты могут быть объединены в более крупные группы, если они разделяют свойство. Вы можете настроить свойство для группировки, установив groupField:

$table->find('list', [
 'groupField' => 'category_id',
]);

При использовании groupField результаты будут возвращены в таком формате:

[
 'group_1' => [
     1 => 'value for id 1',
     2 => 'value for id 2',
 ]
 'group_2' => [
     4 => 'value for id 4'
 ]
]

Параметры

Возвращает

Ищет существующую запись или создаёт новую.

Проводится поиск() для поиска существующей записи, используя атрибуты, определённые в $search. Если записи соответствуют условиям, возвращается первая запись.

Если запись не найдена, создаётся новая сущность с свойствами $search. Если предоставлен обратный вызов, он будет вызван, позволяя определить дополнительные значения по умолчанию. Новая сущность будет сохранена и возвращена.

Если условия поиска требуют настраиваемого порядка, ассоциаций или условий, то параметр $search может быть вызываемой функцией, которая принимает запрос в качестве аргумента, или объектом \Cake\ORM\Query, переданным в качестве параметра $search. Это позволяет настроить результаты поиска.

Параметры

Массив options передаётся методу save со следующими исключениями:

• atomic: Выполнять ли методы find, save и обратные вызовы внутри транзакции базы данных (по умолчанию: true)
• defaults: Использовать ли критерии поиска в качестве значений по умолчанию для новой сущности (по умолчанию: true)

Параметры

Возвращает

Выбрасывает

Результаты этого поиска будут вложенным массивом и подходят, если вы хотите использовать поле parent_id данных вашей модели для построения вложенных результатов.

Значения, относящиеся к родительской строке на основе их значения parent_id, будут рекурсивно вложены внутри значений родительской строки с использованием свойства children

Вы можете настроить, какие поля используются для вложения результатов. По умолчанию используются поля первичного ключа и parent_id. Если вы хотите изменить эти значения по умолчанию, вам необходимо указать ключи keyField, parentField или nestingKey в $options:

$table->find('threaded', [
 'keyField' => 'id',
 'parentField' => 'ancestor_id',
 'nestingKey' => 'children'
]);

Параметры

Возвращает

Возвращает одну запись после поиска по её первичному ключу. Если запись не найдена, этот метод выбрасывает исключение.

Использование

Получение статьи и некоторых отношений:

$article = $articles->get(1, ['contain' => ['Users', 'Comments']]);

Параметры

Возвращает

Выбрасывает

См. также

Возвращает псевдоним таблицы.

Возвращает

Возвращает объект ассоциации, настроенный для указанного псевдонима.

Аргумент name также поддерживает синтаксис точек для доступа к более глубоким ассоциациям.

$users = $this->getAssociation('Articles.Comments.Users');

Обратите внимание, что этот метод требует наличия ассоциации, в противном случае он выбросит исключение. Если вы не уверены, используйте hasAssociation() перед вызовом этого метода.

Параметры

Возвращает

Исключения

Получить поведение из реестра.

Параметры

Возвращает

Исключения

Возвращает экземпляр соединения.

Возвращает

Возвращает поле отображения.

Возвращает

Возвращает класс, используемый для гидратации строк для этой таблицы.

Возвращает

Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.

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

Возвращает

Возвращает имя поля первичного ключа.

Возвращает

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

Возвращает

Получает экземпляр SaveOptionsBuilder.

Параметры

Возвращает

Возвращает объект схемы таблицы, описывающий свойства этой таблицы.

Возвращает

Возвращает имя таблицы базы данных.

Это может включать имя схемы базы данных, если оно задано с использованием setTable().

Возвращает

Возвращает правила проверки, помеченные с помощью $name. Возможно иметь несколько различных наборов проверки с именами, что полезно, когда вам нужно использовать различные правила при сохранении из разных процедур вашей системы.

Если ранее валидатор не был задан, этот метод создаст валидатор, используя метод внутри вашего класса.

Например, если вы хотите создать набор проверки под названием 'forSubscription', вам нужно создать метод в вашем подклассе Table следующим образом:

public function validationForSubscription($validator)
{
    return $validator
        ->add('email', 'valid-email', ['rule' => 'email'])
        ->add('password', 'valid', ['rule' => 'notBlank'])
        ->requirePresence('username');
}

$validator = $this->getValidator('forSubscription');

Вы можете реализовать метод в validationDefault в вашем подклассе Table, если хотите иметь набор проверки, который применяется в тех случаях, когда не указан другой набор.

Если аргумент $name не указан, будет возвращён валидатор по умолчанию. Вы можете настроить имя валидатора по умолчанию в DEFAULT_VALIDATOR константе класса.

Параметры

Возвращает

Проверяет, существует ли определённая ассоциация в этом экземпляре Table.

Аргумент name также поддерживает синтаксис точек для доступа к более глубоким ассоциациям.

$hasUsers = $this->hasAssociation('Articles.Comments.Users');

Параметры

Возвращает

Проверяет, загружено ли поведение с данным псевдонимом.

Параметры

Возвращает

Проверка наличия определённого поля/колонки в таблице.

Делегирует запрос к объекту схемы и проверяет наличие колонки, используя экземпляр Schema\Table.

Параметры

Возвращает

Возвращает true, если поиск существует для таблицы

Параметры

Возвращает

Создаёт новую ассоциацию HasMany между этой таблицей и целевой таблицей. Ассоциация "has many" - это отношение 1-N.

Целевая таблица может быть определена по её имени, которое указано в первом аргументе, или вы можете передать имя класса для создания или экземпляр класса непосредственно.

Массив options принимает следующие ключи:

• className: Имя класса объекта целевой таблицы
• targetTable: Экземпляр объекта таблицы, используемый в качестве целевой таблицы
• foreignKey: Имя поля для использования в качестве внешнего ключа, если false, не будет использоваться
• dependent: Установите в значение true, если вы хотите, чтобы CakePHP каскадно удалял связанные данные в целевой таблице, когда сущность удаляется в этой таблице. Операция удаления в связанной таблице не будет каскадно удалять дальше. Чтобы получить рекурсивные каскадные удаления, включите cascadeCallbacks также. Установите в значение false, если вы не хотите, чтобы CakePHP удалял связанные данные, или когда вы используете ограничения базы данных.
• cascadeCallbacks: Установите в значение true, если вы хотите, чтобы CakePHP вызывал обратные вызовы при каскадном удалении. Если false, ORM будет использовать deleteAll() для удаления данных. При значении true записи будут загружены, а затем удалены.
• conditions: массив с списком условий для фильтрации соединения
• sort: Порядок, в котором должны возвращаться результаты для этой ассоциации
• saveStrategy: Либо 'append', либо 'replace'. При 'append' текущие записи добавляются к любым записям в базе данных. При 'replace' связанные записи, не включённые в текущий набор, будут удалены. Если внешний ключ является полем, допускающим значения null, или если dependent имеет значение true, записи будут сиротами.
• strategy: Стратегия, используемая для выбора результатов. Либо 'select', либо 'subquery'. Если выбран subquery, запрос, используемый для возвращения результатов в исходной таблице, будет использоваться в качестве условий для получения строк в целевой таблице.
• finder: Метод поиска, который нужно использовать при загрузке записей из этой ассоциации. По умолчанию 'all'.

Этот метод вернёт объект ассоциации, который был создан.

Параметры

Возвращает

Создаёт новую ассоциацию HasOne между этой таблицей и целевой таблицей. Ассоциация «имеет один» — это отношение 1-1.

Целевую таблицу можно определить по её имени, которое передаётся в первом аргументе, или вы можете передать имя класса для его экземпляризации, или непосредственно экземпляр класса.

Массив опций принимает следующие ключи:

• className: Имя класса объекта целевой таблицы
• targetTable: Экземпляр объекта таблицы, используемый в качестве целевой таблицы
• foreignKey: Имя поля, используемого в качестве внешнего ключа; если false, внешний ключ не используется
• dependent: Устанавливается в true, если вы хотите, чтобы CakePHP каскадно удалял связанные данные в целевой таблице, когда запись удаляется из этой таблицы. Операция удаления в связанной таблице не будет каскадироваться дальше. Чтобы получить рекурсивную каскадную обработку, также включите cascadeCallbacks. Установите в false, если вы не хотите, чтобы CakePHP удалял связанные данные, или когда вы используете ограничения базы данных.
• cascadeCallbacks: Устанавливается в true, если вы хотите, чтобы CakePHP вызывал обратные вызовы при каскадном удалении. Если false, ORM будет использовать deleteAll() для удаления данных. При true записи будут загружены, а затем удалены.
• conditions: Массив с перечнем условий для фильтрации объединения
• joinType: Тип объединения (например, LEFT)
• strategy: Стратегия загрузки. Поддерживаются 'join' и 'select'.
• finder: Метод поиска для загрузки записей из этой ассоциации. По умолчанию 'all'. Если стратегия 'join', из метода поиска будут использованы только поля, включения и условия where.

Этот метод вернёт объект ассоциации, который был создан.

Параметры

Возвращаемое значение

Проверяет, установлен ли валидатор.

Параметры

Возвращаемое значение

Получает обратные вызовы модели, к которым заинтересована данная таблица.

Реализуя стандартные методы, предполагается, что класс таблицы заинтересован в соответствующем событии.

Переопределите этот метод, если вам нужно добавить обработчики событий, не относящиеся к стандарту. Или если вы хотите, чтобы ваша таблица прослушивала нестандартные события.

Стандартная карта методов:

• Model.beforeMarshal => beforeMarshal
• Model.afterMarshal => afterMarshal
• Model.buildValidator => buildValidator
• Model.beforeFind => beforeFind
• Model.beforeSave => beforeSave
• Model.afterSave => afterSave
• Model.afterSaveCommit => afterSaveCommit
• Model.beforeDelete => beforeDelete
• Model.afterDelete => afterDelete
• Model.afterDeleteCommit => afterDeleteCommit
• Model.beforeRules => beforeRules
• Model.afterRules => afterRules

Возвращаемое значение

Инициализирует экземпляр таблицы. Вызывается после конструктора.

Вы можете использовать этот метод для определения ассоциаций, добавления бихевиоров, определения валидации и выполнения других необходимых операций инициализации.

public function initialize(array $config)
 {
     $this->belongsTo('Users');
     $this->belongsToMany('Tagging.Tags');
     $this->setPrimaryKey('something_else');
 }

Параметры

Возвращаемое значение

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

Пример:

$user = $usersTable->get(1);
$user = $usersTable->loadInto($user, ['Articles.Tags', 'Articles.Comments']);
echo $user->articles[0]->title;

Вы также можете загрузить ассоциации для нескольких объектов одновременно

Пример:

$users = $usersTable->find()->where([...])->toList();
$users = $usersTable->loadInto($users, ['Articles.Tags', 'Articles.Comments']);
echo $user[1]->articles[0]->title;

Свойства ассоциаций, которые будут загружены, перезапишутся для каждого объекта.

Параметры

Возвращаемое значение

См. также

Получить объект, используемый для маршаллирования/преобразования данных массива в объекты.

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

Возвращаемое значение

См. также

Создаёт новый объект сущности.

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

Возвращаемое значение

Создаёт список объектов + связанных объектов из массива.

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

$articles = $this->Articles->newEntities(
  $this->request->getData(),
  ['associated' => ['Tags', 'Comments.Users']]
);

Вы можете ограничить поля, присутствующие в созданных объектах, передав параметр fields, который также принимается для ассоциаций:

$articles = $this->Articles->newEntities($this->request->getData(), [
 'fields' => ['title', 'body', 'tags', 'comments'],
 'associated' => ['Tags', 'Comments.Users' => ['fields' => 'username']]
 ]
);

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

Параметры

Возвращаемое значение

Создаёт новый объект + связанные объекты из массива.

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

$article = $this->Articles->newEntity(
  $this->request->getData(),
  ['associated' => ['Tags', 'Comments.Users']]
);

Вы можете ограничить поля, присутствующие в созданном объекте, передав параметр fields, который также принимается для ассоциаций:

$article = $this->Articles->newEntity($this->request->getData(), [
 'fields' => ['title', 'body', 'tags', 'comments'],
 'associated' => ['Tags', 'Comments.Users' => ['fields' => 'username']]
]
);

Параметр fields позволяет удалить или ограничить данные входных данных, которые попадают в объект. Если вы хотите ослабить доступные поля объекта по умолчанию, вы можете использовать параметр accessibleFields:

$article = $this->Articles->newEntity(
  $this->request->getData(),
  ['accessibleFields' => ['protected_field' => true]]
);

По умолчанию данные валидируются перед передачей новому объекту. В случае некорректных полей они не будут присутствовать в результирующем объекте. Параметр validate может быть использован для отключения валидации на переданных данных:

$article = $this->Articles->newEntity(
  $this->request->getData(),
  ['validate' => false]
);

Вы также можете передать имя валидатора для использования в параметре validate. Если null передаётся в первый параметр этой функции, никакая валидация не будет выполнена.

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

Параметры

Возвращаемое значение

См. также

Объединяет каждый из элементов, переданных в $data, в объекты, найденные в $entities, учитывая доступные поля, настроенные для объектов. Объединение выполняется путём сопоставления первичного ключа в каждом элементе в $data и $entities.

Записи в $entities, которые не могут быть сопоставлены с какой-либо записью в $data, будут отброшены. Записи в $data, которые не смогли быть сопоставлены, будут маршаллированы как новые объекты.

При объединении ассоциаций HasMany или BelongsToMany все объекты в массиве $data будут отображаться, те, которые могут быть сопоставлены по первичному ключу, получат данные, объединённые, но те, которые не могут, будут отброшены.

Вы можете ограничить поля, которые будут присутствовать в объединённых объектах, передав параметр fields, который также принимается для ассоциаций:

$articles = $this->Articles->patchEntities($articles, $this->request->getData(), [
 'fields' => ['title', 'body', 'tags', 'comments'],
 'associated' => ['Tags', 'Comments.Users' => ['fields' => 'username']]
 ]
);

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

Параметры

Возвращаемое значение

Объединяет переданные $data в $entity, учитывая доступные поля, настроенные для сущности. Возвращает ту же сущность после изменения.

При объединении ассоциаций HasMany или BelongsToMany все сущности в массиве $data появятся, те, которые могут быть сопоставлены по первичному ключу, получат объединённые данные, а те, которые нет – будут отброшены.

Вы можете ограничить поля, которые будут присутствовать в объединённой сущности, передав опцию fields, которая также поддерживается для ассоциаций:

$article = $this->Articles->patchEntity($article, $this->request->getData(), [
 'fields' => ['title', 'body', 'tags', 'comments'],
 'associated' => ['Tags', 'Comments.Users' => ['fields' => 'username']]
 ]
);

$article = $this->Articles->patchEntity($article, $this->request->getData(), [
  'associated' => [
    'Tags' => ['accessibleFields' => ['*' => true]]
  ]
]);

По умолчанию данные проверяются перед передачей в сущность. В случае невалидных полей они не будут назначены сущности. Опцию validate можно использовать для отключения проверки переданных данных:

$article = $this->patchEntity($article, $this->request->getData(),[
 'validate' => false
]);

Вы можете использовать событие Model.beforeMarshal для изменения данных запроса перед их преобразованием в сущности.

При обновлении скалярных значений (null/boolean/string/integer/float), если свойство в настоящее время имеет идентичное значение, вызыватель не будет вызван, и свойство не будет помечено как изменённое. Это оптимизация, предотвращающая ненужное обновление полей при сохранении сущностей.

Параметры

Возвращает

См. также

Создаёт новый экземпляр Query для таблицы.

Возвращает

Удаляет поведение из реестра поведения этой таблицы.

Пример:

Удаление поведения из этой таблицы.

$this->removeBehavior('Tree');

Параметры

Возвращает

См. также

Возвращает RulesChecker для этого экземпляра.

Объект RulesChecker используется для проверки сущности на соответствие правилам, которые могут включать сложную логику или данные, которые необходимо извлечь из соответствующих источников данных.

Возвращает

См. также

Сохраняет сущность на основе помеченных как изменённые полей и возвращает ту же сущность после успешного сохранения или false в случае ошибки.

Опции

Массив опций принимает следующие ключи:

• atomic: Выполнять ли сохранение и обратные вызовы внутри транзакции базы данных (по умолчанию: true)
• checkRules: Проверять ли правила на сущности перед сохранением; если проверка завершится неудачно, операция сохранения будет прервана. (по умолчанию: true)
• associated: Если true, будут сохранены связанные сущности 1-го уровня, как они найдены в переданном $entity, всякий раз, когда свойство, определённое для ассоциации, помечается как изменённое. Если массив, он будет интерпретирован как список ассоциаций, которые нужно сохранить. Можно указать разные опции для сохранения объектов связанной таблицы, используя этот ключ, сделав пользовательские опции значением массива. Если false, связанные записи не будут сохранены. (по умолчанию: true)
• checkExisting: Проверять ли, существует ли сущность, предполагая, что сущность не помечена как новая, и первичный ключ был установлен.

События

При сохранении этот метод будет вызывать четыре события:

• Model.beforeRules: Вызывается непосредственно перед любой проверкой правил для переданной сущности, если ключ checkRules в $options не установлен в false. Обработчики получат в качестве аргументов сущность, массив опций и тип операции. Если событие остановлено, результат проверки правил будет установлен в результат самого события.
• Model.afterRules: Вызывается сразу после вызова метода checkRules() для сущности. Обработчики получат в качестве аргументов сущность, массив опций, результат проверки правил и тип операции. Если событие остановлено, результат проверки будет установлен в результат самого события.
• Model.beforeSave: Вызывается непосредственно перед вычислением списка полей, которые нужно сохранить. Он получает как аргументы сущность и массив опций. Массив опций передаётся как ArrayObject, поэтому любые изменения в нём будут отражены в каждом обработчике и запомнятся в конце события, чтобы они могли быть использованы для остальной части операции сохранения. Возврат false в любом из обработчиков прервёт процесс сохранения. Если событие остановлено с помощью API события, свойство result объекта события будет возвращено. Это может быть полезно, когда реализован собственный механизм сохранения внутри обработчика.
• Model.afterSave: Вызывается после успешного вставки или сохранения; обработчики получат в качестве аргументов сущность и массив опций. Тип выполненной операции (вставка или обновление) может быть определён путём проверки метода сущности isNew; true означает вставку, false – обновление.
• Model.afterSaveCommit: Вызывается после подтверждения транзакции для атомарного сохранения; обработчики получат в качестве аргументов сущность и массив опций.

Этот метод определит, нужно ли вставить или обновить переданную сущность в базе данных. Для этого он проверяет метод isNew на сущности. Если сущность, подлежащая сохранению, возвращает ненулевое значение от своего метода errors(), она не будет сохранена.

Сохранение в связанных таблицах

Этот метод по умолчанию сохраняет сущности, принадлежащие связанным таблицам, всякий раз, когда свойство, соответствующее имени свойства, установленного для ассоциации в этой таблице, помечено как изменённое. Можно контролировать, какие ассоциации будут сохранены, и передавать дополнительные опции для их сохранения.

// Only save the comments association
$articles->save($entity, ['associated' => ['Comments']]);

// Save the company, the employees and related addresses for each of them.
// For employees do not check the entity rules
$companies->save($entity, [
  'associated' => [
    'Employees' => [
      'associated' => ['Addresses'],
      'checkRules' => false
    ]
  ]
]);

// Save no associations
$articles->save($entity, ['associated' => false]);

Параметры

Возвращает

Исключения

Сохраняет несколько сущностей таблицы.

Записи будут сохранены в транзакции, которая будет откатана, если какая-либо запись не будет сохранена из-за неудачной проверки или ошибки базы данных.

Параметры

Возвращает

Исключения

Сохраняет несколько сущностей таблицы.

Записи будут сохранены в транзакции, которая будет откатана, если какая-либо запись не будет сохранена из-за неудачной проверки или ошибки базы данных.

Параметры

Возвращает

Исключения

Попробуйте сохранить сущность или выбросить PersistenceFailedException, если проверки прикладных правил завершились неудачей, сущность содержит ошибки или сохранение было прервано обратным вызовом.

Параметры

Возвращает

Исключения

См. также

Устанавливает псевдоним таблицы.

Параметры

Возвращает

Устанавливает экземпляр соединения.

Параметры

Возвращает

Устанавливает поле отображения.

Параметры

Возвращает

Устанавливает класс, используемый для гидрации строк для этой таблицы.

Параметры

Возвращает

Исключения

Возвращает экземпляр Cake\Event\EventManagerInterface для этого объекта.

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

Параметры

Возвращает

Устанавливает имя первичного ключа.

Параметры

Возвращает

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

Параметры

Возвращает

Устанавливает объект схемы таблицы, описывающий свойства этой таблицы.

Если передан массив, из него будет создан новый объект TableSchemaInterface, который будет использоваться в качестве схемы для этой таблицы.

Параметры

Возвращает

Устанавливает имя таблицы базы данных.

Это может включать имя схемы базы данных в формате 'схема.таблица'. Если имя необходимо заключить в кавычки, включите автоматическое заключение идентификаторов в кавычки.

Параметры

Возвращает

Этот метод сохраняет пользовательский валидатор под данным именем.

Вы можете самостоятельно создать объект и сохранить его в своем объекте:

$validator = new \Cake\Validation\Validator();
$validator
    ->add('email', 'valid-email', ['rule' => 'email'])
    ->add('password', 'valid', ['rule' => 'notBlank'])
    ->allowEmpty('bio');
$this->setValidator('forSubscription', $validator);

Параметры

Возвращает

Создаёт новый экземпляр Query::subquery() для таблицы.

Возвращает

См. также

Обновляет все соответствующие записи.

Устанавливает $fields в предоставленные значения на основе $conditions. Этот метод не вызывает события beforeSave/afterSave. Если вам нужны эти события, сначала загрузите коллекцию записей и обновите их.

Параметры

Возвращает

Метод валидации, используемый для проверки уникальности значения для столбца. Он предназначен для использования с API валидации, а не для прямого вызова.

Пример:

$validator->add('email', [
 'unique' => ['rule' => 'validateUnique', 'provider' => 'table']
])

Валидация уникальности может быть ограничена значением другого столбца:

$validator->add('email', [
 'unique' => [
     'rule' => ['validateUnique', ['scope' => 'site_id']],
     'provider' => 'table'
 ]
]);

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

Параметры

Возвращает

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

Параметры

Возвращает

Проверяет наличие метода валидации.

Параметры

Возвращает