summaryrefslogtreecommitdiff
path: root/plugins/Sample
diff options
context:
space:
mode:
authorBrion Vibber <brion@pobox.com>2010-05-12 11:09:37 -0700
committerBrion Vibber <brion@pobox.com>2010-05-12 11:09:37 -0700
commit5d0593ec342f76aa8062584a92108a66328ff41e (patch)
tree7c6003ee87f26192a17c7733b09e18769f4705c2 /plugins/Sample
parent3d00cfd47fe5458a531df1b78b1833eb17321393 (diff)
Fix keys() / keyTypes() mixup in SamplePlugin
Diffstat (limited to 'plugins/Sample')
-rw-r--r--plugins/Sample/User_greeting_count.php19
1 files changed, 12 insertions, 7 deletions
diff --git a/plugins/Sample/User_greeting_count.php b/plugins/Sample/User_greeting_count.php
index d9a59770d..fc0cbd28f 100644
--- a/plugins/Sample/User_greeting_count.php
+++ b/plugins/Sample/User_greeting_count.php
@@ -94,29 +94,34 @@ class User_greeting_count extends Memcached_DataObject
/**
* return key definitions for DB_DataObject
*
- * DB_DataObject needs to know about keys that the table has; this function
- * defines them.
+ * DB_DataObject needs to know about keys that the table has, since it
+ * won't appear in StatusNet's own keys list. In most cases, this will
+ * simply reference your keyTypes() function.
*
- * @return array key definitions
+ * @return array list of key field names
*/
function keys()
{
- return array('user_id' => 'K');
+ return array_keys($this->keyTypes());
}
/**
* return key definitions for Memcached_DataObject
*
* Our caching system uses the same key definitions, but uses a different
- * method to get them.
+ * method to get them. This key information is used to store and clear
+ * cached data, so be sure to list any key that will be used for static
+ * lookups.
*
- * @return array key definitions
+ * @return array associative array of key definitions, field name to type:
+ * 'K' for primary key: for compound keys, add an entry for each component;
+ * 'U' for unique keys: compound keys are not well supported here.
*/
function keyTypes()
{
- return $this->keys();
+ return array('user_id' => 'K');
}
/**