Class yii\caching\DbDependency
继承 | yii\caching\DbDependency » yii\caching\Dependency » yii\base\BaseObject |
---|---|
实现 | yii\base\Configurable |
可用版本自 | 2.0 |
源码 | https://github.com/yiichina/yii2/blob/api/framework/caching/DbDependency.php |
DbDependency 是基于 SQL 语句的查询结果实现的依赖类。
如果查询结果有变化,那么就认为依赖发生了变化。 查询语句由 $sql 属性指定。
在 Cache 上更多的详情和详细的使用信息,请参考 guide article on caching。
公共属性
属性 | 类型 | 描述 | 被定义在 |
---|---|---|---|
$data | mixed | 存储在缓存中的依赖数据, 将来会取出来和最新的依赖数据进行比较。 | yii\caching\Dependency |
$db | string | 表示 DB 连接的应用组件 ID。 | yii\caching\DbDependency |
$params | array | (name => value) 格式的参数,用在 $sql 属性指定的 SQL 语句中。 | yii\caching\DbDependency |
$reusable | boolean | 依赖是否重用。True 表示当前依赖对象的依赖数据只在每个请求里生成一次。 这允许你在多个单独的缓存调用中使用相同的缓存依赖对象, 这样就会生成相同的数据页但是减少了每次生成缓存数据的开销。 默认是 false。 | yii\caching\Dependency |
$sql | string | SQL 查询语句,它的查询结果决定了依赖是否发生了变化。 只使用查询结果的第一行。 | yii\caching\DbDependency |
公共方法
方法 | 描述 | 被定义在 |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\BaseObject |
__construct() | Constructor. | yii\base\BaseObject |
__get() | Returns the value of an object property. | yii\base\BaseObject |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() | Sets value of an object property. | yii\base\BaseObject |
__unset() | Sets an object property to null. | yii\base\BaseObject |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
evaluateDependency() | 通过生成和保存依赖相关的数据来计算依赖。 该方法会在缓存对象把要缓存的数据写入缓存之前调用。 | yii\caching\Dependency |
getHasChanged() | 返回表明依赖是否发生变化的值。 | yii\caching\Dependency |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() | Initializes the object. | yii\base\BaseObject |
isChanged() | 检测依赖是否发生了变化。 | yii\caching\Dependency |
resetReusableData() | 重置所有重用依赖的缓存数据。 | yii\caching\Dependency |
受保护的方法
方法 | 描述 | 被定义在 |
---|---|---|
generateDependencyData() | 生成在判断依赖是否发生变化时用到的依赖数据。 该方法返回全局状态的值。 | yii\caching\DbDependency |
generateReusableHash() | 生成一个唯一的散列,它可以用来接收可重用的缓存数据。 | yii\caching\Dependency |
属性详情
表示 DB 连接的应用组件 ID。
(name => value) 格式的参数,用在 $sql 属性指定的 SQL 语句中。
SQL 查询语句,它的查询结果决定了依赖是否发生了变化。 只使用查询结果的第一行。
方法详情
生成在判断依赖是否发生变化时用到的依赖数据。 该方法返回全局状态的值。
protected mixed generateDependencyData($cache) | ||
$cache | yii\caching\CacheInterface | 正在计算缓存依赖的缓存组件。 |
return | mixed | 判断依赖是否发生变化时的依赖数据。 |
---|---|---|
throws | yii\base\InvalidConfigException | 如果 $db 不是一个有效的应用组件 ID。 |