HumHub Documentation (unofficial)

HttpCache extends ActionFilter
in package

Application

HttpCache implements client-side caching by utilizing the `Last-Modified` and `ETag` HTTP headers.

It is an action filter that can be added to a controller and handles the beforeAction event.

To use HttpCache, declare it in the behaviors() method of your controller class. In the following example the filter will be applied to the index action and the Last-Modified header will contain the date of the last update to the user table in the database.

public function behaviors()
{
    return [
        [
            'class' => 'yii\filters\HttpCache',
            'only' => ['index'],
            'lastModified' => function ($action, $params) {
                $q = new \yii\db\Query();
                return $q->from('user')->max('updated_at');
            },
//            'etagSeed' => function ($action, $params) {
//                return // generate ETag seed here
//            }
        ],
    ];
}

Properties

$cacheControlHeader : string|null
$enabled : bool
$etagSeed : callable
$except : array<string|int, mixed>
$lastModified : callable
$only : array<string|int, mixed>
$owner : Component|null
$params : mixed
$sessionCacheLimiter : string|null
$weakEtag : bool
$_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.
afterAction() : mixed: This method is invoked right after an action is executed.
afterFilter() : mixed
attach() : mixed: Attaches the behavior object to the component.
beforeAction() : bool: This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.
beforeFilter() : mixed
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.
generateEtag() : string: Generates an ETag from the given seed string.
getActionId() : string: Returns an action ID by converting [[Action::$uniqueId]] into an ID relative to the module.
isActive() : bool: Returns a value indicating whether the filter is active for the given action.
sendCacheControlHeader() : mixed: Sends the cache control header to the client.
validateCache() : bool: Validates if the HTTP cache contains valid content.

$cacheControlHeader


    public
        string|null
    $cacheControlHeader
     = 'public, max-age=3600'

the value of the Cache-Control HTTP header. If null, the header will not be sent.

$enabled


    public
        bool
    $enabled
     = true

a value indicating whether this filter should be enabled.

$etagSeed


    public
        callable
    $etagSeed

a PHP callback that generates the ETag seed string. The callback's signature should be:

function ($action, $params)

where $action is the [[Action]] object that this filter is currently handling; $params takes the value of [[params]]. The callback should return a string serving as the seed for generating an ETag.

$except


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

list of action IDs that this filter should not apply to.

$lastModified


    public
        callable
    $lastModified

a PHP callback that returns the UNIX timestamp of the last modification time. The callback's signature should be:

function ($action, $params)

where $action is the [[Action]] object that this filter is currently handling; $params takes the value of [[params]]. The callback should return a UNIX timestamp.

$only


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

list of action IDs that this filter should apply to. If this property is not set, then the filter applies to all actions, unless they are listed in [[except]]. If an action ID appears in both [[only]] and [[except]], this filter will NOT apply to it.

Note that if the filter is attached to a module, the action IDs should also include child module IDs (if any) and controller IDs.

Since version 2.0.9 action IDs can be specified as wildcards, e.g. site/*.

$owner


    public
        Component|null
    $owner

the owner of this behavior

$params


    public
        mixed
    $params

additional parameters that should be passed to the [[lastModified]] and [[etagSeed]] callbacks.

$sessionCacheLimiter


    public
        string|null
    $sessionCacheLimiter
     = ''

the name of the cache limiter to be set when session_cache_limiter() is called. The default value is an empty string, meaning turning off automatic sending of cache headers entirely. You may set this property to be public, private, private_no_expire, and nocache. Please refer to session_cache_limiter() for detailed explanation of these values.

If this property is null, then session_cache_limiter() will not be called. As a result, PHP will send headers according to the session.cache_limiter PHP ini setting.

$weakEtag


    public
        bool
    $weakEtag
     = false

whether to generate weak ETags.

Weak ETags should be used if the content should be considered semantically equivalent, but not byte-equal.

$_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

afterAction()

This method is invoked right after an action is executed.


    public
                    afterAction(Action $action, mixed $result) : mixed

You may override this method to do some postprocessing for the action.

Parameters

$action : Action: the action just executed.
$result : mixed: the action execution result

Return values

mixed —

the processed action result.

afterFilter()


    public
                    afterFilter(ActionEvent $event) : mixed

Parameters

$event : ActionEvent

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.

beforeAction()

This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.


    public
                    beforeAction(Action $action) : bool

Parameters

$action : Action: the action to be executed.

Return values

bool —

whether the action should continue to be executed.

beforeFilter()


    public
                    beforeFilter(ActionEvent $event) : mixed

Parameters

$event : ActionEvent

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

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.

generateEtag()

Generates an ETag from the given seed string.


    protected
                    generateEtag(string $seed) : string

Parameters

$seed : string: Seed for the ETag

Return values

string —

the generated ETag

getActionId()

Returns an action ID by converting [[Action::$uniqueId]] into an ID relative to the module.


    protected
                    getActionId(Action $action) : string

Parameters

$action : Action

Return values

string

isActive()

Returns a value indicating whether the filter is active for the given action.


    protected
                    isActive(Action $action) : bool

Parameters

$action : Action: the action being filtered

Return values

bool —

whether the filter is active for the given action.

sendCacheControlHeader()

Sends the cache control header to the client.


    protected
                    sendCacheControlHeader() : mixed

validateCache()

Validates if the HTTP cache contains valid content.


    protected
                    validateCache(int|null $lastModified, string|null $etag) : bool

If both Last-Modified and ETag are null, returns false.

Parameters

$lastModified : int|null: the calculated Last-Modified value in terms of a UNIX timestamp. If null, the Last-Modified header will not be validated.
$etag : string|null: the calculated ETag value. If null, the ETag header will not be validated.

Return values

bool —

whether the HTTP cache is still valid.

HttpCache extends ActionFilter in package Application

Tags

Table of Contents

Properties

Methods

Properties

$cacheControlHeader

Tags

$enabled

$etagSeed

$except

Tags

$lastModified

Tags

$only

Tags

$owner

$params

$sessionCacheLimiter

$weakEtag

Tags

$_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

afterAction()

Parameters

Return values

afterFilter()

Parameters

attach()

Parameters

beforeAction()

Parameters

Return values

beforeFilter()

Parameters

canGetProperty()

Parameters

Tags

Return values

canSetProperty()

Parameters

Tags

Return values

className()

Tags

Return values

detach()

events()

Return values

hasMethod()

Parameters

Return values

hasProperty()

HttpCache extends ActionFilter
in package

Application