HumHub Documentation (unofficial)

ChainedDependency extends Dependency
in package

ChainedDependency represents a dependency which is composed of a list of other dependencies.

When [[dependOnAll]] is true, if any of the dependencies has changed, this dependency is considered changed; When [[dependOnAll]] is false, if one of the dependencies has NOT changed, this dependency is considered NOT changed.

For more details and usage information on Cache, see the guide article on caching.

Tags
author

Qiang Xue qiang.xue@gmail.com

since
2.0

Table of Contents

Properties

$data  : mixed
$dependencies  : array<string|int, Dependency>
$dependOnAll  : bool
$reusable  : bool
$_reusableData  : 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.
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.
evaluateDependency()  : mixed
Evaluates the dependency by generating and saving the data related with dependency.
getHasChanged()  : bool
Returns a value indicating whether the dependency has changed.
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.
isChanged()  : bool
Checks whether the dependency is changed.
resetReusableData()  : mixed
Resets all cached data for reusable dependencies.
generateDependencyData()  : mixed
Generates the data needed to determine if dependency has been changed.
generateReusableHash()  : string
Generates a unique hash that can be used for retrieving reusable dependency data.

Properties

$data

public mixed $data

the dependency data that is saved in cache and later is compared with the latest dependency data.

$dependencies

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

list of dependencies that this dependency is composed of. Each array element must be a dependency object.

$dependOnAll

public bool $dependOnAll = true

whether this dependency is depending on every dependency in [[dependencies]]. Defaults to true, meaning if any of the dependencies has changed, this dependency is considered changed. When it is set false, it means if one of the dependencies has NOT changed, this dependency is considered NOT changed.

$reusable

public bool $reusable = false

whether this dependency is reusable or not. True value means that dependent data for this cache dependency will be generated only once per request. This allows you to use the same cache dependency for multiple separate cache calls while generating the same page without an overhead of re-evaluating dependency data each time. Defaults to false.

$_reusableData

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

static storage of cached data for reusable dependencies.

Methods

__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

Tags
throws
UnknownMethodException

when calling unknown method

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

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
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

Tags
see
https://www.php.net/manual/en/function.isset.php
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

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__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

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

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

Tags
see
canSetProperty()
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

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

evaluateDependency()

Evaluates the dependency by generating and saving the data related with dependency.

public evaluateDependency(CacheInterface $cache) : mixed
Parameters
$cache : CacheInterface

the cache component that is currently evaluating this dependency

getHasChanged()

Returns a value indicating whether the dependency has changed.

public getHasChanged(CacheInterface $cache) : bool
Parameters
$cache : CacheInterface

the cache component that is currently evaluating this dependency

Tags
deprecated

since version 2.0.11. Will be removed in version 2.1. Use [[isChanged()]] instead.

Return values
bool —

whether the dependency has changed.

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

Tags
see
canGetProperty()
see
canSetProperty()
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.

isChanged()

Checks whether the dependency is changed.

public isChanged(mixed $cache) : bool
Parameters
$cache : mixed

the cache component that is currently evaluating this dependency

Return values
bool —

whether the dependency has changed.

resetReusableData()

Resets all cached data for reusable dependencies.

public static resetReusableData() : mixed

generateDependencyData()

Generates the data needed to determine if dependency has been changed.

protected generateDependencyData(CacheInterface $cache) : mixed

This method does nothing in this class.

Parameters
$cache : CacheInterface

the cache component that is currently evaluating this dependency

Return values
mixed —

the data needed to determine if dependency has been changed.

generateReusableHash()

Generates a unique hash that can be used for retrieving reusable dependency data.

protected generateReusableHash() : string
Tags
see
reusable
Return values
string —

a unique hash value for this cache dependency.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results