Интерфейс RepositoryInterface

alias()source public deprecated

alias( string|null $alias = null )

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

Deprecated

3.4.0 Используйте setAlias()/getAlias() вместо этого.

Параметры

string|null $alias optional null

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

Возвращает

string

delete()source public

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

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

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

Параметры

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 = [] )

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

Параметры

string $type optional 'all'

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

array|ArrayAccess $options optional []

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

Возвращает

Cake\Datasource\QueryInterface

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->getData());

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

Параметры

array $data

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

array $options optional []

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

Возвращает

Cake\Datasource\EntityInterface[]
Массив загруженных записей.

newEntity()source public

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

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

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

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

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

Параметры

array|null $data optional null

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

array $options optional []

Список опций для загрузки объекта.

Возвращает

Cake\Datasource\EntityInterface

patchEntities()source public

patchEntities( Cake\Datasource\EntityInterface[]|Traversable $entities , array $data , array $options = [] )

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

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

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

Параметры

Cake\Datasource\EntityInterface[]|Перечисляемый $entities

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

массив $data

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

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

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

Возвращает

Cake\Datasource\EntityInterface[]

patchEntity()source public

patchEntity( Cake\Datasource\EntityInterface $entity , array $data , array $options = [] )

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

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

$article = $this->Articles->patchEntity($article, $this->request->getData());

Параметры

Cake\Datasource\EntityInterface $entity

сущность, которой будут объединены данные

массив $data

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

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

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

Возвращает

Cake\Datasource\EntityInterface

query()source public

query( )

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

Возвращает

Cake\Datasource\QueryInterface

save()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

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

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

Возвращает

Cake\Datasource\EntityInterface|false

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

Возвращает

целое число
Количество обновлённых строк.

getAlias( )

getRegistryAlias( )