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

$query = $users->findByUsername('mark');

$query = $users->findByUsernameOrEmail('mark', 'mark@example.org');

__call()source public

__call( string $method , array $args )

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

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

Параметры

строка $method

имя метода, который необходимо вызвать

массив $args

Список аргументов, передаваемых в функцию

Возвращает

смешанный тип

Выбрасывает

BadMethodCallException

__construct()source public

__construct( array $config [] )

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

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

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

Параметры

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

Список параметров для этой таблицы

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $property )

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

Параметры

строка $property

имя ассоциации

Возвращает

Cake\ORM\Association

Выбрасывает

RuntimeException
если ассоциация с таким именем не существует

__isset()source public

__isset( string $property )

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

Параметры

строка $property

имя ассоциации

Возвращает

логическое значение

_dynamicFinder()source protected

_dynamicFinder( string $method , array $args )

Обеспечивает динамические методы findBy и findByAll.

Параметры

строка $method

Имя метода, который был вызван.

массив $args

Список аргументов, переданных в функцию.

Возвращает

смешанный тип

Выбрасывает

BadMethodCallException

если отсутствуют аргументы или когда & или & или объединены.

_executeTransaction()source protected

_executeTransaction( callable $worker , boolean $atomic true )

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

Параметры

вызов $worker

Рабочая функция, которая будет выполняться внутри транзакции.

логическое значение $atomic необязательно true

Выполнять ли рабочую функцию внутри транзакции базы данных.

Возвращает

смешанный тип

_getFindOrCreateQuery()source protected

_getFindOrCreateQuery( array|Cake\ORM\Query|string $search )

Получает объект запроса для findOrCreate().

Параметры

массив|Cake\ORM\Query|строка $search

Критерии для поиска существующих записей.

Возвращает

Cake\ORM\Query

_initializeSchema()source protected

_initializeSchema( Cake\Database\Schema\TableSchema $schema )

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

Пример:

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

Параметры

Cake\Database\Schema\TableSchema $schema

Определение таблицы, полученное из базы данных.

Возвращает

Cake\Database\Schema\TableSchema
изменённую схему

_insert()source protected

_insert( Cake\Datasource\EntityInterface $entity , array $data )

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $data

Фактические данные, которые необходимо сохранить

Возвращает

Cake\Datasource\EntityInterface|boolean

Выбрасывает

RuntimeException

если не все первичные ключи были предоставлены или не могли быть сгенерированы, когда таблица имеет составные первичные ключи. Или когда таблица не имеет первичного ключа.

_newId()source protected

_newId( array $primary )

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

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

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

Параметры

массив $primary

Столбцы первичного ключа, для которых нужно получить новый идентификатор.

Возвращает

null|строка|массив
Либо null, либо значение первичного ключа, либо список значений первичных ключей.

_onSaveSuccess()source protected

_onSaveSuccess( Cake\Datasource\EntityInterface $entity , ArrayObject $options )

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

Параметры

Cake\Datasource\EntityInterface $entity

сущность, которая должна быть сохранена

ArrayObject $options

параметры, которые нужно использовать для операции сохранения

Возвращает

boolean
True при успехе

Выбрасывает

Cake\ORM\Exception\RolledbackTransactionException

Если транзакция прервана в событии afterSave.

_processDelete()source protected

_processDelete( Cake\Datasource\EntityInterface $entity , ArrayObject $options )

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

ArrayObject $options

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

Возвращает

boolean
Результат

Выбрасывает

InvalidArgumentException

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

_processFindOrCreate()source protected

_processFindOrCreate( array|callable $search , callable $callback null , array $options [] )

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

Параметры

массив|вызываемый $search

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

вызываемый $callback необязательно null

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

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

Параметры, которые нужно использовать при сохранении.

Возвращает

Cake\Datasource\EntityInterface
Сущность.

_processSave()source protected

_processSave( Cake\Datasource\EntityInterface $entity , ArrayObject $options )

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

Параметры

Cake\Datasource\EntityInterface $entity

сущность, которая должна быть сохранена

