Deprecator

Type
Class
Namespace
craft\services
Inherits
craft\services\Deprecator » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Deprecator service.

An instance of the Deprecator service is globally accessible in Craft via Craft::$app->deprecator.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$logTargetstring, false – Whether deprecation errors should be logged in the database ('db'), error logs ('logs'), or not at all (false).
$logscraft\models\DeprecationError[]
$requestLogscraft\models\DeprecationError[]
$totalLogsinteger

$logTarget

Type
string, false

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

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

View source

Signature

public string, false $logTarget = 'db'

$logs

Signature

public craft\models\DeprecationError[] getLogs ( \craft\services\int $limit = null )

$requestLogs

Signature

public craft\models\DeprecationError[] getRequestLogs ( )

$totalLogs

Type
integer
Access
Read-only

View source

Signature

public integer getTotalLogs ( )

Public Methods

MethodDescription
__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 an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to 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.
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.
trigger()Triggers an event.

deleteAllLogs()

Deletes all logs.

View source

Returns

boolean

Signature

public boolean deleteAllLogs ( )

deleteLogById()

Deletes a log by its ID.

View source

Arguments

Returns

boolean

Signature

public boolean deleteLogById ( \craft\services\int $id )

getLogById()

Returns a log by its ID.

View source

Arguments

Returns

craft\models\DeprecationError, null

Signature

public craft\models\DeprecationError, null getLogById ( \craft\services\int $logId )

getLogs()

Get 'em all.

View source

Arguments

Returns

craft\models\DeprecationError[]

Signature

public craft\models\DeprecationError[] getLogs ( \craft\services\int $limit = null )

getRequestLogs()

Returns the deprecation errors that were logged in the current request.

View source

Returns

craft\models\DeprecationError[]

Signature

public craft\models\DeprecationError[] getRequestLogs ( )

getTotalLogs()

Returns the total number of deprecation errors that have been logged.

View source

Returns

integer

Signature

public integer getTotalLogs ( )

log()

Logs a new deprecation error.

View source

Arguments

Signature

public void log ( \craft\services\string $key, \craft\services\string $message )