Класс Aco

__construct()source public

__construct( boolean|integer|string|array $id false , string $table null , string $ds null )

Конструктор

Параметры

boolean|integer|string|array $id необязательный false

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

string $table необязательный null

Имя таблицы базы данных для использования.

string $ds необязательный null

Имя подключения к источнику данных.

Переопределяет

Model::__construct()

node()source public

node( string|array|Model $ref null )

Возвращает узел Aro/Aco для этой модели

Параметры

string|array|Model $ref необязательный null

Массив с 'model' и 'foreign_key', объектом модели или строковым значением

Возвращает

массив
Найденный в базе данных узел

Выбрасывает

CakeException
при привязке к модели, которая не существует.

__call()source public

__call( string $method , array $params )

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

Параметры

string $method

Имя вызываемого метода.

array $params

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

Возвращает

смешанный
То, что возвращается вызываемым методом

__get()source public

__get( string $name )

Возвращает значение запрошенной переменной, если она может быть установлена с помощью __isset()

Параметры

string $name

Переменная, запрашиваемая для ее значения или ссылки

Возвращает

смешанный
Значение запрошенной переменной, если она установлена

__isset()source public

__isset( string $name )

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

Параметры

string $name

Переменная, проверяемая на существование в классе

Возвращает

boolean
true, если переменная существует (если это не загруженная ассоциация модели, она будет создана), false в противном случае

_addToWhiteList()source protected

_addToWhiteList( string $key , array $options )

Вспомогательный метод для saveAll() и др., для добавления внешнего ключа в список полей

Параметры

string $key

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

array $options

Список опций

Возвращает

массив
опции

_clearCache()source protected

_clearCache( string $type null )

Очищает кэш для этой модели.

Параметры

string $type необязательный null

Если null, удаляет кэшированные представления, если Cache.check true Будет использоваться для разрешения удаления кэша запросов также

Возвращает

смешанный
True при удалении, null в противном случае

_collectForeignKeys()source protected

_collectForeignKeys( string $type 'belongsTo' )

Собирает внешние ключи из ассоциаций.

Параметры

string $type необязательный 'belongsTo'

Тип ассоциации.

Возвращает

массив

_constructLinkedModel()source protected

_constructLinkedModel( string $assoc , string $className null , string $plugin null )

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

Параметры

string $assoc

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

string $className необязательный null

Имя класса

string $plugin необязательный null

Имя плагина, где расположен $className примеры: public $hasMany = array('Assoc' => array('className' => 'ModelName')); использование: $this->Assoc->modelMethods();

public $hasMany = array('ModelName');
                usage: $this->ModelName->modelMethods();

_createLinks()source protected

_createLinks( )

Создать набор ассоциаций.

_deleteDependent()source protected

_deleteDependent( string $id , boolean $cascade )

Каскадно удаляет записи модели через связанные записи hasMany и hasOne child.

Параметры

string $id

Идентификатор записи, которая была удалена

boolean $cascade

Установите в true, чтобы удалить записи, зависящие от этой записи

_deleteLinks()source protected

_deleteLinks( string $id )

Каскадно удаляет записи модели через ключи объединения HABTM.

Параметры

string $id

Идентификатор записи, которая была удалена

_doSave()source protected

_doSave( array $data null , array $options array() )

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

Параметры

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

Данные для сохранения.

массив $options необязательно array()

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

• validate: Устанавливается в true/false для включения или отключения валидации.
• fieldList: Массив полей, которые вы хотите разрешить для сохранения.
• callbacks: Устанавливается в false для отключения обратного вызова. Использование 'before' или 'after' включит только эти обратные вызовы.
• counterCache: Логическое значение для управления обновлением кэшей счетчиков (если таковые имеются)

Возвращает

смешанный
При успехе Model::$data, если оно не пустое, или true, false при ошибке

Выбрасывает

PDOException

Ссылка

https://book.cakephp.org/2.0/ru/models/saving-your-data.html

_filterResults()source protected

_filterResults( array $results , boolean $primary true )

Передает результаты запроса через методы модели и поведения послеFind().

Параметры

массив $results

Результаты для фильтрации

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

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

Возвращает

массив
Набор отфильтрованных результатов

Вызывает

