TemplateCaches

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

Template Caches service.

An instance of the Template Caches service is globally accessible in Craft via Craft::$app->templateCaches.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component

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.
deleteAllCaches()Deletes all the template caches.
deleteCacheById()Deletes a cache by its ID(s).
deleteCachesByElement()Deletes caches that include a given element(s).
deleteCachesByElementId()Deletes caches that include an a given element ID(s).
deleteCachesByElementQuery()Deletes caches that include elements that match a given element query's parameters.
deleteCachesByElementType()Deletes caches by a given element class.
deleteCachesByKey()Deletes a cache by its key(s).
deleteExpiredCaches()Deletes any expired caches.
deleteExpiredCachesIfOverdue()Deletes any expired caches if we haven't already done that within the past 24 hours.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
endTemplateCache()Ends a template cache.
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.
getTemplateCache()Returns a cached template by its key.
handleResponse()Queues up a Delete Stale Template Caches job
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.
includeElementInTemplateCaches()Includes an element in any active caches.
includeElementQueryInTemplateCaches()Includes an element criteria in any active caches.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
startTemplateCache()Starts a new template cache.
trigger()Triggers an event.

deleteAllCaches()

Deletes all the template caches.

View source

Returns

boolean

Signature

public boolean deleteAllCaches ( )

deleteCacheById()

Deletes a cache by its ID(s).

View source

Arguments

Returns

boolean

Signature

public boolean deleteCacheById ( $cacheId )

deleteCachesByElement()

Deletes caches that include a given element(s).

View source

Arguments

Returns

boolean

Signature

public boolean deleteCachesByElement ( $elements )

deleteCachesByElementId()

Deletes caches that include an a given element ID(s).

View source

Arguments

  • $elementId (integer, integer[]) – The ID of the element(s) whose caches should be cleared.
  • $deleteQueryCaches (boolean) – Whether a DeleteStaleTemplateCaches job should be added to the queue, deleting any query caches that may now involve this element, but hadn't previously. (Defaults to true.)

Returns

boolean

Signature

public boolean deleteCachesByElementId ( $elementId, \craft\services\bool $deleteQueryCaches = true )

deleteCachesByElementQuery()

Deletes caches that include elements that match a given element query's parameters.

View source

Arguments

Returns

boolean

Signature

public boolean deleteCachesByElementQuery ( craft\elements\db\ElementQuery $query )

deleteCachesByElementType()

Deletes caches by a given element class.

View source

Arguments

  • $elementType (string) – The element class.

Returns

boolean

Signature

public boolean deleteCachesByElementType ( \craft\services\string $elementType )

deleteCachesByKey()

Deletes a cache by its key(s).

View source

Arguments

Returns

boolean

Signature

public boolean deleteCachesByKey ( $key )

deleteExpiredCaches()

Deletes any expired caches.

View source

Returns

boolean

Signature

public boolean deleteExpiredCaches ( )

deleteExpiredCachesIfOverdue()

Deletes any expired caches if we haven't already done that within the past 24 hours.

View source

Returns

boolean

Signature

public boolean deleteExpiredCachesIfOverdue ( )

endTemplateCache()

Ends a template cache.

View source

Arguments

  • $key (string) – The template cache key.
  • $global (boolean) – Whether the cache should be stored globally.
  • $duration (string, null) – How long the cache should be stored for. Should be a relative time format.
  • $expiration (mixed, null) – When the cache should expire.
  • $body (string) – The contents of the cache.

Throws

Signature

public void endTemplateCache ( \craft\services\string $key, \craft\services\bool $global, \craft\services\string $duration = null, $expiration, \craft\services\string $body )

getTemplateCache()

Returns a cached template by its key.

View source

Arguments

  • $key (string) – The template cache key
  • $global (boolean) – Whether the cache would have been stored globally.

Returns

string, null

Signature

public string, null getTemplateCache ( \craft\services\string $key, \craft\services\bool $global )

handleResponse()

Queues up a Delete Stale Template Caches job

View source

Signature

public void handleResponse ( )

includeElementInTemplateCaches()

Includes an element in any active caches.

View source

Arguments

  • $elementId (integer) – The element ID.

Signature

public void includeElementInTemplateCaches ( \craft\services\int $elementId )

includeElementQueryInTemplateCaches()

Includes an element criteria in any active caches.

View source

Arguments

Signature

public void includeElementQueryInTemplateCaches ( yii\base\Event $event )

startTemplateCache()

Starts a new template cache.

View source

Arguments

  • $key (string) – The template cache key.

Signature

public void startTemplateCache ( \craft\services\string $key )

Events

EVENT_AFTER_DELETE_CACHES

Type
\craft\services\SectionEvent

The event that is triggered after template caches are deleted.

EVENT_BEFORE_DELETE_CACHES

Type
\craft\services\SectionEvent

The event that is triggered before template caches are deleted.