Deprecator

Type: Class
Namespace: craft\services
Inherits: craft\services\Deprecator » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window)
Since: 3.0.0

Deprecator service.

An instance of the service is available via Craft::$app->deprecator.

# Public Properties

Property	Description
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
logTarget	string (opens new window), false (opens new window) – Whether deprecation warnings 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 (opens new window) – Whether deprecation warnings should throw exceptions rather than being logged.
totalLogs	integer (opens new window)

# `logTarget`

Type: string (opens new window), false (opens new window)
Default value: 'db'
Since: 3.0.7

Whether deprecation warnings should be logged in the database ('db'), error logs ('logs'), or not at all (false).

Changing this will prevent deprecation warnings from showing up in the "Deprecation Warnings" utility or in the "Deprecated" panel in the Debug Toolbar.

View source (opens new window)

# `logs`

Type: craft\models\DeprecationError[]
Default value: null
Access: Read-only

View source (opens new window)

# `requestLogs`

Type: craft\models\DeprecationError[]
Default value: null
Access: Read-only

View source (opens new window)

# `throwExceptions`

Type: boolean (opens new window)
Default value: false
Since: 3.1.18

Whether deprecation warnings should throw exceptions rather than being logged.

View source (opens new window)

# `totalLogs`

Type: integer (opens new window)
Default value: null
Access: Read-only

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)	Constructor.
__get() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
deleteAllLogs()	Deletes all logs.
deleteLogById()	Deletes a log by its ID.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getLogById()	Returns a log by its ID.
getLogs()	Get 'em all.
getRequestLogs()	Returns the deprecation warnings that were logged in the current request.
getTotalLogs()	Returns the total number of deprecation warnings that have been logged.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
log()	Logs a new deprecation error.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
storeLogs()	Stores all the deprecation warnings that were logged in this request.
trigger() (opens new window)	Triggers an event.