https://github.com/cakephp/cache

[READ-ONLY] Easy to use Caching library with support for multiple caching backends. This repo is a split of the main code that can be found in https://github.com/cakephp/cakephp
https://github.com/cakephp/cache

Last synced: about 1 month ago
JSON representation

[READ-ONLY] Easy to use Caching library with support for multiple caching backends. This repo is a split of the main code that can be found in https://github.com/cakephp/cakephp

• Host: GitHub
• URL: https://github.com/cakephp/cache
• Owner: cakephp
• License: other
• Created: 2014-10-01T13:06:49.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-04T02:50:43.000Z (2 months ago)
• Last Synced: 2024-10-29T17:35:34.306Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 16.4 MB
• Stars: 51
• Watchers: 30
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-php - CakePHP Cache - A caching library. (Table of Contents / Caching and Locking)
• awesome-php-cn - CakePHP Cache - 缓存库. (目录 / 缓存和锁定 Caching and Locking)
• awesome-projects - CakePHP Cache - A caching library. (PHP / Caching and Locking)
• awesome-php - CakePHP Cache - A caching library. (Table of Contents / Caching and Locking)

README

        
# CakePHP Caching Library

The Cache library provides a `Cache` service locator for interfacing with multiple caching backends using

a simple to use interface.

The caching backends supported are:

* Files

* APC

* Memcached

* Redis

* Wincache

* Xcache

## Usage

Caching engines need to be configured with the `Cache::config()` method.

```php

use Cake\Cache\Cache;

// Using a short name

Cache::config('default', [

    'className' => 'File',

    'duration' => '+1 hours',

    'path' => sys_get_tmp_dir(),

    'prefix' => 'my_app_'

]);

// Using a fully namespaced name.

Cache::config('long', [

    'className' => \Cake\Cache\Engine\ApcuEngine::class,

    'duration' => '+1 week',

    'prefix' => 'my_app_'

]);

// Using a constructed object.

$object = new FileEngine($config);

Cache::config('other', $object);

```

You can now read and write from the cache:

```php

$data = Cache::remember('my_cache_key', function () {

	return Service::expensiveCall();

});

```

The code above will try to look for data stored in cache under the `my_cache_key`, if not found

the callback will be executed and the returned data will be cached for future calls.

## Documentation

Please make sure you check the [official documentation](https://book.cakephp.org/4/en/core-libraries/caching.html)