Класс yii\base\Model

activeAttributes() public method

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

addError() public method

Добавляет новую ошибку к указанному атрибуту.

addErrors() public method (доступно с версии 2.0.2)

Добавляет список ошибок.

afterValidate() public method

Этот метод вызывается после завершения валидации.

Реализация по умолчанию вызывает событие afterValidate. Вы можете переопределить этот метод, чтобы выполнить постобработку после валидации. Убедитесь, что вызывается родительская реализация, чтобы событие могло быть вызвано.

attributeHints() public method (доступно с версии 2.0.4)

Возвращает подсказки атрибутов.

Подсказки атрибутов в основном используются для отображения. Например, для атрибута isPublic, мы можем объявить подсказку Whether the post should be visible for not logged in users, которая предоставляет удобное описание значения атрибута и может быть отображена конечным пользователям.

В отличие от метки, подсказка не будет сгенерирована, если её явное объявление опущено.

Примечание: для наследования подсказок, определённых в родительском классе, дочерний класс должен объединить родительские подсказки с дочерними, используя функции, такие как array_merge().

attributeLabels() public method

Возвращает метки атрибутов.

Метки атрибутов в основном используются для отображения. Например, для атрибута firstName, мы можем объявить метку First Name, которая более удобна для пользователя и может быть отображена конечным пользователям.

По умолчанию метка атрибута генерируется с помощью generateAttributeLabel(). Этот метод позволяет явно указать метки атрибутов.

Примечание: для наследования меток, определённых в родительском классе, дочерний класс должен объединить родительские метки с дочерними, используя функции, такие как array_merge().

См. также generateAttributeLabel().

attributes() public method

Возвращает список имён атрибутов.

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

beforeValidate() public method

Этот метод вызывается перед началом валидации.

Реализация по умолчанию вызывает событие beforeValidate. Вы можете переопределить этот метод, чтобы выполнить предварительные проверки перед валидацией. Убедитесь, что вызывается родительская реализация, чтобы событие могло быть вызвано.

clearErrors() public method

Удаляет ошибки для всех атрибутов или одного атрибута.

createValidators() public method

Создаёт объекты валидаторов на основе правил валидации, указанных в rules().

В отличие от getValidators(), каждый вызов этого метода возвращает новый список валидаторов.

fields() public method

Возвращает список полей, которые должны возвращаться по умолчанию методом toArray(), когда не указаны конкретные поля.

Поле — это именованный элемент в возвращаемом массиве методом toArray().

Этот метод должен возвращать массив имён полей или определений полей. Если это массив имён, имя поля будет рассматриваться как имя свойства объекта, значение которого будет использоваться в качестве значения поля. Если это массив определений, ключ массива должен быть именем поля, а значение — соответствующим определением поля, которое может быть именем свойства объекта или PHP-выражением, возвращающим соответствующее значение поля. Подпись вызова должна быть:

function ($model, $field) {
    // return field value
}

Например, следующий код объявляет четыре поля:

• email: имя поля совпадает с именем свойства email;
• firstName и lastName: имена полей — firstName и lastName, а их значения получены из свойств first_name и last_name;
• fullName: имя поля — fullName. Его значение получено путём конкатенации first_name и last_name.

return [
    'email',
    'firstName' => 'first_name',
    'lastName' => 'last_name',
    'fullName' => function ($model) {
        return $model->first_name . ' ' . $model->last_name;
    },
];

В этом методе вы также можете возвращать разные списки полей в зависимости от контекста. Например, в зависимости от $scenario или привилегий текущего пользователя приложения, вы можете возвращать разные наборы видимых полей или фильтровать некоторые поля.

Реализация по умолчанию этого метода возвращает attributes() с индексами по тем же именам атрибутов.

См. также toArray().

formName() public method

Возвращает имя формы, которое должен использовать этот класс модели.

Имя формы используется в основном yii\widgets\ActiveForm, чтобы определить, как именовать поля ввода для атрибутов модели. Если имя формы "A", а имя атрибута "b", то соответствующее имя ввода будет "A[b]". Если имя формы пустая строка, то имя ввода будет "b".

Цель вышеуказанной схемы именования — для форм, содержащих несколько разных моделей, атрибуты каждой модели группируются в подмассивах POST-данных, что облегчает их различение.

По умолчанию этот метод возвращает имя класса модели (без имени пространства имён) в качестве имени формы. Вы можете переопределить его, когда модель используется в разных формах.

См. также load().

generateAttributeLabel() public method

