/**
* Test is a cache has a key.
*
* The use of the has methods is strongly discouraged. In a high load environment the cache may well change between the
* test and any subsequent action (get, set, delete etc).
* Instead it is recommended to write your code in such a way they it performs the following steps:
* <ol>
* <li>Attempt to retrieve the information.</li>
* <li>Generate the information.</li>
* <li>Attempt to set the information</li>
* </ol>
*
* Its also worth mentioning that not all stores support key tests.
* For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
* Just one more reason you should not use these methods unless you have a very good reason to do so.
*
* @param string|int $key
* @param bool $tryloadifpossible If set to true, the cache doesn't contain the key, and there is another cache loader or
* data source then the code will try load the key value from the next item in the chain.
* @return bool True if the cache has the requested key, false otherwise.
*/
public function has($key, $tryloadifpossible = false)
{
$parsedkey = $this->parse_key($key);
if ($this->is_in_persist_cache($parsedkey)) {
return true;
}
if ($this->has_a_ttl() && !$this->store_supports_native_ttl() || !$this->store_supports_key_awareness()) {
if ($this->store_supports_key_awareness() && !$this->store->has($parsedkey)) {
return false;
}
$data = $this->store->get($parsedkey);
if (!$this->store_supports_native_ttl()) {
$has = $data instanceof cache_ttl_wrapper && !$data->has_expired();
} else {
$has = $data !== false;
}
} else {
$has = $this->store->has($parsedkey);
}
if (!$has && $tryloadifpossible) {
if ($this->loader !== false) {
$result = $this->loader->get($parsedkey);
} else {
if ($this->datasource !== null) {
$result = $this->datasource->load_for_cache($key);
}
}
$has = $result !== null;
if ($has) {
$this->set($key, $result);
}
}
return $has;
}
/**
* Test is a cache has a key.
*
* The use of the has methods is strongly discouraged. In a high load environment the cache may well change between the
* test and any subsequent action (get, set, delete etc).
* Instead it is recommended to write your code in such a way they it performs the following steps:
* <ol>
* <li>Attempt to retrieve the information.</li>
* <li>Generate the information.</li>
* <li>Attempt to set the information</li>
* </ol>
*
* Its also worth mentioning that not all stores support key tests.
* For stores that don't support key tests this functionality is mimicked by using the equivalent get method.
* Just one more reason you should not use these methods unless you have a very good reason to do so.
*
* @param string|int $key
* @param bool $tryloadifpossible If set to true, the cache doesn't contain the key, and there is another cache loader or
* data source then the code will try load the key value from the next item in the chain.
* @return bool True if the cache has the requested key, false otherwise.
*/
public function has($key, $tryloadifpossible = false)
{
$parsedkey = $this->parse_key($key);
if ($this->is_in_persist_cache($parsedkey)) {
// Hoorah, that was easy. It exists in the static acceleration array so we definitely have it.
return true;
}
if ($this->has_a_ttl() && !$this->store_supports_native_ttl()) {
// The data has a TTL and the store doesn't support it natively.
// We must fetch the data and expect a ttl wrapper.
$data = $this->store->get($parsedkey);
$has = $data instanceof cache_ttl_wrapper && !$data->has_expired();
} else {
if (!$this->store_supports_key_awareness()) {
// The store doesn't support key awareness, get the data and check it manually... puke.
// Either no TTL is set of the store supports its handling natively.
$data = $this->store->get($parsedkey);
$has = $data !== false;
} else {
// The store supports key awareness, this is easy!
// Either no TTL is set of the store supports its handling natively.
$has = $this->store->has($parsedkey);
}
}
if (!$has && $tryloadifpossible) {
if ($this->loader !== false) {
$result = $this->loader->get($parsedkey);
} else {
if ($this->datasource !== null) {
$result = $this->datasource->load_for_cache($key);
}
}
$has = $result !== null;
if ($has) {
$this->set($key, $result);
}
}
return $has;
}
/**
* Test the store for basic functionality.
*/
public function run_tests(cache_store $instance)
{
// Test set.
$this->assertTrue($instance->set('test1', 'test1'));
$this->assertTrue($instance->set('test2', 'test2'));
// Test get.
$this->assertEquals('test1', $instance->get('test1'));
$this->assertEquals('test2', $instance->get('test2'));
// Test delete.
$this->assertTrue($instance->delete('test1'));
$this->assertFalse($instance->delete('test3'));
$this->assertFalse($instance->get('test1'));
$this->assertEquals('test2', $instance->get('test2'));
$this->assertTrue($instance->set('test1', 'test1'));
// Test purge.
$this->assertTrue($instance->purge());
$this->assertFalse($instance->get('test1'));
$this->assertFalse($instance->get('test2'));
// Test set_many.
$outcome = $instance->set_many(array(array('key' => 'many1', 'value' => 'many1'), array('key' => 'many2', 'value' => 'many2'), array('key' => 'many3', 'value' => 'many3'), array('key' => 'many4', 'value' => 'many4'), array('key' => 'many5', 'value' => 'many5')));
$this->assertEquals(5, $outcome);
$this->assertEquals('many1', $instance->get('many1'));
$this->assertEquals('many5', $instance->get('many5'));
$this->assertFalse($instance->get('many6'));
// Test get_many.
$result = $instance->get_many(array('many1', 'many3', 'many5', 'many6'));
$this->assertInternalType('array', $result);
$this->assertCount(4, $result);
$this->assertEquals(array('many1' => 'many1', 'many3' => 'many3', 'many5' => 'many5', 'many6' => false), $result);
// Test delete_many.
$this->assertEquals(3, $instance->delete_many(array('many2', 'many3', 'many4')));
$this->assertEquals(2, $instance->delete_many(array('many1', 'many5', 'many6')));
}
/**
* Test the store for basic functionality.
*/
public function run_tests(cache_store $instance)
{
// Test set with a string.
$this->assertTrue($instance->set('test1', 'test1'));
$this->assertTrue($instance->set('test2', 'test2'));
$this->assertTrue($instance->set('test3', '3'));
// Test get with a string.
$this->assertSame('test1', $instance->get('test1'));
$this->assertSame('test2', $instance->get('test2'));
$this->assertSame('3', $instance->get('test3'));
// Test set with an int.
$this->assertTrue($instance->set('test1', 1));
$this->assertTrue($instance->set('test2', 2));
// Test get with an int.
$this->assertSame(1, $instance->get('test1'));
$this->assertInternalType('int', $instance->get('test1'));
$this->assertSame(2, $instance->get('test2'));
$this->assertInternalType('int', $instance->get('test2'));
// Test set with a bool.
$this->assertTrue($instance->set('test1', true));
// Test get with an bool.
$this->assertSame(true, $instance->get('test1'));
$this->assertInternalType('boolean', $instance->get('test1'));
// Test delete.
$this->assertTrue($instance->delete('test1'));
$this->assertTrue($instance->delete('test3'));
$this->assertFalse($instance->delete('test3'));
$this->assertFalse($instance->get('test1'));
$this->assertSame(2, $instance->get('test2'));
$this->assertTrue($instance->set('test1', 'test1'));
// Test purge.
$this->assertTrue($instance->purge());
$this->assertFalse($instance->get('test1'));
$this->assertFalse($instance->get('test2'));
// Test set_many.
$outcome = $instance->set_many(array(array('key' => 'many1', 'value' => 'many1'), array('key' => 'many2', 'value' => 'many2'), array('key' => 'many3', 'value' => 'many3'), array('key' => 'many4', 'value' => 'many4'), array('key' => 'many5', 'value' => 'many5')));
$this->assertSame(5, $outcome);
$this->assertSame('many1', $instance->get('many1'));
$this->assertSame('many5', $instance->get('many5'));
$this->assertFalse($instance->get('many6'));
// Test get_many.
$result = $instance->get_many(array('many1', 'many3', 'many5', 'many6'));
$this->assertInternalType('array', $result);
$this->assertCount(4, $result);
$this->assertSame(array('many1' => 'many1', 'many3' => 'many3', 'many5' => 'many5', 'many6' => false), $result);
// Test delete_many.
$this->assertSame(3, $instance->delete_many(array('many2', 'many3', 'many4')));
$this->assertSame(2, $instance->delete_many(array('many1', 'many5', 'many6')));
}
/**
* Test the store for basic functionality.
*/
public function run_tests(cache_store $instance)
{
$object = new stdClass();
$object->data = 1;
// Test set with a string.
$this->assertTrue($instance->set('test1', 'test1'));
$this->assertTrue($instance->set('test2', 'test2'));
$this->assertTrue($instance->set('test3', '3'));
// Test get with a string.
$this->assertSame('test1', $instance->get('test1'));
$this->assertSame('test2', $instance->get('test2'));
$this->assertSame('3', $instance->get('test3'));
// Test set with an int.
$this->assertTrue($instance->set('test1', 1));
$this->assertTrue($instance->set('test2', 2));
// Test get with an int.
$this->assertSame(1, $instance->get('test1'));
$this->assertInternalType('int', $instance->get('test1'));
$this->assertSame(2, $instance->get('test2'));
$this->assertInternalType('int', $instance->get('test2'));
// Test set with a bool.
$this->assertTrue($instance->set('test1', true));
// Test get with an bool.
$this->assertSame(true, $instance->get('test1'));
$this->assertInternalType('boolean', $instance->get('test1'));
// Test with an object.
$this->assertTrue($instance->set('obj', $object));
if ($instance::get_supported_features() & cache_store::DEREFERENCES_OBJECTS) {
$this->assertNotSame($object, $instance->get('obj'), 'Objects must be dereferenced when returned.');
}
$this->assertEquals($object, $instance->get('obj'));
// Test delete.
$this->assertTrue($instance->delete('test1'));
$this->assertTrue($instance->delete('test3'));
$this->assertFalse($instance->delete('test3'));
$this->assertFalse($instance->get('test1'));
$this->assertSame(2, $instance->get('test2'));
$this->assertTrue($instance->set('test1', 'test1'));
// Test purge.
$this->assertTrue($instance->purge());
$this->assertFalse($instance->get('test1'));
$this->assertFalse($instance->get('test2'));
// Test set_many.
$outcome = $instance->set_many(array(array('key' => 'many1', 'value' => 'many1'), array('key' => 'many2', 'value' => 'many2'), array('key' => 'many3', 'value' => 'many3'), array('key' => 'many4', 'value' => 'many4'), array('key' => 'many5', 'value' => 'many5')));
$this->assertSame(5, $outcome);
$this->assertSame('many1', $instance->get('many1'));
$this->assertSame('many5', $instance->get('many5'));
$this->assertFalse($instance->get('many6'));
// Test get_many.
$result = $instance->get_many(array('many1', 'many3', 'many5', 'many6'));
$this->assertInternalType('array', $result);
$this->assertCount(4, $result);
$this->assertSame(array('many1' => 'many1', 'many3' => 'many3', 'many5' => 'many5', 'many6' => false), $result);
// Test delete_many.
$this->assertSame(3, $instance->delete_many(array('many2', 'many3', 'many4')));
$this->assertSame(2, $instance->delete_many(array('many1', 'many5', 'many6')));
}
/**
* Test the store for basic functionality.
*/
public function run_tests(cache_store $instance)
{
$object = new stdClass();
$object->data = 1;
// Test set with a string.
$this->assertTrue($instance->set('test1', 'test1'));
$this->assertTrue($instance->set('test2', 'test2'));
$this->assertTrue($instance->set('test3', '3'));
$this->assertTrue($instance->set('other3', '3'));
// Test get with a string.
$this->assertSame('test1', $instance->get('test1'));
$this->assertSame('test2', $instance->get('test2'));
$this->assertSame('3', $instance->get('test3'));
// Test find and find with prefix if this class implements the searchable interface.
if ($instance->is_searchable()) {
// Extra settings here ignore the return order of the array.
$this->assertEquals(['test3', 'test1', 'test2', 'other3'], $instance->find_all(), '', 0, 1, true);
// Extra settings here ignore the return order of the array.
$this->assertEquals(['test2', 'test1', 'test3'], $instance->find_by_prefix('test'), '', 0, 1, true);
$this->assertEquals(['test2'], $instance->find_by_prefix('test2'));
$this->assertEquals(['other3'], $instance->find_by_prefix('other'));
$this->assertEquals([], $instance->find_by_prefix('nothere'));
}
// Test set with an int.
$this->assertTrue($instance->set('test1', 1));
$this->assertTrue($instance->set('test2', 2));
// Test get with an int.
$this->assertSame(1, $instance->get('test1'));
$this->assertInternalType('int', $instance->get('test1'));
$this->assertSame(2, $instance->get('test2'));
$this->assertInternalType('int', $instance->get('test2'));
// Test set with a bool.
$this->assertTrue($instance->set('test1', true));
// Test get with an bool.
$this->assertSame(true, $instance->get('test1'));
$this->assertInternalType('boolean', $instance->get('test1'));
// Test with an object.
$this->assertTrue($instance->set('obj', $object));
if ($instance::get_supported_features() & cache_store::DEREFERENCES_OBJECTS) {
$this->assertNotSame($object, $instance->get('obj'), 'Objects must be dereferenced when returned.');
}
$this->assertEquals($object, $instance->get('obj'));
// Test delete.
$this->assertTrue($instance->delete('test1'));
$this->assertTrue($instance->delete('test3'));
$this->assertFalse($instance->delete('test3'));
$this->assertFalse($instance->get('test1'));
$this->assertSame(2, $instance->get('test2'));
$this->assertTrue($instance->set('test1', 'test1'));
// Test purge.
$this->assertTrue($instance->purge());
$this->assertFalse($instance->get('test1'));
$this->assertFalse($instance->get('test2'));
// Test set_many.
$outcome = $instance->set_many(array(array('key' => 'many1', 'value' => 'many1'), array('key' => 'many2', 'value' => 'many2'), array('key' => 'many3', 'value' => 'many3'), array('key' => 'many4', 'value' => 'many4'), array('key' => 'many5', 'value' => 'many5')));
$this->assertSame(5, $outcome);
$this->assertSame('many1', $instance->get('many1'));
$this->assertSame('many5', $instance->get('many5'));
$this->assertFalse($instance->get('many6'));
// Test get_many.
$result = $instance->get_many(array('many1', 'many3', 'many5', 'many6'));
$this->assertInternalType('array', $result);
$this->assertCount(4, $result);
$this->assertSame(array('many1' => 'many1', 'many3' => 'many3', 'many5' => 'many5', 'many6' => false), $result);
// Test delete_many.
$this->assertSame(3, $instance->delete_many(array('many2', 'many3', 'many4')));
$this->assertSame(2, $instance->delete_many(array('many1', 'many5', 'many6')));
}
