Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Adding atomic increment and decrement methods to cache engines, closes

  • Loading branch information...
commit dff7e17fa2c4459450277412c45f044b3690244b 1 parent a804050
@lorenzo lorenzo authored
View
86 cake/libs/cache.php
@@ -329,6 +329,70 @@ function read($key, $config = null) {
}
/**
+ * Increment a number under the key and return incremented value
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to add
+ * @param string $config Optional - string configuration name
+ * @return mixed new value, or false if the data doesn't exist, is not integer, or if there was an error fetching it
+ * @access public
+ */
+ function increment($key, $offset = 1, $config = null) {
+ $self =& Cache::getInstance();
+
+ if (!$config) {
+ $config = $self->__name;
+ }
+ $settings = $self->settings($config);
+
+ if (empty($settings)) {
+ return null;
+ }
+ if (!$self->isInitialized($config)) {
+ return false;
+ }
+ $key = $self->_engines[$config]->key($key);
+
+ if (!$key || is_resource($value)) {
+ return false;
+ }
+ $success = $_this->_Engine[$engine]->increment($settings['prefix'] . $key, $offset);
+ $self->set();
+ return $success;
+ }
+/**
+ * Decrement a number under the key and return decremented value
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to substract
+ * @param string $config Optional - string configuration name
+ * @return mixed new value, or false if the data doesn't exist, is not integer, or if there was an error fetching it
+ * @access public
+ */
+ function decrement($key, $offset = 1, $config = null) {
+ $self =& Cache::getInstance();
+
+ if (!$config) {
+ $config = $self->__name;
+ }
+ $settings = $self->settings($config);
+
+ if (empty($settings)) {
+ return null;
+ }
+ if (!$self->isInitialized($config)) {
+ return false;
+ }
+ $key = $self->_engines[$config]->key($key);
+
+ if (!$key || is_resource($value)) {
+ return false;
+ }
+ $success = $_this->_Engine[$engine]->increment($settings['prefix'] . $key, $offset);
+ $self->set();
+ return $success;
+ }
+/**
* Delete a key from the cache
*
* @param string $key Identifier for the data
@@ -499,6 +563,28 @@ function read($key) {
}
/**
+ * Increment a number under the key and return incremented value
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to add
+ * @return New incremented value, false otherwise
+ * @access public
+ */
+ function increment($key, $offset = 1) {
+ trigger_error(sprintf(__('Method increment() not implemented in %s', true), get_class($this)), E_USER_ERROR);
+ }
+/**
+ * Decrement a number under the key and return decremented value
+ *
+ * @param string $key Identifier for the data
+ * @param integer $value How much to substract
+ * @return New incremented value, false otherwise
+ * @access public
+ */
+ function decrement($key, $offset = 1) {
+ trigger_error(sprintf(__('Method decrement() not implemented in %s', true), get_class($this)), E_USER_ERROR);
+ }
+/**
* Delete a key from the cache
*
* @param string $key Identifier for the data
View
32 cake/libs/cache/apc.php
@@ -75,6 +75,38 @@ function read($key) {
}
/**
+ * Increments the value of an integer cached key
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to increment
+ * @param integer $duration How long to cache the data, in seconds
+ * @return New incremented value, false otherwise
+ * @access public
+ */
+ function increment($key, $offset = 1) {
+ if (!is_integer($offset) || $offset < 0) {
+ return false;
+ }
+ return apc_inc($key, $offset);
+ }
+
+/**
+ * Decrements the value of an integer cached key
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to substract
+ * @param integer $duration How long to cache the data, in seconds
+ * @return New decremented value, false otherwise
+ * @access public
+ */
+ function decrement($key, $offset = 1) {
+ if (!is_integer($offset) || $offset < 0) {
+ return false;
+ }
+ return apc_dec($key, $offset);
+ }
+
+/**
* Delete a key from the cache
*
* @param string $key Identifier for the data
View
38 cake/libs/cache/memcache.php
@@ -126,6 +126,44 @@ function read($key) {
}
/**
+ * Increments the value of an integer cached key
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to increment
+ * @param integer $duration How long to cache the data, in seconds
+ * @return New incremented value, false otherwise
+ * @access public
+ */
+ function increment($key, $offset = 1) {
+ if ($this->settings['compress']) {
+ trigger_error(sprintf(__('Method increment() not implemented for compressed cache in %s', true), get_class($this)), E_USER_ERROR);
+ }
+ if (!is_integer($offset) || $offset < 0) {
+ return false;
+ }
+ return $this->__Memcache->increment($key, $offset);
+ }
+
+/**
+ * Decrements the value of an integer cached key
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to substract
+ * @param integer $duration How long to cache the data, in seconds
+ * @return New decremented value, false otherwise
+ * @access public
+ */
+ function decrement($key, $offset = 1) {
+ if ($this->settings['compress']) {
+ trigger_error(sprintf(__('Method decrement() not implemented for compressed cache in %s', true), get_class($this)), E_USER_ERROR);
+ }
+ if (!is_integer($offset) || $offset < 0) {
+ return false;
+ }
+ return $this->__Memcache->decrement($key, $offset);
+ }
+
+/**
* Delete a key from the cache
*
* @param string $key Identifier for the data
View
33 cake/libs/cache/xcache.php
@@ -91,6 +91,39 @@ function read($key) {
}
/**
+ * Increments the value of an integer cached key
+ * If the cache key is not an integer it will be treated as 0
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to increment
+ * @param integer $duration How long to cache the data, in seconds
+ * @return New incremented value, false otherwise
+ * @access public
+ */
+ function increment($key, $offset = 1) {
+ if (!is_integer($offset) || $offset < 0) {
+ return false;
+ }
+ return xcache_inc($key, $offset);
+ }
+
+/**
+ * Decrements the value of an integer cached key.
+ * If the cache key is not an integer it will be treated as 0
+ *
+ * @param string $key Identifier for the data
+ * @param integer $offset How much to substract
+ * @param integer $duration How long to cache the data, in seconds
+ * @return New decremented value, false otherwise
+ * @access public
+ */
+ function decrement($key, $offset = 1) {
+ if (!is_integer($offset) || $offset < 0) {
+ return false;
+ }
+ return xcache_dec($key, $offset);
+ }
+/**
* Delete a key from the cache
*
* @param string $key Identifier for the data
View
47 cake/tests/cases/libs/cache/apc.test.php
@@ -140,5 +140,52 @@ function testDeleteCache() {
$result = Cache::delete('delete_test');
$this->assertTrue($result);
}
+
+/**
+ * testDecrement method
+ *
+ * @access public
+ * @return void
+ */
+ public function testDecrement() {
+ $result = Cache::write('test_decrement', 5);
+ $this->assertTrue($result);
+
+ $result = Cache::decrement('test_decrement');
+ $this->assertEqual(4, $result);
+
+ $result = Cache::read('test_decrement');
+ $this->assertEqual(4, $result);
+
+ $result = Cache::decrement('test_decrement', 2);
+ $this->assertEqual(2, $result);
+
+ $result = Cache::read('test_decrement');
+ $this->assertEqual(2, $result);
+
+ }
+
+/**
+ * testIncrement method
+ *
+ * @access public
+ * @return void
+ */
+ public function testIncrement() {
+ $result = Cache::write('test_increment', 5);
+ $this->assertTrue($result);
+
+ $result = Cache::increment('test_increment');
+ $this->assertEqual(5, $result);
+
+ $result = Cache::read('test_increment');
+ $this->assertEqual(5, $result);
+
+ $result = Cache::increment('test_increment', 2);
+ $this->assertEqual(7, $result);
+
+ $result = Cache::read('test_increment');
+ $this->assertEqual(7, $result);
+ }
}
?>
View
47 cake/tests/cases/libs/cache/memcache.test.php
@@ -220,5 +220,52 @@ function testDeleteCache() {
$result = Cache::delete('delete_test');
$this->assertTrue($result);
}
+
+/**
+ * testDecrement method
+ *
+ * @access public
+ * @return void
+ */
+ public function testDecrement() {
+ $result = Cache::write('test_decrement', 5);
+ $this->assertTrue($result);
+
+ $result = Cache::decrement('test_decrement');
+ $this->assertEqual(4, $result);
+
+ $result = Cache::read('test_decrement');
+ $this->assertEqual(4, $result);
+
+ $result = Cache::decrement('test_decrement', 2);
+ $this->assertEqual(2, $result);
+
+ $result = Cache::read('test_decrement');
+ $this->assertEqual(2, $result);
+
+ }
+
+/**
+ * testIncrement method
+ *
+ * @access public
+ * @return void
+ */
+ public function testIncrement() {
+ $result = Cache::write('test_increment', 5);
+ $this->assertTrue($result);
+
+ $result = Cache::increment('test_increment');
+ $this->assertEqual(5, $result);
+
+ $result = Cache::read('test_increment');
+ $this->assertEqual(5, $result);
+
+ $result = Cache::increment('test_increment', 2);
+ $this->assertEqual(7, $result);
+
+ $result = Cache::read('test_increment');
+ $this->assertEqual(7, $result);
+ }
}
?>
View
47 cake/tests/cases/libs/cache/xcache.test.php
@@ -173,5 +173,52 @@ function testClearCache() {
$result = Cache::clear();
$this->assertTrue($result);
}
+
+/**
+ * testDecrement method
+ *
+ * @access public
+ * @return void
+ */
+ public function testDecrement() {
+ $result = Cache::write('test_decrement', 5);
+ $this->assertTrue($result);
+
+ $result = Cache::decrement('test_decrement');
+ $this->assertEqual(4, $result);
+
+ $result = Cache::read('test_decrement');
+ $this->assertEqual(4, $result);
+
+ $result = Cache::decrement('test_decrement', 2);
+ $this->assertEqual(2, $result);
+
+ $result = Cache::read('test_decrement');
+ $this->assertEqual(2, $result);
+
+ }
+
+/**
+ * testIncrement method
+ *
+ * @access public
+ * @return void
+ */
+ public function testIncrement() {
+ $result = Cache::write('test_increment', 5);
+ $this->assertTrue($result);
+
+ $result = Cache::increment('test_increment');
+ $this->assertEqual(5, $result);
+
+ $result = Cache::read('test_increment');
+ $this->assertEqual(5, $result);
+
+ $result = Cache::increment('test_increment', 2);
+ $this->assertEqual(7, $result);
+
+ $result = Cache::read('test_increment');
+ $this->assertEqual(7, $result);
+ }
}
?>
Please sign in to comment.
Something went wrong with that request. Please try again.