Генерирует удобочитаемую метку атрибута на основе заданного имени атрибута.

Это делается путём замены подчёркиваний, тире и точек пробелами и изменения первой буквы каждого слова на заглавную. Например, 'department_name' или 'DepartmentName' будут преобразованы в 'Department Name'.

getActiveValidators() public method

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

getAttributeHint() public method (доступно с версии 2.0.4)

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

См. также attributeHints().

getAttributeLabel() public method

Возвращает метку для указанного атрибута.

См. также:

• generateAttributeLabel()
• attributeLabels()

getAttributes() public method

Возвращает значения атрибутов.

getErrors() public method

Возвращает ошибки для всех атрибутов или для одного атрибута.

См. также:

• getFirstErrors()
• getFirstError()

[
    'username' => [
        'Username is required.',
        'Username must contain only word characters.',
    ],
    'email' => [
        'Email address is invalid.',
    ]
]

getFirstError() public method

Возвращает первую ошибку указанного атрибута.

См. также:

• getErrors()
• getFirstErrors()

getFirstErrors() public method

Возвращает первую ошибку каждого атрибута в модели.

См. также:

• getErrors()
• getFirstError()

getIterator() public method

Возвращает итератор для обхода атрибутов в модели.

Этот метод необходим для интерфейса IteratorAggregate.

getScenario() public method

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

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

getValidators() public method

Возвращает все валидаторы, объявленные в rules().

Этот метод отличается от getActiveValidators(), так как последний возвращает только валидаторы, применимые к текущему $scenario.

Поскольку этот метод возвращает объект ArrayObject, вы можете его изменять, вставляя или удаляя валидаторы (полезно в поведении модели). Например,

$model->validators[] = $newValidator;

hasErrors() public method

Возвращает значение, указывающее, есть ли ошибка валидации.

isAttributeActive() public method

Возвращает значение, указывающее, активен ли атрибут в текущем сценарии.

См. также activeAttributes().

isAttributeRequired() public method

Возвращает значение, указывающее, требуется ли атрибут.

Это определяется проверкой, связана ли атрибут с правилом валидации обязательности в текущем $сценарии.

Обратите внимание, что когда к валидатору применено условное ограничение с помощью $когда, этот метод вернет false независимо от when условия, поскольку он может быть вызван до загрузки данных в модель.

isAttributeSafe() public method

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

См. также safeAttributes().

load() public method

Заполняет модель данными из ввода.

Этот метод предоставляет удобный ярлык для:

if (isset($_POST['FormName'])) {
    $model->attributes = $_POST['FormName'];
    if ($model->save()) {
        // handle success
    }
}

который, с load(), можно записать как:

if ($model->load($_POST) && $model->save()) {
    // handle success
}

load() получает 'FormName' из метода formName() модели (который вы можете переопределить), если параметр $formName не задан. Если имя формы пустое, load() заполняет модель всем $data, а не $data['FormName'].

Обратите внимание, что данные, которые загружаются, проверяются на безопасность методом setAttributes().

loadMultiple() public static method

Заполняет набор моделей данными от пользователя.

Этот метод в основном используется для сбора данных табличного ввода. Данные для загрузки каждой модели — $data[formName][index], где formName — значение formName(), а index — индекс модели в массиве $models. Если formName() пустой, $data[index] используется для заполнения каждой модели. Данные, загружаемые в каждую модель, проверяются на безопасность методом setAttributes().

offsetExists() public method

Возвращает, существует ли элемент по указанному смещению.

Этот метод необходим для интерфейса SPL ArrayAccess. Он неявно вызывается, когда вы используете что-то вроде isset($model[$offset]).

offsetGet() public method

Возвращает элемент по указанному смещению.

Этот метод необходим для интерфейса SPL ArrayAccess. Он неявно вызывается, когда вы используете что-то вроде $value = $model[$offset];.

offsetSet() public method

Устанавливает элемент по указанному смещению.

Этот метод необходим для интерфейса SPL ArrayAccess. Он неявно вызывается, когда вы используете что-то вроде $model[$offset] = $item;.

offsetUnset() public method

Устанавливает значение элемента по указанному смещению в null.

Этот метод необходим для интерфейса SPL ArrayAccess. Он неявно вызывается, когда вы используете что-то вроде unset($model[$offset]).

onUnsafeAttribute() public method

Этот метод вызывается при массовом назначении небезопасного атрибута.

Стандартная реализация запишет сообщение об ошибке, если YII_DEBUG включен. В противном случае ничего не делает.

rules() public method

