Spec-Zone.ru › CakePHP 2.9

Класс TranslateBehavior

Поведение перевода

CakeObject
Extended by ModelBehavior
Extended by TranslateBehavior
Пакет: Cake\Модель\Поведение
Ссылка: http://book.cakephp.org/2.0/ru/core-libraries/behaviors/translate.html
Авторские права: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
Лицензия: MIT License
Расположение: Cake/Model/Behavior/TranslateBehavior.php

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

  • $_joinTable protected
    object
    Хранит объект joinTable для генерации соединений.
  • $_runtimeModel protected
    Model
    Хранит модель во время выполнения для генерации соединений.
  • $runtime public
    array
    Используется для конфигурации модели во время выполнения

Унаследованные свойства

  • mapMethods, settings

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

  • _addJoin() protected
    Добавляет соединение для переведенных полей.
  • _checkConditions() protected

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

  • _getLocale() protected
    Получить выбранный язык для модели
  • _prepareTranslations() protected

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

  • _removeField() protected
    Обновляет настройки во время выполнения для заданного поля.
  • _setRuntimeData() protected
    Устанавливает данные во время выполнения.
  • afterDelete() public
    Обработчик afterDelete
  • afterFind() public
    Обработчик afterFind
  • afterSave() public
    Обработчик afterSave
  • afterValidate() public

    Возвращает данные модели к исходным данным. Это решает проблемы с saveAssociated и validate = first.

  • beforeFind() public
    Обработчик beforeFind
  • beforeSave() public
    Обработчик beforeSave.
  • beforeValidate() public
    Обработчик beforeValidate
  • bindTranslation() public

    Связывает перевод для полей, необязательно с ассоциацией hasMany для поддельного поля.

  • cleanup() public
    Обработчик cleanup отвязывает связанные переводы и удаляет информацию о настройках.
  • setup() public
    Обработчик
  • translateModel() public
    Получить экземпляр модели для переводов.
  • unbindTranslation() public

    Отвязывает перевод для полей, необязательно отвязывает ассоциацию hasMany для поддельного поля

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

_addJoin()source protected

_addJoin( Model $Model , array $query , string $field , string $aliasField , string|array $locale )

Добавляет соединение для переведенных полей.

Параметры

Model $Model
Модель, над которой ведется работа.
массив $query
Массив запроса, к которому нужно добавить соединение.
строка $field
Имя поля, к которому добавляется соединение.
строка $aliasField
Псевдоним поля, к которому добавляется соединение.
строка|массив $locale
Язык(и), для которых добавляются соединения.

Возвращает

массив
Измененный запрос

_checkConditions()source protected

_checkConditions( Model $Model , array $query )

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

Параметры

Model $Model
Модель, которая читается.
массив $query
Массив запроса.

Возвращает

массив
Список переведенных полей, присутствующих в условиях.

_getLocale()source protected

_getLocale( Model $Model )

Получить выбранный язык для модели

Параметры

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

Возвращает

смешанный тип
строка или ложь

_prepareTranslations()source protected

_prepareTranslations( Model $Model , array $data )

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

Параметры

Model $Model
Модель, использующая это поведение
массив $data
Неполные данные, которые были предоставлены.

Возвращает

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

_removeField()source protected

_removeField( Model $Model , string $field )

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

Параметры

Model $Model
Модель, использующая это поведение
строка $field
Обновляемое поле.

_setRuntimeData()source protected

_setRuntimeData( Model $Model )

Устанавливает данные во время выполнения.

Используется из beforeValidate() и beforeSave() для совместимости и для возможности сохранения переводов даже при отключенной валидации.

Параметры

Model $Model
Модель, использующая это поведение.

afterDelete()source public

afterDelete( Model $Model )

Обработчик afterDelete

Параметры

Model $Model
Модель, на которой был вызван обработчик.

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

ModelBehavior::afterDelete()

afterFind()source public

afterFind( Model $Model , array $results , boolean $primary false )

Обработчик afterFind

Параметры

Model $Model
Модель, на которой был выполнен поиск
массив $results
Массив результатов модели.
булево $primary необязательно false
Произошел ли поиск на $model.

Возвращает

массив
Измененные результаты

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

ModelBehavior::afterFind()

afterSave()source public

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

Обработчик afterSave

Параметры

Model $Model
Модель, на которой вызывается обработчик
булево $created
Создана ли запись в результате сохранения.
массив $options необязательно array()
Параметры, переданные из Model::save().

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

ModelBehavior::afterSave()
END_OF_DOCUMENT_MARKER

afterValidate()source public

afterValidate( Model $Model )

Восстанавливает данные модели до исходных данных. Это решает проблемы с saveAssociated и validate = first.

Параметры

Model $Model
Модель, использующая этот бихевиор.

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

ModelBehavior::afterValidate()

beforeFind()source public

beforeFind( Model $Model , array $query )

Обработчик beforeFind

Параметры

Model $Model
Модель, на которой выполняется поиск.
массив $query
Массив параметров запроса.

Возвращает

массив
Изменённый запрос

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

ModelBehavior::beforeFind()

beforeSave()source public

beforeSave( Model $Model , array $options array() )

Обработчик beforeSave.

Копирует данные в свойство runtime, когда $options['validate'] отключен. Или данные runtime ещё не установлены.

Параметры

Model $Model
Модель, на которой вызвана сохранение.
массив $options необязательно массив()
Опции, переданные из Model::save().

Возвращает

булево
true.

См. также

Model::save()

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

ModelBehavior::beforeSave()

beforeValidate()source public

beforeValidate( Model $Model , array $options array() )

Обработчик beforeValidate

Параметры

Model $Model
Модель, на которой вызван invalidFields.
массив $options необязательно массив()
Опции, переданные из Model::save().

Возвращает

булево

См. также

Model::save()

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

ModelBehavior::beforeValidate()

bindTranslation()source public

bindTranslation( Model $Model , string|array $fields , boolean $reset true )

Привязывает перевод для полей, необязательно с ассоциацией hasMany для фиктивного поля.

Примечание Следует избегать привязки переводов, которые перекрывают существующие свойства модели. Это может привести к непредсказуемому и нежелательному поведению.

Параметры

Model $Model
использующая модель этого поведения
строка|массив $fields
строка с полем или массив (поле1, поле2=>ИмяАссоциации, поле3)
булево $reset необязательно true

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

Возвращает

булево

Исключения

CakeException

при попытке привязать перевод с именем, используемым для перевода. Это запрещено, так как это затемняет Model::$name.


cleanup()source public

cleanup( Model $Model )

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

Параметры

Model $Model
Модель, которая отсоединяется.

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

ModelBehavior::cleanup()

setup()source public

setup( Model $Model , array $config array() )

Обработчик

$config для TranslateBehavior должен быть массивом ('fields' => массив('поле_один', 'поле_два' => 'АссоциацияПоля', 'поле_три'))

В приведенном выше примере будет присоединена только одна постоянная hasMany (для поля_два как АссоциацияПоля)

$config может быть пустым - и переводы могут быть настроены динамически методом bindTranslation()

Параметры

Model $Model
Модель, к которой прикрепляется поведение.
массив $config необязательно массив()
Массив информации о конфигурации.

Возвращает

смешанное

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

ModelBehavior::setup()

translateModel()source public

translateModel( Model $Model )

Получение экземпляра модели для переводов.

Если для модели установлено свойство translateModel, оно будет использоваться в качестве имени класса для поиска/использования. Если свойство translateModel не найдено, будет использоваться 'I18nModel'.

Параметры

Model $Model
Модель, для которой требуется получить модель перевода.

Возвращает

Model

unbindTranslation()source public

unbindTranslation( Model $Model , string|array $fields null )

Отвязывает перевод для полей, необязательно отвязывает ассоциацию hasMany для фиктивного поля

Параметры

Model $Model
использующая модель этого поведения
строка|массив $fields необязательно null

строка с полем, или массив (поле1, поле2=>ИмяАссоциации, поле3), или null для отвязки всех исходных переводов

Возвращает

булево

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

_addToWhitelist()source protected

_addToWhitelist( Model $model , string $field )

Если свойство whitelist модели не пустое, $field будет добавлен в него. Примечание: этот метод следует использовать только в beforeValidate или beforeSave, чтобы убедиться, что он изменяет белый список только для текущей операции сохранения. Также убедитесь, что вы явно установили значение поля, которое вы разрешаете.

Параметры

Model $model
Модель, использующая это поведение
строка $field
Поле, которое нужно добавить в белый список модели

beforeDelete()source public

beforeDelete( Model $model , boolean $cascade true )

beforeDelete вызывается перед любой операцией удаления на присоединённой модели, но после вызова beforeDelete модели. Возврат false из beforeDelete прервёт удаление.

Параметры

Model $model
Модель, использующая это поведение
булево $cascade необязательно true
Если true, записи, зависящие от этой записи, также будут удалены

Возвращает

смешанное
False, если операция должна быть прервана. Любой другой результат будет продолжен.

onError()source public

onError( Model $model , string $error )

Обработчик ошибки источника данных

Параметры

Model $model
Модель, использующая это поведение
строка $error
Ошибка, сгенерированная в DataSource

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

__construct()source public

__construct( )

Конструктор, неявный

_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 необязательно массив()
Ассоциативный массив, содержащий свойства и соответствующие значения.
END_OF_DOCUMENT_MARKER

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

Возвращает

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

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

$_joinTablesource

protected объект

Хранит объект joinTable для генерации соединений.

$_runtimeModelsource

protected Model

Хранит модель runtime для генерации соединений.

$runtimesource

public массив

Используется для конфигурации модели во время выполнения

array()

© 2005–2016 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.9/class-TranslateBehavior.html

Spec-Zone.ru

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