All line endings are now Unix-style.

git-svn-id: https://code.elgg.org/elgg/trunk@3451 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 208 insertions, 208 deletions

diff --git a/engine/lib/objects.php b/engine/lib/objects.php
index 4090c1c24..7e7e956a4 100644
--- a/engine/lib/objects.php
+++ b/engine/lib/objects.php
@@ -1,147 +1,147 @@
-<?php

-

-	/**

-	 * Elgg objects

-	 * Functions to manage multiple or single objects in an Elgg install

-	 * 

-	 * @package Elgg

-	 * @subpackage Core

+<?php
 
-	 * @author Curverider Ltd

+	/**
+	 * Elgg objects
+	 * Functions to manage multiple or single objects in an Elgg install
+	 * 
+	 * @package Elgg
+	 * @subpackage Core
+
+	 * @author Curverider Ltd
+
+	 * @link http://elgg.org/
+	 */
 
-	 * @link http://elgg.org/

-	 */

-

-	/**

-	 * ElggObject

+	/**
+	 * ElggObject
 	 * Representation of an "object" in the system.
 	 * 
 	 * @package Elgg
-	 * @subpackage Core

-	 */

-	class ElggObject extends ElggEntity

-	{

-		/**

-		 * Initialise the attributes array. 

-		 * This is vital to distinguish between metadata and base parameters.

-		 * 

-		 * Place your base parameters here.

-		 */

-		protected function initialise_attributes()

-		{

-			parent::initialise_attributes();

-			

-			$this->attributes['type'] = "object";

-			$this->attributes['title'] = "";

+	 * @subpackage Core
+	 */
+	class ElggObject extends ElggEntity
+	{
+		/**
+		 * Initialise the attributes array. 
+		 * This is vital to distinguish between metadata and base parameters.
+		 * 
+		 * Place your base parameters here.
+		 */
+		protected function initialise_attributes()
+		{
+			parent::initialise_attributes();
+			
+			$this->attributes['type'] = "object";
+			$this->attributes['title'] = "";
 			$this->attributes['description'] = "";
-			$this->attributes['tables_split'] = 2;

-		}

-				

-		/**

-		 * Construct a new object 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 object. 

-		 */

-		function __construct($guid = null) 

-		{			

+			$this->attributes['tables_split'] = 2;
+		}
+				
+		/**
+		 * Construct a new object 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 object. 
+		 */
+		function __construct($guid = null) 
+		{			
 			$this->initialise_attributes();
-			

-			if (!empty($guid))

-			{

-				// Is $guid is a DB row - either a entity row, or a object table row.

-				if ($guid instanceof stdClass) {					

-					// Load the rest

+			
+			if (!empty($guid))
+			{
+				// Is $guid is a DB row - either a entity row, or a object 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 ElggObject? Use a copy constructor

-				else if ($guid instanceof ElggObject)

-				{					

-					 foreach ($guid->attributes as $key => $value) 

-					 	$this->attributes[$key] = $value;

-				}

-				

-				// Is this is an ElggEntity but not an ElggObject = ERROR!

-				else if ($guid instanceof ElggEntity)

-					throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggObject'));

-										

-				// 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));

+						throw new IOException(sprintf(elgg_echo('IOException:FailedToLoadGUID'), get_class(), $guid->guid)); 
+				}
+				
+				// Is $guid is an ElggObject? Use a copy constructor
+				else if ($guid instanceof ElggObject)
+				{					
+					 foreach ($guid->attributes as $key => $value) 
+					 	$this->attributes[$key] = $value;
+				}
+				
+				// Is this is an ElggEntity but not an ElggObject = ERROR!
+				else if ($guid instanceof ElggEntity)
+					throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggObject'));
+										
+				// 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'));

-			}

-		}

-		

-		/**

-		 * Override the load function.

-		 * This function will ensure that all data is loaded (were possible), so

-		 * if only part of the ElggObject is loaded, it'll load the rest.

-		 * 

-		 * @param int $guid

-		 * @return true|false 

-		 */

-		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']!='object')

-				throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));

-				

-			// Load missing data

+					throw new InvalidParameterException(elgg_echo('InvalidParameterException:UnrecognisedValue'));
+			}
+		}
+		
+		/**
+		 * Override the load function.
+		 * This function will ensure that all data is loaded (were possible), so
+		 * if only part of the ElggObject is loaded, it'll load the rest.
+		 * 
+		 * @param int $guid
+		 * @return true|false 
+		 */
+		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']!='object')
+				throw new InvalidClassException(sprintf(elgg_echo('InvalidClassException:NotValidElggStar'), $guid, get_class()));
+				
+			// Load missing data
 			$row = get_object_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.

