djsmithme / Cache

Src/Cache/Cache.php

Doc Comments +6 added lines, -6 removed lines

@@ -25,7 +25,7 @@ 
      * Persists data in the cache, uniquely referenced by a key with an optional expiration TTL time.
      *
      * @param string                $key   The key of the item to store.
-     * @param mixed                 $value The value of the item to store, must be serializable.
+     * @param string                 $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.
@@ -76,7 +76,7 @@ 
      * 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.
+     * @param string  $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.
      *
@@ -114,7 +114,7 @@ 
     /**
      * Obtains multiple cache items by their unique keys.
      *
-     * @param iterable $keys    A list of keys that can obtained in a single operation.
+     * @param string[] $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.
      *
      * @return iterable A list of key => value pairs. Cache keys that do not exist or are stale will have $default as value.
@@ -140,7 +140,7 @@ 
      * 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 null|int|DateInterval $ttl    Optional. The TTL value of this item. If no value is sent and
+     * @param integer $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.
      *
@@ -169,7 +169,7 @@ 
     /**
      * Deletes multiple cache items in a single operation.
      *
-     * @param iterable $keys A list of string-based keys to be deleted.
+     * @param string[] $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.
      *
@@ -206,7 +206,7 @@ 
     /**
      * Check that provided key is valid.
      *
-     * @param $key
+     * @param string $key
      * @throws InvalidArgumentException
      */
     private function _isValidKey($key){

Spacing +17 added lines, -17 removed lines

@@ -38,13 +38,13 @@ 
     public function set($key, $value, $ttl = null)
     {
         //convert to timestamp from now.
-        if ($ttl instanceof \DateInterval){
+        if ($ttl instanceof \DateInterval) {
             $dateTime = new \DateTime();
-            $dateTime->add( $ttl );
+            $dateTime->add($ttl);
             $ttl = $dateTime->getTimestamp() - time();
         }
 
-        if (!is_int($ttl) ||  $ttl === null){
+        if (!is_int($ttl) || $ttl === null) {
             throw new InvalidArgumentException('$ttl can only be an instance of \DateInterval, int or null');
         }
 
@@ -87,7 +87,7 @@ 
     {
         $this->_isValidKey($key);
 
-        if ($this->cache->has($key)){
+        if ($this->cache->has($key)) {
             return $this->cache->get($key);
         }
 
@@ -128,7 +128,7 @@ 
         $this->_checkTraversable($keys);
         $result = [];
 
-        foreach ((array)$keys as $key){
+        foreach ((array)$keys as $key) {
             $cachedItem = $this->cache->get($key);
             $result[$key] = (null !== $cachedItem) ? $cachedItem : $default;
         }
@@ -155,11 +155,11 @@ 
         $this->_checkTraversable($values);
         $results = [];
 
-        foreach ((array)$values as $key => $value){
+        foreach ((array)$values as $key => $value) {
             $results[] = $this->cache->set($key, $value, $ttl);
         }
 
-        if ($this->_hasFailure($results)){
+        if ($this->_hasFailure($results)) {
             return false;
         }
 
@@ -182,11 +182,11 @@ 
         $this->_checkTraversable($keys);
         $results = [];
 
-        foreach ((array)$keys as $key){
+        foreach ((array)$keys as $key) {
             $results[] = $this->cache->delete($key);
         }
 
-        if ($this->_hasFailure($results)){
+        if ($this->_hasFailure($results)) {
             return false;
         }
 
@@ -209,15 +209,15 @@ 
      * @param $key
      * @throws InvalidArgumentException
      */
-    private function _isValidKey($key){
-        if (!is_string($key)){
+    private function _isValidKey($key) {
+        if (!is_string($key)) {
             throw new InvalidArgumentException('provided key must be a valid string');
         }
     }
 
     private function isAssoc(array $arr)
     {
-        if (array() === $arr){
+        if (array() === $arr) {
             return false;
         }
         return array_keys($arr) !== range(0, count($arr) - 1);
@@ -230,13 +230,13 @@ 
      * @throws InvalidArgumentException
      * @internal
      */
-    private function _checkTraversable($data){
+    private function _checkTraversable($data) {
 
-        if (is_array($data)){
+        if (is_array($data)) {
             return;
         }
 
-        if ($data instanceof \Traversable ){
+        if ($data instanceof \Traversable) {
             return;
         }
 
@@ -250,8 +250,8 @@ 
      * @return bool
      * @internal
      */
-    private function _hasFailure(array $results){
-        if (in_array(false, $results)){
+    private function _hasFailure(array $results) {
+        if (in_array(false, $results)) {
             return true;
         }
         return false;

Tests/Cache/CacheTest.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use Ds\Cache\Cache;
 use Ds\Cache\CacheStorageInterface;
-use Ds\Cache\NullStorage;
 use Psr\SimpleCache\InvalidArgumentException;
 
 /**

Spacing +21 added lines, -21 removed lines

@@ -39,7 +39,7 @@ 
     {
         $key = 21021000;
         $this->expectException(InvalidArgumentException::class);
-        $this->cache->set($key,'value');
+        $this->cache->set($key, 'value');
     }
 
     /**
@@ -202,7 +202,7 @@ 
         $this->cache->delete($key);
     }
 
-    public function testGetMultiple(){
+    public function testGetMultiple() {
 
         $expected = [
             'foo' => 'fooValue',
@@ -212,7 +212,7 @@ 
 
         $i = 0;
 
-        foreach ($expected as $key => $value){
+        foreach ($expected as $key => $value) {
 
             $this->storageMock->expects($this->at($i))
                 ->method('get')
@@ -229,7 +229,7 @@ 
 
     }
 
-    public function testSetMultiple(){
+    public function testSetMultiple() {
 
         $keys = [
             'foo' => 'fooValue',
@@ -243,7 +243,7 @@ 
         $i = 0;
         $expires = 60 * 60;
 
-        foreach ($keys as $key => $value){
+        foreach ($keys as $key => $value) {
             $this->storageMock->expects($this->at($i))
                 ->method('set')
                 ->with(
@@ -255,17 +255,17 @@ 
             $i++;
         }
 
-        $actual = $this->cache->setMultiple($keys,$expires);
+        $actual = $this->cache->setMultiple($keys, $expires);
         $this->assertEquals($expected, $actual);
     }
 
-    public function testDeleteMultiple(){
+    public function testDeleteMultiple() {
 
-        $keys = ['foo','bar','baz'];
+        $keys = ['foo', 'bar', 'baz'];
         $deleteStatus = true;
         $expected = true;
 
-        foreach ($keys as $i => $key){
+        foreach ($keys as $i => $key) {
             $this->storageMock->expects($this->at($i))
                 ->method('delete')
                 ->with(
@@ -278,15 +278,15 @@ 
         $this->assertEquals($expected, $actual);
     }
 
-    public function testDeleteMultipleFailure(){
+    public function testDeleteMultipleFailure() {
 
-        $keys = ['foo','bar','baz'];
+        $keys = ['foo', 'bar', 'baz'];
         $expected = false;
         $deleteStatus = true;
 
-        foreach ($keys as $i => $key){
+        foreach ($keys as $i => $key) {
 
-            if ($i === 1){
+            if ($i === 1) {
                 $deleteStatus = false;
             }
 
@@ -302,7 +302,7 @@ 
         $this->assertEquals($expected, $actual);
     }
 
-    public function testclear(){
+    public function testclear() {
         $this->storageMock->expects($this->once())
             ->method('clear');
 
@@ -312,11 +312,11 @@ 
     /**
      * Private functions
      */
-    public function test_isValidKeyValid(){}
-    public function test_isValidKeyInvalid(){}
-    public function test_checkTraversableArray(){}
-    public function test_checkTraversableTraversable(){}
-    public function test_checkTraversableException(){}
-    public function test_hasFailureNoFailure(){}
-    public function test_hasFailureException(){}
+    public function test_isValidKeyValid() {}
+    public function test_isValidKeyInvalid() {}
+    public function test_checkTraversableArray() {}
+    public function test_checkTraversableTraversable() {}
+    public function test_checkTraversableException() {}
+    public function test_hasFailureNoFailure() {}
+    public function test_hasFailureException() {}
 }

Tests/Cache/Mock/AbstractCacheMock.php

Spacing +1 added lines, -1 removed lines

@@ -11,5 +11,5 @@
  *
  * @package Tests\Cache\Mock
  */
-class AbstractCacheMock extends AbstractCache{
+class AbstractCacheMock extends AbstractCache {
 }
\ No newline at end of file

Tests/Cache/Mock/AbstractStorageMock.php

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
  *
  * @package Tests\Cache\Mock
  */
-class AbstractStorageMock extends AbstractStorage{
+class AbstractStorageMock extends AbstractStorage {
 
     public function set($key, $value, $ttl = null)
     {

Tests/Cache/Storage/MemcacheStorageTest.php

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
     {
         $this->ttl = new \DateInterval('P1M');
         $this->memcacheMock = $this->getMockBuilder('\Memcached')->getMock();
-        $this->memcacheStorage = new MemcacheStorage($this->memcacheMock,'localhost',11211, $this->ttl);
+        $this->memcacheStorage = new MemcacheStorage($this->memcacheMock, 'localhost', 11211, $this->ttl);
     }
 
     public function testAddServer()

Tests/Cache/Storage/NullStorageTest.php

Spacing +5 added lines, -5 removed lines

@@ -28,35 +28,35 @@
     /**
      *
      */
-    public function testHas(){
+    public function testHas() {
         $this->assertEquals($this->cacheStorage->has('key', 'value'), false);
     }
 
     /**
      *
      */
-    public function testSet(){
+    public function testSet() {
         $this->assertEquals($this->cacheStorage->set('key', 'value', 10), true);
     }
 
     /**
      *
      */
-    public function testGet(){
+    public function testGet() {
         $this->assertEquals($this->cacheStorage->get('key'), null);
     }
 
     /**
      *
      */
-    public function testDelete(){
+    public function testDelete() {
         $this->assertEquals($this->cacheStorage->delete('key'), true);
     }
 
     /**
      *
      */
-    public function testClear(){
+    public function testClear() {
         $this->assertEquals($this->cacheStorage->clear(), true);
     }
     

Tests/Cache/Storage/FileStorageTest.php

Indentation +1 added lines, -1 removed lines

@@ -75,7 +75,7 @@
      *
      */
     public function testClear(){
-       $this->assertEquals($this->cacheStorage->clear(), true);
+        $this->assertEquals($this->cacheStorage->clear(), true);
     }
 
     /**

Spacing +13 added lines, -13 removed lines

@@ -27,8 +27,8 @@ 
      */
     public function setUp()
     {
-        $this->testDir = __DIR__ . '/cacheTest';
-        $this->cacheStorage = new FileStorage( $this->testDir, new \DateInterval('P1M'));
+        $this->testDir = __DIR__.'/cacheTest';
+        $this->cacheStorage = new FileStorage($this->testDir, new \DateInterval('P1M'));
     }
 
     /**
@@ -43,47 +43,47 @@ 
     /**
      *
      */
-    public function testSet(){
-        $actual = $this->cacheStorage->set('key','value',60*60);
+    public function testSet() {
+        $actual = $this->cacheStorage->set('key', 'value', 60 * 60);
         $this->assertEquals(true, $actual);
     }
 
     /**
      *
      */
-    public function testHasNoValue(){
+    public function testHasNoValue() {
         $this->assertEquals($this->cacheStorage->has('someRandomKey'), false);
     }
 
     /**
      *
      */
-    public function testHas(){
-        $this->cacheStorage->set('foo','bar');
+    public function testHas() {
+        $this->cacheStorage->set('foo', 'bar');
         $this->assertEquals($this->cacheStorage->has('foo'), true);
     }
 
     /**
      *
      */
-    public function testHasExpired(){
-        $this->cacheStorage->set('expired','bar', -1200);
+    public function testHasExpired() {
+        $this->cacheStorage->set('expired', 'bar', -1200);
         $this->assertEquals($this->cacheStorage->has('expired'), false);
     }
 
     /**
      *
      */
-    public function testClear(){
+    public function testClear() {
        $this->assertEquals($this->cacheStorage->clear(), true);
     }
 
     /**
      *
      */
-    public function testGet(){
+    public function testGet() {
         $expected = 'bat';
-        $this->cacheStorage->set('baz',$expected);
+        $this->cacheStorage->set('baz', $expected);
         $actual = $this->cacheStorage->get('baz');
         $this->assertEquals($expected, $actual);
     }
@@ -95,7 +95,7 @@ 
     {
         $dir = $this->testDir;
 
-        if (is_dir( $dir)){
+        if (is_dir($dir)) {
             array_map('unlink', glob("$dir/*.*"));
         }
         \rmdir($dir);

Tests/Cache/Storage/AbstractStorageTest.php

Spacing +6 added lines, -6 removed lines

@@ -33,7 +33,7 @@ 
     /**
      * Test immutable setter AbstractStorage::withTtl
      */
-    public function testWithTtl(){
+    public function testWithTtl() {
         $newDateInterval = new \DateInterval('P2M');
         $newTtl = $this->abstractStorage->withTtl($newDateInterval);
         $this->assertNotSame($this->abstractStorage->getTtl(), $newTtl->getTtl());
@@ -42,7 +42,7 @@ 
     /**
      * Test getter AbstractStorage::getTtl
      */
-    public function testGetTtl(){
+    public function testGetTtl() {
         $ttl = $this->abstractStorage->getTtl();
         $this->assertSame($this->ttl, $ttl);
     }
@@ -50,9 +50,9 @@ 
     /**
      * Get get ttl when provided with null
      */
-    public function testGetTtlTimestampWhenNull(){
+    public function testGetTtlTimestampWhenNull() {
         $dateTime = new \DateTime();
-        $dateTime->add( $this->ttl );
+        $dateTime->add($this->ttl);
         $expected = $dateTime->getTimestamp();
         $actual = $this->abstractStorage->getTtlTimestamp(null);
         $this->assertEquals($expected, $actual);
@@ -61,8 +61,8 @@ 
     /**
      * Test get ttl when provided with an integer.
      */
-    public function testGetTtlTimestampWhenInt(){
-        $expected = 60*60*7;
+    public function testGetTtlTimestampWhenInt() {
+        $expected = 60 * 60 * 7;
         $actual = $this->abstractStorage->getTtlTimestamp($expected);
         $this->assertEquals($expected, $actual);
     }

Src/Cache/Storage/MemcacheStorage.php

Spacing +3 added lines, -3 removed lines

@@ -67,8 +67,8 @@ 
      *
      * @return bool
      */
-    public function has($key){
-        if (!empty($this->mmc->get($key))){
+    public function has($key) {
+        if (!empty($this->mmc->get($key))) {
             return true;
         }
         return false;
@@ -113,7 +113,7 @@ 
      *
      * @return bool True on success and false on failure.
      */
-    public function clear(){
+    public function clear() {
         return $this->flush();
     }