- craft\services\Gc » yii\base\Component » yii\base\BaseObject
Garbage collection service.
An instance of the GC service is globally accessible in Craft via
# Public Properties
|behaviors||yii\base\Behavior – List of behaviors attached to this component|
|deleteAllTrashed||boolean – Whether hardDelete() should delete all soft-deleted rows, rather than just the ones that were deleted long enough ago to be ready for hard-deletion per the config3:softDeleteDuration config setting.|
|probability||integer – The probability (parts per million) that garbage collection (GC) should be performed on a request.|
- Default value
- Default value
The probability (parts per million) that garbage collection (GC) should be performed on a request. Defaults to 10, meaning 0.001% chance.
This number should be between 0 and 1000000. A value 0 means no GC will be performed at all unless forced.
# Public Methods
|__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.|
|__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.|
|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.|
|hardDelete()||Hard-deletes any rows in the given table(s), that are due for it.|
|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.|
|off()||Detaches an existing event handler from this component.|
|on()||Attaches an event handler to an event.|
|run()||Possibly runs garbage collection.|
|trigger()||Triggers an event.|
Hard-deletes any rows in the given table(s), that are due for it.
Possibly runs garbage collection.
$force(boolean) – Whether garbage collection should be forced. If left as
false, then garbage collection will only run if a random condition passes, factoring in probability.
The event that is triggered when running garbage collection.