ArrayObject $options

параметры, которые нужно использовать для операции сохранения

Возвращает

Cake\Datasource\EntityInterface|boolean

Выбрасывает

RuntimeException
Когда сущность отсутствует некоторые первичные ключи.
Cake\ORM\Exception\RolledbackTransactionException

Если транзакция прервана в событии afterSave.

_setFieldMatchers()source protected

_setFieldMatchers( array $options , array $keys )

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

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

Параметры

массив $options

исходные параметры, переданные в поиск

массив $keys

ключи, которые нужно проверить в $options для создания соответствий из связанного значения

Возвращает

массив

_transactionCommitted()source protected

_transactionCommitted( boolean $atomic , boolean $primary )

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

Параметры

boolean $atomic

True, если использовалась атомарная транзакция.

boolean $primary

True, если использовался первичный ключ.

Возвращает

boolean
Возвращает true, если транзакция была зафиксирована.

_update()source protected

_update( Cake\Datasource\EntityInterface $entity , array $data )

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $data

Фактические данные, которые необходимо сохранить

Возвращает

Cake\Datasource\EntityInterface|boolean

Выбрасывает

InvalidArgumentException
Когда данные первичного ключа отсутствуют.

addAssociations()source public

addAssociations( array $params )

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

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

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

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

Параметры

массив $params

Набор ассоциаций для привязки (индексированный по типу ассоциации)

Возвращает

$this

См.

\Cake\ORM\Table::belongsTo()
\Cake\ORM\Table::hasOne()
\Cake\ORM\Table::hasMany()
\Cake\ORM\Table::belongsToMany()

addBehavior()source public

addBehavior( string $name , array $options [] )

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

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

Пример:

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

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

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

Параметры

строка $name

Название поведения. Может быть краткой ссылкой на класс.

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

Параметры для использования поведения.

Возвращает

$this

Выбрасывает

RuntimeException
Если поведение перезагружается.

См.

Cake\ORM\Behavior

alias()source public

alias( string|null $alias null )

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

Устаревшее

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

Параметры

string|null $alias необязательно null

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

Возвращает

string

Реализация

Cake\Datasource\RepositoryInterface::alias()

aliasField()source public

aliasField( string $field )

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

Если поле уже имеет псевдоним, это приведет к бездействию.

Параметры

string $field

Поле, которому необходимо присвоить псевдоним.

Возвращает

string
Префикс поля с псевдонимом таблицы.

association()source public

association( string $name )

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

Параметры

string $name

псевдоним, используемый для ассоциации.

Возвращает

Cake\ORM\Association|null
Либо ассоциация, либо null.

associations()source public

associations( )

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

Возвращает

Cake\ORM\AssociationCollection|Cake\ORM\Association[]
Коллекция объектов ассоциаций.

behaviors()source public

behaviors( )

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

Возвращает

Cake\ORM\BehaviorRegistry
Экземпляр BehaviorRegistry.

belongsTo()source public

belongsTo( string $associated , array $options [] )

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

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

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

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

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

Параметры

string $associated

псевдоним целевой таблицы. Используется для уникальной идентификации ассоциации

array $options необязательно []

Список опций для настройки определения ассоциации

Возвращает

Cake\ORM\Association\BelongsTo

belongsToMany()source public

belongsToMany( string $associated , array $options [] )

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

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

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

• 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'.

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

Параметры

string $associated

псевдоним целевой таблицы. Используется для уникальной идентификации ассоциации

array $options необязательно []

Список опций для настройки определения ассоциации

Возвращает

Cake\ORM\Association\BelongsToMany

buildRules()source public

buildRules( Cake\ORM\RulesChecker $rules )

Параметры

Cake\ORM\RulesChecker $rules

Объект правил, подлежащий модификации.

Возвращает

Cake\ORM\RulesChecker

callFinder()source public

callFinder( string $type , Cake\ORM\Query $query , array $options [] )

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

Параметры

string $type

имя вызываемого метода поиска

Cake\ORM\Query $query

объект запроса, к которому применяются параметры поиска

