ユーザーキャッシュにキャッシュされたファイルについての情報を取得する

# wincache_ucache_info

(PECL wincache >= 1.1.0)

wincache_ucache_info — ユーザーキャッシュにキャッシュされたファイルについての情報を取得する

### 説明

wincache_ucache_info ([ bool `$summaryonly` = `FALSE` [, string `$key` = NULL ]] ) : array

ユーザーキャッシュに格納されたデータについての情報を取得します。

### パラメータ

`summaryonly`

  返される配列に、ユーザーキャッシュの概要に加えて個々のキャッシュエントリの情報を含めるかどうか。

`key`

  ユーザーキャッシュ内のエントリのキー。 これを指定すると、返される配列にはそのキャッシュエントリの情報だけを含むようになります。 これを指定せず、さらに `summaryonly` が `FALSE` の場合は、 返される配列にはキャッシュ内のすべてのエントリについての情報を含むようになります。

### 返り値

ユーザーキャッシュについてのメタデータの配列を返します。失敗した場合に `FALSE` を返します

この関数が返す配列には次の要素が含まれます。

- total_cache_uptime - ユーザーキャッシュがアクティブになってからの経過秒数。
- total_item_count - 現在ユーザーキャッシュに入っている要素の数。
- is_local_cache - メタデータがローカルキャッシュ用のものである場合に true、 グローバルキャッシュ用のものである場合に false。
- total_hit_count - キャッシュからファイルが取り出された回数。
- total_miss_count - ファイルがキャッシュに見つからなかった回数。

- ucache_entries - キャッシュされているアイテムに関する情報を含む配列。

  - key_name - データを保存する際に使うキーの名前。
  - value_type - キーに関連づけて格納する値の型。
  - use_time - ユーザーキャッシュ内でアクセスされてからの経過秒数。
  - last_check - ファイルの変更をチェックされてからの経過秒数。
  - is_session - indicates if the data is a session variable
  - ttl_seconds - データをキャッシュ内に残す残り時間。0 は無制限。
  - age_seconds - データがキャッシュに追加されてからのおよその経過時間。
  - hitcount - キャッシュからファイルが取り出された回数。

### 例

例1 wincache_ucache_info() の使用

`<?php
wincache_ucache_get('green');
wincache_ucache_set('green', 2922);
wincache_ucache_get('green');
wincache_ucache_get('green');
wincache_ucache_get('green');
print_r(wincache_ucache_info());
?>`

上の例の出力は以下となります。

    Array
    ( ["total_cache_uptime"] => int(0)
      ["is_local_cache"] => bool(false)
      ["total_item_count"] => int(1)
      ["total_hit_count"] => int(3)
      ["total_miss_count"] => int(1)
      ["ucache_entries"] => Array(1)
        ( [1] => Array(6)
          (
            ["key_name"] => string(5) "green"
            ["value_type"] => string(4) "long"
            ["is_session"] => int(0)
            ["ttl_seconds"] => int(0)
            ["age_seconds"] => int(0)
            ["hitcount"] => int(3)
           )
        )
    )

### 参考

- wincache_fcache_meminfo() - ファイルキャッシュのメモリ使用状況についての情報を取得する
- wincache_ocache_fileinfo() - opcode キャッシュにキャッシュされたファイルについての情報を取得する
- wincache_ocache_meminfo() - opcode キャッシュのメモリ使用状況についての情報を取得する
- wincache_rplist_meminfo() - ファイルパス解決キャッシュのメモリ使用状況についての情報を取得する
- wincache_rplist_fileinfo() - ファイルパス解決キャッシュについての情報を取得する
- wincache_refresh_if_changed() - キャッシュされたファイルのキャッシュエントリをリフレッシュする
- wincache_ucache_meminfo() - ユーザーキャッシュのメモリ使用状況についての情報を取得する
- wincache_scache_info() - セッションキャッシュにキャッシュされたファイルについての情報を取得する
- wincache_scache_meminfo() - セッションキャッシュのメモリ使用状況についての情報を取得する