Php simple file caching

Saved searches

Use saved searches to filter your results more quickly

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

A light, simple but powerful PHP5 Cache Class which uses the filesystem for caching.

License

Pongtan/simple-file-cache

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Sign In Required

Please sign in to use Codespaces.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio Code

Your codespace will open once ready.

There was a problem preparing your codespace, please try again.

Latest commit

Git stats

Files

Failed to load latest commit information.

README.markdown

A light, simple but powerful PHP5 Cache Class which uses the filesystem for caching.
Your feedback is always welcome.

Basically the caching class stores its data in files in the JSON format. These files will be created if you store data under a Cache name.

If you set a new Cache name with setCache() , a new cache file will be generated. The Cache will store all further data in the new file. The Setter method allows you to switch between the different Cache files.

It’s not much trouble to setup the Cache.
First create a writable directory cache/ and include the Cache class:

 require_once 'cache.class.php'; // setup 'default' cache $c = new Cache(); ?>

Now we’ve setup the Cache instance and can start caching!

 // store a string $c->store('hello', 'Hello World!'); // generate a new cache file with the name 'newcache' $c->setCache('newcache'); // store an array $c->store('movies', array( 'description' => 'Movies on TV', 'action' => array( 'Tropic Thunder', 'Bad Boys', 'Crank' ) )); // get cached data by its key $result = $c->retrieve('movies'); // display the cached array echo '
'; print_r($result); echo '
'; // grab array entry $description = $result['description']; // switch back to the first cache $c->setCache('mycache'); // update entry by simply overwriting an existing key $c->store('hello', 'Hello everybody out there!'); // erase entry by its key $c->erase('hello'); ?>
 
You can also make use of the Method Chaining feature, introduced in PHP5. 
So you can do something like that:
 
 $c->setCache('mycache') // generate new file ->store('hello', 'world') // store data string ->retrieve('hello'); // retrieve cached data ?>
 
string gives you the basic setup. 
It's the name of your Cache (standard Cache name is 'default'):
 
array allows you to define multiple optional parameters:
 
new Cache(array( 'name' => 'YOUR-CACHE-NAME', 'path' => 'cache/', 'extension' => '.cache' )); 
 
If you don't define a Cache name with the constructor or the setCache() method, it'll be 'default'.
 
 
The key value defines a tag with which the cached data will be associated.
 
The data value can be any type of object (will be serialized).
 
The expiration value allows you to define an expiration time.
 
 
To change data you can overwrite it by using the same key identifier. 
Beside the data, the Cache will also store a timestamp.
 
A sample Cache entry looks like this:
 
< "christmas": < "time": 1324664631, "expire": 28000, "data": "s:29:"A great time to bake cookies.";" // serialized > >
 
Get particular cached data by its key. 
To retrieve the timestamp of a key, set the second parameter to true .
 
This allows you retrieve all the cached data at once. You get the meta data by setting the $meta argument to true .
 
For erasing cached data are these three methods available:
 
 
erase($key) Erases a single entry by its key.
 
eraseAll() Erases all entries from the Cache file.
 
eraseExpired() Erases all expired entries.
 
 
 // returns the count of erased entries echo $c->eraseExpired() . ' expired items erased!'; ?>
 
Check whether any data is associated with the given key. 
Returns true or false .
 
If you want to switch to another Cache or create a new one, then use this method to set a new Cache name.
 
The path to the Cache folder must end with a backslash: my_path_to_the_cache_folder/
 
The method returns the path to your current Cache file (the Cache name is always sh1 encoded):
 
cache/7505d64a54e061b7acd54ccd58b49dc43500b635.cache 
 
 
If you've done one, please let me know.
 
 
 
Upcoming: Simple Cache 2.0 
Implementation of an internal "soft cache", hash-sum handling and the switch to serialization. Thanks @dariushha for his contribution!
 
 
Simple Cache 1.6 - 04/01/2014
 
Simple Cache 1.5 - 01/01/2014
 
Simple Cache 1.4 - 08/09/2013
 
 
bug Fixed loading file twice in store() method.
 
bug Fixed retrieve() method - made it fail safe (thanks @dariushha).
 
 
Simple Cache 1.3 - 28/02/2013
 
 
update Updated docs for the added retrieveAll() method.
 
feature Added retrieveAll() method (thanks @rpnzl).
 
 
Simple Cache 1.2 - 09/05/2012
 
 
update Formatted code
 
bug Fixed isCached() method so that it works as expected (thanks @TigerWolf).
 
 
Simple Cache 1.1 - 01/01/2012
 
 
change The extension config has to start now with a dot.
 
feature Added expiration handling to the store() method
 
feature Added the methods eraseExpired() and eraseAll()
 
