Cache API - Revision history

Patricia Schmidt: /* Cache Implementation In View or Controller */

2013-03-08T01:29:52Z

‎Cache Implementation In View or Controller

Patricia Schmidt: /* Cache Remove In Table Class */

2013-03-08T01:29:20Z

‎Cache Remove In Table Class

Patricia Schmidt: /* Cache Remove in User Plugin */

2013-03-08T01:28:26Z

‎Cache Remove in User Plugin

Patricia Schmidt: /* Cache Remove in User Plugin */

2013-03-08T01:28:15Z

‎Cache Remove in User Plugin

Patricia Schmidt: /* Cache Remove In Table Class */

2013-03-08T01:27:28Z

‎Cache Remove In Table Class

Patricia Schmidt: /* Cache Implement / Remove In Model Class */

2013-03-08T01:26:31Z

‎Cache Implement / Remove In Model Class

Patricia Schmidt: /* Cache Implementation In View Or Controller */

2013-03-08T00:46:59Z

‎Cache Implementation In View Or Controller

Patricia Schmidt: /* Cache Implement In View Or Controller */

2013-03-08T00:46:47Z

‎Cache Implement In View Or Controller

Sinisakrisan: Created page with "===Cache Implement In View Or Controller === $cache = CFactory::getCache('Core'); // Random is to handle shuffle matter, // cache 3 differe..."

2013-01-18T14:20:15Z

Created page with "===Cache Implement In View Or Controller === <syntaxhighlight lang="php"> $cache = CFactory::getCache('Core'); // Random is to handle shuffle matter, // cache 3 differe..."

New page

===Cache Implement In View Or Controller ===
<syntaxhighlight lang="php">
$cache = CFactory::getCache('Core');

// Random is to handle shuffle matter,
// cache 3 different set of data.
$intRandom = rand(COMMUNITY_CACHE_RANDOM_MIN,
COMMUNITY_CACHE_RANDOM_MAX);

// Cache does not exist, implement the cache data.
if (!($data = $cache->load('frontpage_getLatestVideos_' . $intRandom))){
$data = // generate data
$cache->save($data, NULL, array(COMMUNITY_CACHE_TAG_VIDEOS));
}
</syntaxhighlight>
 
===Cache Implement / Remove In Model Class ===
1. To implement cache in model class, add following code in constructor
<syntaxhighlight lang="php">
// addMethod(methodName, [ACTION_SAVE, ACTION_REMOVE], [COMMUNITY_CACHE_TAG_ALL, array(TAG)])
$oCache = CCache::inject($this);
$oCache->addMethod('getAllPhotos', CCache::ACTION_SAVE, array(COMMUNITY_CACHE_TAG_PHOTOS));
</syntaxhighlight>
 
2. To remove cache in model class, add following code in models's constructor
<syntaxhighlight lang="php">
$oCache = CCache::inject($this);
$oCache->addMethod('deleteActivity', CCache::ACTION_REMOVE, array(COMMUNITY_CACHE_TAG_ACTIVITIES));
$oCache->addMethod('removeActivity', CCache::ACTION_REMOVE, array(COMMUNITY_CACHE_TAG_ACTIVITIES));
</syntaxhighlight>
 

===Cache Remove In Table Class ===
1. Extend CTableCache (table/cache.php) in table class
<syntaxhighlight lang="php">
class CTablePhoto extends CTableCache
</syntaxhighlight>
 
2. Add following code in constructor
<syntaxhighlight lang="php">
// Get cache object.
$oCache = CCache::inject($this);
// Remove video cache on every delete & store
$oCache->addMethod(CCache::METHOD_DEL, CCache::ACTION_REMOVE, array(COMMUNITY_CACHE_TAG_VIDEOS));
$oCache->addMethod(CCache::METHOD_STORE, CCache::ACTION_REMOVE, array(COMMUNITY_CACHE_TAG_VIDEOS));

// Only CCache::METHOD_DEL, CCache::METHOD_SAVE, CCache::METHOD_STORE will handle by
// the cache object,other methods need to be done manually by the class itself.
</syntaxhighlight>
 

===Cache Remove in User Plugin ===
Cache will be remove automatically when following functions get trigger.

1. [[onAfterStoreUse|onAfterStoreUser()]] 
2. [[onAfterDeleteUser|onAfterDeleteUser()]]

@@ Line 1: / Line 1: @@
-===Cache Implementation In View Or Controller ===
+===Cache Implementation In View or Controller ===
 <syntaxhighlight lang="php">
 $cache 	   = CFactory::getCache('Core');

@@ Line 7: / Line 7: @@
 $intRandom = rand(COMMUNITY_CACHE_RANDOM_MIN,
                    COMMUNITY_CACHE_RANDOM_MAX);
 // Cache does not exist, implement the cache data.
 if (!($data = $cache->load('frontpage_getLatestVideos_' . $intRandom))){

@@ Line 46: / Line 46: @@
     $oCache->addMethod(CCache::METHOD_DEL, CCache::ACTION_REMOVE, array(COMMUNITY_CACHE_TAG_VIDEOS));
     $oCache->addMethod(CCache::METHOD_STORE, CCache::ACTION_REMOVE, array(COMMUNITY_CACHE_TAG_VIDEOS));
    // Only CCache::METHOD_DEL, CCache::METHOD_SAVE, CCache::METHOD_STORE will handle by
    // the cache object,other methods need to be done manually by the class itself.

@@ Line 54: / Line 54: @@
 ===Cache Remove in User Plugin ===
 Cache will be removed automatically when the following functions are triggered:
-  [[onAfterStoreUse|onAfterStoreUser()]]<br />
+  [[onAfterStoreUse|onAfterStoreUser()]]
   [[onAfterDeleteUser|onAfterDeleteUser()]]

@@ Line 34: / Line 34: @@
 ===Cache Remove In Table Class ===
-. Extend CTableCache (table/cache.php) in table class
+Extend CTableCache (table/cache.php) in the table class:
 <syntaxhighlight lang="php">
 class CTablePhoto extends CTableCache
 </syntaxhighlight>
 <br />
-. Add following code in constructor
+Add the following code in the constructor:
 <syntaxhighlight lang="php">
     // Get cache object.

@@ Line 17: / Line 17: @@
 <br />
-===Cache Implement / Remove In Model Class ===
+===Cache Implementation / Removal In Model Class===
-. To implement cache in model class, add following code in constructor
+To implement cache in model class, add the following code in the constructor:
 <syntaxhighlight lang="php">
 // addMethod(methodName, [ACTION_SAVE, ACTION_REMOVE], [COMMUNITY_CACHE_TAG_ALL, array(TAG)])
@@ Line 25: / Line 25: @@
 </syntaxhighlight>
 <br />
-. To remove cache in model class, add following code in models's constructor
+To remove cache in model class, add following code in models's constructor:
 <syntaxhighlight lang="php">
 $oCache = CCache::inject($this);