https://github.com/yiisoft/cache-memcached
Yii Cache Library - Memcached Handler
https://github.com/yiisoft/cache-memcached
cache cache-storage hacktoberfest memcached psr-16 yii3
Last synced: 3 months ago
JSON representation
Yii Cache Library - Memcached Handler
- Host: GitHub
- URL: https://github.com/yiisoft/cache-memcached
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-05-02T12:39:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T23:07:23.000Z (about 1 year ago)
- Last Synced: 2024-04-15T03:05:27.774Z (about 1 year ago)
- Topics: cache, cache-storage, hacktoberfest, memcached, psr-16, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 146 KB
- Stars: 13
- Watchers: 19
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Cache Library - Memcached Handler
[](https://packagist.org/packages/yiisoft/cache-memcached)
[](https://packagist.org/packages/yiisoft/cache-memcached)
[](https://github.com/yiisoft/cache-memcached/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/yiisoft/cache-memcached/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/cache-memcached/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cache-memcached/master)
[](https://github.com/yiisoft/cache-memcached/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/cache-memcached)
This package provides the [Memcached](https://www.php.net/manual/book.memcached.php)
handler and implements [PSR-16](https://www.php-fig.org/psr/psr-16/) cache.
This option can be considered as the fastest one when dealing with a cache in
a distributed applications (e.g. with several servers, load balancers, etc.).
## Requirements
- PHP 8.0 or higher.
- `Memcached` PHP extension.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/cache-memcached
```
## Configuration
Creating an instance:
```php
$cache = new \Yiisoft\Cache\Memcached\Memcached($persistentId, $servers);
```
`$persistentId (string)` - The ID that identifies the Memcached instance is an empty string by default.
By default, the Memcached instances are destroyed at the end of the request.
To create an instance that persists between requests, use persistent_id to specify a unique ID for the instance.
All instances created with the same `$persistentId` will share the same connection.
For more information, see the description of the
[`\Memcached::__construct()`](https://www.php.net/manual/memcached.construct.php).
`$servers (array)` - List of memcached servers that will be added to the server pool.
List has the following structure:
```php
$servers => [
[
'host' => 'server-1',
'port' => 11211,
'weight' => 100,
],
[
'host' => 'server-2',
'port' => 11211,
'weight' => 50,
],
];
```
The default value:
```php
$servers => [
[
'host' => Memcached::DEFAULT_SERVER_HOST, // '127.0.0.1'
'port' => Memcached::DEFAULT_SERVER_PORT, // 11211
'weight' => Memcached::DEFAULT_SERVER_WEIGHT, // 1
],
];
```
For more information, see the description of the
[`\Memcached::addServers()`](https://www.php.net/manual/memcached.addservers.php).
## General usage
The package does not contain any additional functionality for interacting with the cache,
except those defined in the [PSR-16](https://www.php-fig.org/psr/psr-16/) interface.
```php
$cache = new \Yiisoft\Cache\Memcached\Memcached();
$parameters = ['user_id' => 42];
$key = 'demo';
// try retrieving $data from cache
$data = $cache->get($key);
if ($data === null) {
// $data is not found in cache, calculate it from scratch
$data = calculateData($parameters);
// store $data in cache for an hour so that it can be retrieved next time
$cache->set($key, $data, 3600);
}
// $data is available here
```
In order to delete value you can use:
```php
$cache->delete($key);
// Or all cache
$cache->clear();
```
To work with values in a more efficient manner, batch operations should be used:
- `getMultiple()`
- `setMultiple()`
- `deleteMultiple()`
This package can be used as a cache handler for the [Yii Caching Library](https://github.com/yiisoft/cache).
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for
that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Cache Library - Memcached Handler is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)