Класс DataSource

__construct()source public

__construct( array $config array() )

Конструктор.

Параметры

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

Массив с информацией о конфигурации источника данных.

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

Object::__construct()

__destruct()source public

__destruct( )

Закрывает текущий источник данных.

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

Кэширование описания DataSource

Параметры

строка $object

Имя объекта (модели) для кэширования

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

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

Возвращает

смешанный

begin()source public

begin( )

Начало транзакции

Возвращает

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

close()source public

close( )

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

Возвращает

булево

column()source public

column( string $real )

Преобразование типов столбцов в базовые типы

Параметры

строка $real

Действительный тип столбца (например, "varchar(255)")

Возвращает

строка
Абстрактный тип столбца (например, "строка")

commit()source public

commit( )

Подтверждение транзакции

Возвращает

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

create()source public

create( Model $Model , array $fields null , array $values null )

Используется для создания новых записей. «C» в CRUD.

Подлежит переопределению в подклассах.

Параметры

Model $Model

Модель, которая будет создана.

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

Массив полей, которые будут сохранены.

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

Массив значений для сохранения.

Возвращает

булево
успех

delete()source public

delete( Model $Model , mixed $conditions null )

Удалить запись(и) в источнике данных.

Должно переопределяться в подклассах.

Параметры

Model $Model

Класс модели, у которой удаляются запись(и)

mixed $conditions optional null

Условие для удаления.

Возвращает

boolean
Успех

describe()source public

describe( Model|string $model )

Возвращает описание модели (метаданные) или null, если не найдено.

Параметры

Model|string $model

Модель для описания.

Возвращает

array|null
Массив метаданных для $model

enabled()source public

enabled( )

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

Возвращает

boolean
Выполнены ли условия использования источника данных.

getSchemaName()source public

getSchemaName( )

Возвращает имя схемы. Переопределите в подклассах.

Возвращает

string|null
Имя схемы

insertQueryData()source public

insertQueryData( string $query , array $data , string $association , Model $Model , array $stack )

Заменяет заполнитель {$__cakeID__$} и {$__cakeForeignKey__$} в данных запроса.

Параметры

string $query

Строка запроса, требующая замены.

array $data

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

string $association

Имя модели ассоциации, которая заменяется.

Model $Model

Экземпляр модели.

array $stack

Стек контекста.

Возвращает

mixed
Строка данных запроса с замененными плейсхолдерами или false при ошибке.

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

mixed $source optional null

Имя источника.

Возвращает

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

lastInsertId()source public

lastInsertId( mixed $source null )

Возвращает ID, сгенерированный в результате предыдущей операции INSERT.

Параметры

mixed $source optional null

Имя источника.

Возвращает

mixed
Ключ последнего сгенерированного ID в предыдущем INSERT

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

mixed $source optional null

Имя источника.

Возвращает

integer
Количество строк, возвращенных последней операцией

listSources()source public

listSources( mixed $data null )

Кэширует/возвращает кэшированные результаты для дочерних экземпляров.

Параметры

mixed $data optional null

Не используется в этом классе.

Возвращает

array|null
Массив доступных источников в этом источнике данных.

read()source public

read( Model $Model , array $queryData array() , integer $recursive null )

Используется для чтения записей из источника данных. «Чтение» в CRUD

Должно переопределяться в подклассах.

Параметры

Model $Model

Модель, которая читается.

array $queryData optional array()

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

integer $recursive optional null

Количество уровней ассоциации.

Возвращает

mixed

resolveKey()source public

resolveKey( Model $Model , string $key )

Должно переопределяться в подклассах.

Параметры

Model $Model

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

string $key

Имя ключа, который нужно создать.

Возвращает

string
Имя ключа для модели.

rollback()source public

rollback( )

Откат транзакции

Возвращает

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

setConfig()source public

setConfig( array $config array() )

Устанавливает конфигурацию для DataSource. Объединяет информацию $config с _baseConfig и существующим свойством $config.

Параметры

array $config optional array()

Массив конфигурации

update()source public

update( Model $Model , array $fields null , array $values null , mixed $conditions null )

Обновить запись(и) в источнике данных.

Должно переопределяться в подклассах.

Параметры

Model $Model

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

array $fields optional null

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

array $values optional null

Массив значений для обновления $fields

mixed $conditions optional null

Массив условий для использования.

Возвращает

boolean
Успех

_mergeVars()source protected

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

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

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

Параметры

array $properties

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

string $class

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

boolean $normalize optional true

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

_set()source protected

_set( array $properties array() )

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

Параметры

array $properties optional array()

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status optional 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()

array()

null

false

true

array()

false