summaryrefslogtreecommitdiff
path: root/modules/user/helpers
diff options
context:
space:
mode:
authorTim Almdal <tnalmdal@shaw.ca>2009-10-22 13:09:20 -0700
committerTim Almdal <tnalmdal@shaw.ca>2009-10-22 13:11:03 -0700
commit3c936d661a088fb43b47eb5b208958180e8f65eb (patch)
tree1a117dc1bfe54bec44f664cbd7c5f8c93aa5e993 /modules/user/helpers
parent4cb9ec1d6d37b49ebafc68d0a94d794a1acb8b28 (diff)
Change the name of identity library from Identity to IdentityProvider. Create a helper class called identity to simplify call the Identity Provider. Move the contents of MY_Session.php to the new helper class and remove the MY_Session class
Diffstat (limited to 'modules/user/helpers')
-rw-r--r--modules/user/helpers/group.php18
1 files changed, 14 insertions, 4 deletions
diff --git a/modules/user/helpers/group.php b/modules/user/helpers/group.php
index 8ad52564..567b2ee4 100644
--- a/modules/user/helpers/group.php
+++ b/modules/user/helpers/group.php
@@ -25,7 +25,10 @@
*/
class group_Core {
/**
- * @see Identity_Driver::create.
+ * Create a new group.
+ *
+ * @param string $name
+ * @return Group_Definition the group object
*/
static function create($name) {
$group = ORM::factory("group")->where("name", $name)->find();
@@ -39,14 +42,18 @@ class group_Core {
}
/**
- * @see Identity_Driver::everbody.
+ * The group of all possible visitors. This includes the guest user.
+ *
+ * @return Group_Definition the group object
*/
static function everybody() {
return model_cache::get("group", 1);
}
/**
- * @see Identity_Driver::registered_users.
+ * The group of all logged-in visitors. This does not include guest users.
+ *
+ * @return Group_Definition the group object
*/
static function registered_users() {
return model_cache::get("group", 2);
@@ -71,7 +78,10 @@ class group_Core {
}
/**
- * @see Identity_Driver::get_group_list.
+ * Search the groups by the field and value.
+ * @param string $field_name column to look up the user by
+ * @param string $value value to match
+ * @return Group_Definition the group object, or null if the name was invalid.
*/
static function lookup_by_field($field_name, $value) {
try {