Composer integration

Author: rothkj1022

README.md

@@ -3,22 +3,57 @@ PHP Cache Class (File base)
 A simple file based cache based from Erik Giberti's FileCache class. See [here](http://af-design.com/blog/2010/07/30/simple-file-based-caching-in-php/)
 
 ## Enhanced Features
+
 * Data is serialized and JSON encoded
 * Cache data is encrypted by `mcrypt`
 * File Based Cache was explained [here](http://af-design.com/blog/2010/07/30/simple-file-based-caching-in-php/)
 
 ## Installation
+
+Run the following command in your command line shell in your php project
+
+```sh
+$ composer require rothkj1022/php-cache-class
+```
+
+Done.
+
+You may also edit composer.json manually then perform ```composer update```:
+
+```
+"require": {
+    "rothkj1022/php-cache-class": "^2.1.0"
+}
+```
+
+## Getting started
+
+### Example usage with composer
+
+```php
+//load composer packages
+require('vendor/autoload.php');
+
+//create new instance of the class
+use rothkj1022\Cache;
+$cache = new Cache\Cache("tmp/");
+```
+
+### Example usage without composer
+
 ```php
 //require the class
-require_once("lib/class.cache.php");
+require_once("lib/Cache.php");
 
 //create new instance of the class
-$cache = new Cache("tmp/");
+use rothkj1022\Cache;
+$cache = new Cache\Cache("tmp/");
 
 //...
 ```
 
 ## Sample Call
+
 ```php
 $cache_key = "client_list";
 
@@ -29,37 +64,50 @@ if (!$clients_data = $cache->get($cache_key)) {
 
     //set the cache up!
     $expire = 3600; //1 hour
-    $cache->set($cache_key, $clients_data, $expire); 
+    $cache->set($cache_key, $clients_data, $expire);
 }
 
 var_dump($clients_data);
 ```
 
 ## Reference
+
 Code reference for you to get started!
 
 ### Properties
+
 * `protected $root = '/tmp/';` - Value is pre-pended to the cache, should be the full path to the directory.
 * `protected $error = null;` - For holding any error messages that may have been raised
 * `private $_encryption_key = 'Fil3C@ch33ncryptionK3y'` - Main key used for encryption (you need to set this up inside the class)
 
 ### Methods
+
 #### Public Methods
+
 * `Cache::get($key)` - Reads the data from the cache specified by the cache key
 * `Cache::set($key [, $data, $ttl])` - Saves data to the cache. Anything that evaluates to false, null, '', boolean false, 0 will not be saved. `$ttl` Specifies the expiry time
 * `Cache::delete($key)` - Deletes the cache specified by the `$key`
 * `Cache::get_error()` - Reads and clears the internal error
 * `Cache::have_error()` - Can be used to inspect internal error
 
 #### Private Methods
-See code to see all private methods used like `Cahce::_encrypt($pure_string)` etc.
 
-## Feedback
-All bugs, feature requests, pull requests, feedback, etc., are welcome. Visit my site at [www.lodev09.com](http://www.lodev09.com "www.lodev09.com") or email me at [[email protected]](mailto:[email protected])
+See code to see all private methods used like `Cache::_encrypt($pure_string)` etc.
+
+## Changelog
+
+### Version 2.1.0
+
+* Added: Composer integration
+* Added: changelog
 
 ## Credits
-© 2011-2014 - Coded by Jovanni Lo / [@lodev09](http://twitter.com/lodev09)  
+
+2010 - Authored by Erik Giberti
+2011-2014 - Rewritten by Jovanni Lo / [@lodev09](https://twitter.com/lodev09)
+2018 - Modified by Kevin Roth / [@rothkj1022](https://twitter.com/rothkj1022)
 
 ## License
+
 Released under the [MIT License](http://opensource.org/licenses/MIT).
 See [LICENSE](LICENSE) file.

composer.json

@@ -0,0 +1,28 @@
+{
+	"name": "rothkj1022/php-cache-class",
+	"description": "A simple file based cache based from Erik Giberti's FileCache class, forked from lodev09/php-cache-class.",
+	"type": "library",
+	"license": "MIT",
+	"authors": [
+		{
+			"name": "Erik Giberti"
+		},
+		{
+            "name": "Jovanni Lo",
+            "email": "[email protected]",
+            "homepage": "http://www.lodev09.com/"
+        },
+        {
+			"name": "Kevin Roth",
+            "homepage": "https://kevinroth.com/"
+		}
+	],
+		"require": {
+		"php": "^5.2 || ^7.0"
+	},
+	"autoload": {
+		"psr-4": {
+			"rothkj1022\\Cache\\": "lib"
+		}
+	}
+}

index.php renamed to example.php

@@ -1,10 +1,11 @@
 <?php
 
 //require the class
-require_once("lib/class.cache.php");
+require_once("lib/Cache.php");
 
 //create new instance of the class
-$cache = new Cache("tmp/");
+use rothkj1022\Cache;
+$cache = new Cache\Cache("tmp/");
 
 $cache_key = "client_list";
 
@@ -15,8 +16,7 @@
 
     //set the cache up!
     $expire = 3600; //1 hour
-    $cache->set($cache_key, $clients_data, $expire); 
+    $cache->set($cache_key, $clients_data, $expire);
 }
 
 var_dump($clients_data);
-?>

lib/class.cache.php renamed to lib/Cache.php

@@ -1,9 +1,12 @@
 <?php
+namespace rothkj1022\Cache;
 
 /**
  * @package Cache - A simple file based cache (based from Erik Giberti's FileCache class. http://af-design.com/blog/2010/07/30/simple-file-based-caching-in-php/)
  * @link http://www.lodev09.com
+ * @author Erik Giberti
  * @author Jovanni Lo
+ * @author Kevin Roth
  * @copyright 2014 Jovanni Lo, all rights reserved
  * @license
  * The MIT License (MIT)
@@ -250,7 +253,7 @@ private function _decrypt($encrypted_string) {
             $iv_size = openssl_cipher_iv_length($this->_encryption_method);
             $iv = mb_substr($encrypted_string, 0, $iv_size, '8bit');
             $ciphertext = mb_substr($encrypted_string, $iv_size, null, '8bit');
-            
+
             $decrypted_string = openssl_decrypt($ciphertext, $this->_encryption_method, $this->_encryption_key, OPENSSL_RAW_DATA, $iv);
         }
         return $decrypted_string;