Cache Library - Revision history

Elverion at 16:42, 8 September 2016

2016-09-08T16:42:49Z

2016-08-23T21:28:13Z

2016-08-23T20:21:49Z

‎DB Driver

2016-08-23T20:18:05Z

‎Creating a cache instance

2016-08-23T20:11:22Z

‎DB Driver

2016-08-19T17:39:26Z

‎Cache:rememberForever

2016-08-19T05:09:37Z

2016-08-19T05:07:45Z

‎Cache:rememberForever

2016-08-19T05:07:04Z

‎Cache:remember

2016-08-19T05:06:18Z

‎Cache:get

@@ Line 6: / Line 6: @@
 '''object Cache(string driver, table config)'''
-The cache library is optional and must be used by requiring the module. Next, the cache class must be instantiated:
+The cache library is optional and the module must be required before use. Next, the cache class must be instantiated:
 <source lang="lua">
 require('cache/cache');

← Older revision		Revision as of 21:28, 23 August 2016
Line 106:		Line 106:

	Exactly like [[Cache_Library#Cache:remember\|Cache:remember()]], only the item is set to never expire.		Exactly like [[Cache_Library#Cache:remember\|Cache:remember()]], only the item is set to never expire.
		+
		+
		+	== cache:renew ==
		+	'''Cache:renew(string itemName, number minutes)'''
		+
		+	Updates the expires_at timestamp for an item so that it will expire in 'minutes' from now. If 'minutes' is nil, the item is set to never expire.
		+

	== Cache:forget ==		== Cache:forget ==

@@ Line 23: / Line 23: @@
 <source lang="lua">
 cache = Cache('db');
 </source>

@@ Line 1: / Line 1: @@
 = Creating a cache instance =
 The cache library is optional and must be used by requiring the module. Next, the cache class must be instantiated:
 <source lang="lua">
@@ Line 6: / Line 12: @@
 cache = Cache();
 </source>
 = Drivers =

← Older revision		Revision as of 20:11, 23 August 2016
Line 17:		Line 17:
	</source>		</source>

		+
		+	Optional configurations:
		+	{\| class="wikitable" style="padding: 8px;"
		+	\|-
		+	\| style="width: 150px;" \| file
		+	\| The filename (and optionally path) of the file to use for storing the database; by default this is 'cache.db'
		+	\|-
		+	\| table
		+	\| The name of the table to use for storing cache data; by default this is 'cache'
		+	\|-
		+	\|}

	== Memory Driver ==		== Memory Driver ==

@@ Line 78: / Line 78: @@
 == Cache:rememberForever ==
-'''Cache:rememberForever(string itemName, function callback)'''
+'''value Cache:rememberForever(string itemName, function callback)'''
 Exactly like [[Cache_Library#Cache:remember|Cache:remember()]], only the item is set to never expire.
 == Cache:forget ==

@@ Line 56: / Line 56: @@
 Returns a value from the cache if the item exists and is not expired, otherwise returns defaultValue or nil. In most cases you will probably want to either grab a cached value or set and return a new value, and so it is recommended to use [[Cache_Library#Cache:remember|Cache:remember()]] instead.
 == Cache:has ==
@@ Line 74: / Line 75: @@
 If the item exists and is not expired, the cached value is returned. Otherwise, the callback function will be called (which should return the value you want to be set) and used as the item's new value which expires in 'minutes' from now; again a negative 'minutes' value indicates it should never expire (or use [[Cache_Library#Cache:rememberForever|Cache:rememberForever()]]). If the callback is used to generate a new value, that value is the one returned by this function.
 == Cache:rememberForever ==
@@ Line 79: / Line 81: @@
 Exactly like [[Cache_Library#Cache:remember|Cache:remember()]], only the item is set to never expire.
 == Cache:forget ==

@@ Line 73: / Line 73: @@
 '''value Cache:remember(string itemName, number minutes, function callback)'''
-If the item exists and is not expired, the cached value is returned. Otherwise, the callback function will be called (which should return the value you want to be set) and used as the item's new value which expires in 'minutes' from now; again a negative 'minutes' value indicates it should never expire (or use Cache:rememberForever()). If the callback is used to generate a new value, that value is the one returned by this function.
+If the item exists and is not expired, the cached value is returned. Otherwise, the callback function will be called (which should return the value you want to be set) and used as the item's new value which expires in 'minutes' from now; again a negative 'minutes' value indicates it should never expire (or use [[Cache_Library#Cache:rememberForever|Cache:rememberForever()]]). If the callback is used to generate a new value, that value is the one returned by this function.
 == Cache:rememberForever ==

@@ Line 55: / Line 55: @@
 '''value Cache:get(string itemName, defaultValue)'''
-Returns a value from the cache if the item exists and is not expired, otherwise returns defaultValue or nil. In most cases you will probably want to either grab a cached value or set and return a new value, and so it is recommended to use Cache:remember() instead.
+Returns a value from the cache if the item exists and is not expired, otherwise returns defaultValue or nil. In most cases you will probably want to either grab a cached value or set and return a new value, and so it is recommended to use [[Cache_Library#Cache:remember|Cache:remember()]] instead.
 == Cache:has ==