feature Added method to make sure that a writable directory exists
 
 
Simple Cache 1.0 - 29/12/2011
 
Simple Cache 0.9 - 25/12/2011
 
 
update Added Quick Start guide to the documentation
 
feature Added Method Chaining possibility
 
bug Fixed constructor configuration string/array handling
 
 
Simple Cache 0.8 - 24/12/2011
 
 
release First internal beta version (tested)
 
feature Added Setter and Getter methods
 
update Detailed documentation
 
 
Simple Cache 0.5 - 22/12/2011
 
Copyright (c) 2011-2013 - Programmed by Christian Metz / @cosenary 
Released under the BSD License.
 
About
 
A light, simple but powerful PHP5 Cache Class which uses the filesystem for caching.
 
Источник
 
Saved searches
 
Use saved searches to filter your results more quickly
 
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
 
Light, simple and standalone PHP in-file caching class
 
License
 
Wruczek/PHP-File-Cache
 
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
 
Name already in use
 
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
 
Sign In Required
 
Please sign in to use Codespaces.
 
Launching GitHub Desktop
 
If nothing happens, download GitHub Desktop and try again.
 
Launching GitHub Desktop
 
If nothing happens, download GitHub Desktop and try again.
 
Launching Xcode
 
If nothing happens, download Xcode and try again.
 
Launching Visual Studio Code
 
Your codespace will open once ready.
 
There was a problem preparing your codespace, please try again.
 
Latest commit
 
Git stats
 
Files
 
Failed to load latest commit information.
 
README.md 
 
Light, simple and standalone PHP in-file caching class
 
 
Light, standalone and simple
 
All code in one file - no pointless drivers.
 
Secure - every generated cache file have a php header with die , making direct access impossible even if someone knows the path and your server is not configured properly
 
Well documented and tested
 
Handles concurrency correctly via flock
 
Supports PHP 5.4.0 - 7.1+
 
Free under a MIT license
 
 
Requirements and Installation 
 
You need PHP 5.4.0+ for usage and PHP 5.6+ for development (PHPUnit)
 
Require with composer: 
composer require wruczek/php-file-cache
 
 use Wruczek\PhpFileCache\PhpFileCache; require_once __DIR__ . "/vendor/autoload.php"; $cache = new PhpFileCache(); $data = $cache->refreshIfExpired("simple-cache-test", function () < return date("H:i:s"); // return data to be cached >, 10); echo "Latest cache save: $data";
 
About
 
Light, simple and standalone PHP in-file caching class
 
Источник
 
PHP Simple File Caching Tutorial
 
 
Caching is the practice of storing data in and retrieving data from a file, database or memory so that future requests for that data can be served faster. The data stored in a cache might be the result of an earlier computation or duplicate of data. Memory is faster to access than a file, a remote URL, a database or any other external store of information. Besides that, caching is temporarily storing recently used information such as content, which includes HTML pages, images, files and Web objects to make it faster for the user to access it, which helps improve the efficiency of the computer and its overall performance. In this tutorial, I will cover on how to implements PHP simple file caching in your web page.
 
Add a new project
 
Start your PHP editor and web server, you can go to download PHPStorm and XMPP. Then open your PHP editor create a new project “php-cache-filing”.
 
Create a new folder
 
Right-click the package name and create a new folder “cache”. This folder is to create a cache file after load the web page.
 
Create a new PHP file
 
After creating a project, right click your project name and create a new PHP file “example”. The following source code is the sample implementation of caching the file. After load the web page, it will generate a cache file in your cache folder. If the cache folder existing file, it will load from the existing file.
 
 // a function that opens and and puts the data into a single var function read_content($path) < $f = fopen($path, 'r'); $buffer = ''; while(!feof($f)) < $buffer .= fread($f, 2048); >fclose($f); return $buffer; > // our default cache file and URL $cache_file = 'C:/xampp/htdocs/php-file-cache/cache/cache.page.php'; $url = '//www.linkedin.com/'; if (file_exists($cache_file)) < // is there a cache file? $timedif = (time() - filemtime($cache_file)); // how old is the file? if ($timedif < 3600*24) < // get a new file 24 hours $html = read_content($cache_file); // read the content from cache >else < // create a new cache file $html = get_and_write($url, $cache_file); >> else < // no file? create a cache file $html = get_and_write($url, $cache_file); >echo $html; // End of code echo "Time Elapsed: ".(microtime(true) - $time)."s"; ?>
 
Run your project
 
Now, you can run example.php in your browser. It will load a web page, if web page cache not exists, it will generate a new cache file.
 
Note : you can check the loading speed in the bottom of the page to compare with file caching aprroach.
 
Источник