3 * Per-process memory cache for storing items.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Simple store for keeping values in an associative array for the current process.
27 * Data will not persist and is not shared with other processes.
31 class HashBagOStuff
extends BagOStuff
{
34 /** @var int Max entries allowed */
35 protected $maxCacheKeys;
37 /** @var string CAS token prefix for this instance */
40 /** @var int CAS token counter */
41 private static $casCounter = 0;
48 * @param array $params Additional parameters include:
49 * - maxKeys : only allow this many keys (using oldest-first eviction)
51 function __construct( $params = [] ) {
52 parent
::__construct( $params );
54 $this->token
= microtime( true ) . ':' . mt_rand();
55 $this->maxCacheKeys
= $params['maxKeys'] ?? INF
;
56 if ( $this->maxCacheKeys
<= 0 ) {
57 throw new InvalidArgumentException( '$maxKeys parameter must be above zero' );
61 protected function doGet( $key, $flags = 0 ) {
62 if ( !$this->hasKey( $key ) ) {
66 if ( $this->expire( $key ) ) {
70 // Refresh key position for maxCacheKeys eviction
71 $temp = $this->bag
[$key];
72 unset( $this->bag
[$key] );
73 $this->bag
[$key] = $temp;
75 return $this->bag
[$key][self
::KEY_VAL
];
78 protected function getWithToken( $key, &$casToken, $flags = 0 ) {
81 $value = $this->doGet( $key );
82 if ( $value !== false ) {
83 $casToken = $this->bag
[$key][self
::KEY_CAS
];
89 public function set( $key, $value, $exptime = 0, $flags = 0 ) {
90 // Refresh key position for maxCacheKeys eviction
91 unset( $this->bag
[$key] );
93 self
::KEY_VAL
=> $value,
94 self
::KEY_EXP
=> $this->convertToExpiry( $exptime ),
95 self
::KEY_CAS
=> $this->token
. ':' . ++self
::$casCounter
98 if ( count( $this->bag
) > $this->maxCacheKeys
) {
100 $evictKey = key( $this->bag
);
101 unset( $this->bag
[$evictKey] );
107 public function add( $key, $value, $exptime = 0, $flags = 0 ) {
108 if ( $this->get( $key ) === false ) {
109 return $this->set( $key, $value, $exptime, $flags );
112 return false; // key already set
115 public function delete( $key, $flags = 0 ) {
116 unset( $this->bag
[$key] );
121 public function incr( $key, $value = 1 ) {
122 $n = $this->get( $key );
123 if ( $this->isInteger( $n ) ) {
124 $n = max( $n +
intval( $value ), 0 );
125 $this->bag
[$key][self
::KEY_VAL
] = $n;
134 * Clear all values in cache
136 public function clear() {
144 protected function expire( $key ) {
145 $et = $this->bag
[$key][self
::KEY_EXP
];
146 if ( $et == self
::TTL_INDEFINITE ||
$et > $this->getCurrentTime() ) {
150 $this->delete( $key );
156 * Does this bag have a non-null value for the given key?
162 protected function hasKey( $key ) {
163 return isset( $this->bag
[$key] );