-		 * @return true|false

-		 */

-		public function save()

-		{

-			// Save generic stuff

-			if (!parent::save())

-				return false;

-			

-			// Now save specific stuff

+			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.
+		 * @return true|false
+		 */
+		public function save()
+		{
+			// Save generic stuff
+			if (!parent::save())
+				return false;
+			
+			// Now save specific stuff
 			return create_object_entity($this->get('guid'), $this->get('title'), $this->get('description'), $this->get('container_guid'));
 		}
-		

-		/**

-		 * Get sites that this object is a member of

-		 *

-		 * @param string $subtype Optionally, the subtype of result we want to limit to

-		 * @param int $limit The number of results to return

-		 * @param int $offset Any indexing offset

-		 */

-		function getSites($subtype="", $limit = 10, $offset = 0) {

-			return get_site_objects($this->getGUID(), $subtype, $limit, $offset);

-		}

-		

-		/**

-		 * Add this object to a particular site

-		 *

-		 * @param int $site_guid The guid of the site to add it to

-		 * @return true|false

-		 */

-		function addToSite($site_guid) {

-			return add_site_object($this->getGUID(), $site_guid); 

-		}

+		
+		/**
+		 * Get sites that this object is a member of
+		 *
+		 * @param string $subtype Optionally, the subtype of result we want to limit to
+		 * @param int $limit The number of results to return
+		 * @param int $offset Any indexing offset
+		 */
+		function getSites($subtype="", $limit = 10, $offset = 0) {
+			return get_site_objects($this->getGUID(), $subtype, $limit, $offset);
+		}
+		
+		/**
+		 * Add this object to a particular site
+		 *
+		 * @param int $site_guid The guid of the site to add it to
+		 * @return true|false
+		 */
+		function addToSite($site_guid) {
+			return add_site_object($this->getGUID(), $site_guid); 
+		}
 
 		/**
 		 * Set the container for this object.
@@ -180,16 +180,16 @@
 				
 			return false;
 		}
-		

-		/**

-		 * Get the collections associated with a object.

-		 *

-		 * @param string $subtype Optionally, the subtype of result we want to limit to

-		 * @param int $limit The number of results to return

-		 * @param int $offset Any indexing offset

-		 * @return unknown

-		 */

-		//public function getCollections($subtype="", $limit = 10, $offset = 0) { get_object_collections($this->getGUID(), $subtype, $limit, $offset); }

+		
+		/**
+		 * Get the collections associated with a object.
+		 *
+		 * @param string $subtype Optionally, the subtype of result we want to limit to
+		 * @param int $limit The number of results to return
+		 * @param int $offset Any indexing offset
+		 * @return unknown
+		 */
+		//public function getCollections($subtype="", $limit = 10, $offset = 0) { get_object_collections($this->getGUID(), $subtype, $limit, $offset); }
 		
 		// EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////
 		
@@ -202,18 +202,18 @@
 				'title',
 				'description',
 			));
-		}

-	}

-

-	/**

-	 * Return the object specific details of a object by a row.

-	 * 

-	 * @param int $guid

-	 */

-	function get_object_entity_as_row($guid)