Model.afterFind $this, массив($results, $primary)

_findAll()source protected

_findAll( string $state , array $query , array $results array() )

Обрабатывает логику фильтрации до/после для операций find('all'). Вызывается только Model::find().

Параметры

строка $state

Либо "before", либо "after"

массив $query

Запрос.

массив $results необязательно array()

Результаты.

Возвращает

массив

См. также

Model::find()

_findCount()source protected

_findCount( string $state , array $query , array $results array() )

Обрабатывает логику фильтрации до/после для операций find('count'). Вызывается только Model::find().

Параметры

строка $state

Либо "before", либо "after"

массив $query

Запрос.

массив $results необязательно array()

Результаты.

Возвращает

целое число
Количество найденных записей или false

См. также

Model::find()

_findFirst()source protected

_findFirst( string $state , array $query , array $results array() )

Обрабатывает логику фильтрации до/после для операций find('first'). Вызывается только Model::find().

Параметры

строка $state

Либо "before", либо "after"

массив $query

Запрос.

массив $results необязательно array()

Результаты.

Возвращает

массив

См. также

Model::find()

_findList()source protected

_findList( string $state , array $query , array $results array() )

Обрабатывает логику фильтрации до/после для операций find('list'). Вызывается только Model::find().

Параметры

строка $state

Либо "before", либо "after"

массив $query

Запрос.

массив $results необязательно array()

Результаты.

Возвращает

массив
Пары ключ/значение первичных ключей/полей отображения всех найденных записей

См. также

Model::find()

_findNeighbors()source protected

_findNeighbors( string $state , array $query , array $results array() )

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

Параметры

строка $state

Либо "before", либо "after"

массив $query

Запрос.

массив $results необязательно array()

Результаты.

Возвращает

массив

_findThreaded()source protected

_findThreaded( string $state , array $query , array $results array() )

В случае возврата неоднозначных результатов (несколько результатов верхнего уровня с различными parent_id) результаты верхнего уровня с различными parent_id по отношению к первому результату будут удалены

Параметры

строка $state

Либо "before", либо "after".

массив $query

Запрос.

массив $results необязательно array()

Результаты.

Возвращает

массив
Результаты в виде нитей

_generateAssociation()source protected

_generateAssociation( string $type , string $assocKey )

Создает ассоциацию на основе массива из строки.

Параметры

строка $type

'belongsTo', 'hasOne', 'hasMany', 'hasAndBelongsToMany'

строка $assocKey

Ключ ассоциации.

_isUUIDField()source protected

_isUUIDField( string $field )

Проверяет, является ли переданное поле полем UUID

Параметры

строка $field

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

Возвращает

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

_normalizeXmlData()source protected

_normalizeXmlData( array $xml )

Нормализует Xml::toArray() для использования в Model::save()

Параметры

массив $xml

XML как массив

Возвращает

массив

_prepareUpdateFields()source protected

_prepareUpdateFields( array $data )

Вспомогательный метод для Model::updateCounterCache(). Проверяет поля, которые будут обновлены, на

Параметры

массив $data

Поля записи, которые будут обновлены

Возвращает

массив

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

_readDataSource()source protected

_readDataSource( string $type , array $query )

Чтение из источника данных

Model::_readDataSource() используется во всех вызовах find() для чтения из источника данных и может быть переопределен для кэширования вызовов источника данных.

protected function _readDataSource($type, $query) {
    $cacheName = md5(json_encode($query) . json_encode($this->hasOne) . json_encode($this->belongsTo));
    $cache = Cache::read($cacheName, 'cache-config-name');
    if ($cache !== false) {
        return $cache;
    }

    $results = parent::_readDataSource($type, $query);
    Cache::write($cacheName, $results, 'cache-config-name');
    return $results;
}

Параметры

строка $type

Тип операции поиска (all/first/count/neighbors/list/threaded)

массив $query

Поля опций (условия/поля/соединения/предел/смещение/сортировка/страница/группа/обратные вызовы)

Возвращает

массив

_saveMulti()source protected

_saveMulti( array $joined , integer|string $id , DataSource $db )

Сохраняет данные модели hasAndBelongsToMany в базе данных.

Параметры

массив $joined

Данные для сохранения

