Интерфейс RepositoryInterface
Описывает методы, которым должен соответствовать любой класс, представляющий хранилище данных.
Непосредственные реализаторы
Краткое описание методов
- alias() publicВозвращает псевдоним таблицы или задаёт новый
- delete() publicУдаляет одну сущность.
- deleteAll() publicУдаляет все совпадающие записи.
- exists() public
Возвращает true, если в этом репозитории есть какая-либо запись, соответствующая заданным условиям.
- find() public
Создаёт новый запрос для этого репозитория и применяет некоторые значения по умолчанию, основанные на типе выполненного поиска.
- get() public
Возвращает одну запись после её поиска по первичному ключу. Если запись не найдена, метод генерирует исключение.
- hasField() publicПроверяет, содержит ли репозиторий определённое поле/столбец.
- newEntities() publicСоздаёт список сущностей + связанных сущностей из массива.
- newEntity() publicСоздаёт новую сущность + связанные сущности из массива.
- patchEntities() public
Объединяет каждый элемент, переданный в
$data, с сущностями, найденными в$entities, учитывая доступные поля, настроенные для сущностей. Объединение выполняется путём сопоставления первичного ключа в каждом элементе в$dataи$entities. - patchEntity() public
Объединяет переданный
$dataс$entity, учитывая доступные поля, настроенные для сущности. Возвращает ту же сущность после изменения. - query() publicСоздаёт новый экземпляр запроса для этого репозитория
- save() public
Сохраняет сущность на основе полей, помеченных как изменённые, и возвращает ту же сущность после успешного сохранения или false в случае ошибки.
- updateAll() publicОбновляет все совпадающие записи.
Подробное описание методов
alias()source public
alias( string|null $alias null )
Возвращает псевдоним таблицы или задаёт новый
Параметры
- string|null
$aliasoptional null - новый псевдоним таблицы
Возвращает
stringdelete()source public
delete( Cake\Datasource\EntityInterface $entity , array|ArrayAccess $options [] )
Удаляет одну сущность.
Удаляет сущность и, возможно, связанные ассоциации из базы данных, в зависимости от опции 'dependent', используемой при определении ассоциации.
Параметры
-
Cake\Datasource\EntityInterface$entity - Сущность для удаления.
- array|ArrayAccess
$optionsoptional [] - Опции для удаления.
Возвращает
booleanуспех
deleteAll()source public
deleteAll( mixed $conditions )
Удаляет все совпадающие записи.
Удаляет все записи, соответствующие предоставленным условиям.
Этот метод не будет вызывать события beforeDelete/afterDelete. Если вам нужны эти события, сначала загрузите набор записей и удалите их.
Этот метод не будет выполняться для атрибута cascade ассоциаций. Для каскадного удаления следует использовать внешние ключи базы данных + правила ON CASCADE вместе с этим методом.
Параметры
- mixed
$conditions Условия для использования, поддерживает всё, что может принять Query::where().
Возвращает
integerКоличество Возвращает количество затронутых строк.
См. также
\Cake\Datasource\RepositoryInterface::delete()exists()source public
exists( array|ArrayAccess $conditions )
Возвращает true, если в этом репозитории есть какая-либо запись, соответствующая заданным условиям.
Параметры
- array|ArrayAccess
$conditions - список условий для передачи в запрос
Возвращает
booleanfind()source public
find( string $type 'all' , array|ArrayAccess $options [] )
Создаёт новый запрос для этого репозитория и применяет некоторые значения по умолчанию, основанные на типе выполненного поиска.
Событие Model.beforeFind
Каждый find() будет вызывать событие Model.beforeFind для всех подключенных слушателей. Любой слушатель может установить корректный результат набора данных с помощью $query
Параметры
- string
$typeoptional 'all' - тип запроса для выполнения
- array|ArrayAccess
$optionsoptional [] - Массив, который будет передан в Query::applyOptions()
Возвращает
Cake\ORM\Queryget()source public
get( mixed $primaryKey , array|ArrayAccess $options [] )
Возвращает одну запись после её поиска по первичному ключу. Если запись не найдена, метод генерирует исключение.
Пример:
$id = 10; $article = $articles->get($id); $article = $articles->get($id, ['contain' => ['Comments]]);
Параметры
- mixed
$primaryKey - значение первичного ключа для поиска
- array|ArrayAccess
$optionsoptional [] - опции, принимаемые
Table::find()
Возвращает
Cake\Datasource\EntityInterfaceИсключения
Cake\Datasource\Exception\RecordNotFoundExceptionесли запись с таким идентификатором не была найдена
См. также
\Cake\Datasource\RepositoryInterface::find()hasField()source public
hasField( string $field )
Проверяет, содержит ли репозиторий определённое поле/столбец.
Параметры
- string
$field - Поле, которое нужно проверить.
Возвращает
booleanTrue, если поле существует, false — если нет.
newEntities()source public
newEntities( array $data , array $options [] )
Создаёт список сущностей + связанных сущностей из массива.
Это наиболее полезно при гидратации данных запроса обратно в сущности. Например, в вашем коде контроллера:
$articles = $this->Articles->newEntities($this->request->data());
Гидратированные сущности можно затем перебирать и сохранять.
Параметры
- array
$data - Данные для создания сущности.
- array
$optionsoptional [] - Список опций для гидратации объектов.
Возвращает
arrayМассив гидратированных записей.
newEntity()source public
newEntity( array|null $data null , array $options [] )
Создаёт новую сущность + связанные сущности из массива.
Это наиболее полезно при гидратации данных запроса обратно в сущности. Например, в вашем коде контроллера:
$article = $this->Articles->newEntity($this->request->data());
Гидратированная сущность корректно выполнит вставку/обновление на основе данных первичного ключа, существующих в базе данных, при сохранении сущности. До сохранения сущности она будет представлять собой откреплённую запись.
Параметры
- array|null
$dataoptional null - Данные для создания сущности.
- array
$optionsoptional [] - Список опций для гидратации объекта.
Возвращает
Cake\Datasource\EntityInterfacepatchEntities()source public
patchEntities( array|Traversable $entities , array $data , array $options [] )
Объединяет каждый из переданных элементов $data с сущностями, найденными в $entities, с учётом доступных полей, настроенных для сущностей. Объединение выполняется путем сопоставления первичного ключа в каждом из элементов в $data и $entities.
Это наиболее полезно при редактировании списка существующих сущностей с использованием данных запроса:
$article = $this->Articles->patchEntities($articles, $this->request->data());
Параметры
- array|Traversable
$entities сущности, которым будут добавлены данные
- array
$data - список массивов, которые будут объединены с сущностями
- array
$optionsнеобязательно [] - Список параметров для гидратации объектов.
Возвращает
arraypatchEntity()source public
patchEntity( Cake\Datasource\EntityInterface $entity , array $data , array $options [] )
Объединяет переданные $data с $entity, учитывая доступные поля, настроенные для сущности. Возвращает ту же сущность после изменения.
Это наиболее полезно при редактировании существующей сущности с использованием данных запроса:
$article = $this->Articles->patchEntity($article, $this->request->data());
Параметры
-
Cake\Datasource\EntityInterface$entity сущность, которой будут добавлены данные
- array
$data - список значений полей для объединения с сущностью
- array
$optionsнеобязательно [] - Список параметров для гидратации объекта.
Возвращает
Cake\Datasource\EntityInterfacequery()source public
query( )
Создает новый экземпляр Query для этого хранилища.
Возвращает
Cake\ORM\Querysave()source public
save( Cake\Datasource\EntityInterface $entity , array|ArrayAccess $options [] )
Сохраняет сущность на основе полей, помеченных как измененные, и возвращает ту же сущность после успешного сохранения или false в случае ошибки.
Параметры
-
Cake\Datasource\EntityInterface$entity - сущность для сохранения
- array|ArrayAccess
$optionsнеобязательно [] - Параметры для сохранения.
Возвращает
Cake\Datasource\EntityInterface|booleanupdateAll()source public
updateAll( array $fields , mixed $conditions )
Обновляет все совпадающие записи.
Устанавливает $fields в предоставленные значения на основе $conditions. Этот метод не будет вызывать события beforeSave/afterSave. Если вам нужны эти события, сначала загрузите коллекцию записей и обновите их.
Параметры
- array
$fields - Хэш поля => новое значение.
- mixed
$conditions Условия, которые будут использоваться, поддерживаются функцией Query::where().
Возвращает
integerКоличество обновлённых строк.
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.2/class-Cake.Datasource.RepositoryInterface.html