thecodingmachine / utils.cache.file-cache

src/BigFileCache.php

Doc Comments +6 added lines, -1 removed lines

@@ -69,7 +69,6 @@ 
      * @param LoggerInterface|LogInterface $log

      * @param string $cacheDirectory

      * @param boolean $relativeToSystemTempDirectory

-     * @param int $hashDepth

      */

     function __construct($defaultTimeToLive, $log, $cacheDirectory, $relativeToSystemTempDirectory)

     {

@@ -263,6 +262,9 @@ 
 		return $dir.$subFolder;

 	}

 

+	/**
+	 * @param string $key
+	 */
 	protected function getFileName($key) {

         $subFolder = $this->getDirectory($key);

 		// Remove any "/" and ":" from the name, and replace those with "_" ...

@@ -281,6 +283,9 @@ 
 		return $subFolder.md5($key).'.cache';

 	}

 

+    /**
+     * @param string $dir
+     */
     private static function rrmdir($dir) {

         if (is_dir($dir)) {

             $objects = scandir($dir);

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,7 +1,7 @@
 <?php

 namespace Mouf\Utils\Cache;

 

-use Mouf\Utils\Log\LogInterface;

+use Mouf\Utils\Log\LogInterface;
 use Psr\Log\LoggerInterface;

 

 /**

Indentation +78 added lines, -78 removed lines

@@ -34,7 +34,7 @@ 
 	 * @Property

 	 * @var int

 	 */

-    private $defaultTimeToLive;

+	private $defaultTimeToLive;

 	

 	/**

 	 * The logger used to trace the cache activity.

@@ -42,7 +42,7 @@ 
 	 *

 	 * @var LoggerInterface|LogInterface

 	 */

-    private $log;

+	private $log;

 

 	/**

 	 * The directory the files are stored in.

@@ -52,7 +52,7 @@ 
 	 * @Property

 	 * @var string

 	 */

-    private $cacheDirectory;

+	private $cacheDirectory;

 		

 	/**

 	 * Whether the directory is relative to the system temp directory or not.

@@ -60,49 +60,49 @@ 
 	 * @Property

 	 * @var boolean

 	 */

-    private $relativeToSystemTempDirectory = true;

+	private $relativeToSystemTempDirectory = true;

 

-    private $hashDepth = 2;

+	private $hashDepth = 2;

 

-    /**

-     * @param int $defaultTimeToLive

-     * @param LoggerInterface|LogInterface $log

-     * @param string $cacheDirectory

-     * @param boolean $relativeToSystemTempDirectory

-     * @param int $hashDepth

-     */

-    function __construct($defaultTimeToLive, $log, $cacheDirectory, $relativeToSystemTempDirectory)

-    {

-        $this->defaultTimeToLive = $defaultTimeToLive;

-        $this->log = $log;

-        $this->cacheDirectory = $cacheDirectory;

-        $this->relativeToSystemTempDirectory = $relativeToSystemTempDirectory;

-    }

+	/**

+	 * @param int $defaultTimeToLive

+	 * @param LoggerInterface|LogInterface $log

+	 * @param string $cacheDirectory

+	 * @param boolean $relativeToSystemTempDirectory

+	 * @param int $hashDepth

+	 */

+	function __construct($defaultTimeToLive, $log, $cacheDirectory, $relativeToSystemTempDirectory)

+	{

+		$this->defaultTimeToLive = $defaultTimeToLive;

+		$this->log = $log;

+		$this->cacheDirectory = $cacheDirectory;

+		$this->relativeToSystemTempDirectory = $relativeToSystemTempDirectory;

+	}

 

-    /**

-     * Must be between 1 and 4

-     * Sets the length of the subdirectory. The higher it is, the more subfolders will be created, but the lesser cache file they will contain.

-     * Max count of subfolders is 16^$hashDepth, so you cannot set a depth higher then 4 as it could create more than 1 000 000 subfolders

-     * As an example :

-     *    - 1 000 000 items are stored into 256 subfolders for $hashDepth == 2, witch means around 4 000 files per folder

-     *    - 1 000 000 items are stored into 4096 subfolders for $hashDepth == 3, witch means around 250 files per folder

-     *

-     * If you consider caching more than 1 000 000 items, you should consider another cache service

-     *

-     * @param int $hashDepth

-     */

-    public function setHashDepth($hashDepth)

-    {

-        if ($hashDepth > 4 || $hashDepth < 1){

-            throw new \Exception("hashDepth property should be betwwen 1 and 4");

-        }

-        $this->hashDepth = $hashDepth;

-    }

+	/**

+	 * Must be between 1 and 4

+	 * Sets the length of the subdirectory. The higher it is, the more subfolders will be created, but the lesser cache file they will contain.

+	 * Max count of subfolders is 16^$hashDepth, so you cannot set a depth higher then 4 as it could create more than 1 000 000 subfolders

+	 * As an example :

+	 *    - 1 000 000 items are stored into 256 subfolders for $hashDepth == 2, witch means around 4 000 files per folder

+	 *    - 1 000 000 items are stored into 4096 subfolders for $hashDepth == 3, witch means around 250 files per folder

+	 *

+	 * If you consider caching more than 1 000 000 items, you should consider another cache service

+	 *

+	 * @param int $hashDepth

+	 */

+	public function setHashDepth($hashDepth)

+	{

+		if ($hashDepth > 4 || $hashDepth < 1){

+			throw new \Exception("hashDepth property should be betwwen 1 and 4");

+		}

+		$this->hashDepth = $hashDepth;

+	}

 

 

 

 

-    /**

+	/**

 	 * Returns the cached value for the key passed in parameter.

 	 *

 	 * @param string $key

@@ -112,11 +112,11 @@ 
 		$filename = $this->getFileName($key);

 

 		if (is_readable($filename)) {

-            $fp = fopen($filename, "r");

-            if ($fp === false) {//File may have been deleted between is_readable and fopen

-                return null;

-            }

-            $timeout = fgets($fp);

+			$fp = fopen($filename, "r");

+			if ($fp === false) {//File may have been deleted between is_readable and fopen

+				return null;

+			}

+			$timeout = fgets($fp);

 			

 			if ($timeout > time() || $timeout==0) {

 				$contents = "";

@@ -176,7 +176,7 @@ 
 			}

 		}

 

-        $oldUmask = umask(0);

+		$oldUmask = umask(0);

 		$subfolder = $this->getDirectory($key);

 		if (!is_writable($filename)) {

 			if (!file_exists($subfolder)) {

@@ -198,10 +198,10 @@ 
 		fwrite($fp, $timeOut."\n");

 		fwrite($fp, serialize($value));

 		fclose($fp);

-        // Cache is shared with group, not with the rest of the world.

-        chmod($filename, 0660);

+		// Cache is shared with group, not with the rest of the world.

+		chmod($filename, 0660);

 

-        umask($oldUmask);

+		umask($oldUmask);

 	}

 	

 	/**

@@ -235,13 +235,13 @@ 
 				$this->log->trace("Purging the whole file cache.");

 			}

 		}

-        self::rrmdir($this->getDirectory());

+		self::rrmdir($this->getDirectory());

 	}

 

-    /**

-     * @param mixed $key : if set, this function will return the cache directory WITH subfolder

-     * @return string

-     */

+	/**

+	 * @param mixed $key : if set, this function will return the cache directory WITH subfolder

+	 * @return string

+	 */

 	protected function getDirectory($key = null) {

 

 		$dir = "";

@@ -254,26 +254,26 @@ 
 			$dir .= "filecache/";

 		}

 

-        if ($key){

-            $subFolder = substr(hash("sha256", $key), 0, $this->hashDepth) . "/";

-        }else{

-            $subFolder = "";

-        }

+		if ($key){

+			$subFolder = substr(hash("sha256", $key), 0, $this->hashDepth) . "/";

+		}else{

+			$subFolder = "";

+		}

 

 		return $dir.$subFolder;

 	}

 

 	protected function getFileName($key) {

-        $subFolder = $this->getDirectory($key);

+		$subFolder = $this->getDirectory($key);

 		// Remove any "/" and ":" from the name, and replace those with "_" ...

 		$key = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $key);

 

-        // Windows full path need to be less than 260 characters. We need to limit the size of the filename

-        $fullPath = $subFolder.$key.".cache";

+		// Windows full path need to be less than 260 characters. We need to limit the size of the filename

+		$fullPath = $subFolder.$key.".cache";

 

-        // Approximative value due to NTFS short file names (e.g. PROGRA~1) that get longer when evaluated by Windows

-        if (strlen($fullPath)<160) {

-            return $fullPath;

+		// Approximative value due to NTFS short file names (e.g. PROGRA~1) that get longer when evaluated by Windows

+		if (strlen($fullPath)<160) {

+			return $fullPath;

 		}

 		

 

@@ -281,18 +281,18 @@ 
 		return $subFolder.md5($key).'.cache';

 	}

 

-    private static function rrmdir($dir) {

-        if (is_dir($dir)) {

-            $objects = scandir($dir);

-            foreach ($objects as $object) {

-                if ($object != "." && $object != "..") {

-                    if (filetype($dir."/".$object) == "dir")

-                        self::rrmdir($dir."/".$object);

-                    else unlink   ($dir."/".$object);

-                }

-            }

-            reset($objects);

-            rmdir($dir);

-        }

-    }

+	private static function rrmdir($dir) {

+		if (is_dir($dir)) {

+			$objects = scandir($dir);

+			foreach ($objects as $object) {

+				if ($object != "." && $object != "..") {

+					if (filetype($dir."/".$object) == "dir")

+						self::rrmdir($dir."/".$object);

+					else unlink   ($dir."/".$object);

+				}

+			}

+			reset($objects);

+			rmdir($dir);

+		}

+	}

 }