целое число/строка $id

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

DataSource $db

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

_setAliasData()source protected

_setAliasData( array $data )

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

Параметры

массив $data

Данные.

Возвращает

массив

afterDelete()source public

afterDelete( )

Вызывается после каждой операции удаления.

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#afterdelete

afterFind()source public

afterFind( mixed $results , boolean $primary false )

Вызывается после каждой операции поиска. Может использоваться для изменения любых результатов, возвращаемых find(). Значение возврата должно быть (изменёнными) результатами.

Параметры

mixed $results

Результаты операции поиска

boolean $primary необязательно false

Является ли этот объект модели запросом напрямую (или он запрошен как ассоциация)

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

mixed
Результат операции поиска

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#afterfind

afterSave()source public

afterSave( boolean $created , array $options array() )

Вызывается после каждой успешной операции сохранения.

Параметры

boolean $created

Истина, если это сохранение создало новую запись

array $options необязательно array()

Параметры, переданные из Model::save().

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#aftersave

См. также

Model::save()

afterValidate()source public

afterValidate( )

Вызывается после проверки данных на ошибки

associations()source public

associations( )

Получить ассоциации

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

array

beforeDelete()source public

beforeDelete( boolean $cascade true )

Вызывается перед каждой операцией удаления.

Параметры

boolean $cascade необязательно true

Если true, записи, зависящие от этой записи, также будут удалены

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

boolean
Истина, если операция должна быть продолжена, ложь, если её нужно прервать

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#beforedelete

beforeFind()source public

beforeFind( array $query )

Вызывается перед каждой операцией поиска. Верните ложь, если хотите прервать вызов поиска, в противном случае верните (изменённые) данные запроса.

Параметры

array $query

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

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

mixed

Истина, если операция должна быть продолжена, ложь, если её нужно прервать; или, изменённый $query для продолжения с новым $query

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#beforefind

beforeSave()source public

beforeSave( array $options array() )

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

Параметры

array $options необязательно array()

Параметры, переданные из Model::save().

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

boolean
Истина, если операция должна быть продолжена, ложь, если её нужно прервать

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#beforesave

См. также

Model::save()

beforeValidate()source public

beforeValidate( array $options array() )

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

Параметры

array $options необязательно array()

Параметры, переданные из Model::save().

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

boolean
Истина, если операция валидации должна быть продолжена, ложь для прерывания

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#beforevalidate

См. также

Model::save()

bindModel()source public

bindModel( array $params , boolean $reset true )

Связать ассоциации модели динамически.

Если $reset ложь, ассоциация не будет сброшена к исходным значениям, определённым в модели.

Пример: Добавить новую связь hasOne в модель Profile, не определённую в исходном коде модели:

$this->User->bindModel(array('hasOne' => array('Profile')));

Связи, которые не являются постоянными, будут сброшены следующим вызовом Model::find() для этой модели.

Параметры

array $params

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

boolean $reset необязательно true

Установите в ложь, чтобы сделать связь постоянной

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

boolean
Успех

Ссылка

https://book.cakephp.org/2.0/ru/models/associations-linking-models-together.html#creating-and-destroying-associations-on-the-fly

buildQuery()source public

buildQuery( string $type 'first' , array $query array() )

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

Параметры

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

Тип операции поиска (все / первый / подсчёт / соседи / список / ветвления)

array $query необязательно array()

Поля параметров (условия / поля / соединения / лимит / смещение / порядок / страница / группировка / обратные вызовы)

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

array|null
Массив запроса или null, если запрос не смог быть создан по каким-либо причинам

Срабатывает

Model.beforeFind $this, array($query)

См. также

Model::find()

clear()source public

clear( )

Эта функция — удобная обертка для создания (false) и, как следует из названия, очищает id, данные и ошибки валидации.

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

boolean
Всегда истинно при успехе

См. также

Model::create()

create()source public

create( boolean|array $data array() , boolean $filterKey false )

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

Параметры

boolean|array $data необязательно array()

Необязательный массив данных для назначения модели после её создания. Если null или false, значения по умолчанию схемы не объединяются.

boolean $filterKey необязательно false

Если истинно, перезаписывает любой ввод первичного ключа пустым значением

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

