Merge pull request #827 from Geolim4/master

Updated some docs files (fixed typos)

Author: Geolim4

.github/workflows/tests.yml

@@ -1,8 +1,8 @@
-name: Github tests workflow
+name: Github CI
 on: [push, pull_request]
 jobs:
   build:
-    name: Github PHP unit tests
+    name: Github CI - Branch
     runs-on: ubuntu-latest
     steps:
       - name: Setup PHP 7.3

LICENCE

@@ -1,4 +1,4 @@
-Copyright (c) 2016 phpFastCache
+Copyright (c) 2016 Phpfastcache
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/CREDITS.md

@@ -1,4 +1,4 @@
-## phpFastCache Copyright (c) 2016
+## Phpfastcache Copyright (c) 2016
 https://www.phpfastcache.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -19,30 +19,30 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
-__phpFastCache Current Project Manager:__ Georges.L (Geolim4) / (v5, v6, v7, v8)
+__Phpfastcache Current Project Manager:__ Georges.L (Geolim4) / (v5, v6, v7, v8)
 
-__phpFastCache Former Project Founder:__ Khoa Bui (khoaofgod) / (<= v4)
+__Phpfastcache Former Project Founder:__ Khoa Bui (khoaofgod) / (<= v4)
 
-__phpFastCache Contributors:__    https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
+__Phpfastcache Contributors:__    https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
 
 #### Hall of fame (Special thanks):
 
 - __Jetbrains__ * for providing us a free IDE licence
 - __Scrutinizer-CI__ * for providing us a free Security Analysis
-- __VersionEye__ * For being an awesome tool that helped us to watch version dependencies. You will be missed, thanks you very much Robert.
+- __VersionEye__ * For being an awesome tool that helped us to watch version dependencies. You will be missed, thank you very much Robert.
 - __Sabine van Lommen__ * from __Zend.com__ for providing us a free developer licence of Zend Server
 - __Lucas (_hammermaps_)__ for the "Zend Data Cache" driver implementation
 - __Anton (_git-webmaster_)__ for kindly providing us a Couchbase server for deep tests purposes.
 
-\* Thanks to the companies that provided us free access to their products to help us to build a better quality software every days.
+\* Thanks to the companies that provided us free access to their products to help us to build a better quality software every day.
 
 But above all, many thanks to these companies to support indisputably Open Source Projects.
-Thanks to all the contributors that added their stone to the building. Each contribution made this project a bit better, every commits, every pull request you made contributed to make this project greater and better.
+Thanks to all the contributors that added their stone to the building. Each contribution made this project a bit better, every commit, every pull request you made contributed to make this project greater and better.
 
 #### Software licenses:
 
 - PHP License, version 3.0:
   - Pear (c) 2001-2004 PHP Group, http://pear.php.net
 
 - MIT licenced:
-  - Predis (c) 2009-2015 Daniele Alessandri, https://clorophilla.net
+  - Predis (c) 2009-2015 Daniele Alessandri, https://clorophilla.net

docs/EVENTS.md