-	{

-		global $CONFIG;

-		

+		}
+	}
+
+	/**
+	 * Return the object specific details of a object by a row.
+	 * 
+	 * @param int $guid
+	 */
+	function get_object_entity_as_row($guid)
+	{
+		global $CONFIG;
+		
 		$guid = (int)$guid;
 		
 		/*$row = retrieve_cached_entity_row($guid);
@@ -229,31 +229,31 @@
 		{*/
 			// Object not cached, load it.
 			if ($CONFIG->debug)
-				error_log("** Sub part of GUID:$guid loaded from DB");

-		

+				error_log("** Sub part of GUID:$guid loaded from DB");
+		
 			return get_data_row("SELECT * from {$CONFIG->dbprefix}objects_entity where guid=$guid");
-		//}

-	}

-	

-	/**

-	 * Create or update the extras table for a given object.

-	 * Call create_entity first.

-	 * 

-	 * @param int $guid The guid of the entity you're creating (as obtained by create_entity)

-	 * @param string $title The title of the object

-	 * @param string $description The object's description

-	 */

-	function create_object_entity($guid, $title, $description)

-	{

-		global $CONFIG;

-		

-		$guid = (int)$guid;

-		$title = sanitise_string($title);

+		//}
+	}
+	
+	/**
+	 * Create or update the extras table for a given object.
+	 * Call create_entity first.
+	 * 
+	 * @param int $guid The guid of the entity you're creating (as obtained by create_entity)
+	 * @param string $title The title of the object
+	 * @param string $description The object's description
+	 */
+	function create_object_entity($guid, $title, $description)
+	{
+		global $CONFIG;
+		
+		$guid = (int)$guid;
+		$title = sanitise_string($title);
 		$description = sanitise_string($description);
-		

-		$row = get_entity_as_row($guid);

-		

-		if ($row)

+		
+		$row = get_entity_as_row($guid);
+		
+		if ($row)
 		{
 			// Core entities row exists and we have access to it
 			if ($exists = get_data_row("SELECT guid from {$CONFIG->dbprefix}objects_entity where guid = {$guid}")) {
@@ -267,7 +267,7 @@
 					} else {
 						$entity->delete();
 					}
-				}

+				}
 			}
 			else
 			{
@@ -283,25 +283,25 @@
 						//delete_entity($guid);
 					}
 				}
-			}

-			

-		}

-		

-		return false;

-	}

-	

+			}
+			
+		}
+		
+		return false;
+	}
+	
 	/**
 	 * THIS FUNCTION IS DEPRECATED.
-	 * 

-	 * Delete a object's extra data.

-	 * 

-	 * @param int $guid

-	 */

-	function delete_object_entity($guid)

+	 * 
+	 * Delete a object's extra data.
+	 * 
+	 * @param int $guid
+	 */
+	function delete_object_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.

+		return 1; // Always return that we have deleted one row in order to not break existing code.
 	}
 	
 	/**
@@ -347,22 +347,22 @@
 			}
 		}
 		return false;
-	}

-

-	/**

-	 * Get the sites this object is part of

-	 *

-	 * @param int $object_guid The object's GUID

-	 * @param int $limit Number of results to return

-	 * @param int $offset Any indexing offset

-	 * @return false|array On success, an array of ElggSites

-	 */

-	function get_object_sites($object_guid, $limit = 10, $offset = 0) {

-		$object_guid = (int)$object_guid;

-		$limit = (int)$limit;

-		$offset = (int)$offset;

-		

-		return get_entities_from_relationship("member_of_site", $object_guid, false, "site", "", 0, "time_created desc", $limit, $offset);

-	}

-		

+	}
+
+	/**
+	 * Get the sites this object is part of
+	 *
+	 * @param int $object_guid The object's GUID
+	 * @param int $limit Number of results to return
+	 * @param int $offset Any indexing offset
+	 * @return false|array On success, an array of ElggSites
+	 */
+	function get_object_sites($object_guid, $limit = 10, $offset = 0) {
+		$object_guid = (int)$object_guid;
+		$limit = (int)$limit;
+		$offset = (int)$offset;
+		
+		return get_entities_from_relationship("member_of_site", $object_guid, false, "site", "", 0, "time_created desc", $limit, $offset);
+	}
+		
 ?>
\ No newline at end of file