array $options необязательно []

Список параметров для передачи методу поиска

Возвращает

Cake\ORM\Query

Выбрасывает

BadMethodCallException

connection()source public

connection( Cake\Datasource\ConnectionInterface $connection null )

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

Устаревшее

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

Параметры

Cake\Datasource\ConnectionInterface $connection необязательно null

Новый экземпляр подключения

Возвращает

Cake\Datasource\ConnectionInterface

defaultConnectionName()source public static

defaultConnectionName( )

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

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

Возвращает

string

См. также

\Cake\ORM\TableRegistry::get()

delete()source public

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

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

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

Параметры

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

События

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

array|ArrayAccess $options необязательно []

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

Возвращает

boolean
успех

Реализация

Cake\Datasource\RepositoryInterface::delete()

deleteAll()source public

deleteAll( mixed $conditions )

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

Параметры

mixed $conditions

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

Возвращает

integer
Возвращает количество затронутых строк.

Реализация

Cake\Datasource\RepositoryInterface::deleteAll()

deleteOrFail()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

array|ArrayAccess $options необязательно []

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

Возвращает

boolean
успех

Выбрасывает

Cake\ORM\Exception\PersistenceFailedException

См. также

\Cake\ORM\Table::delete()

displayField()source public

displayField( string|null $key null )

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

Устарело

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

Параметры

string|null $key необязательно null

устанавливает новое имя для использования в качестве поля отображения

Возвращает

string

entityClass()source public

entityClass( string|null $name null )

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

Устарело

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

Параметры

string|null $name необязательно null

Имя класса для использования

Возвращает

string

Выбрасывает

Cake\ORM\Exception\MissingEntityException
при невозможности найти класс сущности

exists()source public

exists( array|ArrayAccess $conditions )

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

Параметры

array|ArrayAccess $conditions

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

Возвращает

boolean

Реализация

Cake\Datasource\RepositoryInterface::exists()

find()source public

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

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

Событие 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.

Параметры

string $type необязательно 'all'

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

array|ArrayAccess $options необязательно []

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

Возвращает

Cake\ORM\Query
Библиотека построения запросов

Реализация

Cake\Datasource\RepositoryInterface::find()

findAll()source public

findAll( Cake\ORM\Query $query , array $options )

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

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

Параметры

Cake\ORM\Query $query

Запрос для поиска

array $options

Параметры для использования при поиске

Возвращает

Cake\ORM\Query
Библиотека построения запросов

findList()source public

findList( Cake\ORM\Query $query , array $options )

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

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

Результаты этого нахождения будут иметь следующий вид:

[
 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'
]);

Результаты могут быть объединены в более крупные группы, если они разделяют свойство. Вы можете настроить свойство для группировки, установив 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'
 ]
]

Параметры

Cake\ORM\Query $query

Запрос для поиска

array $options

Параметры для поиска

Возвращает

Cake\ORM\Query
Библиотека построения запросов

findOrCreate()source public

findOrCreate( array|Cake\ORM\Query $search , callable $callback null , array $options [] )

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

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

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

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

Параметры

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

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

Параметры

array|Cake\ORM\Query $search

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

callable $callback необязательно null

Функция обратного вызова, которая будет вызвана для вновь созданных сущностей. Этот обратный вызов будет вызван *до* сохранения сущности.

array $options необязательно []

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

Возвращает

Cake\Datasource\EntityInterface
Сущность.

findThreaded()source public

findThreaded( Cake\ORM\Query $query , array $options )

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

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

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

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

Параметры

Cake\ORM\Query $query

Запрос для поиска

массив $options

Параметры поиска

Возвращает

Cake\ORM\Query
Строитель запроса

get()source public

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

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

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

Получение статьи и некоторых взаимосвязей:

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

Параметры

смешанный $primaryKey

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

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

Параметры, принимаемые методом Table::find()

Возвращает

Cake\Datasource\EntityInterface

Исключения

Cake\Datasource\Exception\InvalidPrimaryKeyException

При неверном количестве элементов в $primaryKey.

