HumHub Documentation (unofficial)

CacheableWidgetBehavior extends Behavior
in package

Application

Cacheable widget behavior automatically caches widget contents according to duration and dependencies specified.

The behavior may be used without any configuration if an application has cache component configured. By default the widget will be cached for one minute.

The following example will cache the posts widget for an indefinite duration until any post is modified.

use yii\behaviors\CacheableWidgetBehavior;

public function behaviors()
{
    return [
        [
            'class' => CacheableWidgetBehavior::class,
            'cacheDuration' => 0,
            'cacheDependency' => [
                'class' => 'yii\caching\DbDependency',
                'sql' => 'SELECT MAX(updated_at) FROM posts',
            ],
        ],
    ];
}

Properties

$cache : CacheInterface|string|array<string|int, mixed>
$cacheDependency : Dependency|array<string|int, mixed>|null
$cacheDuration : int
$cacheEnabled : bool
$cacheKeyVariations : array<string|int, string>|string
$owner : Component|null
$_attachedEvents : array<string|int, mixed>

Methods

__call() : mixed: Calls the named method which is not a class method.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of an object property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets value of an object property.
__unset() : mixed: Sets an object property to null.
afterRun() : mixed: Outputs widget contents and ends fragment caching.
attach() : mixed: Attaches the behavior object to the component.
beforeRun() : mixed: Begins fragment caching. Prevents owner widget from execution if its contents can be retrieved from the cache.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
detach() : mixed: Detaches the behavior object from the component.
events() : array<string|int, mixed>: Declares event handlers for the [[owner]]'s events.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined.
init() : mixed: Initializes the object.
getCacheInstance() : CacheInterface: Returns the cache instance.
getCacheKey() : array<string|int, string>: Returns the widget cache key.
getFragmentCacheConfiguration() : array<string|int, mixed>: Returns a fragment cache widget configuration array.
initializeEventHandlers() : mixed: Initializes widget event handlers.

$cache


    public
        CacheInterface|string|array<string|int, mixed>
    $cache
     = 'cache'

a cache object or a cache component ID or a configuration array for creating a cache object. Defaults to the cache application component.

$cacheDependency


    public
        Dependency|array<string|int, mixed>|null
    $cacheDependency

a cache dependency or a configuration array for creating a cache dependency or null meaning no cache dependency.

For example,

[
    'class' => 'yii\caching\DbDependency',
    'sql' => 'SELECT MAX(updated_at) FROM posts',
]

would make the widget cache depend on the last modified time of all posts. If any post has its modification time changed, the cached content would be invalidated.

$cacheDuration


    public
        int
    $cacheDuration
     = 60

cache duration in seconds. Set to 0 to indicate that the cached data will never expire. Defaults to 60 seconds or 1 minute.

$cacheEnabled


    public
        bool
    $cacheEnabled
     = true

whether to enable caching or not. Allows to turn the widget caching on and off according to specific conditions. The following configuration will disable caching when a special GET parameter is passed:

empty(Yii::$app->request->get('disable-caching'))

$cacheKeyVariations


    public
        array<string|int, string>|string
    $cacheKeyVariations
     = []

an array of strings or a single string which would cause the variation of the content being cached (e.g. an application language, a GET parameter).

The following variation setting will cause the content to be cached in different versions according to the current application language:

[
    Yii::$app->language,
]

$owner


    public
        Component|null
    $owner

the owner of this behavior

$_attachedEvents


    private
        array<string|int, mixed>
    $_attachedEvents
     = []

Attached events handlers

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

Initializes the object with the given configuration $config.
Call [[init()]].

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

Parameters

$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.


    public
                    __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters

$name : string: the property name

Return values

mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.


    public
                    __isset(string $name) : bool

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set (not null).

__set()

Sets value of an object property.


    public
                    __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets an object property to null.


    public
                    __unset(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

Parameters

$name : string: the property name

afterRun()

Outputs widget contents and ends fragment caching.


    public
                    afterRun(WidgetEvent $event) : mixed

Parameters

$event : WidgetEvent: Widget::EVENT_AFTER_RUN event.

attach()

Attaches the behavior object to the component.


    public
                    attach(mixed $owner) : mixed

Parameters

$owner : mixed: the component that this behavior is to be attached to.

beforeRun()

Begins fragment caching. Prevents owner widget from execution if its contents can be retrieved from the cache.


    public
                    beforeRun(WidgetEvent $event) : mixed

Parameters

$event : WidgetEvent: Widget::EVENT_BEFORE_RUN event.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ]) : bool

A property is readable if:

the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ]) : bool

A property is writable if:

the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

detach()

Detaches the behavior object from the component.


    public
                    detach() : mixed

The default implementation will unset the [[owner]] property and detach event handlers declared in [[events]]. Make sure you call the parent implementation if you override this method.

events()

Declares event handlers for the [[owner]]'s events.


    public
                    events() : array<string|int, mixed>

Child classes may override this method to declare what PHP callbacks should be attached to the events of the [[owner]] component.

The callbacks will be attached to the [[owner]]'s events when the behavior is attached to the owner; and they will be detached from the events when the behavior is detached from the component.

The callbacks can be any of the following:

method in this behavior: 'handleClick', equivalent to [$this, 'handleClick']
object method: [$object, 'handleClick']
static method: ['Page', 'handleClick']
anonymous function: function ($event) { ... }

The following is an example:

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]

Return values

array<string|int, mixed> —

events (array keys) and the corresponding event handler methods (array values).

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters

$name : string: the method name

Return values

bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.


    public
                    hasProperty(string $name[, bool $checkVars = true ]) : bool

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

getCacheInstance()

Returns the cache instance.


    private
                    getCacheInstance() : CacheInterface

Return values

CacheInterface —

cache instance.

getCacheKey()

Returns the widget cache key.


    private
                    getCacheKey() : array<string|int, string>

Return values

array<string|int, string> —

an array of strings representing the cache key.

getFragmentCacheConfiguration()

Returns a fragment cache widget configuration array.


    private
                    getFragmentCacheConfiguration() : array<string|int, mixed>

Return values

array<string|int, mixed> —

a fragment cache widget configuration array.

initializeEventHandlers()

Initializes widget event handlers.


    private
                    initializeEventHandlers() : mixed

CacheableWidgetBehavior extends Behavior in package Application

Tags

Table of Contents

Properties

Methods

Properties

$cache

$cacheDependency

$cacheDuration

$cacheEnabled

$cacheKeyVariations

$owner

$_attachedEvents

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

afterRun()

Parameters

attach()

Parameters

beforeRun()

Parameters

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

detach()

events()

Return values

hasMethod()

Parameters

Return values

hasProperty()

Parameters

Tags

Return values

init()

getCacheInstance()

Tags

Return values

getCacheKey()

Return values

getFragmentCacheConfiguration()

Return values

initializeEventHandlers()

CacheableWidgetBehavior extends Behavior
in package

Application