3 * Object caching using PHP arrays.
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
23 use Wikimedia\Assert\Assert
;
26 * This is a test of the interface, mainly. It stores things in an associative
27 * array, which is not going to persist between program runs.
31 class HashBagOStuff
extends BagOStuff
{
33 protected $bag = array();
34 /** @var integer Max entries allowed */
35 protected $maxCacheKeys;
41 * @param array $params Additional parameters include:
42 * - maxKeys : only allow this many keys (using oldest-first eviction)
44 function __construct( $params = array() ) {
45 parent
::__construct( $params );
47 $this->maxCacheKeys
= isset( $params['maxKeys'] ) ?
$params['maxKeys'] : INF
;
48 Assert
::parameter( $this->maxCacheKeys
> 0, 'maxKeys', 'must be above zero' );
51 protected function expire( $key ) {
52 $et = $this->bag
[$key][self
::KEY_EXP
];
53 if ( $et == self
::TTL_INDEFINITE ||
$et > time() ) {
57 $this->delete( $key );
62 protected function doGet( $key, $flags = 0 ) {
63 if ( !isset( $this->bag
[$key] ) ) {
67 if ( $this->expire( $key ) ) {
71 return $this->bag
[$key][self
::KEY_VAL
];
74 public function set( $key, $value, $exptime = 0, $flags = 0 ) {
75 $this->bag
[$key] = array(
76 self
::KEY_VAL
=> $value,
77 self
::KEY_EXP
=> $this->convertExpiry( $exptime )
80 if ( count( $this->bag
) > $this->maxCacheKeys
) {
82 $evictKey = key( $this->bag
);
83 unset( $this->bag
[$evictKey] );
89 public function delete( $key ) {
90 unset( $this->bag
[$key] );