<?php

namespace Psr\SimpleCache;

interface CacheInterface
{
    /**
     * Fetches a value from the cache.
     * キャッシュから値をフェッチします。
     *
     * @param string $key     The unique key of this item in the cache.
     *                        キャッシュ内のこのアイテムのユニークキー。
     * @param mixed  $default Default value to return if the key does not exist.
     *                        キーが存在しない場合に返すデフォルト値。
     *
     * @return mixed The value of the item from the cache, or $default in case of cache miss.
     *               キャッシュからのアイテムの値、またはキャッシュミスの場合は $default。
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     *   $key正当な値でない場合にスローする必要があります(MUST)。
     */
    public function get($key, $default = null);

    /**
     * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
     * オプションの有効期限(TTL)を持つキーによって一意に参照されるデータをキャッシュに永続化します。
     *
     * @param string                $key   The key of the item to store.
     *                                     保存するアイテムのキー。
     * @param mixed                 $value The value of the item to store. Must be serializable.
     *                                     保存するアイテムの値。シリアル化可能でなければなりません。
     * @param null|int|\DateInterval $ttl   Optional. The TTL value of this item. If no value is sent and
     *                                     the driver supports TTL then the library may set a default 
     *                                     value for it or let the driver take care of that.
     *                                     オプション。このアイテムのTTL値。値が送信されず、
     *                                     ドライバーがTTLをサポートしている場合、ライブラリーは
     *                                     TTLのデフォルト値を設定するか、ドライバーにそれを
     *                                     処理させることができます。
     *
     * @return bool True on success and false on failure.
     *              成功した場合は true、失敗した場合は false。
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     *   $keyが正当な値でない場合にスローする必要があります(MUST)。
     */
    public function set($key, $value, $ttl = null);

    /**
     * Delete an item from the cache by its unique key.
     * ユニークキーによってアイテムをキャッシュから削除します。
     *
     * @param string $key The unique cache key of the item to delete.
     *                    削除するアイテムの一意のキャッシュキー。
     *
     * @return bool True if the item was successfully removed. False if there was an error.
     *              アイテムが正常に削除された場合は true。エラーがあった場合は false。
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     *   $keyが正当な値でない場合にスローする必要があります(MUST)。
     */
    public function delete($key);

    /**
     * Wipes clean the entire cache's keys.
     * キャッシュ全体のキーをきれいに消去します。
     *
     * @return bool True on success and false on failure.
     *              成功した場合は true、失敗した場合は false。
     */
    public function clear();

    /**
     * Obtains multiple cache items by their unique keys.
     * ユニークキーで複数のキャッシュアイテムを取得します。
     *
     * @param iterable $keys    A list of keys that can obtained in a single operation.
     *                          1回の操作で取得できるキーのリスト。
     * @param mixed    $default Default value to return for keys that do not exist.
     *                          存在しないキーに対して返すデフォルト値。
     *
     * @return iterable A list of key => value pairs. 
     *                  Cache keys that do not exist or are stale will have $default as value.
     *                  「キー => 値」のペアのリスト。
     *                  存在しないか古くなっているキャッシュキーは、値として $defaultを持ちます。
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $keys is neither an array nor a Traversable,
     *   or if any of the $keys are not a legal value.
     *   $keysが配列でも Traversableでもない場合、または $keysのいずれかが正当な値でない場合に
     *   スローする必要があります(MUST)。
     */
    public function getMultiple($keys, $default = null);

    /**
     * Persists a set of key => value pairs in the cache, with an optional TTL.
     * オプションのTTLを使用して、「キー => 値」のペアのセットをキャッシュに永続化します。
     *
     * @param iterable               $values A list of key => value pairs for a multiple-set operation.
     *                                       複数セット操作の「キー => 値」ペアのリスト。
     * @param null|int|\DateInterval $ttl    Optional. The TTL value of this item. If no value is sent 
     *                                       and the driver supports TTL then the library may set a default 
     *                                       value for it or let the driver take care of that.
     *                                       オプション。このアイテムのTTL値。値が送信されず、
     *                                       ドライバーがTTLをサポートしている場合、ライブラリーは
     *                                       TTLのデフォルト値を設定するか、ドライバーにそれを
     *                                       処理させることができます。
     *
     * @return bool True on success and false on failure.
     *              成功した場合は true、失敗した場合は false。
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $values is neither an array nor a Traversable,
     *   or if any of the $values are not a legal value.
     *   $valuesが配列でも Traversableでもない場合、または $valuesのいずれかが正当な値でない場合に
     *   スローする必要があります(MUST)。
     */
    public function setMultiple($values, $ttl = null);

    /**
     * Deletes multiple cache items in a single operation.
     * 1回の操作で複数のキャッシュアイテムを削除します。
     *
     * @param iterable $keys A list of string-based keys to be deleted.
     *                       削除する文字列ベースのキーのリスト。
     *
     * @return bool True if the items were successfully removed. False if there was an error.
     *              アイテムが正常に削除された場合は true。エラーがあった場合は false。
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if $keys is neither an array nor a Traversable,
     *   or if any of the $keys are not a legal value.
     *   $keysが配列でも Traversableでもない場合、または $keysのいずれかが正当な値でない場合に
     *  スローする必要があります(MUST)。
     */
    public function deleteMultiple($keys);
 

    /**
     * Determines whether an item is present in the cache.
     * アイテムがキャッシュに存在するかどうかを決定します。
     *
     * NOTE: It is recommended that has() is only to be used for cache warming type purposes
     * and not to be used within your live applications operations for get/set, as this method
     * is subject to a race condition where your has() will return true and immediately after,
     * another script can remove it, making the state of your app out of date.
     * 注：has()は、キャッシュウォーミング的な目的でのみ使用し、get/setの本番のアプリケーション
     * 操作内では使用しないことをお勧めします。なぜなら、このメソッドは、競合状態の影響を受けるためで、
     * has()が trueを返し、直後に、別のスクリプトがそれを削除して、アプリの状態を古くする可能性が
     * あるからです。
     *
     * @param string $key The cache item key.
     *                    キャッシュアイテムのキー。
     *
     * @return bool
     *
     * @throws \Psr\SimpleCache\InvalidArgumentException
     *   MUST be thrown if the $key string is not a legal value.
     *   $keyが正当な値でない場合にスローする必要があります(MUST)。
     */
    public function has($key);
}