array
Текущий Model::data; после объединения $data и/или значений по умолчанию из базы данных

Ссылка

https://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-create-array-data-array

deconstruct()source public

deconstruct( string $field , array|object $data )

Раскладывает сложный тип данных (массив или объект) в значение одного поля.

Параметры

string $field

Имя поля, которое нужно разложить

array|object $data

Массив или объект, который нужно разложить в поле

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

mixed
Полученные данные, которые должны быть назначены полю

delete()source public

delete( integer|string $id null , boolean $cascade true )

Удаляет запись для заданного ID. Если ID не указан, используется текущий ID. Возвращает true при успехе.

Параметры

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

ID записи для удаления

boolean $cascade необязательно true

Установите в значение true, чтобы удалить записи, зависящие от этой записи

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

boolean
True при успехе

Триггеры

Model.beforeDelete $this, array($cascade)
Model.afterDelete $this

Ссылка

https://book.cakephp.org/2.0/ru/models/deleting-data.html

deleteAll()source public

deleteAll( mixed $conditions , boolean $cascade true , boolean $callbacks false )

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

Параметры

mixed $conditions

Условия для соответствия

boolean $cascade необязательно true

Установите в значение true, чтобы удалить записи, зависящие от этой записи

boolean $callbacks необязательно false

Выполнять коллбеки

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

boolean
True при успехе, false при ошибке

Ссылка

https://book.cakephp.org/2.0/ru/models/deleting-data.html#deleteall

escapeField()source public

escapeField( string $field null , string $alias null )

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

Параметры

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

Поле для экранирования (например: id)

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

Псевдоним модели (например: Post)

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

string
Имя экранированного поля для этой модели (например, id становится Post.id).

exists()source public

exists( integer|string $id null )

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

Если $id не передан, вызывается Model::getID(), чтобы получить текущий ID записи, а затем выполняется Model::find('count') на текущем источнике данных, чтобы определить существование записи в постоянном хранилище.

Параметры

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

ID записи для проверки на существование

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

boolean
True, если такая запись существует

field()source public

field( string $name , array $conditions null , string $order null )

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

Параметры

string $name

Имя поля для получения.

array $conditions необязательно null

SQL условия (по умолчанию NULL).

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

SQL фрагмент ORDER BY.

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

string|false
Содержание поля, или false, если не найдено.

Ссылка

https://book.cakephp.org/2.0/ru/models/retrieving-your-data.html#model-field

find()source public

find( string $type 'first' , array $query array() )

Запрашивает у источника данных и возвращает массив результатов.

Используется для выполнения операций поиска, где первый аргумент — тип операции поиска (all / first / count / neighbors / list / threaded), второй параметр — опции для поиска (индексированный массив, включая: 'conditions', 'limit', 'recursive', 'page', 'fields', 'offset', 'order', 'callbacks')

Например:

$model->find('all', array(
  'conditions' => array('name' => 'Thomas Anderson'),
  'fields' => array('name', 'email'),
  'order' => 'field3 DESC',
  'recursive' => 1,
  'group' => 'type',
  'callbacks' => false,
));

В дополнение к стандартным ключам запроса выше, вы можете предоставить ключи, специфичные для источника данных и поведения. Например, при использовании источника данных на основе SQL, вы можете использовать ключ joins, чтобы указать дополнительные соединения, которые должны быть частью запроса.

$model->find('all', array(
  'conditions' => array('name' => 'Thomas Anderson'),
  'joins' => array(
    array(
      'alias' => 'Thought',
      'table' => 'thoughts',
      'type' => 'LEFT',
      'conditions' => '`Thought`.`person_id` = `Person`.`id`'
    )
  )
));

Отключение коллбеков

Ключ callbacks позволяет вам отключить или указать коллбеки, которые должны быть выполнены. Чтобы отключить коллбеки beforeFind и afterFind, установите 'callbacks' => false в ваших опциях. Вы также можете установить значение callbacks в 'before' или 'after', чтобы включить только указанный коллбек.

Добавление новых типов поиска