@@ -1,4 +1,4 @@
-:mega: As of the V6, PhpFastCache provides an event mechanism.
+:mega: As of the V6, Phpfastcache provides an event mechanism.
 You can subscribe to an event by passing a Closure to an active event:
 
 ```php

docs/OPTIONS.md

@@ -1,22 +1,22 @@
-PhpFastCache has some options that you may want to know before using them, here's the list:
+Phpfastcache has some options that you may want to know before using them, here's the list:
 
 ### File-based drivers options *
 * **path** See the "**Host/Authenticating options**" section
 * **default_chmod** _| int>octal (default: 0777)_ `[>=V4, <V7]` This option will define the chmod used to write driver cache files.
 * **defaultChmod** _| int>octal (default: 0777)_ `[>=V7]` New configuration name of `default_chmod` as of V7
 * **securityKey** _| string (default: 'auto')_ `[>=V4]` A security key that define the subdirectory name. 'auto' value will be the HTTP_HOST value.
 * **htaccess** _| bool (default: true)_ `[>=V4]` Option designed to (dis)allow the auto-generation of .htaccess.
-* **autoTmpFallback** _| bool (default: false)_ `[>=V6]`Option designed to automatically attempt to fallback to temporary directory if the cache fails to write on the specified directory
-* **secureFileManipulation** _| bool (default: false)_ `[>=V6]` This option enforces a strict I/O manipulation policy by adding more integrity checks. This option may slow down the write operations, therefore you must use it with caution. In case of failure an **phpFastCacheIOException** exception will be thrown. Currently only supported by _Files_ driver.
-* **cacheFileExtension** _| string (default: 'txt')_ `[>=V6.0.2]` This allows you to setup a custom (but safe) cache file extension.
+* **autoTmpFallback** _| bool (default: false)_ `[>=V6]`Option designed to automatically attempt to fall back to temporary directory if the cache fails to write on the specified directory
+* **secureFileManipulation** _| bool (default: false)_ `[>=V6]` This option enforces a strict I/O manipulation policy by adding more integrity checks. This option may slow down the write operations, therefore you must use it with caution. In case of failure a **PhpfastcacheIOException** exception will be thrown. Currently, only supported by _Files_ driver.
+* **cacheFileExtension** _| string (default: 'txt')_ `[>=V6.0.2]` This allows you to set up a custom (but safe) cache file extension.
 
 \* Drivers like _Files_, _Sqlite_, _Leveldb_, etc.
 
 ### Global options
 * **fallback** _| string|bool_  (default: false)`[>=V4.2]` A driver name used in case the main driver stopped working. E.g. a missing php extension.
 * **fallbackConfig** _| ConfigurationOption|null_  (default: null)`[>=V7]` A dedicated `ConfigurationOption` object for the `fallback` driver, if needed.
-* **compress_data** _| bool (default: false)_ `[>=V4.3]` Compress stored data, if the backend supports it. Currently only supported by _Memcache(d)_ driver.
-* **limited_memory_each_object** _| int (default: 4096)_ `[>=V4.2]` Maximum size (bytes) of object stored in memory. Currently only supported by _Cookie_ driver.
+* **compress_data** _| bool (default: false)_ `[>=V4.3]` Compress stored data, if the backend supports it. Currently, only supported by _Memcache(d)_ driver.
+* **limited_memory_each_object** _| int (default: 4096)_ `[>=V4.2]` Maximum size (bytes) of object stored in memory. Currently, only supported by _Cookie_ driver.
 * **defaultTtl** _| int (default: 900)_ `[>=V5]` This option define a default ttl (time-to-live, in seconds) for item that has no specified expiration date/ttl.
 * **itemDetailedDate** _| bool (default: false)_ `[>=V6]` This option will define if the Items will make use of detailed dates such as Creation/modification date. Trying to access to these date without being explicitly enabled will throw a `LogicException`
 * **defaultKeyHashFunction** _| string (default: 'md5')_ `[>=V6]` This option will allow you to define a custom hash function for the `$item->getEncodedKey()` method. Callable objects are not allowed, but static method such as `\Absolute\Namespace\ToStatic::method` are allowed.
@@ -38,7 +38,7 @@ PhpFastCache has some options that you may want to know before using them, here'
 * **redisClient** _| \Redis (default: null)_ `[>=V7]` An optional Redis Client created outside Phpfastcache's scope. This option overrides every _Host/Authenticating_ options
 * **predisClient** _| \Predis\Client (default: null)_ `[>=V7]` An optional Predis Client created outside Phpfastcache's scope. This option overrides every _Host/Authenticating_ options
 
-These options differs depending the driver that you are using, see **/Examples** folder for more information about these options.
+These options differ depend on the driver that you are using, see **/Examples** folder for more information about these options.
 
 \* Drivers like _CouchBase_, _MongoDb_, _(P)redis_, _Ssdb_, etc.
 

lib/Phpfastcache/Drivers/Cassandra/Driver.php

@@ -60,7 +60,7 @@ public function getHelp(): string
 To install the php Cassandra extension via Pecl:
 <code>sudo pecl install cassandra</code>
 More information on: https://github.com/datastax/php-driver
-Please not that this repository only provide php stubs and C/C++ sources, it does NOT provide php client.
+Please note that this repository only provide php stubs and C/C++ sources, it does NOT provide php client.
 </p>
 HELP;
     }

lib/Phpfastcache/Drivers/Memstatic/Driver.php

@@ -73,11 +73,7 @@ protected function driverConnect(): bool
      */
     protected function driverRead(CacheItemInterface $item)
     {
-        $key = md5($item->getKey());
-        if (isset($this->staticStack[$key])) {
-            return $this->staticStack[$key];
-        }
-        return null;
+        return $this->staticStack[$item->getKey()] ?? null;
     }
 
     /**
@@ -91,7 +87,7 @@ protected function driverWrite(CacheItemInterface $item): bool
          * Check for Cross-Driver type confusion
          */
         if ($item instanceof Item) {
-            $this->staticStack[md5($item->getKey())] = $this->driverPreWrap($item);
+            $this->staticStack[$item->getKey()] = $this->driverPreWrap($item);
             return true;
         }
 
@@ -109,7 +105,7 @@ protected function driverDelete(CacheItemInterface $item): bool
          * Check for Cross-Driver type confusion
          */
         if ($item instanceof Item) {
-            $key = md5($item->getKey());
+            $key = $item->getKey();
             if (isset($this->staticStack[$key])) {
                 unset($this->staticStack[$key]);
                 return true;
@@ -135,4 +131,4 @@ protected function driverClear(): bool
         $this->staticStack = [];
         return true;
     }
-}
+}

lib/Phpfastcache/Helper/Psr16Adapter.php

@@ -232,6 +232,7 @@ public function has($key): bool
 
     /**
      * @return ExtendedCacheItemPoolInterface
+     * @internal
      */
     public function getInternalCacheInstance(): ExtendedCacheItemPoolInterface
     {

tests/Memstatic.test.php

@@ -12,33 +12,6 @@
 require_once __DIR__ . '/../vendor/autoload.php';
 $testHelper = new TestHelper('Memstatic driver');
 $cacheInstance = CacheManager::getInstance('Memstatic');
-$cacheKey = 'testItem';
-$randomStr = str_shuffle(sha1(uniqid('pfc', true) . mt_rand(100, 10000)));
-$testHelper->printText("Random-generated cache value for key '{$cacheKey}': {$randomStr}");
-
-$item = $cacheInstance->getItem($cacheKey);
-$item->set($randomStr)->expiresAfter(60);
-$cacheInstance->save($item);
-$cacheInstance->detachAllItems();
-unset($item);
-
-$item = $cacheInstance->getItem($cacheKey);
-
-$cacheResult = $cacheInstance->getItem($cacheKey)->get();
-
-if ($cacheResult === $randomStr) {
-    $testHelper->assertPass("The cache key value match, got expected value '{$cacheResult}'");
-} else {
-    $testHelper->assertFail("The cache key value match expected value '{$randomStr}', got '{$cacheResult}'");
-}
-$testHelper->printText('Clearing the whole cache to test item cleaning...');
-$cacheInstance->clear();
-$cacheResult = ($cacheInstance->getItem($cacheKey)->isHit() === false && $cacheInstance->getItem($cacheKey)->get() === null);
-
-if ($cacheResult === true) {
-    $testHelper->assertPass('The cache item is null as expected');
-} else {
-    $testHelper->assertFail('The cache is not null');
-}
 
+$testHelper->runCRUDTests($cacheInstance);
 $testHelper->terminateTest();