Merge pull request #625 from Geolim4/master

More type hint & opcache optimizations

Author: Geolim4

.github/PULL_REQUEST_TEMPLATE.md

@@ -9,6 +9,7 @@ What types of changes does your code introduce to Phpfastcache?
 _Put an `x` in the boxes that apply_
 
 - [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] Improvement (non-breaking change which improves an existing code/behavior)
 - [ ] Deprecated third party dependency update
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

docs/migration/MigratingFromV6ToV7.md

@@ -158,9 +158,9 @@ The method still returns a valid string but its format has changed slightly.
 ### Couchbase PHP SDK
 The Couchbase driver has been updated to works with PHP SDK 2.4+ (Couchbase Server 5+).
 Therefore it way requires a Couchbase Server updated combined with an SDK update.
-
+ 
 ### Constants autoload-related
-As of the V7, all the constant starting by _PFC\_*_ were moved into the `Phpfastcache\Autoload` namespace\ 
+As of the V7, all the constant starting by _PFC\_*_ were moved in     to the `Phpfastcache\Autoload` namespace\ 
 to not pollute php's root namespace.
 
 ### Autoload mechanism

lib/Phpfastcache/CacheManager.php

@@ -165,7 +165,7 @@ protected static function getFallbackInstance(string $driver, ConfigurationOptio
                 $fallback = $config->getFallback();
                 $config->setFallback('');
                 \trigger_error(\sprintf('The "%s" driver is unavailable at the moment, the fallback driver "%s" has been used instead.', $driver,
-                    $fallback), E_USER_WARNING);
+                    $fallback),  \E_USER_WARNING);
                 return self::getInstance($fallback, $config->getFallbackConfig());
             } catch (PhpfastcacheInvalidArgumentException $e) {
                 throw new PhpfastcacheInvalidConfigurationException('Invalid fallback driver configuration', 0, $e);
@@ -328,7 +328,7 @@ public static function getDefaultConfig(): ConfigurationOption
     public static function getStaticSystemDrivers(): array
     {
         \trigger_error(\sprintf('Method "%s" is deprecated as of the V7 and will be removed soon or later, use CacheManager::getDriverList() instead.',
-            __METHOD__), E_USER_DEPRECATED);
+            __METHOD__), \E_USER_DEPRECATED);
         return [
             'Apc',
             'Apcu',
@@ -361,7 +361,7 @@ public static function getStaticSystemDrivers(): array
     public static function getStaticAllDrivers(): array
     {
         \trigger_error(\sprintf('Method "%s" is deprecated as of the V7 and will be removed soon or later, use CacheManager::getDriverList() instead.',
-            __METHOD__), E_USER_DEPRECATED);
+            __METHOD__), \E_USER_DEPRECATED);
         return \array_merge(self::getStaticSystemDrivers(), [
             'Devtrue',
             'Devfalse',

lib/Phpfastcache/Config/ConfigurationOption.php

@@ -110,25 +110,25 @@ public function __construct(...$args)
          * Detect unwanted keys and throw an exception.
          * No more kidding now, it's 21th century.
          */
-        if (array_diff_key($array, get_object_vars($this))) {
+        if (\array_diff_key($array, \get_object_vars($this))) {
             throw new PhpfastcacheInvalidConfigurationException(\sprintf(
                 'Invalid option(s) for the config %s: %s',
                 static::class,
-                implode(', ', array_keys(array_diff_key($array, get_object_vars($this))))
+                \implode(', ', \array_keys(\array_diff_key($array, \get_object_vars($this))))
             ));
         }
 
-        foreach (get_object_vars($this) as $property => $value) {
+        foreach (\get_object_vars($this) as $property => $value) {
 
-            if (array_key_exists($property, $array)) {
+            if (\array_key_exists($property, $array)) {
                 $this->$property = &$array[$property];
             } else {
                 $array[$property] = &$this->$property;
             }
         }
 
-        foreach (get_class_methods($this) as $method) {
-            if (strpos($method, 'set') === 0) {
+        foreach (\get_class_methods($this) as $method) {
+            if (\strpos($method, 'set') === 0) {
                 $value = null;
                 try {
                     /**
@@ -137,7 +137,7 @@ public function __construct(...$args)
                      * to allow us to retrieve the value
                      * in catch statement bloc
                      */
-                    $value = $this->{lcfirst(substr($method, 3))};
+                    $value = $this->{\lcfirst(\substr($method, 3))};
                     $this->{$method}($value);
                 } catch (\TypeError $e) {
                     $typeHintGot = \is_object($value) ? \get_class($value) : \gettype($value);
@@ -147,7 +147,7 @@ public function __construct(...$args)
 
                     throw new PhpfastcacheInvalidConfigurationException(\sprintf(
                         'Invalid type hint found for "%s", expected "%s" got "%s"',
-                        lcfirst(substr($method, 3)),
+                        \lcfirst(\substr($method, 3)),
                         $typeHintExpected,
                         $typeHintGot
                     ));
@@ -163,7 +163,7 @@ public function __construct(...$args)
      */
     public function getOption(string $optionName)
     {
-        \trigger_error(\sprintf('Method "%s" is deprecated, use "getOptionName()" instead', __METHOD__), E_USER_DEPRECATED);
+        \trigger_error(\sprintf('Method "%s" is deprecated, use "getOptionName()" instead', __METHOD__), \E_USER_DEPRECATED);
         return $this->$optionName ?? null;
     }
 
@@ -173,7 +173,7 @@ public function getOption(string $optionName)
      */
     public function isValidOption(string $optionName)
     {
-        return property_exists($this, $optionName);
+        return \property_exists($this, $optionName);
     }
 
     /**
@@ -229,7 +229,7 @@ public function isIgnoreSymfonyNotice(): bool
     public function setIgnoreSymfonyNotice(bool $ignoreSymfonyNotice): self
     {
         if ($ignoreSymfonyNotice) {
-            \trigger_error('Configuration option "ignoreSymfonyNotice" is deprecated as of the V7', E_USER_DEPRECATED);
+            \trigger_error('Configuration option "ignoreSymfonyNotice" is deprecated as of the V7', \E_USER_DEPRECATED);
         }
         $this->ignoreSymfonyNotice = $ignoreSymfonyNotice;
         return $this;

lib/Phpfastcache/Core/Item/ItemExtendedTrait.php

@@ -382,7 +382,7 @@ public function getTagsAsString($separator = ', '): string
      */
     public function removeTag($tagName): ExtendedCacheItemInterface
     {
-        if (($key = \array_search($tagName, $this->tags)) !== false) {
+        if (($key = \array_search($tagName, $this->tags, true)) !== false) {
             unset($this->tags[$key]);
             $this->removedTags[] = $tagName;
         }

lib/Phpfastcache/Core/Pool/CacheItemPoolTrait.php

@@ -395,7 +395,7 @@ public function saveDeferred(CacheItemInterface $item)
     }
 
     /**
-     * @return mixed|null
+     * @return bool
      * @throws PhpfastcacheInvalidArgumentException
      */
     public function commit()
@@ -416,6 +416,6 @@ public function commit()
             }
         }
 
-        return (bool)$return;
+        return (bool) $return;
     }
 }

lib/Phpfastcache/Core/Pool/DriverBaseTrait.php

@@ -242,7 +242,7 @@ public function getInstanceId(): string
      * @return bool
      * @throws PhpfastcacheLogicException
      */
-    public function driverWriteTags(ExtendedCacheItemInterface $item)
+    public function driverWriteTags(ExtendedCacheItemInterface $item): bool
     {
         /**
          * Do not attempt to write tags
@@ -322,7 +322,7 @@ public function driverWriteTags(ExtendedCacheItemInterface $item)
      * @param $key
      * @return string
      */
-    public function getTagKey($key)
+    public function getTagKey($key):string
     {
         return self::DRIVER_TAGS_KEY_PREFIX . $key;
     }

lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolInterface.php

@@ -181,7 +181,7 @@ public function getHelp(): string;
      *   key is not found. However, if no keys are specified then an empty
      *   traversable MUST be returned instead.
      */
-    public function getItemsByTag($tagName);
+    public function getItemsByTag($tagName): array;
 
     /**
      * Returns a traversable set of cache items by one of multiple tag names.
@@ -199,7 +199,7 @@ public function getItemsByTag($tagName);
      *   key is not found. However, if no keys are specified then an empty
      *   traversable MUST be returned instead.
      */
-    public function getItemsByTags(array $tagNames);
+    public function getItemsByTags(array $tagNames): array;
 
     /**
      * Returns a traversable set of cache items by all of multiple tag names.
@@ -217,7 +217,7 @@ public function getItemsByTags(array $tagNames);
      *   key is not found. However, if no keys are specified then an empty
      *   traversable MUST be returned instead.
      */
-    public function getItemsByTagsAll(array $tagNames);
+    public function getItemsByTagsAll(array $tagNames): array;
 
     /**
      * Returns A json string that represents an array of items by tags-based.
@@ -233,7 +233,7 @@ public function getItemsByTagsAll(array $tagNames);
      *
      * @return string
      */
-    public function getItemsByTagsAsJsonString(array $tagNames, $option = 0, $depth = 512);
+    public function getItemsByTagsAsJsonString(array $tagNames, $option = 0, $depth = 512): string;
 
     /**
      * Removes the item from the pool by tag.
@@ -248,7 +248,7 @@ public function getItemsByTagsAsJsonString(array $tagNames, $option = 0, $depth
      * @return bool
      *   True if the item was successfully removed. False if there was an error.
      */
-    public function deleteItemsByTag($tagName);
+    public function deleteItemsByTag($tagName): bool;
 
     /**
      * Removes the item from the pool by one of multiple tag names.
@@ -263,7 +263,7 @@ public function deleteItemsByTag($tagName);
      * @return bool
      *   True if the items were successfully removed. False if there was an error.
      */
-    public function deleteItemsByTags(array $tagNames);
+    public function deleteItemsByTags(array $tagNames): bool;
 
     /**
      * Removes the item from the pool by all of multiple tag names.
@@ -278,7 +278,7 @@ public function deleteItemsByTags(array $tagNames);
      * @return bool
      *   True if the items were successfully removed. False if there was an error.
      */
-    public function deleteItemsByTagsAll(array $tagNames);
+    public function deleteItemsByTagsAll(array $tagNames): bool;
 
     /**
      * Increment the items from the pool by tag.
@@ -295,7 +295,7 @@ public function deleteItemsByTagsAll(array $tagNames);
      * @return bool
      *   True if the item was successfully incremented. False if there was an error.
      */
-    public function incrementItemsByTag($tagName, $step = 1);
+    public function incrementItemsByTag($tagName, $step = 1): bool;
 
     /**
      * Increment the items from the pool by one of multiple tag names.
@@ -312,7 +312,7 @@ public function incrementItemsByTag($tagName, $step = 1);
      * @return bool
      *   True if the items were successfully incremented. False if there was an error.
      */
-    public function incrementItemsByTags(array $tagNames, $step = 1);
+    public function incrementItemsByTags(array $tagNames, $step = 1): bool;
 
     /**
      * Increment the items from the pool by all of multiple tag names.
@@ -329,7 +329,7 @@ public function incrementItemsByTags(array $tagNames, $step = 1);
      * @return bool
      *   True if the items were successfully incremented. False if there was an error.
      */
-    public function incrementItemsByTagsAll(array $tagNames, $step = 1);
+    public function incrementItemsByTagsAll(array $tagNames, $step = 1): bool;
 
     /**
      * Decrement the items from the pool by tag.
@@ -346,7 +346,7 @@ public function incrementItemsByTagsAll(array $tagNames, $step = 1);
      * @return bool
      *   True if the item was successfully decremented. False if there was an error.
      */
-    public function decrementItemsByTag($tagName, $step = 1);
+    public function decrementItemsByTag($tagName, $step = 1): bool;
 
     /**
      * Decrement the items from the pool by one of multiple tag names.
@@ -363,7 +363,7 @@ public function decrementItemsByTag($tagName, $step = 1);
      * @return bool
      *   True if the item was successfully decremented. False if there was an error.
      */
-    public function decrementItemsByTags(array $tagNames, $step = 1);
+    public function decrementItemsByTags(array $tagNames, $step = 1): bool;
 
     /**
      * Decrement the items from the pool by all of multiple tag names.
@@ -380,7 +380,7 @@ public function decrementItemsByTags(array $tagNames, $step = 1);
      * @return bool
      *   True if the items were successfully decremented. False if there was an error.
      */
-    public function decrementItemsByTagsAll(array $tagNames, $step = 1);
+    public function decrementItemsByTagsAll(array $tagNames, $step = 1): bool;
 
     /**
      * Decrement the items from the pool by tag.
@@ -397,7 +397,7 @@ public function decrementItemsByTagsAll(array $tagNames, $step = 1);
      * @return bool
      *   True if the item was successfully appended. False if there was an error.
      */
-    public function appendItemsByTag($tagName, $data);
+    public function appendItemsByTag($tagName, $data): bool;
 
     /**
      * Append the items from the pool by one of multiple tag names.
@@ -414,7 +414,7 @@ public function appendItemsByTag($tagName, $data);
      * @return bool
      *   True if the items were successfully appended. False if there was an error.
      */
-    public function appendItemsByTags(array $tagNames, $data);
+    public function appendItemsByTags(array $tagNames, $data): bool;
 
     /**
      * Append the items from the pool by all of multiple tag names.
@@ -431,7 +431,7 @@ public function appendItemsByTags(array $tagNames, $data);
      * @return bool
      *   True if the items were successfully appended. False if there was an error.
      */
-    public function appendItemsByTagsAll(array $tagNames, $data);
+    public function appendItemsByTagsAll(array $tagNames, $data): bool;
 
     /**
      * Prepend the items from the pool by tag.
@@ -448,7 +448,7 @@ public function appendItemsByTagsAll(array $tagNames, $data);
      * @return bool
      *   True if the item was successfully prepended. False if there was an error.
      */
-    public function prependItemsByTag($tagName, $data);
+    public function prependItemsByTag($tagName, $data): bool;
 
     /**
      * Prepend the items from the pool by one of multiple tag names.
@@ -465,7 +465,7 @@ public function prependItemsByTag($tagName, $data);
      * @return bool
      *   True if the item was successfully prepended. False if there was an error.
      */
-    public function prependItemsByTags(array $tagNames, $data);
+    public function prependItemsByTags(array $tagNames, $data): bool;
 
     /**
      * Prepend the items from the pool by all of multiple tag names.
@@ -482,7 +482,7 @@ public function prependItemsByTags(array $tagNames, $data);
      * @return bool
      *   True if the items were successfully prepended. False if there was an error.
      */
-    public function prependItemsByTagsAll(array $tagNames, $data);
+    public function prependItemsByTagsAll(array $tagNames, $data): bool;
 
     /**
      * @param \Psr\Cache\CacheItemInterface $item