mirror of
https://github.com/YGGverse/cache-php.git
synced 2026-03-31 17:45:28 +00:00
update readme
This commit is contained in:
parent
bf12b5b7e5
commit
895a3dd6a2
1 changed files with 56 additions and 0 deletions
56
README.md
56
README.md
|
|
@ -1,2 +1,58 @@
|
|||
# cache-php
|
||||
Cache tools for PHP applications
|
||||
|
||||
### Memory
|
||||
|
||||
Extends [PHP memcached](https://www.php.net/manual/en/book.memcached.php)
|
||||
|
||||
#### Init
|
||||
|
||||
```
|
||||
$memory = new Yggverse\Cache\Memory(
|
||||
|
||||
'localhost, // memcached server host, localhost by default
|
||||
11211, // memcached server port, 11211 by default
|
||||
|
||||
'my_app', // application namespace
|
||||
3600 // cache time offset by default
|
||||
);
|
||||
```
|
||||
|
||||
#### Supported methods
|
||||
|
||||
##### Memory::set
|
||||
|
||||
##### Memory::delete
|
||||
|
||||
##### Memory::flush
|
||||
|
||||
##### Memory::get
|
||||
|
||||
##### Memory::getByValueCallback
|
||||
|
||||
Return cached or cache new value of plain value callback
|
||||
|
||||
```
|
||||
$value = $memory->getByValueCallback(
|
||||
'key_name', // string, unique key name
|
||||
'value', // mixed, plain value
|
||||
3600, // optional, cache timeout offset for this value
|
||||
);
|
||||
```
|
||||
|
||||
##### Memory::getByMethodCallback
|
||||
|
||||
Return cached or cache new value of object method callback
|
||||
|
||||
```
|
||||
$value = $memory->getByMethodCallback(
|
||||
$class_object, // object of method class
|
||||
'method_name', // object method name
|
||||
[
|
||||
$method_attribute_1, // optional, array of attributes callback method requires
|
||||
$method_attribute_2,
|
||||
...
|
||||
]
|
||||
3600, // optional, cache timeout offset for this value
|
||||
);
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue