Класс AclNode

__construct()исходный код public

__construct( )

Конструктор

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

Model::__construct()

node()исходный код public

node( string|array|Model $ref null )

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

Параметры

строка|массив|Model $ref необязательный null

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

Возвращает

массив
Узел, найденный в базе данных

Исключения

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

__call()исходный код public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

Возвращает

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

__get()исходный код public

__get( string $name )

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

Параметры

строка $name

Запрошенная переменная для получения её значения или ссылки

Возвращает

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

__isset()исходный код public

__isset( string $name )

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

Параметры

строка $name

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

Возвращает

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

_addToWhiteList()исходный код protected

_addToWhiteList( string $key , array $options )

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

Параметры

строка $key

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

массив $options

Список опций

Возвращает

массив
опции

_clearCache()исходный код protected

_clearCache( string $type null )

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

Параметры

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

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

Возвращает

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

_collectForeignKeys()исходный код protected

_collectForeignKeys( string $type 'belongsTo' )

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

Параметры

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

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

Возвращает

массив

_constructLinkedModel()исходный код protected

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

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

Параметры

строка $assoc

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

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

Имя класса

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

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

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

_createLinks()исходный код protected

_createLinks( )

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

_deleteDependent()исходный код protected

_deleteDependent( string $id , boolean $cascade )

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

Параметры

строка $id

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

булево значение $cascade

Устанавливается в true для удаления записей, которые зависят от этой записи

_deleteLinks()исходный код protected

_deleteLinks( string $id )

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

Параметры

строка $id

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

_doSave()исходный код 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

Ссылка

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

_filterResults()source protected

_filterResults( array $results , boolean $primary true )

Пропускает результаты запроса через методы model и behavior послеFind().

Параметры

массив $results

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

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

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

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

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

Триггеры

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

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

массив $query

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

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

массив

_saveMulti()source protected

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

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

Параметры

массив $joined

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

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

ID записи в этой модели

DataSource $db

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

_setAliasData()source protected

_setAliasData( array $data )

Перемещение значений в псевдоним

Параметры

массив $data

Данные.

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

массив

afterDelete()source public

afterDelete( )

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

Ссылка

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

afterFind()source public

afterFind( mixed $results , boolean $primary false )

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

Параметры

смешанный $results

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

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

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

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

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

Ссылка

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

afterSave()source public

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

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

Параметры

boolean $created

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

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

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

Ссылка

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

См. также

Model::save()

afterValidate()source public

afterValidate( )

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

associations()source public

associations( )

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

Возвращает

массив

beforeDelete()source public

beforeDelete( boolean $cascade true )

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

Параметры

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

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

Возвращает

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

Ссылка

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

beforeFind()source public

beforeFind( array $query )

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

Параметры

массив $query

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

Возвращает

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

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

Ссылка

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

beforeSave()source public

beforeSave( array $options array() )

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

Параметры

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

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

Возвращает

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

Ссылка

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

См. также

Model::save()

beforeValidate()source public

beforeValidate( array $options array() )

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

Параметры

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

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

Возвращает

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

Ссылка

http://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() для этой модели.

Параметры

массив $params

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

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

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

Возвращает

boolean
Успех

Ссылка

http://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() )

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

Параметры

строка $type необязательно 'first'

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

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

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

Возвращает

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

Вызывает

Model.beforeFind $this, array($query)

См. также

Model::find()

clear()source public

clear( )

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

Возвращает

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

См. также

Model::create()

create()source public

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

http://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 )

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

Параметры

строка $field

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

массив|объект $data

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

Возвращает

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

delete()source public

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

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

Параметры

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

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

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

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

Возвращает

boolean
Истина при успехе

Вызывает

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

Ссылка

http://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 optional true

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

boolean $callbacks optional false

Выполнять обратные вызовы

Возвращает

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

Ссылка

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

escapeField()source public

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

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

Параметры

string $field optional null

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

string $alias optional null

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

Возвращает

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

exists()source public

exists( integer|string $id null )

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

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

Параметры

integer|string $id optional null

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

Возвращает

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

field()source public

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

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

Параметры

string $name

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

array $conditions optional null

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

string $order optional null

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

Возвращает

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

Ссылка

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

find()source public

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

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

