Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Psr\SimpleCache;

[2] Fix | Delete

[3] Fix | Delete

interface CacheInterface

[4] Fix | Delete

{

[5] Fix | Delete

/**

[6] Fix | Delete

* Fetches a value from the cache.

[7] Fix | Delete

[8] Fix | Delete

* @param string $key The unique key of this item in the cache.

[9] Fix | Delete

* @param mixed $default Default value to return if the key does not exist.

[10] Fix | Delete

[11] Fix | Delete

* @return mixed The value of the item from the cache, or $default in case of cache miss.

[12] Fix | Delete

[13] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[14] Fix | Delete

* MUST be thrown if the $key string is not a legal value.

[15] Fix | Delete

[16] Fix | Delete

public function get($key, $default = null);

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.

[20] Fix | Delete

[21] Fix | Delete

* @param string $key The key of the item to store.

[22] Fix | Delete

* @param mixed $value The value of the item to store, must be serializable.

[23] Fix | Delete

* @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and

[24] Fix | Delete

* the driver supports TTL then the library may set a default value

[25] Fix | Delete

* for it or let the driver take care of that.

[26] Fix | Delete

[27] Fix | Delete

* @return bool True on success and false on failure.

[28] Fix | Delete

[29] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[30] Fix | Delete

* MUST be thrown if the $key string is not a legal value.

[31] Fix | Delete

[32] Fix | Delete

public function set($key, $value, $ttl = null);

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Delete an item from the cache by its unique key.

[36] Fix | Delete

[37] Fix | Delete

* @param string $key The unique cache key of the item to delete.

[38] Fix | Delete

[39] Fix | Delete

* @return bool True if the item was successfully removed. False if there was an error.

[40] Fix | Delete

[41] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[42] Fix | Delete

* MUST be thrown if the $key string is not a legal value.

[43] Fix | Delete

[44] Fix | Delete

public function delete($key);

[45] Fix | Delete

[46] Fix | Delete

/**

[47] Fix | Delete

* Wipes clean the entire cache's keys.

[48] Fix | Delete

[49] Fix | Delete

* @return bool True on success and false on failure.

[50] Fix | Delete

[51] Fix | Delete

public function clear();

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Obtains multiple cache items by their unique keys.

[55] Fix | Delete

[56] Fix | Delete

* @param iterable $keys A list of keys that can obtained in a single operation.

[57] Fix | Delete

* @param mixed $default Default value to return for keys that do not exist.

[58] Fix | Delete

[59] Fix | Delete

* @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.

[60] Fix | Delete

[61] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[62] Fix | Delete

* MUST be thrown if $keys is neither an array nor a Traversable,

[63] Fix | Delete

* or if any of the $keys are not a legal value.

[64] Fix | Delete

[65] Fix | Delete

public function getMultiple($keys, $default = null);

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Persists a set of key => value pairs in the cache, with an optional TTL.

[69] Fix | Delete

[70] Fix | Delete

* @param iterable $values A list of key => value pairs for a multiple-set operation.

[71] Fix | Delete

* @param null|int|\DateInterval $ttl Optional. The TTL value of this item. If no value is sent and

[72] Fix | Delete

* the driver supports TTL then the library may set a default value

[73] Fix | Delete

* for it or let the driver take care of that.

[74] Fix | Delete

[75] Fix | Delete

* @return bool True on success and false on failure.

[76] Fix | Delete

[77] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[78] Fix | Delete

* MUST be thrown if $values is neither an array nor a Traversable,

[79] Fix | Delete

* or if any of the $values are not a legal value.

[80] Fix | Delete

[81] Fix | Delete

public function setMultiple($values, $ttl = null);

[82] Fix | Delete

[83] Fix | Delete

/**

[84] Fix | Delete

* Deletes multiple cache items in a single operation.

[85] Fix | Delete

[86] Fix | Delete

* @param iterable $keys A list of string-based keys to be deleted.

[87] Fix | Delete

[88] Fix | Delete

* @return bool True if the items were successfully removed. False if there was an error.

[89] Fix | Delete

[90] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[91] Fix | Delete

* MUST be thrown if $keys is neither an array nor a Traversable,

[92] Fix | Delete

* or if any of the $keys are not a legal value.

[93] Fix | Delete

[94] Fix | Delete

public function deleteMultiple($keys);

[95] Fix | Delete

[96] Fix | Delete

/**

[97] Fix | Delete

* Determines whether an item is present in the cache.

[98] Fix | Delete

[99] Fix | Delete

* NOTE: It is recommended that has() is only to be used for cache warming type purposes

[100] Fix | Delete

* and not to be used within your live applications operations for get/set, as this method

[101] Fix | Delete

* is subject to a race condition where your has() will return true and immediately after,

[102] Fix | Delete

* another script can remove it making the state of your app out of date.

[103] Fix | Delete

[104] Fix | Delete

* @param string $key The cache item key.

[105] Fix | Delete

[106] Fix | Delete

* @return bool

[107] Fix | Delete

[108] Fix | Delete

* @throws \Psr\SimpleCache\InvalidArgumentException

[109] Fix | Delete

* MUST be thrown if the $key string is not a legal value.

[110] Fix | Delete

[111] Fix | Delete

public function has($key);

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete