Класс DataSource

__construct()source public

__construct( array $config array() )

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

Параметры

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

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

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

__destruct()source public

__destruct( )

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

_cacheDescription()source protected

_cacheDescription( string $object , mixed $data null )

Кэширование описания источника данных

Параметры

строка $object

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

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

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

Возвращает

begin()source public

begin( )

Начать транзакцию

Возвращает

close()source public

close( )

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

Возвращает

column()source public

column( string $real )

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

Параметры

строка $real

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

Возвращает

commit()source public

commit( )

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

Возвращает

create()source public

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

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

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

Параметры

Model $Model

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

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

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

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

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

Возвращает

delete()source public

delete( Model $Model , mixed $conditions null )

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

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

Параметры

Model $Model

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

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

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

Возвращает

describe()source public

describe( Model|string $model )

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

Параметры

Model|string $model

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

Возвращает

enabled()source public

enabled( )

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

Возвращает

getSchemaName()source public

getSchemaName( )

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

Возвращает

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

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

Возвращает

lastAffected()source public

lastAffected( mixed $source null )

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

Параметры

mixed $source необязательно null

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

Возвращает

lastInsertId()source public

lastInsertId( mixed $source null )

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

Параметры

mixed $source необязательно null

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

Возвращает

lastNumRows()source public

lastNumRows( mixed $source null )

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

Параметры

mixed $source необязательно null

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

Возвращает

listSources()source public

listSources( mixed $data null )

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

Параметры

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

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

Возвращает

read()source public

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

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

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

Параметры

Model $Model

Читаемая модель.

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

Массив данных запроса для поиска нужных данных.

integer $recursive необязательно null

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

Возвращает

resolveKey()source public

resolveKey( Model $Model , string $key )

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

Параметры

Model $Model

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

string $key

Имя ключа для создания

Возвращает

rollback()source public

rollback( )

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

Возвращает

setConfig()source public

setConfig( array $config array() )

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

Параметры

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

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

update()source public

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

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

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

Параметры

Model $Model

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

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

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

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

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

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

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

Возвращает

_mergeVars()source protected

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

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

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

Параметры

array $properties

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

string $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

integer|string $status необязательно 0

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

Возвращает

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

Возвращает

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 и именованных/переданных аргументов.

Возвращает

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

toString()source public

toString( )

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

Возвращает