Возвращает правила валидации для атрибутов.

Правила валидации используются методом validate() для проверки корректности значений атрибутов. Дочерние классы могут переопределять этот метод, чтобы объявить различные правила валидации.

Каждое правило — это массив со следующей структурой:

[
    ['attribute1', 'attribute2'],
    'validator type',
    'on' => ['scenario1', 'scenario2'],
    //...other parameters...
]

где

• список атрибутов: обязательный, определяет массив атрибутов, подлежащих валидации. Для одного атрибута можно передать строку;
• тип валидатора: обязательный, определяет используемый валидатор. Это может быть встроенное имя валидатора, имя метода класса модели, анонимная функция или имя класса валидатора.
• on: необязательный, определяет массив сценариев, в которых правило валидации может быть применено. Если этот параметр не задан, правило будет применено ко всем сценариям.
• дополнительные пары имя-значение могут быть заданы для инициализации соответствующих свойств валидатора. Обратитесь к API отдельных классов валидаторов для возможных свойств.

Валидатор может быть объектом класса, расширяющего yii\validators\Validator, или методом класса модели (встроенный валидатор), имеющим следующий синтаксис:

// $params refers to validation parameters given in the rule
function validatorName($attribute, $params)

В приведенном выше примере $attribute относится к атрибуту, который в данный момент валидируется, а $params содержит массив параметров конфигурации валидатора, например max в случае валидатора string. Значение атрибута, который в данный момент валидируется, можно получить как $this->$attribute. Обратите внимание на $ перед attribute; это берет значение переменной $attribute и использует его в качестве имени свойства для доступа.

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

Ниже приведены некоторые примеры:

[
    // built-in "required" validator
    [['username', 'password'], 'required'],
    // built-in "string" validator customized with "min" and "max" properties
    ['username', 'string', 'min' => 3, 'max' => 12],
    // built-in "compare" validator that is used in "register" scenario only
    ['password', 'compare', 'compareAttribute' => 'password2', 'on' => 'register'],
    // an inline validator defined via the "authenticate()" method in the model class
    ['password', 'authenticate', 'on' => 'login'],
    // a validator of class "DateRangeValidator"
    ['dateRange', 'DateRangeValidator'],
];

Обратите внимание, что для наследования правил, определенных в родительском классе, дочернему классу необходимо объединить родительские правила с дочерними правилами с помощью функций, таких как array_merge().

См. также scenarios().

safeAttributes() public метод

Возвращает имена атрибутов, которые безопасно массово назначать в текущей ситуации.

scenarios() public метод

Возвращает список сценариев и соответствующих активных атрибутов.

Активный атрибут — это атрибут, который подвергается валидации в текущем сценарии. Возвращаемый массив должен иметь следующий формат:

[
    'scenario1' => ['attribute11', 'attribute12', ...],
    'scenario2' => ['attribute21', 'attribute22', ...],
    ...
]

По умолчанию активный атрибут считается безопасным и может быть массово назначен. Если атрибут НЕ должен быть массово назначен (следовательно, считается небезопасным), пожалуйста, добавьте перед именем атрибута символ восклицания (например, '!rank').

По умолчанию этот метод возвращает все сценарии, найденные в объявлении правил(). Специальный сценарий с именем SCENARIO_DEFAULT будет содержать все атрибуты, найденные в правилах(). Каждый сценарий будет связан с атрибутами, которые проверяются правилами валидации, применяемыми к сценарию.

setAttributes() public метод

Устанавливает значения атрибутов массовым способом.

См. также:

• безопасныеАтрибуты()
• атрибуты()

setScenario() public метод

Устанавливает сценарий для модели.

Обратите внимание, что этот метод не проверяет существование сценария. Метод validate() выполнит эту проверку.

validate() public метод

Выполняет валидацию данных.

Этот метод выполняет правила валидации, применимые к текущему $сценарий. Следующие критерии используются для определения того, применимо ли правило в данный момент:

• правило должно быть связано с атрибутами, относящимися к текущему сценарию;
• правила должны быть актуальны для текущего сценария.

Этот метод вызовет beforeValidate() и afterValidate() до и после фактической валидации соответственно. Если beforeValidate() возвращает false, валидация будет отменена, и afterValidate() не будет вызван.

Ошибки, обнаруженные во время валидации, могут быть получены с помощью getErrors(), getFirstErrors() и getFirstError().

validateMultiple() public статический метод

Проверяет несколько моделей.

Этот метод проверит каждую модель. Проверяемые модели могут быть одного или разных типов.