Реализация

Cake\Datasource\RepositoryInterface::get()

getAlias()source public

getAlias( )

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

Возвращает

строка

getConnection()source public

getConnection( )

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

Возвращает

Cake\Database\Connection

getDisplayField()source public

getDisplayField( )

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

Возвращает

строка

getEntityClass()source public

getEntityClass( )

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

Возвращает

строка

getPrimaryKey()source public

getPrimaryKey( )

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

Возвращает

строка|массив

getRegistryAlias()source public

getRegistryAlias( )

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

Возвращает

строка

getSaveOptionsBuilder()source public

getSaveOptionsBuilder( array $options [] )

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

Параметры

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

Параметры для обработки билдером.

Возвращает

Cake\ORM\SaveOptionsBuilder

getSchema()source public

getSchema( )

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

Возвращает

Cake\Database\Schema\TableSchema

getTable()source public

getTable( )

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

Возвращает

строка

hasBehavior()source public

hasBehavior( string $name )

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

Параметры

строка $name

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

Возвращает

логическое значение
Существует ли компонент.

hasField()source public

hasField( string $field )

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

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

Параметры

строка $field

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

Возвращает

логическое значение
True, если поле существует, false — если нет.

Реализация

Cake\Datasource\RepositoryInterface::hasField()

hasFinder()source public

hasFinder( string $type )

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

Параметры

строка $type

имя поиска для проверки

Возвращает

логическое значение

hasMany()source public

hasMany( string $associated , array $options [] )

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

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

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

• 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'.

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

Параметры

строка $associated

Псевдоним целевой таблицы. Используется для уникальной идентификации ассоциации

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

Список параметров для настройки определения ассоциации

Возвращает

Cake\ORM\Association\HasMany

hasOne()source public

hasOne( string $associated , array $options [] )

Создаёт новую ассоциацию HasOne между этой таблицей и целевой таблицей. Ассоциация "has one" — это отношение 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.

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

Параметры

строка $associated

псевдоним целевой таблицы. Используется для уникальной идентификации ассоциации

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

список опций для настройки определения ассоциации

Возвращает

Cake\ORM\Association\HasOne

implementedEvents()source public

implementedEvents( )

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

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

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

Стандартное соответствие методов:

• Model.beforeMarshal => beforeMarshal
• 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

Возвращает

массив

Реализация

Cake\Event\EventListenerInterface::implementedEvents()

initialize()source public

initialize( array $config )

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

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

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

Параметры

массив $config

Опции конфигурации, переданные в конструктор

loadInto()source public

loadInto( Cake\Datasource\EntityInterface|array $entities , array $contain )

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

Пример:

$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;

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

Параметры

Cake\Datasource\EntityInterface|массив $entities

один объект или список объектов

массив $contain

Массив, совместимый с contain().

Возвращает

Cake\Datasource\EntityInterface|массив

См. также

\Cake\ORM\Query::contain()

marshaller()source public

marshaller( )

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

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

Возвращает

Cake\ORM\Marshaller

См. также

Cake\ORM\Marshaller

newEntities()source public

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

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

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

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

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

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

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

Параметры

массив $data

Данные для создания объекта.

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

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

Возвращает

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

Реализация

Cake\Datasource\RepositoryInterface::newEntities()

newEntity()source public

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

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

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

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

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

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

Опция fieldList позволяет удалить или ограничить данные ввода, которые попадают в объект. Если вы хотите ослабить доступные поля объекта по умолчанию, вы можете использовать опцию 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 для изменения данных запроса перед их преобразованием в объекты.

Параметры

массив|null $data необязательно null

Данные для создания объекта.

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

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

Возвращает

Cake\Datasource\EntityInterface

Реализация

Cake\Datasource\RepositoryInterface::newEntity()

patchEntities()source public

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

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

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

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

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

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

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

Параметры

Cake\Datasource\EntityInterface[]|Перебираемый $entities

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

массив $data

список массивов для объединения с объектами

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

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

Возвращает

Cake\Datasource\EntityInterface[]

Реализация

