0 关注者

类 yii\caching\MemCacheServer

所有类 | 属性 | 方法
继承关系yii\caching\MemCacheServer » yii\base\BaseObject
实现接口yii\base\Configurable
可用版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/caching/MemCacheServer.php

MemCacheServer 表示单个 Memcache 或 Memcached 服务器的配置数据。

有关每个配置属性的详细说明，请参阅 PHP 手册。

有关缓存的更多详细信息和使用方法，请参阅 缓存概述指南文章。

公共属性

隐藏继承的属性

属性 类型 描述 定义于
$failureCallback Closure 此回调函数将在遇到错误时运行。 yii\caching\MemCacheServer
$host string Memcache 服务器主机名或 IP 地址 yii\caching\MemCacheServer
$persistent boolean 是否使用持久连接。 yii\caching\MemCacheServer
$port integer Memcache 服务器端口 yii\caching\MemCacheServer
$retryInterval integer 失败的服务器将重试的频率（以秒为单位）。 yii\caching\MemCacheServer
$status boolean 如果服务器在发生故障后应标记为在线。 yii\caching\MemCacheServer
$timeout integer 连接到服务器时使用的超时时间（以毫秒为单位）。 yii\caching\MemCacheServer
$weight integer 在所有服务器中使用此服务器的概率。 yii\caching\MemCacheServer

公共方法

隐藏继承的方法

方法 描述 定义于
__call() 调用不是类方法的命名方法。 yii\base\BaseObject
__construct() 构造函数。 yii\base\BaseObject
__get() 返回对象属性的值。 yii\base\BaseObject
__isset() 检查属性是否已设置，即已定义且不为 null。 yii\base\BaseObject
__set() 设置对象属性的值。 yii\base\BaseObject
__unset() 将对象属性设置为 null。 yii\base\BaseObject
canGetProperty() 返回一个值，指示是否可以读取属性。 yii\base\BaseObject
canSetProperty() 返回一个值，指示是否可以设置属性。 yii\base\BaseObject
className() 返回此类的完全限定名称。 yii\base\BaseObject
hasMethod() 返回一个值，指示方法是否已定义。 yii\base\BaseObject
hasProperty() 返回一个值，指示属性是否已定义。 yii\base\BaseObject
init() 初始化对象。 yii\base\BaseObject

属性详情

隐藏继承的属性

$failureCallback 公共属性

此回调函数将在遇到错误时运行。在尝试故障转移之前运行回调。该函数接受两个参数，$host 和失败服务器的 $port。仅供 memcache 使用。

public Closure $failureCallback = null
$host 公共属性

Memcache 服务器主机名或 IP 地址

public string $host = null
$persistent 公共属性

是否使用持久连接。仅供 memcache 使用。

public boolean $persistent = true
$port 公共属性

Memcache 服务器端口

public integer $port = 11211
$retryInterval 公共属性

失败的服务器将重试的频率（以秒为单位）。仅供 memcache 使用。

public integer $retryInterval = 15
$status 公共属性

如果服务器在发生故障时应被标记为在线状态。这仅由 memcache 使用。

public 布尔型 $status = true
$timeout 公共属性

连接到服务器时将使用的超时时间（毫秒）。这仅由 memcache 使用。对于仅支持以秒为单位指定超时的旧版 memcache，此值将四舍五入到完整的秒数。

public 整型 $timeout = 1000
$weight 公共属性

在所有服务器中使用此服务器的概率。

public 整型 $weight = 1

方法详情

隐藏继承的方法

__call() 公共方法

定义于： yii\base\BaseObject::__call()

调用不是类方法的命名方法。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当调用未知方法时会隐式调用。

public 混合型 __call ( $name, $params )
$name string

方法名
$params 数组

方法参数
返回值 混合型

方法的返回值
抛出异常 yii\base\UnknownMethodException

调用未知方法时

 

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

定义于： yii\base\BaseObject::__construct()

构造函数。

默认实现执行两件事

  • 使用给定的配置 $config 初始化对象。
  • 调用 init()。