Поведения и типы поиска также могут определять пользовательские ключи поиска, которые передаются в find(). См. документацию по пользовательским типам поиска (https://book.cakephp.org/2.0/ru/models/retrieving-your-data.html#creating-custom-find-types) для информации о реализации пользовательских типов поиска.

Указание 'fields' для обозначения 'list':

• Если поля не указаны, для ключа используется 'id', а для значения — 'model->displayField'.
• Если указано одно поле, для ключа используется 'id', а для значения — указанное поле.
• Если указано три поля, они используются (в порядке) для ключа, значения и группы.
• В противном случае, первые два поля используются для ключа и значения.

Примечание: find(list) + представления базы данных имеют проблемы с MySQL 5.0. Попробуйте обновить до MySQL 5.1, если у вас есть проблемы с представлениями базы данных.

Примечание: find(count) имеет свои собственные значения возврата.

Параметры

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

Тип операции поиска (all / first / count / neighbors / list / threaded)

array $query необязательно array()

Поля опций (conditions / fields / joins / limit / offset / order / page / group / callbacks)

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

array|null
Массив записей, или Null при ошибке.

Ссылка

https://book.cakephp.org/2.0/ru/models/retrieving-your-data.html

getAffectedRows()source public

getAffectedRows( )

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

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

integer
Количество строк

getAssociated()source public

getAssociated( string $type null )

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

Параметры

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

Только ассоциации результатов этого типа

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

array|null
Ассоциации

getColumnType()source public

getColumnType( string $column )

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

Параметры

string $column

Имя столбца модели

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

string
Тип столбца

getColumnTypes()source public

getColumnTypes( )

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

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

array
Типы полей, индексированные по имени поля

getDataSource()source public

getDataSource( )

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

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

DataSource
Объект DataSource

getEventManager()source public

getEventManager( )

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

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

CakeEventManager

getID()source public

getID( integer $list 0 )

Возвращает ID текущей записи.

Параметры

integer $list необязательно 0

Индекс, в котором находится составленный ID

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

mixed
ID текущей записи, false, если ID отсутствует

getInsertID()source public

getInsertID( )

Возвращает ID последней записи, вставленной этим моделем.

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

mixed
ID последней вставленной записи

getLastInsertID()source public

getLastInsertID( )

Возвращает ID последней записи, вставленной этим моделем.

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

mixed
ID последней вставленной записи

getNumRows()source public

getNumRows( )

Возвращает количество строк, возвращенных из последнего запроса.

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

integer
Количество строк

getVirtualField()source public

getVirtualField( string $field null )

Возвращает выражение для виртуального поля модели.

Параметры

string $field необязательный null

Имя поля для поиска

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

mixed

Если $field — строковое выражение, связанное с виртуальным полем $field. Если $field равен null, возвращает массив всех виртуальных полей модели или false, если такие поля не существуют.

hasAny()source public

hasAny( array $conditions null )

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

Параметры

array $conditions необязательный null

Массив условий SQL

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

boolean
True, если такая запись существует

hasField()source public

hasField( string|array $name , boolean $checkVirtual false )

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

Параметры

string|array $name

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

boolean $checkVirtual необязательный false

проверяет, объявлено ли поле как виртуальное

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

mixed

Если $name — строка, возвращает boolean, указывающий, существует ли поле. Если $name — массив имён полей, возвращает первое существующее поле или false, если таковых нет.

hasMethod()source public

hasMethod( string $method )

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

Параметры

string $method

Метод, который должен быть вызван.

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

boolean
True, если метод доступен.

implementedEvents()source public

implementedEvents( )

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

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

array

Реализация

CakeEventListener::implementedEvents()

invalidFields()source public

invalidFields( array|string $options array() )

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

Кроме того, заполняет свойство validationErrors модели тем же массивом.

Параметры

array|string $options необязательный array()

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

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

array
Массив невалидных полей и их сообщений об ошибках

См. также

Model::validates()

invalidate()source public

invalidate( string $field , mixed $value true )

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

Параметры

string $field

Имя поля для помечания как невалидного

mixed $value необязательный true

Имя правила валидации, которое не удалось выполнить, или сообщение об ошибке для возврата. Если ключ валидации не указан, значение по умолчанию равно true.

isForeignKey()source public

isForeignKey( string $field )

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

Параметры

string $field

Возвращает true, если входная строка заканчивается на "_id"

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

boolean
True, если поле является внешним ключом, перечисленным в массиве belongsTo.

isUnique()source public

isUnique( array $fields , boolean|array $or true )

Возвращает false, если какие-либо переданные поля совпадают с любыми (по умолчанию, со всеми, если $or = false) из их соответствующих значений.

Может использоваться как метод валидации. При использовании в качестве метода валидации параметр $or содержит массив полей, подлежащих валидации.

Параметры

array $fields

Пары поле/значение для поиска (если значения не указаны, они извлекаются из $this->data)

boolean|array $or необязательный true

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

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

boolean
False, если найдены какие-либо записи, совпадающие с любыми полями

isVirtualField()source public

isVirtualField( string $field )

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

Параметры

string $field

Имя поля для поиска

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

boolean
Указывает, существует ли поле в качестве виртуального поля модели.

joinModel()source public

joinModel( string|array $assoc , array $keys array() )

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

Параметры

string|array $assoc

Модель для объединения

array $keys необязательный array()

Ключи объединения, которые необходимо объединить с запрошенными ключами

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

array

onError()source public

onError( )

Вызывается при возникновении ошибки на уровне источника данных.

Ссылка

https://book.cakephp.org/2.0/ru/models/callback-methods.html#onerror

query()source public

query( string $sql )

Возвращает набор результатов для заданного SQL-запроса. Пользовательские SQL-запросы должны выполняться с помощью этого метода.

Метод может принимать 2-й и 3-й параметры.

• 2-й параметр: либо boolean для управления кэшированием запроса, либо массив параметров для использования с заготовками параметров подготовленного оператора.
• 3-й параметр: если 2-й параметр указан, флаг boolean для включения/выключения кэширования запроса.

Если параметр кэша запроса не задан ни как 2-й, ни как 3-й параметр, используется значение по умолчанию модели $cacheQueries.

Параметры

string $sql

SQL-запрос

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

mixed
Массив набора результатов или boolean, указывающий на успех/неудачу в зависимости от выполненного запроса

Ссылка

https://book.cakephp.org/2.0/ru/models/retrieving-your-data.html#model-query

read()source public

read( string|array $fields null , integer|string $id null )

Возвращает список полей из базы данных и устанавливает текущие данные модели (Model::$data) с найденной записью.

Параметры

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

Имя одного поля или массив имён полей.

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

Идентификатор записи для чтения

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

array
Массив полей базы данных или false, если запись не найдена

Ссылка

https://book.cakephp.org/2.0/ru/models/retrieving-your-data.html#model-read

resetAssociations()source public

resetAssociations( )

Сбрасывает массивы ассоциаций модели до первоначальных значений, определённых в модели. Обычно вызывается в конце каждого вызова Model::find()

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

boolean
Успех

save()source public

save( array $data null , boolean|array $validate true , array $fieldList array() )

Сохраняет данные модели (в зависимости от белого списка, если он указан) в базе данных. По умолчанию валидация происходит перед сохранением. Метод-проход к _doSave() с обработкой транзакций.

Параметры

array $data необязательно null

Данные для сохранения.

boolean|array $validate необязательно true

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

• atomic: Если true (по умолчанию), попытается сохранить запись в одной транзакции.
• validate: Устанавливает true/false для включения или выключения валидации.
• fieldList: Массив полей, которые вы хотите разрешить для сохранения.
• callbacks: Устанавливает значение false для отключения обратных вызовов. Использование 'before' или 'after' включит только эти обратные вызовы.
• counterCache: Булево значение для управления обновлением счётчиков (если они есть)

array $fieldList необязательно array()

Список полей, разрешённых для сохранения

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

mixed
Успешно: Model::$data, если оно не пустое, или true; неуспех: false

Исключения

Exception
PDOException

Триггеры

Model.beforeSave $this, array($options)
Model.afterSave $this, array($created, $options)

Ссылка

https://book.cakephp.org/2.0/ru/models/saving-your-data.html

saveAll()source public

saveAll( array $data array() , array $options array() )

Обратный метод совместимости для: saveMany(), validateMany(), saveAssociated() и validateAssociated()

Сохраняет несколько отдельных записей для одной модели; Также работает с одной записью, а также со всеми связанными записями.

Параметры

array $data необязательно array()

Данные записи для сохранения. Это может быть массив с числовым индексированием (для сохранения нескольких записей одного типа) или массив, индексированный именем ассоциации.

array $options необязательно array()

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

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

mixed

При атомарности: True при успехе, false при неудаче. Иначе: массив, подобный массиву $data, переданному, но значения установлены в true/false в зависимости от успешного сохранения каждой записи.

Ссылки

https://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-saveassociated-array-data-null-array-options-array
https://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-saveall-array-data-null-array-options-array

saveAssociated()source public

saveAssociated( array $data null , array $options array() )

Сохраняет одну запись, а также все её непосредственно связанные записи.

Параметры

array $data необязательно null

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

array $options необязательно array()

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

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

mixed

При атомарности: True при успехе, false при неудаче. Иначе: массив, подобный массиву $data, переданному, но значения установлены в true/false в зависимости от успешного сохранения каждой записи.

Исключения

PDOException

Ссылки

https://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-saveassociated-array-data-null-array-options-array

saveField()source public

saveField( string $name , mixed $value , boolean|array $validate false )

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

Параметры

string $name

Имя поля таблицы

mixed $value

Значение поля

boolean|array $validate необязательно false

Булево значение или массив. Если булево, указывает, нужно ли выполнять валидацию перед сохранением. Если массив, позволяет управлять параметрами 'validate', 'callbacks' и 'counterCache'. См. Model::save() для подробностей о каждом параметре.

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

boolean|array
См. Model::save() False при неудаче или массив данных модели при успехе.

См. также

Model::save()

Ссылки

https://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-savefield-string-fieldname-string-fieldvalue-validate-false

saveMany()source public

saveMany( array $data null , array $options array() )

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

Параметры

array $data необязательно null

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

array $options необязательно array()

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

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

mixed

При атомарности: True при успехе, false при неудаче. Иначе: массив, подобный массиву $data, переданному, но значения установлены в true/false в зависимости от успешного сохранения каждой записи.

Исключения

PDOException

Ссылки

https://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-savemany-array-data-null-array-options-array

schema()source public

schema( boolean|string $field false )

Возвращает массив метаданных таблицы (имена и типы столбцов) из базы данных. $field => ключи (тип, null, значение по умолчанию, ключ, длина, дополнительная информация)

Параметры

boolean|string $field необязательно false

Установите в значение true для перезагрузки схемы или строку для возвращения определенного поля

Возвращает

array|null
Массив метаданных таблицы

set()source public

set( string|array|SimpleXmlElement|DomNode $one , string $two null )

Эта функция выполняет два действия:

1. она ищет первичный ключ в массиве $one и, если он найден, устанавливает текущий id в значение $one[id]. Для всех ключей, кроме 'id', ключи и значения $one копируются в свойство 'data' этого объекта.
2. Возвращает массив со всеми ключами и значениями из $one. (Альтернативный ввод данных: две строки, которые преобразуются в одномерный массив с двумя измерениями, используя $one в качестве ключа и $two в качестве его значения.)

Параметры

string|array|SimpleXmlElement|DomNode $one

Массив или строка данных

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

Строковое значение для альтернативного метода ввода данных

Возвращает

array|null
Данные со всеми ключами и значениями из $one, в противном случае null.

Ссылка

https://book.cakephp.org/2.0/en/models/saving-your-data.html

setDataSource()source public

setDataSource( string $dataSource null )

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

Параметры

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

Имя источника данных, как определено в app/Config/database.php

Выбрасывает

MissingConnectionException

setInsertID()source public

setInsertID( integer|string $id )

Устанавливает идентификатор последней записи, вставленной этой моделью

Параметры

integer|string $id

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

setSource()source public

setSource( string $tableName )

Устанавливает пользовательскую таблицу для вашего класса модели. Используется контроллером для выбора таблицы базы данных.

Параметры

string $tableName

Имя пользовательской таблицы

Выбрасывает

MissingTableException
при отсутствии таблицы базы данных $tableName в источнике данных

unbindModel()source public

unbindModel( array $params , boolean $reset true )

Отключает ассоциации на лету.

Если $reset равен false, ассоциация не будет сброшена до первоначальных значений, определенных в модели.

Пример: Отключить ассоциированную модель Support request, чтобы временно уменьшить нагрузку на модель User:

$this->User->unbindModel(array('hasMany' => array('SupportRequest'))); Или альтернативно: $this->User->unbindModel(array('hasMany' => 'SupportRequest'));

Непривязанные модели, которые не сделаны постоянными, будут сброшены при следующем вызове Model::find()

Параметры

array $params

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

boolean $reset необязательно true

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

Возвращает

boolean
Успех

Ссылка

https://book.cakephp.org/2.0/en/models/associations-linking-models-together.html#creating-and-destroying-associations-on-the-fly

updateAll()source public

updateAll( array $fields , mixed $conditions true )

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

Параметры

array $fields

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

mixed $conditions необязательно true

Условия соответствия, true для всех записей

Возвращает

boolean
True при успехе, false при ошибке

Ссылка

https://book.cakephp.org/2.0/en/models/saving-your-data.html#model-updateall-array-fields-mixed-conditions

updateCounterCache()source public

updateCounterCache( array $keys array() , boolean $created false )

Обновляет кэш счетчика ассоциаций belongsTo после операции сохранения или удаления

Параметры

array $keys необязательно array()

Необязательные данные внешнего ключа, по умолчанию информация $this->data

boolean $created необязательно false

True, если была создана новая запись, иначе обновляются только ассоциации с определенным 'counterScope'

validateAssociated()source public

validateAssociated( array $data , array $options array() )

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

Параметры

array $data

$data Данные записи для проверки. Должен быть массив, индексированный по имени ассоциации.

array $options необязательно array()

Параметры для использования при проверке данных записи (см. выше), см. также $options метода validates().

Возвращает

array|boolean

Если атомарно: True при успехе, или false при ошибке. В противном случае: массив, похожий на переданный массив $data, но значения устанавливаются в true/false в зависимости от того, прошла ли проверку каждая запись успешно.

validateMany()source public

validateMany( array $data , array $options array() )

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

Параметры

array $data

$data Данные записи для проверки. Должен быть числовым массивом

array $options необязательно array()

Параметры для использования при проверке данных записи (см. выше), см. также $options метода validates().

Возвращает

boolean|array

Если атомарно: True при успехе, или false при ошибке. В противном случае: массив, похожий на переданный массив $data, но значения устанавливаются в true/false в зависимости от того, прошла ли проверку каждая запись успешно.

validates()source public

validates( array $options array() )

Возвращает true, если все поля проходят проверку. Будет проверять ассоциации hasAndBelongsToMany, которые используют ключ 'with'. Поскольку _saveMulti не может выйти из операции сохранения.

Будет проверять текущие данные. Используйте Model::set() или Model::create() для установки активных данных.

Параметры

array $options необязательно array()

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

Возвращает

boolean
True, если нет ошибок

validator()source public

validator( ModelValidator $instance null )

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

Параметры

ModelValidator $instance необязательно null

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

Возвращает

ModelValidator

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства этого объекта $property со свойствами в определении $class. Значение свойства этого класса для свойства будет объединено поверх значения $class.

Это обеспечивает некоторую из DRY-магии CakePHP. Если вы хотите отключить её, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с.

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

Установите в значение true, чтобы выполнить нормализацию свойств с помощью Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет устанавливать несколько свойств объекта в одной строке кода. Будут установлены только те свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число|строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет объектно-ориентированную оболочку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно array()

Список параметров, используемых при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. См. CakeLog::write() для получения дополнительной информации о записи в журналы.

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и), в которой создаётся сообщение журнала. См. CakeLog::config() для получения дополнительной информации о областях ведения журнала.

Возвращает

boolean
Успех записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

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

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строку URL. Вы должны использовать форматы URL, совместимые с Router::reverse()

Передача данных POST и GET

Данные POST и GET можно моделировать в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

Строка или URL на основе массива. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательно array()

Если массив содержит ключ "return", он устанавливает AutoRender в значение true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

mixed

Булево значение true или false при успехе/неудаче или содержимое отрисованного действия, если в $extra установлен ключ 'return'.

toString()source public

toString( )

Преобразование CakeObject в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

строка
Имя этого класса

array('Aro' => array('with' => 'Permission'))

'Aco'