Class craft\services\Deprecator
- Inheritance
- craft\services\Deprecator » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/services/Deprecator.php
Deprecator service.
An instance of the Deprecator service is globally accessible in Craft via Craft::$app->deprecator.
| 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 |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\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 |
deleteAllLogs() |
Deletes all logs. | craft\services\Deprecator |
deleteLogById() |
Deletes a log by its ID. | craft\services\Deprecator |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getLogById() |
Returns a log by its ID. | craft\services\Deprecator |
getLogs() |
Get 'em all. | craft\services\Deprecator |
getRequestLogs() |
Returns the deprecation errors that were logged in the current request. | craft\services\Deprecator |
getTotalLogs() |
Returns the total number of deprecation errors that have been logged. | craft\services\Deprecator |
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 |
init() |
Initializes the object. | yii\base\BaseObject |
log() |
Logs a new deprecation error. | craft\services\Deprecator |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
trigger() |
Triggers an event. | yii\base\Component |
Method Details
deleteAllLogs()
public method
#
Deletes all logs.
public boolean deleteAllLogs ( )
deleteLogById()
public method
#
Deletes a log by its ID.
public boolean deleteLogById ( \craft\services\int $id )$id |
integer |
getLogById()
public method
#
Returns a log by its ID.
public craft\models\DeprecationError, null getLogById ( \craft\services\int $logId )$logId |
integer |
getLogs()
public method
#
Get 'em all.
public craft\models\DeprecationError[] getLogs ( \craft\services\int $limit = null )$limit |
integer, null |
getRequestLogs()
public method
#
Returns the deprecation errors that were logged in the current request.
public craft\models\DeprecationError[] getRequestLogs ( )
getTotalLogs()
public method
#
Returns the total number of deprecation errors that have been logged.
public integer getTotalLogs ( )
log()
public method
#
Logs a new deprecation error.
public boolean log ( \craft\services\string $key, \craft\services\string $message )$key |
string | |
$message |
string |