Class craft\utilities\DeprecationErrors
- Inheritance
- craft\utilities\DeprecationErrors » craft\base\Utility » craft\base\Component » craft\base\Model » yii\base\Model » yii\base\Component » yii\base\BaseObject
- Implements
- ArrayAccess, IteratorAggregate, craft\base\ComponentInterface, craft\base\UtilityInterface, yii\base\Arrayable, yii\base\Configurable, yii\base\StaticInstanceInterface
- Uses Traits
- yii\base\ArrayableTrait, yii\base\StaticInstanceTrait
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/utilities/DeprecationErrors.php
DeprecationErrors represents a DeprecationErrors dashboard widget.
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
activeAttributes() |
Returns the attribute names that are subject to validation in the current scenario. | yii\base\Model |
addError() |
Adds a new error to the specified attribute. | yii\base\Model |
addErrors() |
Adds a list of errors. | yii\base\Model |
addModelErrors() |
Adds errors from another model, with a given attribute name prefix. | craft\base\Model |
afterValidate() |
This method is invoked after validation ends. | yii\base\Model |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
attributeHints() |
Returns the attribute hints. | yii\base\Model |
attributeLabels() |
Returns the attribute labels. | yii\base\Model |
attributes() |
Returns the list of attribute names. | yii\base\Model |
badgeCount() |
Returns the number that should be shown in the utility’s nav item badge. | craft\utilities\DeprecationErrors |
beforeValidate() |
This method is invoked before validation starts. | yii\base\Model |
behaviors() |
Returns a list of behaviors that this component should behave as. | craft\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
clearErrors() |
Removes errors for all attributes or a single attribute. | yii\base\Model |
contentHtml() |
Returns the utility's content HTML. | craft\utilities\DeprecationErrors |
createValidators() |
Creates validator objects based on the validation rules specified in rules(). | yii\base\Model |
datetimeAttributes() |
Returns the names of any attributes that should hold DateTime values. | craft\base\Model |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
displayName() |
Returns the display name of this class. | craft\utilities\DeprecationErrors |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
extraFields() |
Returns the list of fields that can be expanded further and returned by toArray(). | yii\base\ArrayableTrait |
fields() |
Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. | yii\base\ArrayableTrait |
formName() |
Returns the form name that this model class should use. | yii\base\Model |
generateAttributeLabel() |
Generates a user friendly attribute label based on the give attribute name. | yii\base\Model |
getActiveValidators() |
Returns the validators applicable to the current \yii\base\scenario. | yii\base\Model |
getAttributeHint() |
Returns the text hint for the specified attribute. | yii\base\Model |
getAttributeLabel() |
Returns the text label for the specified attribute. | yii\base\Model |
getAttributes() |
Returns attribute values. | yii\base\Model |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getError() |
Returns the first error of the specified attribute. | craft\base\Model |
getErrorSummary() |
Returns the errors for all attributes as a one-dimensional array. | yii\base\Model |
getErrors() |
Returns the errors for all attributes or a single attribute. | yii\base\Model |
getFirstError() |
Returns the first error of the specified attribute. | yii\base\Model |
getFirstErrors() |
Returns the first error of every attribute in the model. | yii\base\Model |
getIterator() |
Returns an iterator for traversing the attributes in the model. | yii\base\Model |
getScenario() |
Returns the scenario that this model is used in. | yii\base\Model |
getValidators() |
Returns all the validators declared in rules(). | yii\base\Model |
hasErrors() |
Returns a value indicating whether there is any validation error. | yii\base\Model |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
iconPath() |
Returns the path to the utility’s SVG icon. | craft\utilities\DeprecationErrors |
id() |
Returns the utility’s unique identifier. | craft\utilities\DeprecationErrors |
init() |
Initializes the object. | craft\base\Component |
instance() |
Returns static class instance, which can be used to obtain meta information. | yii\base\StaticInstanceTrait |
isAttributeActive() |
Returns a value indicating whether the attribute is active in the current scenario. | yii\base\Model |
isAttributeRequired() |
Returns a value indicating whether the attribute is required. | yii\base\Model |
isAttributeSafe() |
Returns a value indicating whether the attribute is safe for massive assignments. | yii\base\Model |
load() |
Populates the model with input data. | yii\base\Model |
loadMultiple() |
Populates a set of models with the data from end user. | yii\base\Model |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
offsetExists() |
Returns whether there is an element at the specified offset. | yii\base\Model |
offsetGet() |
Returns the element at the specified offset. | yii\base\Model |
offsetSet() |
Sets the element at the specified offset. | yii\base\Model |
offsetUnset() |
Sets the element value at the specified offset to null. | yii\base\Model |
on() |
Attaches an event handler to an event. | yii\base\Component |
onUnsafeAttribute() |
This method is invoked when an unsafe attribute is being massively assigned. | yii\base\Model |
rules() |
Returns the validation rules for attributes. | yii\base\Model |
safeAttributes() |
Returns the attribute names that are safe to be massively assigned in the current scenario. | yii\base\Model |
scenarios() |
Returns a list of scenarios and the corresponding active attributes. | yii\base\Model |
setAttributes() |
Sets the attribute values in a massive way. | yii\base\Model |
setScenario() |
Sets the scenario for the model. | yii\base\Model |
toArray() |
Converts the model into an array. | yii\base\ArrayableTrait |
trigger() |
Triggers an event. | yii\base\Component |
validate() |
Performs the data validation. | yii\base\Model |
validateMultiple() |
Validates multiple models. | yii\base\Model |
| Method | Description | Defined By |
|---|---|---|
extractFieldsFor() |
Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: "item.id" The previous example would extract "id". | yii\base\ArrayableTrait |
extractRootFields() |
Extracts the root field names from nested fields. | yii\base\ArrayableTrait |
resolveFields() |
Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
| Event | Type | Description | Defined By |
|---|---|---|---|
EVENT_AFTER_VALIDATE |
yii\base\Event | An event raised at the end of validate() | yii\base\Model |
EVENT_BEFORE_VALIDATE |
yii\base\ModelEvent | An event raised at the beginning of validate(). | yii\base\Model |
EVENT_DEFINE_BEHAVIORS |
craft\events\DefineBehaviorsEvent | The event that is triggered when defining the class behaviors | craft\base\Component |
EVENT_INIT |
yii\base\Event | The event that is triggered after the component's init cycle | craft\base\Component |
| Constant | Value | Description | Defined By |
|---|---|---|---|
SCENARIO_DEFAULT |
'default' | The name of the default scenario. | yii\base\Model |
Method Details
badgeCount()
public static method
#
Returns the number that should be shown in the utility’s nav item badge.
If 0 is returned, no badge will be shown
public static integer badgeCount ( )
contentHtml()
public static method
#
Returns the utility's content HTML.
public static string contentHtml ( )
displayName()
public static method
#
Returns the display name of this class.
public static string displayName ( )| return | string | The display name of this class. |
|---|
iconPath()
public static method
#
Returns the path to the utility’s SVG icon.
public static string, null iconPath ( )
id()
public static method
#
Returns the utility’s unique identifier.
The ID should be in kebab-case, as it will be visible in the URL (admin/utilities/the-handle).
public static string id ( )