Refs #2220: Pulled most classes / interfaces out of lib files (except query.php and exception.php) into "classes" folder. Replaced inline classes with "require_once" statements for now. Ran unit tests to verify functionality before committing.

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

1 files changed, 199 insertions, 0 deletions

diff --git a/engine/classes/ElggObject.php b/engine/classes/ElggObject.php
new file mode 100644
index 000000000..af67ef3f6
--- /dev/null
+++ b/engine/classes/ElggObject.php
@@ -0,0 +1,199 @@
+<?php

+

+/**

+ * 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'] = "";

+		$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->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 (!$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) {

+				elgg_deprecated_notice('This type of usage of the ElggObject constructor was deprecated. Please use the clone method.', 1.7);

+

+				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)) {

+					throw new 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

+		$row = get_object_entity_as_row($guid);

+		if (($row) && (!$this->isFullyLoaded())) {

+			// If $row isn't a cached copy then increment the counter

+			$this->attributes['tables_loaded'] ++;

+		}

+

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

+	}

+

+	/**

+	 * Set the container for this object.

+	 *

+	 * @param int $container_guid The ID of the container.

+	 * @return bool

+	 */

+	function setContainer($container_guid) {

+		$container_guid = (int)$container_guid;

+

+		return $this->set('container_guid', $container_guid);

+	}

+

+	/**

+	 * Return the container GUID of this object.

+	 *

+	 * @return int

+	 */

+	function getContainer() {

+		return $this->get('container_guid');

+	}

+

+	/**

+	 * As getContainer(), but returns the whole entity.

+	 *

+	 * @return mixed ElggGroup object or false.

+	 */

+	function getContainerEntity() {

+		$result = get_entity($this->getContainer());

+

+		if (($result) && ($result instanceof ElggGroup)) {

+			return $result;

+		}

+

+		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); }

+

+	// EXPORTABLE INTERFACE ////////////////////////////////////////////////////////////

+

+	/**

+	 * Return an array of fields which can be exported.

+	 */

+	public function getExportableValues() {

+		return array_merge(parent::getExportableValues(), array(

+			'title',

+			'description',

+		));

+	}

+}
\ No newline at end of file