Spec-Zone.ru › CakePHP 2.10

Класс CakeSchema

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

CakeObject
Extended by CakeSchema
Пакет: Cake\Модель
Авторские права: Авторские права (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Model/CakeSchema.php

Краткое описание свойств

  • $connection public
    string
    Подключение, используемое для чтения.
  • $file public
    string
    Файл для записи.
  • $name public
    string
    Имя схемы.
  • $path public
    string
    Путь для записи.
  • $plugin public
    string
    Имя плагина.
  • $tables public
    array
    Набор таблиц.

Краткое описание методов

  • __construct() public
    Конструктор
  • _arrayDiffAssoc() protected
    Расширенная функция array_diff_assoc, учитывающая изменения с/на значения NULL.
  • _columns() protected
    Форматирует столбцы схемы из объекта модели.
  • _compareIndexes() protected
    Сравнение двух индексов схемы.
  • _compareTableParameters() protected
    Сравнение параметров таблицы в двух файлах схемы.
  • _noPrefixTable() protected

    Убирает префикс таблицы из полного имени таблицы и возвращает имя без префикса.

  • _requireFile() protected
    Попытка включить указанный файл схемы.
  • _values() protected
    Форматирует столбцы схемы из объекта модели.
  • after() public
    Обработчик после выполнения, подлежащий реализации в подклассах.
  • before() public
    Обработчик до выполнения, подлежащий реализации в подклассах.
  • build() public
    Создает свойства объекта схемы.
  • compare() public
    Сравнивает два набора схем.
  • generateTable() public
    Генерирует код схемы для таблицы.
  • load() public
    Считывает базу данных и создает таблицы схемы.
  • read() public
    Считывает базу данных и создает таблицы схемы.
  • write() public
    Записывает файл схемы из объекта или опций.

Подробное описание методов

__construct()source public

__construct( array $options array() )

Конструктор

Параметры

массив $options необязательно массив()
Необязательные свойства объекта загрузки.

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

CakeObject::__construct()

_arrayDiffAssoc()source protected

_arrayDiffAssoc( array $array1 , array $array2 )

Расширенная функция array_diff_assoc, учитывающая изменения с/на значения NULL.

Она ведет себя почти так же, как array_diff_assoc, за исключением значений NULL: если одно из значений не NULL — изменение обнаруживается. Это полезно в ситуациях, когда одно значение равно strval('') а другое strval(null) — при сравнении строк в методах сравнения это приводит к результату РАВНО, в то время как на самом деле это не так.

Параметры

массив $array1
Базовый массив.
массив $array2
Соответствующий массив, проверяемый на равенство.

Возвращает

массив

Разница в виде массива с элементами (ключи => значения) из входного массива, где соответствие не найдено.


_columns()source protected

_columns( array $Obj )

Форматирует столбцы схемы из объекта модели.

Параметры

массив $Obj
$Obj объект модели.

Возвращает

массив
Отформатированные столбцы.

_compareIndexes()source protected

_compareIndexes( array $new , array $old )

Сравнение двух индексов схемы.

Параметры

массив $new
Новые индексы.
массив $old
Старые индексы.

Возвращает

смешанный тип
False при ошибке или массив индексов для добавления и удаления.

_compareTableParameters()source protected

_compareTableParameters( array $new , array $old )

Сравнение параметров таблицы в двух файлах схемы.

Параметры

массив $new
Новые индексы.
массив $old
Старые индексы.

Возвращает

смешанный тип
False при ошибке или массив параметров для добавления и удаления.

_noPrefixTable()source protected

_noPrefixTable( string $prefix , string $table )

Убирает префикс таблицы из полного имени таблицы и возвращает имя без префикса.

Параметры

строка $prefix
Префикс таблицы.
строка $table
Полное имя таблицы.

Возвращает

строка
Имя таблицы без префикса.

_requireFile()source protected

_requireFile( string $path , string $file )

Попытка включить указанный файл схемы.

Параметры

строка $path
Путь к файлу в файловой системе.
строка $file
Имя файла в файловой системе.

Возвращает

boolean
True, если файл успешно включён, false при ошибке.

_values()source protected

_values( array $values )

Форматирует столбцы схемы из объекта модели.

Параметры

массив $values
Ключи параметров (тип, null, значение по умолчанию, ключ, длина, дополнительно).

Возвращает

массив
Отформатированные значения.

after()source public

after( array $event array() )

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

Параметры

массив $event необязательно массив()
Свойства объекта схемы.

before()source public

before( array $event array() )

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

Параметры

массив $event необязательно массив()
Свойства объекта схемы.

Возвращает

boolean
Следует ли продолжить обработку.

build()source public

build( array $data )

Создает свойства объекта схемы.

Параметры

массив $data
Загруженные свойства объекта.
END_OF_DOCUMENT_MARKER

compare()source public

compare( array|object $old , array|object $new null )

Сравнивает два набора схем.

Параметры

массив|объект $old
Объект или массив схемы.
массив|объект $new необязательно null
Объект или массив схемы.

Возвращает

массив
Таблицы (которые добавлены, удалены или изменены).

generateTable()source public

generateTable( string $table , array $fields )

Генерирует код схемы для таблицы.

Принимает имя таблицы и массив $fields и возвращает полное, экранированное объявление переменной, которое будет использовано в классах схем.

Параметры

строка $table
Имя таблицы, которое вы хотите получить.
массив $fields
Массив информации о полях для генерации таблицы.

Возвращает

строка
Объявление переменной для класса схемы.

Выбрасывает

Исключение

load()source public

load( array $options array() )

Считывает базу данных и создает таблицы схемы.

Параметры

массив $options необязательно array()
Свойства объекта схемы.

Возвращает

массив|булево
Набор имен и таблиц.

read()source public

read( array $options array() )

Считывает базу данных и создает таблицы схемы.

Параметры

  • 'connection' - подключение к базе данных, которое нужно использовать
  • 'name' - имя схемы
  • 'models' - список моделей для использования, или false для игнорирования моделей

Параметры

массив $options необязательно array()
Свойства объекта схемы.

Возвращает

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

write()source public

write( array|object $object , array $options array() )

Записывает файл схемы из объекта или параметров.

Параметры

массив|объект $object
Объект схемы или массив параметров.
массив $options необязательно array()
Свойства объекта схемы для переопределения объекта.

Возвращает

смешанное
Ложь или строка, записанная в файл.

Методы, унаследованные от CakeObject

_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

Возвращает

смешанное
Возвращает результат вызова метода

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 в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

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

Подробное описание свойств

$connectionsource

public строка

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

'default'

$filesource

public строка

Файл для записи.

'schema.php'

$namesource

public строка

Имя схемы.

null

$pathsource

public строка

Путь к месту записи.

null

$pluginsource

public строка

Имя плагина.

null
END_OF_DOCUMENT_MARKER

$tablessource

public array

Набор таблиц.

array()

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-CakeSchema.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API