-<?php\r
- /**\r
- * Elgg Groups.\r
- * Groups contain other entities, or rather act as a placeholder for other entities to mark any given container\r
- * as their container.\r
- * \r
- * @package Elgg\r
- * @subpackage Core\r
+<?php
+ /**
+ * Elgg Groups.
+ * Groups contain other entities, or rather act as a placeholder for other entities to mark any given container
+ * as their container.
+ *
+ * @package Elgg
+ * @subpackage Core
- * @author Curverider Ltd\r
+ * @author Curverider Ltd
+
+ * @link http://elgg.org/
+ */
- * @link http://elgg.org/\r
- */\r
-\r
- /**\r
- * @class ElggGroup Class representing a container for other elgg entities.\r
- * @author Curverider Ltd\r
- */\r
- class ElggGroup extends ElggEntity\r
- implements Friendable\r
- {\r
- protected function initialise_attributes()\r
- {\r
- parent::initialise_attributes();\r
- \r
- $this->attributes['type'] = "group";\r
- $this->attributes['name'] = "";\r
- $this->attributes['description'] = "";\r
- $this->attributes['tables_split'] = 2;\r
- }\r
- \r
- /**\r
- * Construct a new user entity, optionally from a given id value.\r
- *\r
- * @param mixed $guid If an int, load that GUID. \r
- * If a db row then will attempt to load the rest of the data.\r
- * @throws Exception if there was a problem creating the user. \r
- */\r
- function __construct($guid = null) \r
- { \r
- $this->initialise_attributes();\r
- \r
- if (!empty($guid))\r
- {\r
- // Is $guid is a DB row - either a entity row, or a user table row.\r
- if ($guid instanceof stdClass) { \r
- // Load the rest\r
- if (!$this->load($guid->guid))\r
- throw new IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid->guid)); \r
- }\r
- \r
- // Is $guid is an ElggGroup? Use a copy constructor\r
- else if ($guid instanceof ElggGroup)\r
- { \r
- foreach ($guid->attributes as $key => $value)\r
- $this->attributes[$key] = $value;\r
- }\r
- \r
- // Is this is an ElggEntity but not an ElggGroup = ERROR!\r
- else if ($guid instanceof ElggEntity)\r
- throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggGroup'));\r
- \r
- // We assume if we have got this far, $guid is an int\r
- else if (is_numeric($guid)) { \r
- if (!$this->load($guid)) IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid));\r
- }\r
- \r
- else\r
- throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnrecognisedValue'));\r
- }\r
- }\r
- \r
- /**\r
- * Add an ElggObject to this group.\r
- *\r
- * @param ElggObject $object The object.\r
- * @return bool\r
- */\r
- public function addObjectToGroup(ElggObject $object)\r
- {\r
- return add_object_to_group($this->getGUID(), $object->getGUID());\r
- }\r
- \r
- /**\r
- * Remove an object from the containing group.\r
- *\r
- * @param int $guid The guid of the object.\r
- * @return bool\r
- */\r
- public function removeObjectFromGroup($guid)\r
- {\r
- return remove_object_from_group($this->getGUID(), $guid);\r
- }\r
- \r
- public function get($name) {\r
- \r
- if ($name == 'username') {\r
- return 'group:' . $this->getGUID();\r
- }\r
- return parent::get($name);\r
- \r
- }\r
- \r
- /**\r
- * Start friendable compatibility block:\r
- * \r
- * public function addFriend($friend_guid);\r
- public function removeFriend($friend_guid);\r
- public function isFriend();\r
- public function isFriendsWith($user_guid);\r
- public function isFriendOf($user_guid);\r
- public function getFriends($subtype = "", $limit = 10, $offset = 0);\r
- public function getFriendsOf($subtype = "", $limit = 10, $offset = 0);\r
- public function getObjects($subtype="", $limit = 10, $offset = 0);\r
- public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0);\r
- public function countObjects($subtype = "");\r
- */\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function addFriend($friend_guid) {\r
- return $this->join(get_entity($friend_guid));\r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function removeFriend($friend_guid) {\r
- return $this->leave(get_entity($friend_guid));\r
- }\r
-\r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function isFriend() {\r
- return $this->isMember();\r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function isFriendsWith($user_guid) {\r
- return $this->isMember($user_guid);\r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function isFriendOf($user_guid) {\r
- return $this->isMember($user_guid);\r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function getFriends($subtype = "", $limit = 10, $offset = 0) { \r
- return get_group_members($this->getGUID(), $limit, $offset); \r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function getFriendsOf($subtype = "", $limit = 10, $offset = 0) { \r
- return get_group_members($this->getGUID(), $limit, $offset); \r
- }\r
- \r
- /**\r
- * Get objects contained in this group.\r
- *\r
- * @param string $subtype\r
- * @param int $limit\r
- * @param int $offset\r
- * @return mixed\r
- */\r
- public function getObjects($subtype="", $limit = 10, $offset = 0) \r
- {\r
- return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", $limit, $offset, false);\r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0) {\r
- return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", $limit, $offset, false);\r
- }\r
- \r
- /**\r
- * For compatibility with Friendable\r
- */\r
- public function countObjects($subtype = "") {\r
- return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", 10, 0, true);\r
- }\r
- \r
- /**\r
- * End friendable compatibility block\r
- */\r
- \r
- /**\r
- * Get a list of group members.\r
- *\r
- * @param int $limit\r
- * @param int $offset\r
- * @return mixed\r
- */\r
- public function getMembers($limit = 10, $offset = 0, $count = false)\r
- {\r
- return get_group_members($this->getGUID(), $limit, $offset, 0 , $count);\r
- }\r
-\r
- \r
- \r
- /**\r
- * Returns whether the current group is public membership or not.\r
- * @return bool\r
- */\r
- public function isPublicMembership()\r
- {\r
- if ($this->membership == ACCESS_PUBLIC)\r
- return true;\r
- \r
- return false;\r
- }\r
- \r
- /**\r
- * Return whether a given user is a member of this group or not.\r
- *\r
- * @param ElggUser $user The user\r
- * @return bool\r
- */\r
- public function isMember($user = 0)\r
- {\r
- if (!($user instanceof ElggUser)) $user = get_loggedin_user();\r
- if (!($user instanceof ElggUser)) return false;\r
- return is_group_member($this->getGUID(), $user->getGUID());\r
- }\r
- \r
- /**\r
- * Join an elgg user to this group.\r
- *\r
- * @param ElggUser $user\r
- * @return bool\r
- */\r
- public function join(ElggUser $user)\r
- {\r
- return join_group($this->getGUID(), $user->getGUID());\r
- }\r
- \r
- /**\r
- * Remove a user from the group.\r
- *\r
- * @param ElggUser $user\r
- */\r
- public function leave(ElggUser $user)\r
- {\r
- return leave_group($this->getGUID(), $user->getGUID());\r
- } \r
- \r
- /**\r
- * Override the load function.\r
- * This function will ensure that all data is loaded (were possible), so\r
- * if only part of the ElggGroup is loaded, it'll load the rest.\r
- * \r
- * @param int $guid \r
- */\r
- protected function load($guid)\r
- { \r
- // Test to see if we have the generic stuff\r
- if (!parent::load($guid)) \r
- return false;\r
-\r
- // Check the type\r
- if ($this->attributes['type']!='group')\r
- throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));\r
- \r
- // Load missing data\r
- $row = get_group_entity_as_row($guid);\r
- if (($row) && (!$this->isFullyLoaded())) $this->attributes['tables_loaded'] ++; // If $row isn't a cached copy then increment the counter\r
- \r
- // Now put these into the attributes array as core values\r
- $objarray = (array) $row;\r
- foreach($objarray as $key => $value) \r
- $this->attributes[$key] = $value;\r
- \r
- return true;\r
- }\r
- \r
- /**\r
- * Override the save function.\r
- */\r
- public function save()\r
- {\r
- // Save generic stuff\r
- if (!parent::save())\r
- return false;\r
- \r
- // Now save specific stuff\r
- return create_group_entity($this->get('guid'), $this->get('name'), $this->get('description'));\r
- }\r
- \r
- // EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////\r
- \r
- /**\r
- * Return an array of fields which can be exported.\r
- */\r
- public function getExportableValues()\r
- {\r
- return array_merge(parent::getExportableValues(), array(\r
- 'name',\r
- 'description',\r
- ));\r
- }\r
- }\r
-\r
- /**\r
- * Get the group entity.\r
- *\r
- * @param int $guid\r
- */\r
- function get_group_entity_as_row($guid)\r
- {\r
- global $CONFIG;\r
- \r
- $guid = (int)$guid;\r
- \r
- /*$row = retrieve_cached_entity_row($guid);\r
- if ($row)\r
- {\r
- // We have already cached this object, so retrieve its value from the cache\r
- if (isset($CONFIG->debug) && $CONFIG->debug)\r
- error_log("** Retrieving sub part of GUID:$guid from cache");\r
- \r
- return $row;\r
- }\r
- else\r
- {*/\r
- // Object not cached, load it.\r
- if (isset($CONFIG->debug) && $CONFIG->debug == true)\r
- error_log("** Sub part of GUID:$guid loaded from DB");\r
- \r
- return get_data_row("SELECT * from {$CONFIG->dbprefix}groups_entity where guid=$guid");\r
- //}\r
- }\r
-\r
- /**\r
- * Create or update the extras table for a given group.\r
- * Call create_entity first.\r
- * \r
- * @param int $guid\r
- * @param string $name\r
- * @param string $description\r
- */\r
- function create_group_entity($guid, $name, $description)\r
- {\r
- global $CONFIG;\r
- \r
- $guid = (int)$guid;\r
- $name = sanitise_string($name);\r
- $description = sanitise_string($description);\r
- \r
- $row = get_entity_as_row($guid);\r
- \r
- if ($row)\r
- {\r
- // Exists and you have access to it\r
- if ($exists = get_data_row("SELECT guid from {$CONFIG->dbprefix}groups_entity WHERE guid = {$guid}")) {\r
- $result = update_data("UPDATE {$CONFIG->dbprefix}groups_entity set name='$name', description='$description' where guid=$guid");\r
- if ($result!=false)\r
- {\r
- // Update succeeded, continue\r
- $entity = get_entity($guid);\r
- if (trigger_elgg_event('update',$entity->type,$entity)) {\r
- return $guid;\r
- } else {\r
- $entity->delete();\r
- //delete_entity($guid);\r
- }\r
- }\r
- }\r
- else\r
- {\r
- // Update failed, attempt an insert.\r
- $result = insert_data("INSERT into {$CONFIG->dbprefix}groups_entity (guid, name, description) values ($guid, '$name','$description')");\r
- if ($result!==false) {\r
- $entity = get_entity($guid);\r
- if (trigger_elgg_event('create',$entity->type,$entity)) {\r
- return $guid;\r
- } else {\r
- $entity->delete();\r
- //delete_entity($guid);\r
- }\r
- }\r
- }\r
- }\r
- \r
- return false;\r
- }\r
- \r
- \r
+ /**
+ * @class ElggGroup Class representing a container for other elgg entities.
+ * @author Curverider Ltd
+ */
+ class ElggGroup extends ElggEntity
+ implements Friendable
+ {
+ protected function initialise_attributes()
+ {
+ parent::initialise_attributes();
+
+ $this->attributes['type'] = "group";
+ $this->attributes['name'] = "";
+ $this->attributes['description'] = "";
+ $this->attributes['tables_split'] = 2;
+ }
+
+ /**
+ * Construct a new user entity, optionally from a given id value.
+ *
+ * @param mixed $guid If an int, load that GUID.
+ * If a db row then will attempt to load the rest of the data.
+ * @throws Exception if there was a problem creating the user.
+ */
+ function __construct($guid = null)
+ {
+ $this->initialise_attributes();
+
+ if (!empty($guid))
+ {
+ // Is $guid is a DB row - either a entity row, or a user table row.
+ if ($guid instanceof stdClass) {
+ // Load the rest
+ if (!$this->load($guid->guid))
+ throw new IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid->guid));
+ }
+
+ // Is $guid is an ElggGroup? Use a copy constructor
+ else if ($guid instanceof ElggGroup)
+ {
+ foreach ($guid->attributes as $key => $value)
+ $this->attributes[$key] = $value;
+ }
+
+ // Is this is an ElggEntity but not an ElggGroup = ERROR!
+ else if ($guid instanceof ElggEntity)
+ throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggGroup'));
+
+ // We assume if we have got this far, $guid is an int
+ else if (is_numeric($guid)) {
+ if (!$this->load($guid)) IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid));
+ }
+
+ else
+ throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnrecognisedValue'));
+ }
+ }
+
+ /**
+ * Add an ElggObject to this group.
+ *
+ * @param ElggObject $object The object.
+ * @return bool
+ */
+ public function addObjectToGroup(ElggObject $object)
+ {
+ return add_object_to_group($this->getGUID(), $object->getGUID());
+ }
+
+ /**
+ * Remove an object from the containing group.
+ *
+ * @param int $guid The guid of the object.
+ * @return bool
+ */
+ public function removeObjectFromGroup($guid)
+ {
+ return remove_object_from_group($this->getGUID(), $guid);
+ }
+
+ public function get($name) {
+
+ if ($name == 'username') {
+ return 'group:' . $this->getGUID();
+ }
+ return parent::get($name);
+
+ }
+
+ /**
+ * Start friendable compatibility block:
+ *
+ * public function addFriend($friend_guid);
+ public function removeFriend($friend_guid);
+ public function isFriend();
+ public function isFriendsWith($user_guid);
+ public function isFriendOf($user_guid);
+ public function getFriends($subtype = "", $limit = 10, $offset = 0);
+ public function getFriendsOf($subtype = "", $limit = 10, $offset = 0);
+ public function getObjects($subtype="", $limit = 10, $offset = 0);
+ public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0);
+ public function countObjects($subtype = "");
+ */
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function addFriend($friend_guid) {
+ return $this->join(get_entity($friend_guid));
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function removeFriend($friend_guid) {
+ return $this->leave(get_entity($friend_guid));
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function isFriend() {
+ return $this->isMember();
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function isFriendsWith($user_guid) {
+ return $this->isMember($user_guid);
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function isFriendOf($user_guid) {
+ return $this->isMember($user_guid);
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function getFriends($subtype = "", $limit = 10, $offset = 0) {
+ return get_group_members($this->getGUID(), $limit, $offset);
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function getFriendsOf($subtype = "", $limit = 10, $offset = 0) {
+ return get_group_members($this->getGUID(), $limit, $offset);
+ }
+
+ /**
+ * Get objects contained in this group.
+ *
+ * @param string $subtype
+ * @param int $limit
+ * @param int $offset
+ * @return mixed
+ */
+ public function getObjects($subtype="", $limit = 10, $offset = 0)
+ {
+ return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", $limit, $offset, false);
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0) {
+ return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", $limit, $offset, false);
+ }
+
+ /**
+ * For compatibility with Friendable
+ */
+ public function countObjects($subtype = "") {
+ return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", 10, 0, true);
+ }
+
+ /**
+ * End friendable compatibility block
+ */
+
+ /**
+ * Get a list of group members.
+ *
+ * @param int $limit
+ * @param int $offset
+ * @return mixed
+ */
+ public function getMembers($limit = 10, $offset = 0, $count = false)
+ {
+ return get_group_members($this->getGUID(), $limit, $offset, 0 , $count);
+ }
+
+
+
+ /**
+ * Returns whether the current group is public membership or not.
+ * @return bool
+ */
+ public function isPublicMembership()
+ {
+ if ($this->membership == ACCESS_PUBLIC)
+ return true;
+
+ return false;
+ }
+
+ /**
+ * Return whether a given user is a member of this group or not.
+ *
+ * @param ElggUser $user The user
+ * @return bool
+ */
+ public function isMember($user = 0)
+ {
+ if (!($user instanceof ElggUser)) $user = get_loggedin_user();
+ if (!($user instanceof ElggUser)) return false;
+ return is_group_member($this->getGUID(), $user->getGUID());
+ }
+
+ /**
+ * Join an elgg user to this group.
+ *
+ * @param ElggUser $user
+ * @return bool
+ */
+ public function join(ElggUser $user)
+ {
+ return join_group($this->getGUID(), $user->getGUID());
+ }
+
+ /**
+ * Remove a user from the group.
+ *
+ * @param ElggUser $user
+ */
+ public function leave(ElggUser $user)
+ {
+ return leave_group($this->getGUID(), $user->getGUID());
+ }
+
+ /**
+ * Override the load function.
+ * This function will ensure that all data is loaded (were possible), so
+ * if only part of the ElggGroup is loaded, it'll load the rest.
+ *
+ * @param int $guid
+ */
+ protected function load($guid)
+ {
+ // Test to see if we have the generic stuff
+ if (!parent::load($guid))
+ return false;
+
+ // Check the type
+ if ($this->attributes['type']!='group')
+ throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));
+
+ // Load missing data
+ $row = get_group_entity_as_row($guid);
+ if (($row) && (!$this->isFullyLoaded())) $this->attributes['tables_loaded'] ++; // If $row isn't a cached copy then increment the counter
+
+ // Now put these into the attributes array as core values
+ $objarray = (array) $row;
+ foreach($objarray as $key => $value)
+ $this->attributes[$key] = $value;
+
+ return true;
+ }
+
+ /**
+ * Override the save function.
+ */
+ public function save()
+ {
+ // Save generic stuff
+ if (!parent::save())
+ return false;
+
+ // Now save specific stuff
+ return create_group_entity($this->get('guid'), $this->get('name'), $this->get('description'));
+ }
+
+ // EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////
+
+ /**
+ * Return an array of fields which can be exported.
+ */
+ public function getExportableValues()
+ {
+ return array_merge(parent::getExportableValues(), array(
+ 'name',
+ 'description',
+ ));
+ }
+ }
+
+ /**
+ * Get the group entity.
+ *
+ * @param int $guid
+ */
+ function get_group_entity_as_row($guid)
+ {
+ global $CONFIG;
+
+ $guid = (int)$guid;
+
+ /*$row = retrieve_cached_entity_row($guid);
+ if ($row)
+ {
+ // We have already cached this object, so retrieve its value from the cache
+ if (isset($CONFIG->debug) && $CONFIG->debug)
+ error_log("** Retrieving sub part of GUID:$guid from cache");
+
+ return $row;
+ }
+ else
+ {*/
+ // Object not cached, load it.
+ if (isset($CONFIG->debug) && $CONFIG->debug == true)
+ error_log("** Sub part of GUID:$guid loaded from DB");
+
+ return get_data_row("SELECT * from {$CONFIG->dbprefix}groups_entity where guid=$guid");
+ //}
+ }
+
+ /**
+ * Create or update the extras table for a given group.
+ * Call create_entity first.
+ *
+ * @param int $guid
+ * @param string $name
+ * @param string $description
+ */
+ function create_group_entity($guid, $name, $description)
+ {
+ global $CONFIG;
+
+ $guid = (int)$guid;
+ $name = sanitise_string($name);
+ $description = sanitise_string($description);
+
+ $row = get_entity_as_row($guid);
+
+ if ($row)
+ {
+ // Exists and you have access to it
+ if ($exists = get_data_row("SELECT guid from {$CONFIG->dbprefix}groups_entity WHERE guid = {$guid}")) {
+ $result = update_data("UPDATE {$CONFIG->dbprefix}groups_entity set name='$name', description='$description' where guid=$guid");
+ if ($result!=false)
+ {
+ // Update succeeded, continue
+ $entity = get_entity($guid);
+ if (trigger_elgg_event('update',$entity->type,$entity)) {
+ return $guid;
+ } else {
+ $entity->delete();
+ //delete_entity($guid);
+ }
+ }
+ }
+ else
+ {
+ // Update failed, attempt an insert.
+ $result = insert_data("INSERT into {$CONFIG->dbprefix}groups_entity (guid, name, description) values ($guid, '$name','$description')");
+ if ($result!==false) {
+ $entity = get_entity($guid);
+ if (trigger_elgg_event('create',$entity->type,$entity)) {
+ return $guid;
+ } else {
+ $entity->delete();
+ //delete_entity($guid);
+ }
+ }
+ }
+ }
+
+ return false;
+ }
+
+
/**
* THIS FUNCTION IS DEPRECATED.
- * \r
- * Delete a group's extra data.\r
- *\r
- * @param int $guid The guid of the group\r
- * @return bool\r
- */\r
- function delete_group_entity($guid)\r
+ *
+ * Delete a group's extra data.
+ *
+ * @param int $guid The guid of the group
+ * @return bool
+ */
+ function delete_group_entity($guid)
{
system_message(sprintf(elgg_echo('deprecatedfunction'), 'delete_user_entity'));
- return 1; // Always return that we have deleted one row in order to not break existing code.\r
- }\r
- \r
- /**\r
- * Add an object to the given group.\r
- *\r
- * @param int $group_guid The group to add the object to.\r
- * @param int $object_guid The guid of the elgg object (must be ElggObject or a child thereof)\r
- * @return bool\r
- */\r
- function add_object_to_group($group_guid, $object_guid)\r
- {\r
- $group_guid = (int)$group_guid;\r
- $object_guid = (int)$object_guid;\r
- \r
- $group = get_entity($group_guid);\r
- $object = get_entity($object_guid);\r
- \r
- if ((!$group) || (!$object)) return false;\r
- \r
- if (!($group instanceof ElggGroup))\r
- throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $group_guid, 'ElggGroup'));\r
-\r
- if (!($object instanceof ElggObject))\r
- throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $object_guid, 'ElggObject'));\r
-\r
- $object->container_guid = $group_guid;\r
- return $object->save();\r
- }\r
- \r
- /**\r
- * Remove an object from the given group.\r
- *\r
- * @param int $group_guid The group to remove the object from\r
- * @param int $object_guid The object to remove\r
- */\r
- function remove_object_from_group($group_guid, $object_guid)\r
- {\r
- $group_guid = (int)$group_guid;\r
- $object_guid = (int)$object_guid;\r
- \r
- $group = get_entity($group_guid);\r
- $object = get_entity($object_guid);\r
- \r
- if ((!$group) || (!$object)) return false;\r
- \r
- if (!($group instanceof ElggGroup))\r
- throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $group_guid, 'ElggGroup'));\r
-\r
- if (!($object instanceof ElggObject))\r
- throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $object_guid, 'ElggObject'));\r
-\r
- $object->container_guid = $object->owner_guid;\r
- return $object->save();\r
- }\r
- \r
- /**\r
- * Return an array of objects in a given container.\r
- * @see get_entities()\r
- *\r
- * @param int $group_guid The container (defaults to current page owner)\r
- * @param string $subtype The subtype\r
- * @param int $owner_guid Owner\r
- * @param int $site_guid The site\r
- * @param string $order_by Order\r
- * @param unknown_type $limit Limit on number of elements to return, by default 10.\r
- * @param unknown_type $offset Where to start, by default 0.\r
- * @param unknown_type $count Whether to return the entities or a count of them.\r
- */\r
- function get_objects_in_group($group_guid, $subtype = "", $owner_guid = 0, $site_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false)\r
- {\r
- global $CONFIG;\r
- \r
- if ($subtype === false || $subtype === null || $subtype === 0)\r
- return false;\r
- \r
- $subtype = get_subtype_id('object', $subtype);\r
- \r
- if ($order_by == "") $order_by = "e.time_created desc";\r
- $order_by = sanitise_string($order_by);\r
- $limit = (int)$limit;\r
- $offset = (int)$offset;\r
- $site_guid = (int) $site_guid;\r
- if ($site_guid == 0)\r
- $site_guid = $CONFIG->site_guid;\r
- \r
- $container_guid = (int)$group_guid;\r
- if ($container_guid == 0)\r
- $container_guid = page_owner();\r
- \r
- $where = array();\r
- \r
- $where[] = "e.type='object'";\r
- if ($subtype!=="")\r
- $where[] = "e.subtype=$subtype";\r
- if ($owner_guid != "") {\r
- if (!is_array($owner_guid)) {\r
- $owner_guid = (int) $owner_guid;\r
- $where[] = "e.container_guid = '$owner_guid'";\r
- } else if (sizeof($owner_guid) > 0) {\r
- // Cast every element to the owner_guid array to int\r
- $owner_guid = array_map("sanitise_int", $owner_guid);\r
- $owner_guid = implode(",",$owner_guid);\r
- $where[] = "e.container_guid in ({$owner_guid})";\r
- }\r
- }\r
- if ($site_guid > 0)\r
- $where[] = "e.site_guid = {$site_guid}";\r
-\r
- if ($container_guid > 0)\r
- $where[] = "e.container_guid = {$container_guid}";\r
- \r
- if (!$count) {\r
- $query = "SELECT * from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}objects_entity o on e.guid=o.guid where ";\r
- } else {\r
- $query = "SELECT count(e.guid) as total from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}objects_entity o on e.guid=o.guid where ";\r
- }\r
- foreach ($where as $w)\r
- $query .= " $w and ";\r
- $query .= get_access_sql_suffix('e'); // Add access controls\r
- if (!$count) {\r
- $query .= " order by $order_by";\r
- if ($limit) $query .= " limit $offset, $limit"; // Add order and limit\r
-\r
- $dt = get_data($query, "entity_row_to_elggstar");\r
- return $dt;\r
- } else {\r
- $total = get_data_row($query);\r
- return $total->total;\r
- }\r
- }\r
- \r
- /**\r
- * Get all the entities from metadata from a group.\r
- *\r
- * @param int $group_guid The ID of the group.\r
- * @param mixed $meta_name \r
- * @param mixed $meta_value\r
- * @param string $entity_type The type of entity to look for, eg 'site' or 'object'\r
- * @param string $entity_subtype The subtype of the entity.\r
- * @param int $limit \r
- * @param int $offset\r
- * @param string $order_by Optional ordering.\r
- * @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.\r
- * @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)\r
- */\r
- function get_entities_from_metadata_groups($group_guid, $meta_name, $meta_value = "", $entity_type = "", $entity_subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $order_by = "", $site_guid = 0, $count = false)\r
- {\r
- global $CONFIG;\r
- \r
- $meta_n = get_metastring_id($meta_name);\r
- $meta_v = get_metastring_id($meta_value);\r
- \r
- $entity_type = sanitise_string($entity_type);\r
- $entity_subtype = get_subtype_id($entity_type, $entity_subtype);\r
- $limit = (int)$limit;\r
- $offset = (int)$offset;\r
- if ($order_by == "") $order_by = "e.time_created desc";\r
- $order_by = sanitise_string($order_by);\r
- $site_guid = (int) $site_guid;\r
- if (is_array($owner_guid)) {\r
- foreach($owner_guid as $key => $guid) {\r
- $owner_guid[$key] = (int) $guid;\r
- }\r
- } else {\r
- $owner_guid = (int) $owner_guid;\r
- }\r
- if ($site_guid == 0)\r
- $site_guid = $CONFIG->site_guid;\r
- \r
- $container_guid = (int)$group_guid;\r
- if ($container_guid == 0)\r
- $container_guid = page_owner();\r
- \r
- //$access = get_access_list();\r
- \r
- $where = array();\r
- \r
- if ($entity_type!="")\r
- $where[] = "e.type='$entity_type'";\r
- if ($entity_subtype)\r
- $where[] = "e.subtype=$entity_subtype";\r
- if ($meta_name!="")\r
- $where[] = "m.name_id='$meta_n'";\r
- if ($meta_value!="")\r
- $where[] = "m.value_id='$meta_v'";\r
- if ($site_guid > 0)\r
- $where[] = "e.site_guid = {$site_guid}";\r
- if ($container_guid > 0)\r
- $where[] = "e.container_guid = {$container_guid}";\r
- if (is_array($owner_guid)) {\r
- $where[] = "e.container_guid in (".implode(",",$owner_guid).")";\r
- } else if ($owner_guid > 0)\r
- $where[] = "e.container_guid = {$owner_guid}";\r
- \r
- if (!$count) {\r
- $query = "SELECT distinct e.* "; \r
- } else {\r
- $query = "SELECT count(e.guid) as total ";\r
- }\r
- \r
- $query .= "from {$CONFIG->dbprefix}entities e JOIN {$CONFIG->dbprefix}metadata m on e.guid = m.entity_guid join {$CONFIG->dbprefix}objects_entity o on e.guid = o.guid where";\r
- foreach ($where as $w)\r
- $query .= " $w and ";\r
- $query .= get_access_sql_suffix("e"); // Add access controls\r
- \r
- if (!$count) {\r
- $query .= " order by $order_by limit $offset, $limit"; // Add order and limit\r
- return get_data($query, "entity_row_to_elggstar");\r
- } else {\r
- if ($row = get_data_row($query))\r
- return $row->total;\r
- }\r
- return false;\r
- }\r
- \r
- /**\r
- * As get_entities_from_metadata_groups() but with multiple entities.\r
- *\r
- * @param int $group_guid The ID of the group.\r
- * @param array $meta_array Array of 'name' => 'value' pairs\r
- * @param string $entity_type The type of entity to look for, eg 'site' or 'object'\r
- * @param string $entity_subtype The subtype of the entity.\r
- * @param int $limit \r
- * @param int $offset\r
- * @param string $order_by Optional ordering.\r
- * @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.\r
- * @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)\r
- * @return int|array List of ElggEntities, or the total number if count is set to false\r
- */\r
- function get_entities_from_metadata_groups_multi($group_guid, $meta_array, $entity_type = "", $entity_subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $order_by = "", $site_guid = 0, $count = false)\r
- {\r
- global $CONFIG;\r
- \r
- if (!is_array($meta_array) || sizeof($meta_array) == 0) {\r
- return false;\r
- }\r
- \r
- $where = array();\r
- \r
- $mindex = 1;\r
- $join = "";\r
- foreach($meta_array as $meta_name => $meta_value) {\r
- $meta_n = get_metastring_id($meta_name);\r
- $meta_v = get_metastring_id($meta_value);\r
- $join .= " JOIN {$CONFIG->dbprefix}metadata m{$mindex} on e.guid = m{$mindex}.entity_guid join {$CONFIG->dbprefix}objects_entity o on e.guid = o.guid "; \r
- if ($meta_name!="")\r
- $where[] = "m{$mindex}.name_id='$meta_n'";\r
- if ($meta_value!="")\r
- $where[] = "m{$mindex}.value_id='$meta_v'";\r
- $mindex++;\r
- }\r
- \r
- $entity_type = sanitise_string($entity_type);\r
- $entity_subtype = get_subtype_id($entity_type, $entity_subtype);\r
- $limit = (int)$limit;\r
- $offset = (int)$offset;\r
- if ($order_by == "") $order_by = "e.time_created desc";\r
- $order_by = sanitise_string($order_by);\r
- $owner_guid = (int) $owner_guid;\r
- \r
- $site_guid = (int) $site_guid;\r
- if ($site_guid == 0)\r
- $site_guid = $CONFIG->site_guid;\r
- \r
- //$access = get_access_list();\r
- \r
- if ($entity_type!="")\r
- $where[] = "e.type = '{$entity_type}'";\r
- if ($entity_subtype)\r
- $where[] = "e.subtype = {$entity_subtype}";\r
- if ($site_guid > 0)\r
- $where[] = "e.site_guid = {$site_guid}";\r
- if ($owner_guid > 0)\r
- $where[] = "e.owner_guid = {$owner_guid}";\r
- if ($container_guid > 0)\r
- $where[] = "e.container_guid = {$container_guid}";\r
- \r
- if ($count) {\r
- $query = "SELECT count(e.guid) as total ";\r
- } else {\r
- $query = "SELECT distinct e.* "; \r
- }\r
- \r
- $query .= " from {$CONFIG->dbprefix}entities e {$join} where";\r
- foreach ($where as $w)\r
- $query .= " $w and ";\r
- $query .= get_access_sql_suffix("e"); // Add access controls\r
- \r
- if (!$count) {\r
- $query .= " order by $order_by limit $offset, $limit"; // Add order and limit\r
- return get_data($query, "entity_row_to_elggstar");\r
- } else {\r
- if ($count = get_data_row($query)) {\r
- return $count->total;\r
- }\r
- }\r
- return false;\r
- }\r
- \r
- /**\r
- * Return a list of this group's members.\r
- * \r
- * @param int $group_guid The ID of the container/group.\r
- * @param int $limit The limit\r
- * @param int $offset The offset\r
- * @param int $site_guid The site\r
- * @param bool $count Return the users (false) or the count of them (true)\r
- * @return mixed\r
- */\r
- function get_group_members($group_guid, $limit = 10, $offset = 0, $site_guid = 0, $count = false)\r
- {\r
- return get_entities_from_relationship('member', $group_guid, true, 'user', '', 0, "", $limit, $offset, $count, $site_guid);\r
- }\r
- \r
- /**\r
- * Return whether a given user is a member of the group or not.\r
- * \r
- * @param int $group_guid The group ID\r
- * @param int $user_guid The user guid\r
- * @return bool\r
- */\r
- function is_group_member($group_guid, $user_guid)\r
- {\r
- return check_entity_relationship($user_guid, 'member', $group_guid);\r
- }\r
- \r
- /**\r
- * Join a user to a group.\r
- * \r
- * @param int $group_guid The group.\r
- * @param int $user_guid The user.\r
- */\r
- function join_group($group_guid, $user_guid)\r
- {\r
- trigger_elgg_event('join','group',array('group' => get_entity($group_guid), 'user' => get_entity($user_guid)));\r
- return add_entity_relationship($user_guid, 'member', $group_guid);\r
- }\r
- \r
- /**\r
- * Remove a user from a group.\r
- * \r
- * @param int $group_guid The group.\r
- * @param int $user_guid The user.\r
- */\r
- function leave_group($group_guid, $user_guid)\r
- {\r
- trigger_elgg_event('leave','group',array('group' => get_entity($group_guid), 'user' => get_entity($user_guid)));\r
- return remove_entity_relationship($user_guid, 'member', $group_guid);\r
- }\r
- \r
- /**\r
- * Return all groups a user is a member of.\r
- *\r
- * @param unknown_type $user_guid\r
- */\r
- function get_users_membership($user_guid)\r
- {\r
- return get_entities_from_relationship('member', $user_guid, false);\r
- }\r
- \r
- /**\r
- * Checks access to a group.\r
- *\r
- * @param boolean $forward If set to true (default), will forward the page; if set to false, will return true or false.\r
- * @return true|false If $forward is set to false.\r
- */\r
- function group_gatekeeper($forward = true) {\r
-\r
- $allowed = true;\r
- $url = '';\r
- \r
- if ($group = page_owner_entity()) {\r
- if ($group instanceof ElggGroup) {\r
- $url = $group->getURL();\r
+ return 1; // Always return that we have deleted one row in order to not break existing code.
+ }
+
+ /**
+ * Add an object to the given group.
+ *
+ * @param int $group_guid The group to add the object to.
+ * @param int $object_guid The guid of the elgg object (must be ElggObject or a child thereof)
+ * @return bool
+ */
+ function add_object_to_group($group_guid, $object_guid)
+ {
+ $group_guid = (int)$group_guid;
+ $object_guid = (int)$object_guid;
+
+ $group = get_entity($group_guid);
+ $object = get_entity($object_guid);
+
+ if ((!$group) || (!$object)) return false;
+
+ if (!($group instanceof ElggGroup))
+ throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $group_guid, 'ElggGroup'));
+
+ if (!($object instanceof ElggObject))
+ throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $object_guid, 'ElggObject'));
+
+ $object->container_guid = $group_guid;
+ return $object->save();
+ }
+
+ /**
+ * Remove an object from the given group.
+ *
+ * @param int $group_guid The group to remove the object from
+ * @param int $object_guid The object to remove
+ */
+ function remove_object_from_group($group_guid, $object_guid)
+ {
+ $group_guid = (int)$group_guid;
+ $object_guid = (int)$object_guid;
+
+ $group = get_entity($group_guid);
+ $object = get_entity($object_guid);
+
+ if ((!$group) || (!$object)) return false;
+
+ if (!($group instanceof ElggGroup))
+ throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $group_guid, 'ElggGroup'));
+
+ if (!($object instanceof ElggObject))
+ throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $object_guid, 'ElggObject'));
+
+ $object->container_guid = $object->owner_guid;
+ return $object->save();
+ }
+
+ /**
+ * Return an array of objects in a given container.
+ * @see get_entities()
+ *
+ * @param int $group_guid The container (defaults to current page owner)
+ * @param string $subtype The subtype
+ * @param int $owner_guid Owner
+ * @param int $site_guid The site
+ * @param string $order_by Order
+ * @param unknown_type $limit Limit on number of elements to return, by default 10.
+ * @param unknown_type $offset Where to start, by default 0.
+ * @param unknown_type $count Whether to return the entities or a count of them.
+ */
+ function get_objects_in_group($group_guid, $subtype = "", $owner_guid = 0, $site_guid = 0, $order_by = "", $limit = 10, $offset = 0, $count = false)
+ {
+ global $CONFIG;
+
+ if ($subtype === false || $subtype === null || $subtype === 0)
+ return false;
+
+ $subtype = get_subtype_id('object', $subtype);
+
+ if ($order_by == "") $order_by = "e.time_created desc";
+ $order_by = sanitise_string($order_by);
+ $limit = (int)$limit;
+ $offset = (int)$offset;
+ $site_guid = (int) $site_guid;
+ if ($site_guid == 0)
+ $site_guid = $CONFIG->site_guid;
+
+ $container_guid = (int)$group_guid;
+ if ($container_guid == 0)
+ $container_guid = page_owner();
+
+ $where = array();
+
+ $where[] = "e.type='object'";
+ if ($subtype!=="")
+ $where[] = "e.subtype=$subtype";
+ if ($owner_guid != "") {
+ if (!is_array($owner_guid)) {
+ $owner_guid = (int) $owner_guid;
+ $where[] = "e.container_guid = '$owner_guid'";
+ } else if (sizeof($owner_guid) > 0) {
+ // Cast every element to the owner_guid array to int
+ $owner_guid = array_map("sanitise_int", $owner_guid);
+ $owner_guid = implode(",",$owner_guid);
+ $where[] = "e.container_guid in ({$owner_guid})";
+ }
+ }
+ if ($site_guid > 0)
+ $where[] = "e.site_guid = {$site_guid}";
+
+ if ($container_guid > 0)
+ $where[] = "e.container_guid = {$container_guid}";
+
+ if (!$count) {
+ $query = "SELECT * from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}objects_entity o on e.guid=o.guid where ";
+ } else {
+ $query = "SELECT count(e.guid) as total from {$CONFIG->dbprefix}entities e join {$CONFIG->dbprefix}objects_entity o on e.guid=o.guid where ";
+ }
+ foreach ($where as $w)
+ $query .= " $w and ";
+ $query .= get_access_sql_suffix('e'); // Add access controls
+ if (!$count) {
+ $query .= " order by $order_by";
+ if ($limit) $query .= " limit $offset, $limit"; // Add order and limit
+
+ $dt = get_data($query, "entity_row_to_elggstar");
+ return $dt;
+ } else {
+ $total = get_data_row($query);
+ return $total->total;
+ }
+ }
+
+ /**
+ * Get all the entities from metadata from a group.
+ *
+ * @param int $group_guid The ID of the group.
+ * @param mixed $meta_name
+ * @param mixed $meta_value
+ * @param string $entity_type The type of entity to look for, eg 'site' or 'object'
+ * @param string $entity_subtype The subtype of the entity.
+ * @param int $limit
+ * @param int $offset
+ * @param string $order_by Optional ordering.
+ * @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
+ * @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)
+ */
+ function get_entities_from_metadata_groups($group_guid, $meta_name, $meta_value = "", $entity_type = "", $entity_subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $order_by = "", $site_guid = 0, $count = false)
+ {
+ global $CONFIG;
+
+ $meta_n = get_metastring_id($meta_name);
+ $meta_v = get_metastring_id($meta_value);
+
+ $entity_type = sanitise_string($entity_type);
+ $entity_subtype = get_subtype_id($entity_type, $entity_subtype);
+ $limit = (int)$limit;
+ $offset = (int)$offset;
+ if ($order_by == "") $order_by = "e.time_created desc";
+ $order_by = sanitise_string($order_by);
+ $site_guid = (int) $site_guid;
+ if (is_array($owner_guid)) {
+ foreach($owner_guid as $key => $guid) {
+ $owner_guid[$key] = (int) $guid;
+ }
+ } else {
+ $owner_guid = (int) $owner_guid;
+ }
+ if ($site_guid == 0)
+ $site_guid = $CONFIG->site_guid;
+
+ $container_guid = (int)$group_guid;
+ if ($container_guid == 0)
+ $container_guid = page_owner();
+
+ //$access = get_access_list();
+
+ $where = array();
+
+ if ($entity_type!="")
+ $where[] = "e.type='$entity_type'";
+ if ($entity_subtype)
+ $where[] = "e.subtype=$entity_subtype";
+ if ($meta_name!="")
+ $where[] = "m.name_id='$meta_n'";
+ if ($meta_value!="")
+ $where[] = "m.value_id='$meta_v'";
+ if ($site_guid > 0)
+ $where[] = "e.site_guid = {$site_guid}";
+ if ($container_guid > 0)
+ $where[] = "e.container_guid = {$container_guid}";
+ if (is_array($owner_guid)) {
+ $where[] = "e.container_guid in (".implode(",",$owner_guid).")";
+ } else if ($owner_guid > 0)
+ $where[] = "e.container_guid = {$owner_guid}";
+
+ if (!$count) {
+ $query = "SELECT distinct e.* ";
+ } else {
+ $query = "SELECT count(e.guid) as total ";
+ }
+
+ $query .= "from {$CONFIG->dbprefix}entities e JOIN {$CONFIG->dbprefix}metadata m on e.guid = m.entity_guid join {$CONFIG->dbprefix}objects_entity o on e.guid = o.guid where";
+ foreach ($where as $w)
+ $query .= " $w and ";
+ $query .= get_access_sql_suffix("e"); // Add access controls
+
+ if (!$count) {
+ $query .= " order by $order_by limit $offset, $limit"; // Add order and limit
+ return get_data($query, "entity_row_to_elggstar");
+ } else {
+ if ($row = get_data_row($query))
+ return $row->total;
+ }
+ return false;
+ }
+
+ /**
+ * As get_entities_from_metadata_groups() but with multiple entities.
+ *
+ * @param int $group_guid The ID of the group.
+ * @param array $meta_array Array of 'name' => 'value' pairs
+ * @param string $entity_type The type of entity to look for, eg 'site' or 'object'
+ * @param string $entity_subtype The subtype of the entity.
+ * @param int $limit
+ * @param int $offset
+ * @param string $order_by Optional ordering.
+ * @param int $site_guid The site to get entities for. Leave as 0 (default) for the current site; -1 for all sites.
+ * @param true|false $count If set to true, returns the total number of entities rather than a list. (Default: false)
+ * @return int|array List of ElggEntities, or the total number if count is set to false
+ */
+ function get_entities_from_metadata_groups_multi($group_guid, $meta_array, $entity_type = "", $entity_subtype = "", $owner_guid = 0, $limit = 10, $offset = 0, $order_by = "", $site_guid = 0, $count = false)
+ {
+ global $CONFIG;
+
+ if (!is_array($meta_array) || sizeof($meta_array) == 0) {
+ return false;
+ }
+
+ $where = array();
+
+ $mindex = 1;
+ $join = "";
+ foreach($meta_array as $meta_name => $meta_value) {
+ $meta_n = get_metastring_id($meta_name);
+ $meta_v = get_metastring_id($meta_value);
+ $join .= " JOIN {$CONFIG->dbprefix}metadata m{$mindex} on e.guid = m{$mindex}.entity_guid join {$CONFIG->dbprefix}objects_entity o on e.guid = o.guid ";
+ if ($meta_name!="")
+ $where[] = "m{$mindex}.name_id='$meta_n'";
+ if ($meta_value!="")
+ $where[] = "m{$mindex}.value_id='$meta_v'";
+ $mindex++;
+ }
+
+ $entity_type = sanitise_string($entity_type);
+ $entity_subtype = get_subtype_id($entity_type, $entity_subtype);
+ $limit = (int)$limit;
+ $offset = (int)$offset;
+ if ($order_by == "") $order_by = "e.time_created desc";
+ $order_by = sanitise_string($order_by);
+ $owner_guid = (int) $owner_guid;
+
+ $site_guid = (int) $site_guid;
+ if ($site_guid == 0)
+ $site_guid = $CONFIG->site_guid;
+
+ //$access = get_access_list();
+
+ if ($entity_type!="")
+ $where[] = "e.type = '{$entity_type}'";
+ if ($entity_subtype)
+ $where[] = "e.subtype = {$entity_subtype}";
+ if ($site_guid > 0)
+ $where[] = "e.site_guid = {$site_guid}";
+ if ($owner_guid > 0)
+ $where[] = "e.owner_guid = {$owner_guid}";
+ if ($container_guid > 0)
+ $where[] = "e.container_guid = {$container_guid}";
+
+ if ($count) {
+ $query = "SELECT count(e.guid) as total ";
+ } else {
+ $query = "SELECT distinct e.* ";
+ }
+
+ $query .= " from {$CONFIG->dbprefix}entities e {$join} where";
+ foreach ($where as $w)
+ $query .= " $w and ";
+ $query .= get_access_sql_suffix("e"); // Add access controls
+
+ if (!$count) {
+ $query .= " order by $order_by limit $offset, $limit"; // Add order and limit
+ return get_data($query, "entity_row_to_elggstar");
+ } else {
+ if ($count = get_data_row($query)) {
+ return $count->total;
+ }
+ }
+ return false;
+ }
+
+ /**
+ * Return a list of this group's members.
+ *
+ * @param int $group_guid The ID of the container/group.
+ * @param int $limit The limit
+ * @param int $offset The offset
+ * @param int $site_guid The site
+ * @param bool $count Return the users (false) or the count of them (true)
+ * @return mixed
+ */
+ function get_group_members($group_guid, $limit = 10, $offset = 0, $site_guid = 0, $count = false)
+ {
+ return get_entities_from_relationship('member', $group_guid, true, 'user', '', 0, "", $limit, $offset, $count, $site_guid);
+ }
+
+ /**
+ * Return whether a given user is a member of the group or not.
+ *
+ * @param int $group_guid The group ID
+ * @param int $user_guid The user guid
+ * @return bool
+ */
+ function is_group_member($group_guid, $user_guid)
+ {
+ return check_entity_relationship($user_guid, 'member', $group_guid);
+ }
+
+ /**
+ * Join a user to a group.
+ *
+ * @param int $group_guid The group.
+ * @param int $user_guid The user.
+ */
+ function join_group($group_guid, $user_guid)
+ {
+ $result = add_entity_relationship($user_guid, 'member', $group_guid);
+ trigger_elgg_event('join','group',array('group' => get_entity($group_guid), 'user' => get_entity($user_guid)));
+ return $result;
+ }
+
+ /**
+ * Remove a user from a group.
+ *
+ * @param int $group_guid The group.
+ * @param int $user_guid The user.
+ */
+ function leave_group($group_guid, $user_guid)
+ {
+ $result = remove_entity_relationship($user_guid, 'member', $group_guid);
+ trigger_elgg_event('leave','group',array('group' => get_entity($group_guid), 'user' => get_entity($user_guid)));
+ return $result;
+ }
+
+ /**
+ * Return all groups a user is a member of.
+ *
+ * @param unknown_type $user_guid
+ */
+ function get_users_membership($user_guid)
+ {
+ return get_entities_from_relationship('member', $user_guid, false);
+ }
+
+ /**
+ * Checks access to a group.
+ *
+ * @param boolean $forward If set to true (default), will forward the page; if set to false, will return true or false.
+ * @return true|false If $forward is set to false.
+ */
+ function group_gatekeeper($forward = true) {
+
+ $allowed = true;
+ $url = '';
+
+ if ($group = page_owner_entity()) {
+ if ($group instanceof ElggGroup) {
+ $url = $group->getURL();
if (
- ((!isloggedin()) && (!$group->isPublicMembership())) ||\r
- ((!$group->isMember(get_loggedin_user()) && (!$group->isPublicMembership())))\r
+ ((!isloggedin()) && (!$group->isPublicMembership())) ||
+ ((!$group->isMember(get_loggedin_user()) && (!$group->isPublicMembership())))
) $allowed = false;
// Admin override
- if (isadminloggedin()) $allowed = true;\r
- }\r
- }\r
- \r
- if ($forward && $allowed == false) {\r
- forward($url);\r
- exit;\r
- }\r
- \r
- return $allowed;\r
- \r
- }\r
- \r
- /**\r
- * Manages group tool options\r
- *\r
- * @param string $name Name of the group tool option\r
- * @param string $label Used for the group edit form\r
- * @param boolean $default_on True if this option should be active by default\r
- * \r
- **/\r
- \r
- function add_group_tool_option($name,$label,$default_on=true) {\r
- global $CONFIG;\r
- \r
- if (!isset($CONFIG->group_tool_options)) {\r
- $CONFIG->group_tool_options = array();\r
- }\r
- \r
- $group_tool_option = new stdClass;\r
- \r
- $group_tool_option->name = $name;\r
- $group_tool_option->label = $label;\r
- $group_tool_option->default_on = $default_on;\r
- \r
- $CONFIG->group_tool_options[] = $group_tool_option;\r
+ if (isadminloggedin()) $allowed = true;
+ }
+ }
+
+ if ($forward && $allowed == false) {
+ forward($url);
+ exit;
+ }
+
+ return $allowed;
+
+ }
+
+ /**
+ * Manages group tool options
+ *
+ * @param string $name Name of the group tool option
+ * @param string $label Used for the group edit form
+ * @param boolean $default_on True if this option should be active by default
+ *
+ **/
+
+ function add_group_tool_option($name,$label,$default_on=true) {
+ global $CONFIG;
+
+ if (!isset($CONFIG->group_tool_options)) {
+ $CONFIG->group_tool_options = array();
+ }
+
+ $group_tool_option = new stdClass;
+
+ $group_tool_option->name = $name;
+ $group_tool_option->label = $label;
+ $group_tool_option->default_on = $default_on;
+
+ $CONFIG->group_tool_options[] = $group_tool_option;
}
/**
return elgg_view_entity_list($entities, $count, $offset, $limit, $fullview, false);
- }\r
- \r
- /**\r
- * Performs initialisation functions for groups\r
- *\r
- */\r
+ }
+
+ /**
+ * Performs initialisation functions for groups
+ *
+ */
function group_init() {
- // Register an entity type\r
+ // Register an entity type
register_entity_type('group','');
// Register a search hook
- register_plugin_hook('search','all','search_list_groups_by_name');\r
- }\r
- \r
- register_elgg_event_handler('init','system','group_init');\r
- \r
-?>
\ No newline at end of file
+ register_plugin_hook('search','all','search_list_groups_by_name');
+ }
+
+ register_elgg_event_handler('init','system','group_init');
+
+?>
projects / lorea / elgg.git / commitdiff