Cake\Datasource\RepositoryInterface::patchEntities()

patchEntity()source public

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

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

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

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

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

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

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

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

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

Параметры

Cake\Datasource\EntityInterface $entity

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

массив $data

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

массив $options опционально []

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

Возвращает

Cake\Datasource\EntityInterface

Реализация

Cake\Datasource\RepositoryInterface::patchEntity()

primaryKey()source public

primaryKey( string|array|null $key null )

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

Устаревшее

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

Параметры

строка|массив|null $key опционально null

Устанавливает новое имя, используемое в качестве первичного ключа

Возвращает

строка|массив

query()source public

query( )

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

Возвращает

Cake\ORM\Query

Реализация

Cake\Datasource\RepositoryInterface::query()

registryAlias()source public

registryAlias( string|null $registryAlias null )

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

Устаревшее

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

Параметры

строка|null $registryAlias опционально null

ключ для доступа к этому объекту

Возвращает

строка

removeBehavior()source public

removeBehavior( string $name )

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

Пример:

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

$this->removeBehavior('Tree');

Параметры

строка $name

Псевдоним, с которым поведение было добавлено.

Возвращает

$this

См. также

Cake\ORM\Behavior

save()source public

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

Сохраняет сущность, основываясь на полях, помеченных как изменённые, и возвращает ту же сущность после успешного сохранения или 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]);

Параметры

Cake\Datasource\EntityInterface $entity

сущность, подлежащая сохранению

массив|ArrayAccess $options опционально []

Опции для сохранения.

Возвращает

Cake\Datasource\EntityInterface|false

Выбрасывает

Cake\ORM\Exception\RolledbackTransactionException

Если транзакция прервана в событии afterSave.

Реализация

Cake\Datasource\RepositoryInterface::save()

saveMany()source public

saveMany( Cake\Datasource\EntityInterface[]|Cake\ORM\ResultSet $entities , array|ArrayAccess $options [] )

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

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

Параметры

Cake\Datasource\EntityInterface[]|Cake\ORM\ResultSet $entities

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

массив|ArrayAccess $options опционально []

Опции, используемые при вызове Table::save() для каждой сущности.

Возвращает

boolean|Cake\Datasource\EntityInterface[]|Cake\ORM\ResultSet
False при ошибке, список сущностей при успехе.

saveOrFail()source public

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

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

Параметры

Cake\Datasource\EntityInterface $entity

сущность, подлежащая сохранению

массив|ArrayAccess $options опционально []

Опции для сохранения.

Возвращает

Cake\Datasource\EntityInterface

Выбрасывает

Cake\ORM\Exception\PersistenceFailedException
При невозможности сохранить сущность

См. также

\Cake\ORM\Table::save()

schema()source public

schema( array|Cake\Database\Schema\TableSchema|null $schema null )

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

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

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

Устаревшее

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

Параметры

массив|Cake\Database\Schema\TableSchema|null $schema необязательный null

Новая схема, которая будет использоваться для этой таблицы

Возвращает

Cake\Database\Schema\TableSchema

setAlias()source public

setAlias( string $alias )

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

Параметры

строка $alias

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

Возвращает

$this

setConnection()source public

setConnection( Cake\Datasource\ConnectionInterface $connection )

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

Параметры

Cake\Datasource\ConnectionInterface $connection

Экземпляр подключения

Возвращает

$this

setDisplayField()source public

setDisplayField( string $key )

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

Параметры

строка $key

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

Возвращает

$this

setEntityClass()source public

setEntityClass( string $name )

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

Параметры

строка $name

Имя используемого класса

Возвращает

$this

Выбрасывает

Cake\ORM\Exception\MissingEntityException
при невозможности найти класс сущности

setPrimaryKey()source public

setPrimaryKey( string|array $key )

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

Параметры

строка|массив $key

Устанавливает новое имя, которое будет использоваться в качестве первичного ключа

Возвращает

$this

setRegistryAlias()source public

setRegistryAlias( string $registryAlias )

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

Параметры

строка $registryAlias

