TemplateCaches

Type

Class

Namespace

craft\services

Inherits

craft\services\TemplateCaches » yii\base\Component » yii\base\BaseObject

Implements

yii\base\Configurable

Since

3.0.0

Template Caches service.

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

View source

Public Properties

Property	Description
behaviors	yii\base\Behavior – List of behaviors attached to this component.

Public Methods

Method	Description
__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 a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be 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.
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 for this component.
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()

DEPRECATED

Deprecated in 3.5.0. Use craft\services\Elements::invalidateAllCaches() instead.

Deletes all the template caches.

View source

Returns

boolean

deleteCacheById()

DEPRECATED

Deprecated in 3.5.0

Deletes a cache by its ID(s).

View source

Arguments

• $cacheId (integer, integer[]) – The cache ID(s)

Returns

boolean

deleteCachesByElement()

DEPRECATED

Deprecated in 3.5.0. Use craft\services\Elements::invalidateCachesForElement() instead.

Deletes caches that include a given element(s).

View source

Arguments

• $elements (craft\base\ElementInterface, craft\base\ElementInterface[]) – The element(s) whose caches should be deleted.

Returns

boolean

deleteCachesByElementId()

DEPRECATED

Deprecated in 3.5.0. Use craft\services\Elements::invalidateCachesForElement() instead.

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

deleteCachesByElementQuery()

DEPRECATED

Deprecated in 3.5.0. Use craft\services\Elements::invalidateCachesForElementType() instead.

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

View source

Arguments

• $query (craft\elements\db\ElementQuery) – The element query that should be used to find elements whose caches should be deleted.

Returns

boolean

deleteCachesByElementType()

DEPRECATED

Deprecated in 3.5.0. Use craft\services\Elements::invalidateCachesForElementType() instead.

Deletes caches by a given element class.

View source

Arguments

• $elementType (string) – The element class.

Returns

boolean

deleteCachesByKey()

Deletes a cache by its key(s).

View source

Arguments

• $key (string, string[]) – The cache key(s) to delete.
• $global (boolean, null) – Whether the template caches are stored globally.
• $siteId (integer, null) – The site ID to delete caches for.

Returns

boolean

Throws

• yii\base\Exception
  if this is a console request and null or false is passed to $global

deleteExpiredCaches()

DEPRECATED

Deprecated in 3.5.0

Deletes any expired caches.

View source

Returns

boolean

deleteExpiredCachesIfOverdue()

DEPRECATED

Deprecated in 3.2.0

Deletes any expired caches.

View source

Returns

boolean

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.
• $withScripts (boolean) – Whether JS and CSS code registered with craft\web\View::registerJs(), craft\web\View::registerScript(), and craft\web\View::registerCss() should be captured and included in the cache.

Throws

• yii\base\Exception
  if this is a console request and false is passed to $global
• Throwable

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.
• $registerScripts (boolean) – Whether JS and CSS code coptured with the cache should be registered

Returns

string, null

Throws

• yii\base\Exception
  if this is a console request and false is passed to $global

handleResponse()

DEPRECATED

Deprecated in 3.5.0

Queues up a Delete Stale Template Caches job

View source

includeElementInTemplateCaches()

DEPRECATED

Deprecated in 3.5.0

Includes an element in any active caches.

View source

Arguments

• $elementId (integer) – The element ID.

includeElementQueryInTemplateCaches()

DEPRECATED

Deprecated in 3.5.0

Includes an element criteria in any active caches.

View source

Arguments

• $event (yii\base\Event) – The 'afterPrepare' element query event

startTemplateCache()

Starts a new template cache.

View source

Arguments

• $withScripts (boolean) – Whether JS and CSS code registered with craft\web\View::registerJs(), craft\web\View::registerScript(), and craft\web\View::registerCss() should be captured and included in the cache. If this is true, be sure to pass $withScripts = true to endTemplateCache() as well.
• $global (boolean) – Whether the cache should be stored globally.

Events

EVENT_AFTER_DELETE_CACHES

DEPRECATED

Deprecated in 3.5.0

Type

craft\services\SectionEvent

Since

3.0.2

The event that is triggered after template caches are deleted.

---

EVENT_BEFORE_DELETE_CACHES

DEPRECATED

Deprecated in 3.5.0

Type

craft\services\SectionEvent

Since

3.0.2

The event that is triggered before template caches are deleted.

---