Skip to content

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

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 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.
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.
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.
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.

endTemplateCache()

Ends a template cache.

View source

Arguments

Throws

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.
  • $registerResources (boolean) – Whether JS and CSS resources captured by the cache should be registered

Returns

string, null

Throws

startTemplateCache()

Starts a new template cache.

View source

Arguments