Ключ, используемый для доступа к этому объекту.

Возвращает

$this

setSchema()source public

setSchema( array|Cake\Database\Schema\TableSchema $schema )

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

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

Параметры

массив|Cake\Database\Schema\TableSchema $schema

Схема, которая будет использоваться для этой таблицы

Возвращает

$this

setTable()source public

setTable( string $table )

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

Параметры

строка $table

Имя таблицы.

Возвращает

$this

table()source public

table( string|null $table null )

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

Устаревшее

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

Параметры

строка|null $table необязательный null

новое имя таблицы

Возвращает

строка

updateAll()source public

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

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

Параметры

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

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

смешанный $conditions

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

Возвращает

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

Реализация

Cake\Datasource\RepositoryInterface::updateAll()

validateUnique()source public

validateUnique( mixed $value , array $options , array $context null )

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

Пример:

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

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

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

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

Параметры

смешанный $value

Значение столбца, которое будет проверяться на уникальность.

массив $options

Массив параметров, необязательно содержащий ключ 'scope'. Также может быть контекстом валидации, если параметров нет.

массив $context необязательный null

Либо контекст валидации, либо null.

Возвращает

логическое значение
Истина, если значение уникально, или ложь, если было передано нескалярное, неуникальное значение.

validationMethodExists()source protected

validationMethodExists( $method )

dispatchEvent()source public

dispatchEvent( string $name , array|null $data null , object|null $subject null )

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

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

Параметры

строка $name

Имя события.

массив|null $data необязательный null

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

объект|null $subject необязательный null

Объект, к которому относится это событие ($this по умолчанию).

Возвращает

Cake\Event\Event

eventManager()source public

eventManager( Cake\Event\EventManager $eventManager null )

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

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

Устаревшее

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager необязательный null

менеджер событий для установки

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

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

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

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

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

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

Параметры

Cake\Event\EventManager $eventManager

менеджер событий для установки

Возвращает

$this

checkRules()source public

checkRules( Cake\Datasource\EntityInterface $entity , string $operation RulesChecker::CREATE , ArrayObject|array|null $options null )

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

Параметры

Cake\Datasource\EntityInterface $entity

Сущность, проверяемая на валидность.

string $operation необязательно RulesChecker::CREATE

Операция, выполняемая. Может быть 'create', 'update' или 'delete'.

ArrayObject|array|null $options необязательно null

Параметры, которые будут переданы правилам.

Возвращает

boolean

rulesChecker()source public

rulesChecker( )

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

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

Возвращает

Cake\Datasource\RulesChecker

См. также

Cake\Datasource\RulesChecker

createValidator()source protected

createValidator( string $name )

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

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

Параметры

string $name

Имя набора валидации для создания.

Возвращает

Cake\Validation\Validator

Выбрасывает

RuntimeException

getValidator()source public

getValidator( string|null $name null )

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

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

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

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

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

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

Параметры

string|null $name необязательно null

Имя набора валидации для возвращения.

Возвращает

Cake\Validation\Validator

hasValidator()source public

hasValidator( string $name )

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

Параметры

string $name

Имя валидатора.

Возвращает

boolean

setValidator()source public

setValidator( string $name , Cake\Validation\Validator $validator )

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

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

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

Параметры

string $name

Имя валидатора для установки.

Cake\Validation\Validator $validator

Объект валидатора для установки.

Возвращает

$this

validationDefault()source public

validationDefault( Cake\Validation\Validator $validator )

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

Параметры

Cake\Validation\Validator $validator

Валидатор, который можно изменить, чтобы добавить к нему некоторые правила.

Возвращает

Cake\Validation\Validator

validator()source public

validator( string|null $name null , Cake\Validation\Validator $validator null )

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

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

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

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

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

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

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

Устарело

3.5.0 Используйте getValidator/setValidator вместо этого.

Параметры

string|null $name необязательно null

имя набора валидации для возвращения

Cake\Validation\Validator $validator необязательно null

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

Возвращает

Cake\Validation\Validator

Выбрасывает

RuntimeException