djsmithme / Cache

Src/Cache/Storage/AbstractStorage.php

Spacing +5 added lines, -5 removed lines

@@ -41,7 +41,7 @@ 
      * @param DateInterval $ttl
      * @return CacheStorageInterface
      */
-    public function withTtl(DateInterval $ttl){
+    public function withTtl(DateInterval $ttl) {
         $new = clone $this;
         $new->ttl = $ttl;
         return $new;
@@ -53,11 +53,11 @@ 
      * @param null|int $ttl
      * @return int
      */
-    public function getTtlTimestamp($ttl = null){
+    public function getTtlTimestamp($ttl = null) {
 
-        if (null === $ttl){
+        if (null === $ttl) {
             $dateTime = new DateTime();
-            $dateTime->add( $this->ttl );
+            $dateTime->add($this->ttl);
             $ttl = $dateTime->getTimestamp();
         }
 
@@ -69,7 +69,7 @@ 
      *
      * @return DateInterval
      */
-    public function getTtl(){
+    public function getTtl() {
         return $this->ttl;
     }
 

Src/Cache/Cache.php

Doc Comments +6 added lines, -6 removed lines

@@ -24,7 +24,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.
@@ -75,7 +75,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.
      *
@@ -113,7 +113,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.
@@ -139,7 +139,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.
      *
@@ -168,7 +168,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.
      *
@@ -205,7 +205,7 @@ 
     /**
      * Check that provided key is valid.
      *
-     * @param $key
+     * @param string $key
      * @throws InvalidArgumentException
      */
     private function _isValidKey($key){

Spacing +16 added lines, -16 removed lines

@@ -37,13 +37,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');
         }
 
@@ -86,7 +86,7 @@ 
     {
         $this->_isValidKey($key);
 
-        if ($this->cache->has($key)){
+        if ($this->cache->has($key)) {
             return $this->cache->get($key);
         }
 
@@ -127,7 +127,7 @@ 
         $this->_isTraversable($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->_isTraversable($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->_isTraversable($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,8 +209,8 @@ 
      * @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');
         }
     }
@@ -223,9 +223,9 @@ 
      * @return bool
      * @internal
      */
-    private function _isTraversable($data){
+    private function _isTraversable($data) {
 
-        if (is_array($data) || $data instanceof \Traversable){
+        if (is_array($data) || $data instanceof \Traversable) {
             return true;
         }
 
@@ -239,7 +239,7 @@ 
      */
     private function _hasKeys(array $arr)
     {
-        if (array() === $arr || array_keys($arr) === range(0, count($arr) - 1)){
+        if (array() === $arr || array_keys($arr) === range(0, count($arr) - 1)) {
             throw new InvalidArgumentException('Keys missing');
         }
 
@@ -253,8 +253,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/Storage/FileStorageTest.php

Indentation +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
      * Test that clear is called.
      */
     public function testClear(){
-       $this->assertEquals($this->cacheStorage->clear(), true);
+        $this->assertEquals($this->cacheStorage->clear(), true);
     }
 
     /**

Spacing +25 added lines, -25 removed lines

@@ -29,8 +29,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'));
     }
 
     /**
@@ -45,7 +45,7 @@ 
     /**
      * Test that CacheException is thrown if directory is not valid/writable.
      */
-    public function testUnwritableDirectory(){
+    public function testUnwritableDirectory() {
 
         $this->expectException(CacheException::class);
         $this->cacheStorage = new FileStorage('php://memory', new \DateInterval('P1M'));
@@ -54,67 +54,67 @@ 
     /**
      * Test that set is called.
      */
-    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);
     }
 
     /**
      * Test has when not value is found.
      */
-    public function testHasNoValue(){
+    public function testHasNoValue() {
         $this->assertEquals($this->cacheStorage->has('someRandomKey'), false);
     }
 
     /**
      * Test has when value is found.
      */
-    public function testHas(){
-        $this->cacheStorage->set('foo','bar');
+    public function testHas() {
+        $this->cacheStorage->set('foo', 'bar');
         $this->assertEquals($this->cacheStorage->has('foo'), true);
     }
 
     /**
      * Test has when value is found but has expired.
      */
-    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);
     }
 
     /**
      * Test that clear is called.
      */
-    public function testClear(){
+    public function testClear() {
        $this->assertEquals($this->cacheStorage->clear(), true);
     }
 
     /**
      * Test that get returns a found key.
      */
-    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);
     }
 
-    public function testDelete(){
+    public function testDelete() {
         $this->cacheStorage->delete('baz');
     }
 
-    public function testCreateCacheItem(){
+    public function testCreateCacheItem() {
 
         $reflector = new \ReflectionClass(FileStorage::class);
         $method = $reflector->getMethod('_createCacheItem');
         $method->setAccessible(true);
 
-        $key= 'my-key_+';
+        $key = 'my-key_+';
         $value = 'my-value';
         $ttl = 60 * 60 * 7;
 
         $expected = [
-            'file' => $this->testDir . DIRECTORY_SEPARATOR . implode('.',[$key, FileStorage::EXTENSION]),
+            'file' => $this->testDir.DIRECTORY_SEPARATOR.implode('.', [$key, FileStorage::EXTENSION]),
             'data' => json_encode([$ttl, $value])
         ];
 
@@ -122,7 +122,7 @@ 
         $this->assertEquals($expected, $actual);
     }
 
-    public function testCreateCacheItemInvalidKey(){
+    public function testCreateCacheItemInvalidKey() {
 
         $this->expectException(InvalidArgumentException::class);
         $reflector = new \ReflectionClass(FileStorage::class);
@@ -134,18 +134,18 @@ 
         $method->invokeArgs($this->cacheStorage, [$key, $value, $ttl]);
     }
 
-    public function testFetchCacheNoItem(){
+    public function testFetchCacheNoItem() {
         $reflector = new \ReflectionClass(FileStorage::class);
         $method = $reflector->getMethod('_fetchCacheFile');
         $method->setAccessible(true);
-        $key= 'unknown';
+        $key = 'unknown';
         $actual = $method->invokeArgs($this->cacheStorage, [$key]);
         $this->assertEquals(false, $actual);
     }
 
-    public function testFetchCacheValid(){
+    public function testFetchCacheValid() {
 
-        $key= 'my-item';
+        $key = 'my-item';
         $ttl = 60 * 60;
         $value = 'some-value';
 
@@ -163,8 +163,8 @@ 
         $this->assertEquals($expected, $actual);
     }
 
-    public function testFetchCacheExpired(){
-        $key= 'my-item';
+    public function testFetchCacheExpired() {
+        $key = 'my-item';
         $ttl = -1500;
         $value = 'some-value';
         $this->cacheStorage->set($key, $value, $ttl);
@@ -182,7 +182,7 @@ 
     {
         $dir = $this->testDir;
 
-        if (is_dir( $dir)){
+        if (is_dir($dir)) {
             array_map('unlink', glob("$dir/*.*"));
         }
         \rmdir($dir);

Src/Cache/Storage/FileStorage.php

Indentation +4 added lines, -4 removed lines

@@ -99,10 +99,10 @@
      * @return bool
      */
     public function has($key){
-       if ($this->_fetchCacheFile($key)){
-         return true;
-       }
-       return false;
+        if ($this->_fetchCacheFile($key)){
+            return true;
+        }
+        return false;
     }
 
     /**

Spacing +21 added lines, -21 removed lines

@@ -45,13 +45,13 @@ 
      */
     public function __construct($directory, DateInterval $ttl)
     {
-        if (!is_string($directory)){
+        if (!is_string($directory)) {
             throw new InvalidArgumentException('Directory must be a valid string');
         }
 
         $this->dir = $directory;
 
-        if(!@mkdir($this->dir, 0755) && !is_dir($this->dir)){
+        if (!@mkdir($this->dir, 0755) && !is_dir($this->dir)) {
             throw new CacheException('unable to create directory');
         }
 
@@ -75,9 +75,9 @@ 
         $ttl = time() + $this->getTtlTimestamp($ttl);
         $cacheItem = $this->_createCacheItem($key, $value, $ttl);
 
-        if (null !== $value){
-            \file_put_contents($cacheItem['file'],$cacheItem['data']);
-            if (!file_exists($cacheItem['file'])){
+        if (null !== $value) {
+            \file_put_contents($cacheItem['file'], $cacheItem['data']);
+            if (!file_exists($cacheItem['file'])) {
                 return false;
             }
         }
@@ -98,8 +98,8 @@ 
      *
      * @return bool
      */
-    public function has($key){
-       if ($this->_fetchCacheFile($key)){
+    public function has($key) {
+       if ($this->_fetchCacheFile($key)) {
          return true;
        }
        return false;
@@ -113,8 +113,8 @@ 
      * @return mixed The value of the item from the cache, or $default in case of cache miss.
      *
      */
-    public function get($key){
-        if ($this->has($key)){
+    public function get($key) {
+        if ($this->has($key)) {
             return $this->previousRequest[1];
         }
         return null;
@@ -137,14 +137,14 @@ 
      *
      * @return bool True on success and false on failure.
      */
-    public function clear(){
-        if (is_dir( $this->dir )){
+    public function clear() {
+        if (is_dir($this->dir)) {
             array_map('unlink', glob("$this->dir/*.*"));
         }
 
         $data = glob("$this->dir/*.*");
 
-        if (!empty($data)){
+        if (!empty($data)) {
             return false;
         }
 
@@ -158,20 +158,20 @@ 
      * @return bool|mixed
      * @internal
      */
-    private function _fetchCacheFile($key){
+    private function _fetchCacheFile($key) {
 
-        $cacheFile = implode('.',[$key, FileStorage::EXTENSION]);
-        $cacheLocation = $this->dir . DIRECTORY_SEPARATOR . $cacheFile;
+        $cacheFile = implode('.', [$key, FileStorage::EXTENSION]);
+        $cacheLocation = $this->dir.DIRECTORY_SEPARATOR.$cacheFile;
         $this->previousRequest = false;
 
-        if (file_exists($cacheLocation)){
+        if (file_exists($cacheLocation)) {
 
             $data = \file_get_contents($cacheLocation);
             $cacheData = json_decode($data, TRUE);
             $this->previousRequest = $cacheData;
 
             //cache has expired
-            if ( $cacheData[0] < time() ){
+            if ($cacheData[0] < time()) {
                 \unlink($cacheLocation);
                 $this->previousRequest = false;
             }
@@ -188,16 +188,16 @@ 
      * @return array
      * @throws InvalidArgumentException
      */
-    private function _createCacheItem($key, $value, $ttl){
+    private function _createCacheItem($key, $value, $ttl) {
 
-        if (preg_match('/[\\/\\*\\\\\?.]+/i', $key)){
+        if (preg_match('/[\\/\\*\\\\\?.]+/i', $key)) {
             throw new InvalidArgumentException('$key must be a valid string');
         }
 
-        $filename = implode('.',[(string)$key, FileStorage::EXTENSION]);
+        $filename = implode('.', [(string)$key, FileStorage::EXTENSION]);
 
         return [
-            'file' => $this->dir . DIRECTORY_SEPARATOR . $filename,
+            'file' => $this->dir.DIRECTORY_SEPARATOR.$filename,
             'data' => json_encode([$ttl, $value])
         ];
     }