Интерфейс RepositoryInterface

alias()source public

alias( string|null $alias null )

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

Параметры

string|null $alias optional null

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

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

string

delete()source public

delete( Cake\Datasource\EntityInterface $entity , array|ArrayAccess $options [] )

Удаляет отдельную сущность.

Удаляет сущность и, возможно, связанные ассоциации из базы данных на основе параметра «зависимые», используемого при определении ассоциации.

Параметры

Cake\Datasource\EntityInterface $entity

Сущность для удаления.

array|ArrayAccess $options optional []

Параметры для удаления.

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

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

список условий для передачи запросу

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

boolean

find()source public

find( string $type 'all' , array|ArrayAccess $options [] )

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

Событие модели Model.beforeFind

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

Параметры

string $type optional 'all'

тип запроса для выполнения

array|ArrayAccess $options optional []

Массив, который будет передан в Query::applyOptions()

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

Cake\ORM\Query

get()source public

get( mixed $primaryKey , array|ArrayAccess $options [] )

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

Пример:

$id = 10;
$article = $articles->get($id);

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

Параметры

mixed $primaryKey

значение первичного ключа для поиска

array|ArrayAccess $options optional []

опции, принимаемые Table::find()

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

Cake\Datasource\EntityInterface

Исключения

Cake\Datasource\Exception\RecordNotFoundException

если запись с таким идентификатором не найдена

См. также

\Cake\Datasource\RepositoryInterface::find()

hasField()source public

hasField( string $field )

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

Параметры

string $field

Поле для проверки.

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

boolean
True, если поле существует, false — если нет.

newEntities()source public

newEntities( array $data , array $options [] )

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

Это наиболее полезно при гидратации данных запроса обратно в сущности. Например, в коде контроллера:

$articles = $this->Articles->newEntities($this->request->data());

Затем гидратированные сущности можно итерировать и сохранять.

Параметры

array $data

Данные для создания сущности.

array $options optional []

Список параметров для гидратации объектов.

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

array
Массив гидратированных записей.

newEntity()source public

newEntity( array|null $data null , array $options [] )

Создаёт новую сущность + связанные сущности из массива.

Это наиболее полезно при гидратации данных запроса обратно в сущности. Например, в коде контроллера:

$article = $this->Articles->newEntity($this->request->data());

Гидратированная сущность корректно выполнит вставку/обновление на основе данных первичного ключа, существующих в базе данных, при сохранении сущности. До тех пор, пока сущность не будет сохранена, она будет являться откреплённой записью.

Параметры

array|null $data optional null

Данные для создания сущности.

array $options optional []

Список параметров для гидратации объекта.

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

Cake\Datasource\EntityInterface

patchEntities()source public

patchEntities( array|Traversable $entities , array $data , array $options [] )

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

Это наиболее полезно при редактировании списка существующих сущностей с использованием данных запроса:

$article = $this->Articles->patchEntities($articles, $this->request->data());

Параметры

массив|Перечисляемый $entities

сущности, в которые будут добавлены данные

массив $data

список массивов, которые будут объединены с сущностями

массив $options необязательно []

Список параметров для гидратации объектов.

Возвращает

массив

patchEntity()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

сущность, в которую будут добавлены данные

массив $data

список пар «ключ-значение» полей, которые будут объединены с сущностью

массив $options необязательно []

Список параметров для гидратации объекта.

Возвращает

Cake\Datasource\EntityInterface

query()source public

query( )

Создает новый экземпляр запроса для этого репозитория

Возвращает

Cake\ORM\Query

save()source public

save( Cake\Datasource\EntityInterface $entity , array|ArrayAccess $options [] )

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

Параметры

Cake\Datasource\EntityInterface $entity

сущность, которую нужно сохранить

массив|ArrayAccess $options необязательно []

Параметры для сохранения.

Возвращает

Cake\Datasource\EntityInterface|boolean

updateAll()source public

updateAll( string|array|callable|Cake\Database\Expression\QueryExpression $fields , mixed $conditions )

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

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

Параметры

строка|массив|вызов|Cake\Database\Expression\QueryExpression $fields

Хэш полей => новое значение.

смешанный $conditions

Условия для использования, принимает все, что может принять Query::where().

Возвращает

целое число
Количество затронутых строк.