Standardized code in all of core, not including language files, tests, or core mods.

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

1 files changed, 40 insertions, 21 deletions

diff --git a/engine/lib/export.php b/engine/lib/export.php
index 667366cc4..eaf2fd3dd 100644
--- a/engine/lib/export.php
+++ b/engine/lib/export.php
@@ -2,14 +2,15 @@
 /**
  * Elgg Data import export functionality.
  *
- * @package Elgg
- * @subpackage Core
+ * @package Elgg.Core
+ * @subpackage DataModel.Export
  */
 
 /**
  * Get a UUID from a given object.
  *
- * @param $object The object either an ElggEntity, ElggRelationship or ElggExtender
+ * @param mixed $object The object either an ElggEntity, ElggRelationship or ElggExtender
+ *
  * @return the UUID or false
  */
 function get_uuid_from_object($object) {
@@ -18,9 +19,9 @@ function get_uuid_from_object($object) {
 	} else if ($object instanceof ElggExtender) {
 		$type = $object->type;
 		if ($type == 'volatile') {
-			$uuid = guid_to_uuid($object->entity_guid). $type . "/{$object->name}/";
+			$uuid = guid_to_uuid($object->entity_guid) . $type . "/{$object->name}/";
 		} else {
-			$uuid = guid_to_uuid($object->entity_guid). $type . "/{$object->id}/";
+			$uuid = guid_to_uuid($object->entity_guid) . $type . "/{$object->id}/";
 		}
 
 		return $uuid;
@@ -35,6 +36,8 @@ function get_uuid_from_object($object) {
  * Generate a UUID from a given GUID.
  *
  * @param int $guid The GUID of an object.
+ *
+ * @return string
  */
 function guid_to_uuid($guid) {
 	global $CONFIG;
@@ -44,7 +47,9 @@ function guid_to_uuid($guid) {
 
 /**
  * Test to see if a given uuid is for this domain, returning true if so.
- * @param $uuid
+ *
+ * @param string $uuid A unique ID
+ *
  * @return bool
  */
 function is_uuid_this_domain($uuid) {
@@ -60,12 +65,15 @@ function is_uuid_this_domain($uuid) {
 /**
  * This function attempts to retrieve a previously imported entity via its UUID.
  *
- * @param $uuid
+ * @param string $uuid A unique ID
+ *
+ * @return mixed
  */
 function get_entity_from_uuid($uuid) {
 	$uuid = sanitise_string($uuid);
 
-	$entities = elgg_get_entities_from_metadata(array('metadata_name' => 'import_uuid', 'metadata_value' => $uuid));
+	$options = array('metadata_name' => 'import_uuid', 'metadata_value' => $uuid);
+	$entities = elgg_get_entities_from_metadata($options);
 
 	if ($entities) {
 		return $entities[0];
@@ -77,8 +85,9 @@ function get_entity_from_uuid($uuid) {
 /**
  * Tag a previously created guid with the uuid it was imported on.
  *
- * @param int $guid
- * @param string $uuid
+ * @param int    $guid A GUID
+ * @param string $uuid A Unique ID
+ *
  * @return bool
  */
 function add_uuid_to_guid($guid, $uuid) {
@@ -100,8 +109,10 @@ $IMPORTED_OBJECT_COUNTER = 0;
  * If nobody processes the top level element, the sub level elements are processed.
  *
  * @param ODD $odd The odd element to process
+ *
+ * @return bool
  */
-function __process_element(ODD $odd) {
+function _process_element(ODD $odd) {
 	global $IMPORTED_DATA, $IMPORTED_OBJECT_COUNTER;
 
 	// See if anyone handles this element, return true if it is.
@@ -122,17 +133,22 @@ function __process_element(ODD $odd) {
 	return false;
 }
 
+/**
+ * Exports an entity as an array
+ *
+ * @param int $guid Entity GUID
+ *
+ * @return array
+ * @throws ExportException
+ */
 function exportAsArray($guid) {
 	$guid = (int)$guid;
 
-	// Initialise the array
-	$to_be_serialised = array();
-
 	// Trigger a hook to
-	$to_be_serialised = trigger_plugin_hook("export", "all", array("guid" => $guid), $to_be_serialised);
+	$to_be_serialised = trigger_plugin_hook("export", "all", array("guid" => $guid), array());
 
 	// Sanity check
-	if ((!is_array($to_be_serialised)) || (count($to_be_serialised)==0)) {
+	if ((!is_array($to_be_serialised)) || (count($to_be_serialised) == 0)) {
 		throw new ExportException(sprintf(elgg_echo('ExportException:NoSuchEntity'), $guid));
 	}
 
@@ -147,10 +163,10 @@ function exportAsArray($guid) {
  * This function makes use of the "serialise" plugin hook, which is passed an array to which plugins
  * should add data to be serialised to.
  *
- * @see ElggEntity for an example of its usage.
  * @param int $guid The GUID.
- * @param ODDWrapperFactory $wrapper Optional wrapper permitting the export process to embed ODD in other document formats.
+ *
  * @return xml
+ * @see ElggEntity for an example of its usage.
  */
 function export($guid) {
 	$odd = new ODDDocument(exportAsArray($guid));
@@ -162,7 +178,8 @@ function export($guid) {
  * Import an XML serialisation of an object.
  * This will make a best attempt at importing a given xml doc.
  *
- * @param string $xml
+ * @param string $xml XML string
+ *
  * @return bool
  * @throws Exception if there was a problem importing the data.
  */
@@ -178,10 +195,10 @@ function import($xml) {
 	}
 
 	foreach ($document as $element) {
-		__process_element($element);
+		_process_element($element);
 	}
 
-	if ($IMPORTED_OBJECT_COUNTER!= count($IMPORTED_DATA)) {
+	if ($IMPORTED_OBJECT_COUNTER != count($IMPORTED_DATA)) {
 		throw new ImportException(elgg_echo('ImportException:NotAllImported'));
 	}
 
@@ -191,6 +208,8 @@ function import($xml) {
 
 /**
  * Register the OpenDD import action
+ *
+ * @return void
  */
 function export_init() {
 	global $CONFIG;