Class: Merb::Cache::AbstractStore

Class | Merb::Cache::AbstractStore
In: | lib/merb-cache/stores/fundamental/abstract_store.rb
Parent: | Object

### Methods

delete delete_all delete_all! exists? fetch new read writable? write write_all

### Public Class methods

new(config = {})

### Public Instance methods

delete(key, parameters = {})

deletes the entry for the key & parameter from the store.

@param [to_s] key the key used to identify an entry @param [Hash] parameters optional parameters used to identify an entry @raise [TrueClass] true if the an entry matching the key and parameters is successfully deleted, false otherwise @raise [NotImplementedError] API method has not been implemented

delete_all()

deletes all entries for the key & parameters for the store.

@return [TrueClass] true if all entries in the store are erased, false otherwise @raise [NotImplementedError] API method has not been implemented

delete_all!()

dangerous version of delete_all. Used by strategy stores, which may delete entries not associated with the strategy store making the call.

@return [TrueClass] true if all entries in the store are erased, false otherwise @raise [NotImplementedError] API method has not been implemented

exists?(key, parameters = {})

returns true/false/nil based on if data identified by the key & parameters is persisted in the store.

@param [to_s] key the key used to identify an entry @param [Hash] parameters optional parameters used to identify an entry @return [TrueClass] true if the key and parameters match an entry in the store, false otherwise @raise [NotImplementedError] API method has not been implemented

fetch(key, parameters = {}, conditions = {}, &blk)

tries to read the data from the store. If that fails, it calls the block parameter and persists the result.

@param [to_s] key the key used to identify an entry @param [Hash] parameters optional parameters used to identify an entry @param [Hash] conditions optional conditions that place constraints or detail instructions for storing an entry @return [Object, NilClass] the match entry or the result of the block call, or nil if the entry is not successfully written @raise [NotImplementedError] API method has not been implemented

read(key, parameters = {})

gets the data from the store identified by the key & parameters. return nil if the entry does not exist.

@param [to_s] key the key used to identify an entry @param [Hash] parameters optional parameters used to identify an entry @return [Object, NilClass] the match entry, or nil if no entry exists matching the key and parameters @raise [NotImplementedError] API method has not been implemented

writable?(key, parameters = {}, conditions = {})

determines if the store is able to persist data identified by the key & parameters with the given conditions.

@param [to_s] key the key used to identify an entry @param [Hash] parameters optional parameters used to identify an entry @param [Hash] conditions optional conditions that place constraints or detail instructions for storing an entry @return [TrueClass] the ability of the store to write an entry based on the key, parameters, and conditions @raise [NotImplementedError] API method has not been implemented

write(key, data = nil, parameters = {}, conditions = {})

persists the data so that it can be retrieved by the key & parameters. returns nil if it is unable to persist the data. returns true if successful.

@param [to_s] key the key used to identify an entry @param data the object to persist as an entry @param [Hash] parameters optional parameters used to identify an entry @param [Hash] conditions optional conditions that place constraints or detail instructions for storing an entry @return [TrueClass, NilClass] true if the entry was successfully written, otherwise nil @raise [NotImplementedError] API method has not been implemented

write_all(key, data = nil, parameters = {}, conditions = {})

@param [to_s] key the key used to identify an entry @param data the object to persist as an entry @param [Hash] parameters optional parameters used to identify an entry @param [Hash] conditions optional conditions that place constraints or detail instructions for storing an entry @return [TrueClass, NilClass] true if the entry was successfully written, otherwise nil @raise [NotImplementedError] API method has not been implemented

[Validate]