aboutsummaryrefslogtreecommitdiff
path: root/engine/lib
diff options
context:
space:
mode:
Diffstat (limited to 'engine/lib')
-rw-r--r--engine/lib/sites.php478
1 files changed, 477 insertions, 1 deletions
diff --git a/engine/lib/sites.php b/engine/lib/sites.php
index c9785e4ab..2ab8bc630 100644
--- a/engine/lib/sites.php
+++ b/engine/lib/sites.php
@@ -11,7 +11,483 @@
* @copyright Curverider Ltd 2008
* @link http://elgg.org/
*/
-
+
+
+ /**
+ * @class ElggSite
+ * This class represents an elgg site.
+ * @author Marcus Povey <marcus@dushka.co.uk>
+ */
+ class ElggSite
+ {
+
+ /**
+ * This contains the site's main properties (id, etc)
+ * @var array
+ */
+ private $attributes;
+
+ /**
+ * Construct a new site object, optionally from a given id value.
+ *
+ * @param int $id
+ */
+ function __construct($id = null)
+ {
+ if (!empty($id)) {
+
+ $site = null;
+
+ if (is_int($id))
+ $site = get_site($id); // This is an integer ID
+ else
+ $site = get_site_byurl($id); // Otherwise assume URL
+
+ if ($site) {
+ $objarray = (array) $site;
+ foreach($objarray as $key => $value) {
+ $this->attributes[$key] = $value;
+ }
+ }
+ }
+ }
+
+ function __get($name) {
+ if (isset($attributes[$name])) {
+ return $attributes[$name];
+ }
+ return null;
+ }
+
+ function __set($name, $value) {
+ $this->attributes[$name] = $value;
+ return true;
+ }
+
+ /**
+ * Return the owner of this site.
+ *
+ * @return mixed
+ */
+ function getOwner() { return get_user($this->owner_id); }
+
+ /**
+ * Return a list of users using this site.
+ *
+ * @param int $limit
+ * @param int $offset
+ * @return array of ElggUsers
+ */
+ function getMembers($limit, $offset) { return get_site_users($this->id, $limit, $offset); }
+
+ /**
+ * Get an array of member ElggObjects.
+ *
+ * @param string $type
+ * @param int $limit
+ * @param int $offset
+ */
+ function getObjects($type="", $limit = 10, $offset = 0) { return get_site_objects($this->id, $type, $limit, $offset); }
+
+ /**
+ * Get the collections associated with a site.
+ *
+ * @param string $type
+ * @param int $limit
+ * @param int $offset
+ * @return unknown
+ */
+ function getCollections($type="", $limit = 10, $offset = 0) { return get_site_collections($this->id, $type, $limit, $offset); }
+
+ /**
+ * Add a user to the site.
+ *
+ * @param int $user_id
+ */
+ function addUser($user_id) { return add_site_user($this->id, $user_id); }
+
+ /**
+ * Remove a site user.
+ *
+ * @param int $user_id
+ */
+ function removeUser($user_id) { return remove_site_user($this->id, $user_id); }
+
+ /**
+ * Set the meta data.
+ *
+ * @param string $name
+ * @param string $value
+ * @param int $access_id
+ * @param string $vartype
+ */
+ function setMetadata($name, $value, $access_id = 0, $vartype = "") { return set_site_metadata($name, $value, $access_id, $this->id, $vartype); }
+
+ /**
+ * Get the metadata for a site.
+ *
+ * @param string $name
+ */
+ function getMetadata($name) { return get_site_metadata($name, $this->id); }
+
+ /**
+ * Clear the metadata for a given site.
+ *
+ * @param string $name
+ */
+ function clearMetadata($name = "") { return remove_site_metadata($this->id, $name); }
+
+ /**
+ * Adds an annotation to a site. By default, the type is detected automatically; however,
+ * it can also be set. Note that by default, annotations are private.
+ *
+ * @param string $name
+ * @param string $value
+ * @param int $access_id
+ * @param int $owner_id
+ * @param string $vartype
+ */
+ function annotate($name, $value, $access_id = 0, $owner_id = 0, $vartype = "") { return add_site_annotation($name, $value, $access_id, $owner_id, $this->id, $vartype); }
+
+ /**
+ * Get the annotations for a site.
+ *
+ * @param string $name
+ * @param int $limit
+ * @param int $offset
+ */
+ function getAnnotations($name, $limit = 50, $offset = 0) { return get_site_annotations($name, $limit, $offset); }
+
+ /**
+ * Return the annotations for the site.
+ *
+ * @param string $name The type of annotation.
+ */
+ function countAnnotations($name) { return count_site_annotations($name, $this->id); }
+
+ /**
+ * Get the average of an integer type annotation.
+ *
+ * @param string $name
+ */
+ function getAnnotationsAvg($name) { return get_site_annotations_avg($name, $this->id); }
+
+ /**
+ * Get the sum of integer type annotations of a given type.
+ *
+ * @param string $name
+ */
+ function getAnnotationsSum($name) { return get_site_annotations_sum($name, $this->id); }
+
+ /**
+ * Get the minimum of integer type annotations of given type.
+ *
+ * @param string $name
+ */
+ function getAnnotationsMin($name) { return get_site_annotations_min($name, $this->id); }
+
+ /**
+ * Get the maximum of integer type annotations of a given type.
+ *
+ * @param string $name
+ */
+ function getAnnotationsMax($name) { return get_site_annotations_max($name, $this->id); }
+
+ /**
+ * Remove all annotations or all annotations of a given site.
+ *
+ * @param string $name
+ */
+ function removeAnnotations($name = "") { return remove_site_annotations($this->id, $name); }
+
+ /**
+ * Saves or updates the site to the db depending on whether or not id is specified.
+ */
+ function save()
+ {
+
+
+
+
+
+ }
+
+ /**
+ * Delete a given site.
+ */
+ function delete() { return delete_site($this->id); }
+ }
+
+
+
+
+ // todo: Get sites
+
+
+ /**
+ * Retrieves details about a site, if the current user is allowed to see it
+ *
+ * @param int $object_id The ID of the object to load
+ * @return object A database representation of the object
+ */
+ function get_site($site_id) {
+
+ global $CONFIG;
+
+ $site_id = (int) $site_id;
+ $access = get_access_list();
+
+ return get_data_row("select o.* from {$CONFIG->dbprefix}sites where id=$site_id and (o.access_id in {$access} or (o.access_id = 0 and o.owner_id = {$_SESSION['id']}))");
+
+ }
+
+ /**
+ * Retrieve details about a site via its URL, if the current user is allowed to see it
+ *
+ * @param string $url
+ * @return object A database representation of the object
+ */
+ function get_site_byurl($url)
+ {
+ global $CONFIG;
+
+ $url = mysql_real_escape_string(trim($url));
+ $access = get_access_list();
+
+ return get_data_row("select o.* from {$CONFIG->dbprefix}sites where url='$url' and (o.access_id in {$access} or (o.access_id = 0 and o.owner_id = {$_SESSION['id']}))");
+
+ }
+
+ /**
+ * Get a list of users using a given site.
+ *
+ * @param int $site_id
+ * @param int $limit
+ * @param int $offset
+ */
+ function get_site_users($site_id, $limit, $offset)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the objects for a given site
+ *
+ * @param int $site_id
+ * @param string $type
+ * @param int $limit
+ * @param int $offset
+ */
+ function get_site_objects($site_id, $type = "", $limit = 10, $offset = 0)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the collections associated with this site.
+ *
+ * @param int $site_id
+ * @param string $type
+ * @param int $limit
+ * @param int $offset
+ */
+ function get_site_collections($site_id, $type = "", $limit = 10, $offset = 0)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Add a site user.
+ *
+ * @param int $site_id
+ * @param int $user_id
+ */
+ function add_site_user($site_id, $user_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Remove a site user.
+ *
+ * @param int $site_id
+ * @param int $user_id
+ */
+ function remove_site_user($site_id, $user_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Set the site metadata.
+ *
+ * @param string $name
+ * @param string $value
+ * @param int $access_id
+ * @param int $site_id
+ * @param string $vartype
+ */
+ function set_site_metadata($name, $value, $access_id, $site_id, $vartype = "")
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the site metadata.
+ *
+ * @param string $name
+ * @param int $site_id
+ */
+ function get_site_metadata($name, $site_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Remove site metadata
+ *
+ * @param int $site_id
+ * @param string $name
+ */
+ function remove_site_metadata($site_id, $name)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Adds an annotation to a site. By default, the type is detected automatically;
+ * however, it can also be set. Note that by default, annotations are private.
+ *
+ * @param string $name
+ * @param string $value
+ * @param int $access_id
+ * @param int $owner_id
+ * @param int $site_id
+ * @param string $vartype
+ */
+ function add_site_annotation($name, $value, $access_id, $owner_id, $site_id, $vartype)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the annotations for a site.
+ *
+ * @param string $name
+ * @param int $site_id
+ * @param int $limit
+ * @param int $offset
+ */
+ function get_site_annotations($name, $site_id, $limit, $offset)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Count the site annotations for a site of a given type.
+ *
+ * @param string $name
+ * @param int $site_id
+ */
+ function count_site_annotations($name, $site_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the average of an integer type annotation.
+ *
+ * @param string $name
+ * @param int $site_id
+ */
+ function get_site_annotations_avg($name, $site_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the sum of integer type annotations of a given type.
+ *
+ * @param string $name
+ * @param int $site_id
+ */
+ function get_site_annotations_sum($name, $site_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the min of integer type annotations of a given type.
+ *
+ * @param string $name
+ * @param int $site_id
+ */
+ function get_site_annotations_min($name, $site_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Get the max of integer type annotations of a given type.
+ *
+ * @param string $name
+ * @param int $site_id
+ */
+ function get_site_annotations_max($name, $site_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Remove all site annotations, or site annotations of a given type.
+ *
+ * @param int $site_id
+ * @param string $name
+ */
+ function remove_site_annotations($site_id, $name)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Create a site.
+ *
+ * @param string $title
+ * @param string $description
+ * @param string $url
+ * @param int $owner_id
+ * @param int $access_id
+ */
+ function create_site($title, $description, $url, $owner_id, $access_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Saves or updates the site to the db depending on whether or not id is specified
+ *
+ * @param int $id
+ * @param string $title
+ * @param string $description
+ * @param string $url
+ * @param int $owner_id
+ * @param int $access_id
+ */
+ function update_site($id, $title, $description, $url, $owner_id, $access_id)
+ {
+ // TODO : Writeme
+ }
+
+ /**
+ * Delete a given site.
+ *
+ * @param int $site_id
+ */
+ function delete_site($site_id)
+ {
+ // TODO : Writeme
+ }
+
/**
* Initialise site handling
*
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-30 03:50:26 +0000