Require cache key to be a string, added test for cache key

src/PhpFileCache.php

@@ -51,20 +51,21 @@ class PhpFileCache {
      * @param string $cacheDirPath cache directory. Must end with "/"
      * @param string $cacheFileName cache file name
      * @param string $cacheFileExtension cache file extension. Must end with .php
-     * @throws \Exception if there is a problem with loading the cache
+     * @throws \Exception if there is a problem loading the cache
      */
     public function __construct($cacheDirPath = "cache/", $cacheFileName = "defaultcache", $cacheFileExtension = ".cache.php") {
         $this->setCacheFilename($cacheFileName);
         $this->setCacheDir($cacheDirPath);
         $this->setCacheFileExtension($cacheFileExtension);
+        $this->setDevMode(false);
 
         $this->reloadFromDisc();
     }
 
     /**
      * Loads cache
      * @return array array filled with data
-     * @throws \Exception if there is a problem with loading the cache
+     * @throws \Exception if there is a problem loading the cache
      */
     private function loadCacheFile() {
         $filepath = $this->getCacheFilePath();
@@ -131,6 +132,10 @@ private function saveCacheFile() {
      * @throws \Exception if the file cannot be saved
      */
     public function store($key, $data, $expiration = 60, $permanent = false) {
+        if(!is_string($key)) {
+            throw new \InvalidArgumentException('$key must be a string, got type "' . get_class($key) . '" instead');
+        }
+
         if ($this->isDevMode())
             $expiration = 1;
 
@@ -301,7 +306,7 @@ public function debugCache() {
     /**
      * Reloads cache from disc. Can be used after changing file name, extension or cache dir
      * using functions instead of constructor. (This class loads data once, when is created)
-     * @throws \Exception if there is a problem with loading the cache
+     * @throws \Exception if there is a problem loading the cache
      */
     public function reloadFromDisc() {
         // Try to load the cache, otherwise create a empty array
@@ -312,8 +317,13 @@ public function reloadFromDisc() {
      * Returns md5 hash of the given string.
      * @param $str string String to be hashed
      * @return string MD5 hash
+     * @throws \InvalidArgumentException if $str is not a string
      */
     private function getStringHash($str) {
+        if(!is_string($str)) {
+            throw new \InvalidArgumentException('$key must be a string, got type "' . get_class($str) . '" instead');
+        }
+
         return md5($str);
     }
 
@@ -379,8 +389,13 @@ public function getCacheFilename() {
      * Sets new cache file name. If you want to read data from new file, consider calling reloadFromDisc.
      * @param string $cacheFilename
      * @return $this
+     * @throws \InvalidArgumentException if $cacheFilename is not a string
      */
     public function setCacheFilename($cacheFilename) {
+        if(!is_string($cacheFilename)) {
+            throw new \InvalidArgumentException('$key must be a string, got type "' . get_class($cacheFilename) . '" instead');
+        }
+
         $this->cacheFilename = $cacheFilename;
         $this->cacheFilenameHashed = $this->getStringHash($cacheFilename);
         return $this;

tests/PhpFileCacheTest.php

@@ -53,6 +53,14 @@ public function testStore() {
         self::assertFalse($cache->isExpired("test"));
     }
 
+    public function testKeyCharacters() {
+        $cache = new PhpFileCache(self::__TESTDIR);
+
+        foreach (["'", "\"", "test & test", "óÓłć€$123"] as $key) {
+            self::assertSame($this->testarray, $cache->store($key, $this->testarray)->retrieve($key));
+        }
+    }
+
     public function testRetrieve() {
         $cache = new PhpFileCache(self::__TESTDIR);