Spacing +7 added lines, -7 removed lines

@@ -93,7 +93,7 @@ 
      */

     public function setHashDepth($hashDepth)

     {

-        if ($hashDepth > 4 || $hashDepth < 1){

+        if ($hashDepth > 4 || $hashDepth < 1) {

             throw new \Exception("hashDepth property should be betwwen 1 and 4");

         }

         $this->hashDepth = $hashDepth;

@@ -118,7 +118,7 @@ 
             }

             $timeout = fgets($fp);

 			

-			if ($timeout > time() || $timeout==0) {

+			if ($timeout > time() || $timeout == 0) {

 				$contents = "";

 				while (!feof($fp)) {

 				  $contents .= fread($fp, 65536);

@@ -254,9 +254,9 @@ 
 			$dir .= "filecache/";

 		}

 

-        if ($key){

-            $subFolder = substr(hash("sha256", $key), 0, $this->hashDepth) . "/";

-        }else{

+        if ($key) {

+            $subFolder = substr(hash("sha256", $key), 0, $this->hashDepth)."/";

+        } else {

             $subFolder = "";

         }

 

@@ -272,7 +272,7 @@ 
         $fullPath = $subFolder.$key.".cache";

 

         // Approximative value due to NTFS short file names (e.g. PROGRA~1) that get longer when evaluated by Windows

-        if (strlen($fullPath)<160) {

+        if (strlen($fullPath) < 160) {

             return $fullPath;

 		}

 		

@@ -288,7 +288,7 @@ 
                 if ($object != "." && $object != "..") {

                     if (filetype($dir."/".$object) == "dir")

                         self::rrmdir($dir."/".$object);

-                    else unlink   ($dir."/".$object);

+                    else unlink($dir."/".$object);

                 }

             }

             reset($objects);

Braces +6 added lines, -4 removed lines

@@ -256,7 +256,7 @@ 
 

         if ($key){

             $subFolder = substr(hash("sha256", $key), 0, $this->hashDepth) . "/";

-        }else{

+        } else{

             $subFolder = "";

         }

 

@@ -286,9 +286,11 @@ 
             $objects = scandir($dir);

             foreach ($objects as $object) {

                 if ($object != "." && $object != "..") {

-                    if (filetype($dir."/".$object) == "dir")

-                        self::rrmdir($dir."/".$object);

-                    else unlink   ($dir."/".$object);

+                    if (filetype($dir."/".$object) == "dir") {

+                                            self::rrmdir($dir."/".$object);

+                    } else {

+                    	unlink   ($dir."/".$object);

+                    }

                 }

             }

             reset($objects);

src/FileCacheInstaller.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -1,7 +1,7 @@
 <?php

 namespace Mouf\Utils\Cache;

 

-use Mouf\Installer\PackageInstallerInterface;

+use Mouf\Installer\PackageInstallerInterface;
 use Mouf\MoufManager;

 

 /**

Indentation +21 added lines, -21 removed lines

@@ -9,30 +9,30 @@
  */

 class FileCacheInstaller implements PackageInstallerInterface {

 

-    /**

-     * (non-PHPdoc)

-     * @see \Mouf\Installer\PackageInstallerInterface::install()

-     */

-    public static function install(MoufManager $moufManager) {

-        if (!$moufManager->instanceExists("fileCacheService")) {

-            $fileCacheService = $moufManager->createInstance("Mouf\\Utils\\Cache\\FileCache");

-            $fileCacheService->setName("fileCacheService");

-            $fileCacheService->getProperty("defaultTimeToLive")->setValue(3600);

-            /*if ($moufManager->instanceExists("psr.errorLogLogger")) {

+	/**

+	 * (non-PHPdoc)

+	 * @see \Mouf\Installer\PackageInstallerInterface::install()

+	 */

+	public static function install(MoufManager $moufManager) {

+		if (!$moufManager->instanceExists("fileCacheService")) {

+			$fileCacheService = $moufManager->createInstance("Mouf\\Utils\\Cache\\FileCache");

+			$fileCacheService->setName("fileCacheService");

+			$fileCacheService->getProperty("defaultTimeToLive")->setValue(3600);

+			/*if ($moufManager->instanceExists("psr.errorLogLogger")) {

                 $fileCacheService->getProperty("log")->setValue($moufManager->getInstanceDescriptor("psr.errorLogLogger"));

             }*/

-        } else {

-            $fileCacheService = $moufManager->getInstanceDescriptor("fileCacheService");

-        }

+		} else {

+			$fileCacheService = $moufManager->getInstanceDescriptor("fileCacheService");

+		}

 

-        $configManager = $moufManager->getConfigManager();

-        $constants = $configManager->getMergedConstants();

-        if (isset($constants['SECRET'])) {

-            $fileCacheService->getProperty('prefix')->setValue('SECRET')->setOrigin('config');

-        }

+		$configManager = $moufManager->getConfigManager();

+		$constants = $configManager->getMergedConstants();

+		if (isset($constants['SECRET'])) {

+			$fileCacheService->getProperty('prefix')->setValue('SECRET')->setOrigin('config');

+		}

 

-        // Let's rewrite the MoufComponents.php file to save the component

-        $moufManager->rewriteMouf();

-    }

+		// Let's rewrite the MoufComponents.php file to save the component

+		$moufManager->rewriteMouf();

+	}

 }

 ?>
\ No newline at end of file

src/FileCache.php

Indentation +11 added lines, -11 removed lines

@@ -66,11 +66,11 @@ 
 		$filename = $this->getFileName($key);

 

 		if (is_readable($filename)) {

-            $fp = fopen($filename, "r");

-            if ($fp === false) {//File may have been deleted between is_readable and fopen

-                return null;

-            }

-            $timeout = fgets($fp);

+			$fp = fopen($filename, "r");

+			if ($fp === false) {//File may have been deleted between is_readable and fopen

+				return null;

+			}

+			$timeout = fgets($fp);

 			

 			if ($timeout > time() || $timeout==0) {

 				$contents = "";

@@ -130,7 +130,7 @@ 
 			}

 		}

 

-        $oldUmask = umask(0);

+		$oldUmask = umask(0);

 		

 		if (!is_writable($filename)) {

 			if (!file_exists($this->getDirectory())) {

@@ -152,10 +152,10 @@ 
 		fwrite($fp, $timeOut."\n");

 		fwrite($fp, serialize($value));

 		fclose($fp);

-        // Cache is shared with group, not with the rest of the world.

-        chmod($filename, 0660);

+		// Cache is shared with group, not with the rest of the world.

+		chmod($filename, 0660);

 

-        umask($oldUmask);

+		umask($oldUmask);

 	}

 	

 	/**

@@ -190,10 +190,10 @@ 
 			}

 		}

 		$files = glob($this->getDirectory()."*");

-        $prefixFile = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix);

+		$prefixFile = str_replace(array("_", "/", "\\", ":"), array("___", "_s_", "_b_", "_d_"), $this->prefix);

 		foreach ($files as $filename) {

 			if (empty($prefixFile) || strpos(basename($filename), $prefixFile) === 0) {

-		    	unlink($filename);

+				unlink($filename);

 			}

 		}

 	}

Spacing +2 added lines, -2 removed lines

@@ -72,7 +72,7 @@ 
             }

             $timeout = fgets($fp);

 			

-			if ($timeout > time() || $timeout==0) {

+			if ($timeout > time() || $timeout == 0) {

 				$contents = "";

 				while (!feof($fp)) {

 				  $contents .= fread($fp, 65536);

@@ -220,7 +220,7 @@ 
 		$fullPath = $this->getDirectory().$key.".cache";

 		

 		// Approximative value due to NTFS short file names (e.g. PROGRA~1) that get longer when evaluated by Windows

-		if (strlen($fullPath)<160) {

+		if (strlen($fullPath) < 160) {

 			return $fullPath;

 		}

 		

src/PhpFileCache.php

Indentation +13 added lines, -13 removed lines

@@ -83,7 +83,7 @@ 
 			}

 		}

 

-        $oldUmask = umask(0);

+		$oldUmask = umask(0);

 

 		if (!is_writable($filename)) {

 			if (!file_exists($this->getDirectory())) {

@@ -106,20 +106,20 @@ 
 			'data'      => $value

 		);

 

-        $serializeData = serialize($data);

-        if(strpos($serializeData, 'r:') !== false || (is_object($value) && !method_exists($value, '__set_state'))){

-            $code   = sprintf('<?php return unserialize(%s);', var_export($serializeData, true));

-            file_put_contents($filename, $code);

-        }else{

-            $data  = var_export($data, true);

-            $code   = sprintf('<?php return %s;', $data);

-            file_put_contents($filename, $code);

-        }

+		$serializeData = serialize($data);

+		if(strpos($serializeData, 'r:') !== false || (is_object($value) && !method_exists($value, '__set_state'))){

+			$code   = sprintf('<?php return unserialize(%s);', var_export($serializeData, true));

+			file_put_contents($filename, $code);

+		}else{

+			$data  = var_export($data, true);

+			$code   = sprintf('<?php return %s;', $data);

+			file_put_contents($filename, $code);

+		}

 

-        // Cache is shared with group, not with the rest of the world.

-        chmod($filename, 0660);

+		// Cache is shared with group, not with the rest of the world.

+		chmod($filename, 0660);

 

-        umask($oldUmask);

+		umask($oldUmask);

 	}

 

 }

Spacing +6 added lines, -6 removed lines

@@ -31,7 +31,7 @@ 
 	public function get($key) {

 		$filename = $this->getFileName($key);

 

-		if ( ! is_file($filename)) {

+		if (!is_file($filename)) {

 			if ($this->log) {

 				if ($this->log instanceof LoggerInterface) {

 					$this->log->info("Retrieving key '{key}' from file cache: cache miss.", array('key'=>$key));

@@ -107,12 +107,12 @@ 
 		);

 

         $serializeData = serialize($data);

-        if(strpos($serializeData, 'r:') !== false || (is_object($value) && !method_exists($value, '__set_state'))){

-            $code   = sprintf('<?php return unserialize(%s);', var_export($serializeData, true));

+        if (strpos($serializeData, 'r:') !== false || (is_object($value) && !method_exists($value, '__set_state'))) {

+            $code = sprintf('<?php return unserialize(%s);', var_export($serializeData, true));

             file_put_contents($filename, $code);

-        }else{

-            $data  = var_export($data, true);

-            $code   = sprintf('<?php return %s;', $data);

+        } else {

+            $data = var_export($data, true);

+            $code = sprintf('<?php return %s;', $data);

             file_put_contents($filename, $code);

         }

 

Braces +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
         if(strpos($serializeData, 'r:') !== false || (is_object($value) && !method_exists($value, '__set_state'))){

             $code   = sprintf('<?php return unserialize(%s);', var_export($serializeData, true));

             file_put_contents($filename, $code);

-        }else{

+        } else{

             $data  = var_export($data, true);

             $code   = sprintf('<?php return %s;', $data);

             file_put_contents($filename, $code);