Deprecator ​
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Deprecator » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
Deprecator service.
An instance of the service is available via Craft::$app->deprecator.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| logTarget | string, false – Whether deprecation errors should be logged in the database ('db'), error logs ('logs'), or not at all (false). |
| logs | craft\models\DeprecationError[] |
| requestLogs | craft\models\DeprecationError[] |
| throwExceptions | boolean – Whether deprecation warnings should throw exceptions rather than being logged. |
| totalLogs | integer |
logTarget ​
Whether deprecation errors should be logged in the database ('db'), error logs ('logs'), or not at all (false).
logs ​
- Type
- craft\models\DeprecationError[]
- Default value
null- Access
- Read-only
requestLogs ​
- Type
- craft\models\DeprecationError[]
- Default value
null- Access
- Read-only
throwExceptions ​
- Type
- boolean
- Default value
false- Since
- 3.1.18
Whether deprecation warnings should throw exceptions rather than being logged.
totalLogs ​
- Type
- integer
- Default value
null- Access
- Read-only
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __get() | Returns the value of a component property. |
| __isset() | Checks if a property is set, i.e. defined and not null. |
| __set() | Sets the value of a component property. |
| __unset() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| deleteAllLogs() | Deletes all logs. |
| deleteLogById() | Deletes a log by its ID. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getLogById() | Returns a log by its ID. |
| getLogs() | Get 'em all. |
| getRequestLogs() | Returns the deprecation errors that were logged in the current request. |
| getTotalLogs() | Returns the total number of deprecation errors that have been logged. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| log() | Logs a new deprecation error. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| storeLogs() | Stores all the deprecation warnings that were logged in this request. |
| trigger() | Triggers an event. |
deleteAllLogs() ​
Deletes all logs.
Returns ​
deleteLogById() ​
Deletes a log by its ID.
Arguments ​
$id(integer)
Returns ​
getLogById() ​
Returns a log by its ID.
Arguments ​
$logId(integer)
Returns ​
craft\models\DeprecationError, null
getLogs() ​
Get 'em all.
Arguments ​
Returns ​
craft\models\DeprecationError[]
getRequestLogs() ​
Returns the deprecation errors that were logged in the current request.
Returns ​
craft\models\DeprecationError[]
getTotalLogs() ​
Returns the total number of deprecation errors that have been logged.
Returns ​
init() ​
- Since
- 3.4.12
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
log() ​
Logs a new deprecation error.
Arguments ​
Throws ​
storeLogs() ​
- Since
- 3.4.12
Stores all the deprecation warnings that were logged in this request.