Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Corrected type hints #7

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Corrected type hints #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea20752
add missing imports
mindplay-dk Nov 24, 2016
a197b2d
Merge remote-tracking branch 'origin/patch-1'
mindplay-dk Feb 1, 2017
4cecb1b
corrected php 7.1 `iterable` type-hints to `array|Traversable` per th…
mindplay-dk Feb 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions src/CacheInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

namespace Psr\SimpleCache;

use DateInterval;
use Traversable;

interface CacheInterface
{
/**
Expand Down Expand Up @@ -55,10 +58,10 @@ 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.
* @param mixed $default Default value to return for keys that do not exist.
* @param array|Traversable $keys A list of keys that can obtained in a single operation.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that can be obtained (be is missing), right ?

* @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.
* @return array|Traversable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
*
* @throws \Psr\SimpleCache\InvalidArgumentException
* MUST be thrown if $keys is neither an array nor a Traversable,
Expand All @@ -69,7 +72,7 @@ public function getMultiple($keys, $default = null);
/**
* Persists a set of key => value pairs in the cache, with an optional TTL.
*
* @param iterable $values A list of key => value pairs for a multiple-set operation.
* @param array|Traversable $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.
Expand All @@ -85,7 +88,7 @@ public function setMultiple($values, $ttl = null);
/**
* Deletes multiple cache items in a single operation.
*
* @param iterable $keys A list of string-based keys to be deleted.
* @param array|Traversable $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.
*
Expand Down