[スターアイコン] フォロワー数: 0

クラス `yii\caching\MemCacheServer`

[全てのクラスへのリンク] | [プロパティへのリンク] | [メソッドへのリンク]
継承[yii\caching\MemCacheServerへのリンク] » [yii\base\BaseObjectへのリンク]
実装`yii\base\Configurable`
利用可能バージョン2.0
ソースコード [GitHubへのリンク]

MemCacheServer は、単一のmemcacheまたはmemcachedサーバーの構成データを表します。

各構成プロパティの詳細については、[PHPマニュアルへのリンク]を参照してください。

キャッシュの詳細と使用方法については、[キャッシュに関するガイド記事へのリンク]を参照してください。

公開プロパティ

継承されたプロパティを非表示

プロパティ 型 説明 定義元
`$failureCallback` クロージャ このコールバック関数は、エラーが発生したときに実行されます。 `yii\caching\MemCacheServer`
`$host` 文字列 Memcacheサーバーのホスト名またはIPアドレス `yii\caching\MemCacheServer`
`$persistent` ブール値 永続接続を使用するかどうか。 `yii\caching\MemCacheServer`
`$port` 整数 Memcacheサーバーのポート `yii\caching\MemCacheServer`
`$retryInterval` 整数 失敗したサーバーが再試行される頻度（秒単位）。 `yii\caching\MemCacheServer`
`$status` ブール値 失敗時にサーバーをオンラインとしてフラグ付けするかどうか。 `yii\caching\MemCacheServer`
`$timeout` 整数 サーバーへの接続に使用されるタイムアウト（ミリ秒単位）。 `yii\caching\MemCacheServer`
`$weight` 整数 全てのサーバーの中で、このサーバーを使用する確率。 `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`

プロパティの詳細

継承されたプロパティを非表示

[トップへのリンク] [このメソッドへの直接リンク] [GitHubで編集するリンク] [GitHubでソースを見るリンク] `$failureCallback` public property

このコールバック関数は、エラーが発生したときに実行されます。 フェイルオーバーが試行される前にコールバックが実行されます。この関数は、失敗したサーバーの[$hostへのリンク]と[$portへのリンク]の2つのパラメーターを取ります。これはmemcacheでのみ使用されます。

`public Closure $failureCallback = null`
[トップへのリンク] [このメソッドへの直接リンク] [GitHubで編集するリンク] [GitHubでソースを見るリンク] `$host` public property

Memcacheサーバーのホスト名またはIPアドレス

`public string $host = null`
[トップへのリンク] [このメソッドへの直接リンク] [GitHubで編集するリンク] [GitHubでソースを見るリンク] `$persistent` public property

永続接続を使用するかどうか。これはmemcacheのみで使用されます。

public boolean $persistent = true
$port public プロパティ

Memcacheサーバーのポート

public integer $port = 11211
$retryInterval public プロパティ

失敗したサーバーが再試行される頻度（秒単位）。これはmemcacheのみで使用されます。

public integer $retryInterval = 15
$status public プロパティ

失敗時にサーバーをオンラインとしてフラグ付けするかどうか。これはmemcacheのみで使用されます。

public boolean $status = true
$timeout public プロパティ

サーバーへの接続に使用されるタイムアウト（ミリ秒単位）。これはmemcacheのみで使用されます。秒単位でのタイムアウトしかサポートしていない古いバージョンのmemcacheの場合、これは秒単位に切り上げられます。

public integer $timeout = 1000
$weight public プロパティ

全てのサーバーの中で、このサーバーを使用する確率。

public integer $weight = 1

メソッドの詳細

継承されたメソッドを非表示

__call() public メソッド

定義場所: yii\base\BaseObject::__call()

クラスメソッドではない、指定された名前のメソッドを呼び出します。

これはPHPのマジックメソッドであり、未知のメソッドが呼び出されたときに暗黙的に呼び出されるため、直接呼び出さないでください。

public mixed __call ( $name, $params )
$name 文字列

メソッド名
$params 配列

メソッドパラメータ
戻り値 mixed

メソッドの戻り値
例外 yii\base\UnknownMethodException

未知のメソッドを呼び出した場合

 

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

定義場所: yii\base\BaseObject::__construct()

コンストラクタ。

デフォルトの実装は2つのことを行います。

  • 指定された設定`$config`を使用してオブジェクトを初期化します。
  • init()を呼び出します。

このメソッドを子クラスでオーバーライドする場合は、

  • コンストラクタの最後のパラメータがここにあるような設定配列であることをお勧めします。
  • コンストラクタの最後に親の実装を呼び出します。
public void __construct ( $config = [] )
$config 配列

オブジェクトのプロパティを初期化するのに使用される名前と値のペア

 

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

定義場所: yii\base\BaseObject::__get()

オブジェクトプロパティの値を返します。

`$value = $object->property;`を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

__set()も参照してください。

public mixed __get ( $name )
$name 文字列

プロパティ名
戻り値 mixed

プロパティ値
例外 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() public メソッド

定義場所: yii\base\BaseObject::__isset()

プロパティが設定されているかどうか（定義されていてnullではない）をチェックします。

`isset($object->property)`を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

プロパティが定義されていない場合、falseが返されることに注意してください。

https://www.php.net/manual/en/function.isset.phpも参照してください。

public boolean __isset ( $name )
$name 文字列

プロパティ名またはイベント名
戻り値 ブール値

名前付きプロパティが設定されているかどうか（nullではない）。

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public メソッド

定義場所: yii\base\BaseObject::__set()

オブジェクトプロパティの値を設定します。

`$object->property = $value;`を実行したときに暗黙的に呼び出されるPHPのマジックメソッドであるため、直接呼び出さないでください。

__get()も参照してください。

public void __set ( $name, $value )
$name 文字列

プロパティ名またはイベント名
$value mixed

プロパティ値
例外 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() public メソッド

定義先: yii\base\BaseObject::__unset()

オブジェクトプロパティをnullに設定します。

このメソッドはPHPのマジックメソッドであり、unset($object->property)を実行した際に暗黙的に呼び出されるため、直接呼び出さないでください。

プロパティが定義されていない場合、このメソッドは何もしません。プロパティが読み取り専用の場合、例外をスローします。

こちらも参照してください https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name 文字列

プロパティ名
例外 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() public メソッド

定義先: yii\base\BaseObject::canGetProperty()

プロパティを読み取ることができるかどうかを示す値を返します。

プロパティは、以下の場合に読み取り可能です。

  • 指定された名前と関連付けられたゲッターメソッドがクラスに存在する場合（この場合、プロパティ名はケースインセンシティブです）。
  • 指定された名前のメンバ変数がクラスに存在する場合（$checkVarsがtrueの場合）。

こちらも参照してください canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name 文字列

プロパティ名
$checkVars ブール値

メンバ変数をプロパティとして扱うかどうか
戻り値 ブール値

プロパティを読み取ることができるかどうか

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public メソッド

定義先: yii\base\BaseObject::canSetProperty()

プロパティを設定できるかどうかを示す値を返します。

プロパティは、以下の場合に書き込み可能です。

  • 指定された名前と関連付けられたセッターメソッドがクラスに存在する場合（この場合、プロパティ名はケースインセンシティブです）。
  • 指定された名前のメンバ変数がクラスに存在する場合（$checkVarsがtrueの場合）。

こちらも参照してください canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name 文字列

プロパティ名
$checkVars ブール値

メンバ変数をプロパティとして扱うかどうか
戻り値 ブール値

プロパティを書き込むことができるかどうか

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static メソッド
2.0.14以降非推奨。PHP >= 5.5では、代わりに::classを使用してください。

定義先: yii\base\BaseObject::className()

このクラスの完全修飾名を返します。

public static string className ( )
戻り値 文字列

このクラスの完全修飾名。

 

                public static function className()
{
    return get_called_class();
}
hasMethod() public メソッド

定義先: yii\base\BaseObject::hasMethod()

メソッドが定義されているかどうかを示す値を返します。

デフォルトの実装は、PHP関数method_exists()の呼び出しです。PHPのマジックメソッド__call()を実装した場合は、このメソッドをオーバーライドできます。

public boolean hasMethod ( $name )
$name 文字列

メソッド名
戻り値 ブール値

メソッドが定義されているかどうか

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public メソッド

定義先: yii\base\BaseObject::hasProperty()

プロパティが定義されているかどうかを示す値を返します。

プロパティは、以下の場合に定義されています。

  • 指定された名前と関連付けられたゲッターまたはセッターメソッドがクラスに存在する場合（この場合、プロパティ名はケースインセンシティブです）。
  • 指定された名前のメンバ変数がクラスに存在する場合（$checkVarsがtrueの場合）。

こちらも参照してください

public boolean hasProperty ( $name, $checkVars = true )
$name 文字列

プロパティ名
$checkVars ブール値

メンバ変数をプロパティとして扱うかどうか
戻り値 ブール値

プロパティが定義されているかどうか

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public メソッド

定義先: yii\base\BaseObject::init()

オブジェクトを初期化します。

このメソッドは、オブジェクトが指定された設定で初期化された後、コンストラクタの最後に呼び出されます。

public void init ( )

                public function init()
{
}