RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-caching-dbquerydependency below:

DbQueryDependency, yii\caching\DbQueryDependency | API Documentation for Yii 2.0

Class yii\caching\DbQueryDependency

DbQueryDependency represents a dependency based on the query result of an yii\db\QueryInterface instance.

If the query result changes, the dependency is considered as changed. The query is specified via the $query property.

Object of any class which matches yii\db\QueryInterface can be used, so this dependency can be used not only with regular relational databases but with MongoDB, Redis and so on as well.

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

See also yii\db\QueryInterface.

Property Details

Hide inherited properties

The application component ID of the database connection, connection object or its array configuration. This field can be left blank, allowing query to determine connection automatically.

Method which should be invoked in over the $query object.

If specified as a string an own query method with such name will be invoked, passing $db value as its first argument. For example: exists, all.

This field can be specified as a PHP callback of following signature:

function (QueryInterface $query, mixed $db) {
    
}

If not set - yii\db\QueryInterface::one() will be used.

The query which result is used to determine if the dependency has been changed. Actual query method to be invoked is determined by $method.

Method Details

Hide inherited methods

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

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.

Source code

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

Defined in: yii\base\BaseObject::__construct()

Constructor.

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.

public void __construct ( $config = [] ) $config array

Name-value pairs that will be used to initialize the object properties

Source code

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

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

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true ) $name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be written

Source code

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

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

Source code

                public static function className()
{
    return get_called_class();
}

Source code

                public function evaluateDependency($cache)
{
    if ($this->reusable) {
        $hash = $this->generateReusableHash();
        if (!array_key_exists($hash, self::$_reusableData)) {
            self::$_reusableData[$hash] = $this->generateDependencyData($cache);
        }
        $this->data = self::$_reusableData[$hash];
    } else {
        $this->data = $this->generateDependencyData($cache);
    }
}

Generates the data needed to determine if dependency is changed.

This method returns the query result.

Source code

                protected function generateDependencyData($cache)
{
    $db = $this->db;
    if ($db !== null) {
        $db = Instance::ensure($db);
    }
    if (!$this->query instanceof QueryInterface) {
        throw new InvalidConfigException('"' . get_class($this) . '::$query" should be an instance of "yii\db\QueryInterface".');
    }
    if (!empty($db->enableQueryCache)) {
        
        $originEnableQueryCache = $db->enableQueryCache;
        $db->enableQueryCache = false;
        $result = $this->executeQuery($this->query, $db);
        $db->enableQueryCache = $originEnableQueryCache;
    } else {
        $result = $this->executeQuery($this->query, $db);
    }
    return $result;
}

Source code

                protected function generateReusableHash()
{
    $clone = clone $this;
    $clone->data = null; 
    try {
        $serialized = serialize($clone);
    } catch (\Exception $e) {
        
        foreach ($clone as $name => $value) {
            if (is_object($value) && $value instanceof \Closure) {
                $clone->{$name} = null;
            }
        }
        $serialized = serialize($clone);
    }
    return sha1($serialized);
}

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

Source code

                public function getHasChanged($cache)
{
    return $this->isChanged($cache);
}

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

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

Source code

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

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);