Используется для выполнения операций поиска, где первый аргумент — тип операции поиска (все / первый / количество / соседи / список / нитевой), второй параметр — опции для поиска (индексированный массив, включающий: '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(). Смотрите документацию по пользовательским типам поиска (http://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 optional 'first'

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

array $query optional array()

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

Возвращает

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

Ссылка

http://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 optional 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 optional 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( )

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

Ссылка

http://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 для включения/выключения кэширования запросов.

Параметры

string $sql

SQL-запрос

Возвращает

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

Ссылка

http://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

ID записи для чтения

Возвращает

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

Ссылка

http://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() с обработкой транзакций.

Параметры

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

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

boolean|массив $validate необязательно true

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

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

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

Список полей, которые разрешено сохранить

Возвращает

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

Исключения

Исключение
PDOException

Вызывает

Model.beforeSave $this, массив($options)
Model.afterSave $this, массив($created, $options)

Ссылка

http://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()

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

Параметры

• validate: Устанавливается в false для отключения валидации, true для проверки каждой записи перед сохранением, 'first' для валидации всех записей перед сохранением любой (по умолчанию), или 'only' для проверки записей, но без их сохранения.
• atomic: Если true (по умолчанию), попытается сохранить все записи в одной транзакции. Должно быть установлено в false, если база данных/таблица не поддерживает транзакции.
• fieldList: Эквивалентно параметру $fieldList в Model::save(). Должно быть ассоциативным массивом, где ключ - имя модели, а значение - массив полей. Пример: array( 'SomeModel' => array('field'), 'AssociatedModel' => array('field', 'otherfield') )
• deep: См. saveMany/saveAssociated
• callbacks: См. Model::save()
• counterCache: См. Model::save()

Параметры

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

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

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

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

Возвращает

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

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

Ссылка

http://book.cakephp.org/2.0/ru/models/saving-your-data.html#model-saveassociated-array-data-null-array-options-array
http://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() )

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

Параметры

• validate: Устанавливается в false для отключения валидации, true для проверки каждой записи перед сохранением, 'first' для валидации всех записей перед сохранением любой (по умолчанию),
• atomic: Если true (по умолчанию), попытается сохранить все записи в одной транзакции. Должно быть установлено в false, если база данных/таблица не поддерживает транзакции.
• fieldList: Эквивалентно параметру $fieldList в Model::save(). Должно быть ассоциативным массивом, где ключ - имя модели, а значение - массив полей. Пример: array( 'SomeModel' => array('field'), 'AssociatedModel' => array('field', 'otherfield') )
• deep: Если установлено в true, сохраняются не только непосредственно связанные данные, но и вложенные связанные данные.
• callbacks: См. Model::save()
• counterCache: См. Model::save()

Параметры

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

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

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

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

Возвращает

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

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

Исключения

PDOException

Ссылка

http://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 )

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

Параметры

строка $name

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

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

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

boolean|массив $validate необязательно false

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

Возвращает

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

См. также

Model::save()

Ссылка

http://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() )

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

Параметры

• validate: Устанавливается в false для отключения валидации, true для проверки каждой записи перед сохранением, 'first' для валидации всех записей перед сохранением любой (по умолчанию),
• atomic: Если true (по умолчанию), попытается сохранить все записи в одной транзакции. Должно быть установлено в false, если база данных/таблица не поддерживает транзакции.
• fieldList: Эквивалентно параметру $fieldList в Model::save()
• deep: Если установлено в true, будут сохранены все связанные данные.
• callbacks: См. Model::save()
• counterCache: См. Model::save()

Параметры

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

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

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

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

Возвращает

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

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

Исключения

PDOException

Ссылка

http://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 => ключи(type, null, default, key, length, extra)

Параметры

boolean|строка $field необязательно false

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

Возвращает

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

set()source public

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

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

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

Параметры

строка|массив|SimpleXmlElement|DomNode $one

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

строка $two необязательно null

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

Возвращает

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

Ссылка

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

setDataSource()source public

setDataSource( string $dataSource null )

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

Параметры

строка $dataSource необязательно null

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

Выбрасывает

MissingConnectionException

setInsertID()source public

setInsertID( integer|string $id )

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

Параметры

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

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

setSource()source public

setSource( string $tableName )

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

Параметры

строка $tableName

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

Выбрасывает

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

unbindModel()source public

unbindModel( array $params , boolean $reset true )

Отключение ассоциаций в динамическом режиме.

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

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

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

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

Параметры

массив $params

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

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

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

Возвращает

логическое
Успех

Ссылка

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

updateAll()source public

updateAll( array $fields , mixed $conditions true )

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

Параметры

массив $fields

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

смешанный $conditions необязательно true

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

Возвращает

логическое
True при успехе, false при ошибке

Ссылка

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

updateCounterCache()source public

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

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

Параметры

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

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

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

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

validateAssociated()source public

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

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

Параметры

массив $data

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

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

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

Возвращает

массив|логическое

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

validateMany()source public

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

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

Параметры

массив $data

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

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

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

Возвращает

логическое|массив

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

validates()source public

validates( array $options array() )

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

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

Параметры

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

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

Возвращает

логическое
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( )

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

Возвращает

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

array('Tree' => array('type' => 'nested'))

false