/** * Sends a key => value pair to the cache. * * <code> * // This code will add four entries to the cache, one for each url. * $cache->set('main', 'http://moodle.org'); * $cache->set('docs', 'http://docs.moodle.org'); * $cache->set('tracker', 'http://tracker.moodle.org'); * $cache->set('qa', 'http://qa.moodle.net'); * </code> * * @param string|int $key The key for the data being requested. * It can be any structure although using a scalar string or int is recommended in the interests of performance. * In advanced cases an array may be useful such as in situations requiring the multi-key functionality. * @param mixed $data The data to set against the key. * @return bool True on success, false otherwise. */ public function set($key, $data) { if ($this->perfdebug) { cache_helper::record_cache_set($this->storetype, $this->definition->get_id()); } if ($this->loader !== false) { // We have a loader available set it there as well. // We have to let the loader do its own parsing of data as it may be unique. $this->loader->set($key, $data); } if (is_object($data) && $data instanceof cacheable_object) { $data = new cache_cached_object($data); } else { if (!is_scalar($data)) { // If data is an object it will be a reference. // If data is an array if may contain references. // We want to break references so that the cache cannot be modified outside of itself. // Call the function to unreference it (in the best way possible). $data = $this->unref($data); } } if ($this->has_a_ttl() && !$this->store_supports_native_ttl()) { $data = new cache_ttl_wrapper($data, $this->definition->get_ttl()); } $parsedkey = $this->parse_key($key); if ($this->is_using_persist_cache()) { $this->set_in_persist_cache($parsedkey, $data); } return $this->store->set($parsedkey, $data); }
/** * 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'))); }