如果此方法在子类中被重写，建议

  • 构造函数的最后一个参数是一个配置数组，如这里的 $config。
  • 在构造函数的末尾调用父类的实现。
public 空型 __construct ( $config = [] )
$config 数组

将用于初始化对象属性的名称-值对

 

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

定义于： yii\base\BaseObject::__get()

返回对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $value = $object->property; 时会隐式调用。

另见 __set()。

public 混合型 __get ( $name )
$name string

属性名
返回值 混合型

属性值
抛出异常 yii\base\UnknownPropertyException

如果属性未定义
抛出异常 yii\base\InvalidCallException

如果属性为只写

 

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
__isset() 公共方法

定义于： yii\base\BaseObject::__isset()

检查属性是否已设置，即已定义且不为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 isset($object->property) 时会隐式调用。

注意，如果属性未定义，则将返回 false。

另见 https://php.ac.cn/manual/en/function.isset.php。

public 布尔型 __isset ( $name )
$name string

属性名或事件名
返回值 boolean

命名的属性是否已设置（非 null）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() 公共方法

定义于： yii\base\BaseObject::__set()

设置对象属性的值。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 $object->property = $value; 时会隐式调用。

另见 __get()。

public 空型 __set ( $name, $value )
$name string

属性名或事件名
$value 混合型

属性值
抛出异常 yii\base\UnknownPropertyException

如果属性未定义
抛出异常 yii\base\InvalidCallException

如果属性为只读

 

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() 公共方法

定义于： yii\base\BaseObject::__unset()

将对象属性设置为 null。

不要直接调用此方法，因为它是一个 PHP 魔术方法，当执行 unset($object->property) 时会隐式调用。

注意，如果属性未定义，则此方法将不做任何事情。如果属性为只读，则会抛出异常。

另见 https://php.ac.cn/manual/en/function.unset.php。

public 空型 __unset ( $name )
$name string

属性名
抛出异常 yii\base\InvalidCallException

如果属性为只读。

 

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() 公共方法

定义于： yii\base\BaseObject::canGetProperty()

返回一个值，指示是否可以读取属性。

如果满足以下条件，则属性可读

  • 类具有与指定名称关联的 getter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另见 canSetProperty()。

public 布尔型 canGetProperty ( $name, $checkVars = true )
$name string

属性名
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否可读

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() 公共方法

定义于： yii\base\BaseObject::canSetProperty()

返回一个值，指示是否可以设置属性。

如果满足以下条件，则属性可写

  • 类具有与指定名称关联的 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另见 canGetProperty()。

public 布尔型 canSetProperty ( $name, $checkVars = true )
$name string

属性名
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否可写

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() 公共静态方法
自 2.0.14 版本起已弃用。在 PHP >= 5.5 中，请使用 ::class 代替。

定义于： yii\base\BaseObject::className()

返回此类的完全限定名称。

public static string className ( )
返回值 string

此类的完全限定名称。

 

                public static function className()
{
    return get_called_class();
}
hasMethod() 公共方法

定义于： yii\base\BaseObject::hasMethod()

返回一个值，指示方法是否已定义。

默认实现是调用 PHP 函数 method_exists()。当您实现 PHP 魔术方法 __call() 时，可以覆盖此方法。

public boolean hasMethod ( $name )
$name string

方法名
返回值 boolean

方法是否已定义

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() 公共方法

定义于： yii\base\BaseObject::hasProperty()

返回一个值，指示属性是否已定义。

如果满足以下条件，则定义了一个属性：

  • 类具有与指定名称关联的 getter 或 setter 方法（在这种情况下，属性名称不区分大小写）；
  • 类具有与指定名称相同的成员变量（当 $checkVars 为 true 时）；

另请参阅

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

属性名
$checkVars boolean

是否将成员变量视为属性
返回值 boolean

属性是否已定义

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() 公共方法

定义于： yii\base\BaseObject::init()

初始化对象。

此方法在构造函数结束时调用，在对象使用给定配置初始化后调用。

public void init ( )

                public function init()
{
}