- Replaced \LogicException occurrences with phpFastCacheLogicException

Author: Geolim4

MigratingFromV5ToV6.md

@@ -92,7 +92,7 @@ try{
 ```
 
 #### :alarm_clock: Now:
-This has been changed you now MUST catch `\phpFastCache\Exceptions\phpFastCacheInvalidArgumentException` interface
+This has been changed you now MUST catch `\phpFastCache\Exceptions\phpFastCacheInvalidArgumentException` class
 
 ```php
 namespace My\Custom\Project;
@@ -108,6 +108,40 @@ try{
 ```
 :warning: Please note that `\phpFastCache\Exceptions\phpFastCacheInvalidArgumentException` implements `\Psr\Cache\InvalidArgumentException` as per PSR-6.
 
+### Catching \LogicException
+
+#### :clock1: Then:
+Code used to catch a `\LogicException`. 
+
+```php
+namespace My\Custom\Project;
+
+$instance = CacheManager::getInstance('Files');
+
+try{
+    $item = $instance->getItem(array());
+}catch(\LogicException $e){
+    //Catched exception code
+}
+
+```
+
+#### :alarm_clock: Now:
+This has been changed you now MUST catch `\phpFastCache\Exceptions\phpFastCacheLogicException` interface
+
+```php
+namespace My\Custom\Project;
+
+$instance = CacheManager::getInstance('Files');
+
+try{
+    $item = $instance->getItem(array());
+}catch(\phpFastCache\Exceptions\phpFastCacheLogicException $e){
+    //Catched exception code
+}
+
+```
+
 ### Allowed characters in key identifier
 :warning: As of the V6, the following characters can not longer being a part of the key identifier: `{}()/\@:`
 

src/phpFastCache/CacheManager.php

@@ -22,25 +22,27 @@
  * Class CacheManager
  * @package phpFastCache
  *
- * @method static ExtendedCacheItemPoolInterface Apc() Apc($config = []) Return a driver "apc" instance
- * @method static ExtendedCacheItemPoolInterface Apcu() Apcu($config = []) Return a driver "apcu" instance
+ * @method static ExtendedCacheItemPoolInterface Apc() Apc($config = []) Return a driver "Apc" instance
+ * @method static ExtendedCacheItemPoolInterface Apcu() Apcu($config = []) Return a driver "Apcu" instance
  * @method static ExtendedCacheItemPoolInterface Cassandra() Cassandra($config = []) Return a driver "Cassandra" instance
- * @method static ExtendedCacheItemPoolInterface Cookie() Cookie($config = []) Return a driver "cookie" instance
- * @method static ExtendedCacheItemPoolInterface Couchbase() Couchbase($config = []) Return a driver "couchbase" instance
+ * @method static ExtendedCacheItemPoolInterface Cookie() Cookie($config = []) Return a driver "Cookie" instance
+ * @method static ExtendedCacheItemPoolInterface Couchbase() Couchbase($config = []) Return a driver "Couchbase" instance
  * @method static ExtendedCacheItemPoolInterface Couchdb() Couchdb($config = []) Return a driver "Couchdb" instance
+ * @method static ExtendedCacheItemPoolInterface Devnull() Devnull($config = []) Return a driver "Devnull" instance
  * @method static ExtendedCacheItemPoolInterface Files() Files($config = []) Return a driver "files" instance
- * @method static ExtendedCacheItemPoolInterface Leveldb() Leveldb($config = []) Return a driver "leveldb" instance
- * @method static ExtendedCacheItemPoolInterface Memcache() Memcache($config = []) Return a driver "memcache" instance
- * @method static ExtendedCacheItemPoolInterface Memcached() Memcached($config = []) Return a driver "memcached" instance
- * @method static ExtendedCacheItemPoolInterface Mongodb() Mongodb($config = []) Return a driver "mongodb" instance
- * @method static ExtendedCacheItemPoolInterface Predis() Predis($config = []) Return a driver "predis" instance
- * @method static ExtendedCacheItemPoolInterface Redis() Redis($config = []) Return a driver "redis" instance
- * @method static ExtendedCacheItemPoolInterface Sqlite() Sqlite($config = []) Return a driver "sqlite" instance
- * @method static ExtendedCacheItemPoolInterface Ssdb() Ssdb($config = []) Return a driver "ssdb" instance
- * @method static ExtendedCacheItemPoolInterface Wincache() Wincache($config = []) Return a driver "wincache" instance
- * @method static ExtendedCacheItemPoolInterface Xcache() Xcache($config = []) Return a driver "xcache" instance
- * @method static ExtendedCacheItemPoolInterface Zenddisk() Zenddisk($config = []) Return a driver "zend disk cache" instance
- * @method static ExtendedCacheItemPoolInterface Zendshm() Zendshm($config = []) Return a driver "zend memory cache" instance
+ * @method static ExtendedCacheItemPoolInterface Leveldb() Leveldb($config = []) Return a driver "Leveldb" instance
+ * @method static ExtendedCacheItemPoolInterface Memcache() Memcache($config = []) Return a driver "Memcache" instance
+ * @method static ExtendedCacheItemPoolInterface Memcached() Memcached($config = []) Return a driver "Memcached" instance
+ * @method static ExtendedCacheItemPoolInterface Memstatic() Memstatic($config = []) Return a driver "Memstatic" instance
+ * @method static ExtendedCacheItemPoolInterface Mongodb() Mongodb($config = []) Return a driver "Mongodb" instance
+ * @method static ExtendedCacheItemPoolInterface Predis() Predis($config = []) Return a driver "Predis" instance
+ * @method static ExtendedCacheItemPoolInterface Redis() Redis($config = []) Return a driver "Pedis" instance
+ * @method static ExtendedCacheItemPoolInterface Sqlite() Sqlite($config = []) Return a driver "Sqlite" instance
+ * @method static ExtendedCacheItemPoolInterface Ssdb() Ssdb($config = []) Return a driver "Ssdb" instance
+ * @method static ExtendedCacheItemPoolInterface Wincache() Wincache($config = []) Return a driver "Wincache" instance
+ * @method static ExtendedCacheItemPoolInterface Xcache() Xcache($config = []) Return a driver "Xcache" instance
+ * @method static ExtendedCacheItemPoolInterface Zenddisk() Zenddisk($config = []) Return a driver "Zend disk cache" instance
+ * @method static ExtendedCacheItemPoolInterface Zendshm() Zendshm($config = []) Return a driver "Zend memory cache" instance
  *
  */
 class CacheManager
@@ -71,7 +73,7 @@ class CacheManager
       'autoTmpFallback' => false,
 
         /**
-         * Provide a secure file manipulation mechanism
+         * Provide a secure file manipulation mechanism,
          * on intensive usage the performance can be affected.
          */
       'secureFileManipulation' => false,

src/phpFastCache/Core/Item/ExtendedCacheItemInterface.php

@@ -18,6 +18,7 @@
 use phpFastCache\Exceptions\phpFastCacheInvalidArgumentException;
 use Psr\Cache\CacheItemInterface;
 use phpFastCache\Core\Pool\ExtendedCacheItemPoolInterface;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
 
 /**
  * Interface ExtendedCacheItemInterface
@@ -60,27 +61,27 @@ public function setExpirationDate(\DateTimeInterface $expiration);
 
     /**
      * @return \DateTimeInterface
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function getCreationDate();
 
     /**
      * @return \DateTimeInterface
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function getModificationDate();
 
     /**
      * @param $date \DateTimeInterface
      * @return $this
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function setCreationDate(\DateTimeInterface $date);
 
     /**
      * @param $date \DateTimeInterface
      * @return $this
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function setModificationDate(\DateTimeInterface $date);
 

src/phpFastCache/Core/Item/ItemBaseTrait.php

@@ -11,11 +11,14 @@
  * @author Georges.L (Geolim4)  <[email protected]>
  *
  */
-
 namespace phpFastCache\Core\Item;
 
 use phpFastCache\Exceptions\phpFastCacheInvalidArgumentException;
 
+/**
+ * Trait ItemBaseTrait
+ * @package phpFastCache\Core\Item
+ */
 trait ItemBaseTrait
 {
     use ItemExtendedTrait;

src/phpFastCache/Core/Item/ItemExtendedTrait.php

@@ -17,10 +17,12 @@
 use phpFastCache\EventManager;
 use phpFastCache\Core\Pool\ExtendedCacheItemPoolInterface;
 use phpFastCache\Exceptions\phpFastCacheInvalidArgumentException;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
 
 /**
  * Class ItemExtendedTrait
  * @package phpFastCache\Core\Item
+ * @property \Datetime $expirationDate Expiration date of the item
  */
 trait ItemExtendedTrait
 {
@@ -90,57 +92,57 @@ public function setExpirationDate(\DateTimeInterface $expiration)
 
     /**
      * @return \DateTimeInterface
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function getCreationDate()
     {
         if($this->driver->getConfig()['itemDetailedDate']){
             return $this->creationDate;
         }else{
-            throw new \LogicException('Cannot access to the creation date when the "itemDetailedDate" configuration is disabled.');
+            throw new phpFastCacheLogicException('Cannot access to the creation date when the "itemDetailedDate" configuration is disabled.');
         }
     }
 
     /**
      * @param \DateTimeInterface $date
      * @return $this
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function setCreationDate(\DateTimeInterface $date)
     {
         if($this->driver->getConfig()['itemDetailedDate']){
             $this->creationDate = $date;
             return $this;
         }else{
-            throw new \LogicException('Cannot access to the creation date when the "itemDetailedDate" configuration is disabled.');
+            throw new phpFastCacheLogicException('Cannot access to the creation date when the "itemDetailedDate" configuration is disabled.');
         }
     }
 
     /**
      * @return \DateTimeInterface
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function getModificationDate()
     {
         if($this->driver->getConfig()['itemDetailedDate']){
             return $this->modificationDate;
         }else{
-            throw new \LogicException('Cannot access to the modification date when the "itemDetailedDate" configuration is disabled.');
+            throw new phpFastCacheLogicException('Cannot access to the modification date when the "itemDetailedDate" configuration is disabled.');
         }
     }
 
     /**
      * @param \DateTimeInterface $date
      * @return $this
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function setModificationDate(\DateTimeInterface $date)
     {
         if($this->driver->getConfig()['itemDetailedDate']){
             $this->modificationDate = $date;
             return $this;
         }else{
-            throw new \LogicException('Cannot access to the modification date when the "itemDetailedDate" configuration is disabled.');
+            throw new phpFastCacheLogicException('Cannot access to the modification date when the "itemDetailedDate" configuration is disabled.');
         }
     }
 
@@ -207,7 +209,7 @@ public function decrement($step = 1)
     public function append($data)
     {
         if (is_array($this->data)) {
-            array_push($this->data, $data);
+            $this->data[] = $data;
         } else if (is_string($data)) {
             $this->data .= (string) $data;
         } else {
@@ -292,6 +294,7 @@ public function getTags()
     }
 
     /**
+     * @param string $separator
      * @return string
      */
     public function getTagsAsString($separator = ', ')

src/phpFastCache/Core/Pool/CacheItemPoolTrait.php

@@ -20,6 +20,7 @@
 use phpFastCache\EventManager;
 use phpFastCache\Exceptions\phpFastCacheCoreException;
 use phpFastCache\Exceptions\phpFastCacheInvalidArgumentException;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
 use Psr\Cache\CacheItemInterface;
 use phpFastCache\Util\ClassNamespaceResolverTrait;
 
@@ -56,7 +57,7 @@ trait CacheItemPoolTrait
      * @param string $key
      * @return \phpFastCache\Core\Item\ExtendedCacheItemInterface
      * @throws phpFastCacheInvalidArgumentException
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      * @throws phpFastCacheCoreException
      */
     public function getItem($key)

src/phpFastCache/Core/Pool/DriverBaseTrait.php

@@ -15,6 +15,7 @@
 
 use phpFastCache\Core\Item\ExtendedCacheItemInterface;
 use phpFastCache\Exceptions\phpFastCacheInvalidArgumentException;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
 
 
 /**
@@ -217,7 +218,7 @@ public function getDriverName()
     /**
      * @param \phpFastCache\Core\Item\ExtendedCacheItemInterface $item
      * @return bool
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function driverWriteTags(ExtendedCacheItemInterface $item)
     {
@@ -227,7 +228,7 @@ public function driverWriteTags(ExtendedCacheItemInterface $item)
          * to an infinite recursive calls
          */
         if(strpos($item->getKey(), self::DRIVER_TAGS_KEY_PREFIX ) === 0){
-            throw new \LogicException('Trying to set tag(s) to an Tag item index: ' . $item->getKey());
+            throw new phpFastCacheLogicException('Trying to set tag(s) to an Tag item index: ' . $item->getKey());
         }
 
         /**

src/phpFastCache/Core/Pool/ExtendedCacheItemPoolInterface.php

@@ -20,6 +20,7 @@
 use phpFastCache\EventManager;
 use Psr\Cache\CacheItemInterface;
 use Psr\Cache\CacheItemPoolInterface;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
 
 /**
  * Interface ExtendedCacheItemPoolInterface
@@ -472,7 +473,7 @@ public function detachAllItems();
     /**
      * @param \Psr\Cache\CacheItemInterface $item
      * @return void
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function attachItem(CacheItemInterface $item);
 
@@ -483,7 +484,7 @@ public function attachItem(CacheItemInterface $item);
      *
      * @param \Psr\Cache\CacheItemInterface $item
      * @return bool|null
-     * @throws \LogicException
+     * @throws phpFastCacheLogicException
      */
     public function isAttached(CacheItemInterface $item);
 

src/phpFastCache/Core/Pool/ExtendedCacheItemPoolTrait.php

@@ -18,6 +18,7 @@
 use phpFastCache\Core\Item\ExtendedCacheItemInterface;
 use phpFastCache\EventManager;
 use phpFastCache\Exceptions\phpFastCacheInvalidArgumentException;
+use phpFastCache\Exceptions\phpFastCacheLogicException;
 use Psr\Cache\CacheItemInterface;
 
 
@@ -399,7 +400,7 @@ public function detachAllItems()
     public function attachItem(CacheItemInterface $item)
     {
         if (isset($this->itemInstances[ $item->getKey() ]) && spl_object_hash($item) !== spl_object_hash($this->itemInstances[ $item->getKey() ])) {
-            throw new \LogicException('The item already exists and cannot be overwritten because the Spl object hash mismatches ! You probably tried to re-attach a detached item which has been already retrieved from cache.');
+            throw new phpFastCacheLogicException('The item already exists and cannot be overwritten because the Spl object hash mismatches ! You probably tried to re-attach a detached item which has been already retrieved from cache.');
         } else {
             $this->itemInstances[ $item->getKey() ] = $item;
         }
@@ -433,7 +434,6 @@ protected function deregisterItem($item)
      *
      * @param \Psr\Cache\CacheItemInterface $item
      * @return bool|null
-     * @throws \LogicException
      */
     public function isAttached(CacheItemInterface $item)
     {

src/phpFastCache/Core/Pool/IO/IOHelperTrait.php

@@ -175,7 +175,6 @@ protected function encodeFilename($keyword)
     }
 
     /**
-     * @param $this ->config
      * @return int
      */
     protected function getDefaultChmod()