From 85e4c16f39a8b00b229644bcd175663541dfd51a Mon Sep 17 00:00:00 2001
From: Steve Clay <steve@mrclay.org>
Date: Mon, 4 Feb 2013 20:37:25 -0500
Subject: Doc fixes and inline type hints for variables (big static analysis
 cleanup)

---
 engine/lib/plugins.php | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 94aff277e..3a42cb9b8 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -107,6 +107,7 @@ function elgg_generate_plugin_entities() {
 	$old_access = access_get_show_hidden_status();
 	access_show_hidden_entities(true);
 	$known_plugins = elgg_get_entities_from_relationship($options);
+	/* @var ElggPlugin[] $known_plugins */
 
 	if (!$known_plugins) {
 		$known_plugins = array();
@@ -192,7 +193,7 @@ function _elgg_cache_plugin_by_id(ElggPlugin $plugin) {
  * Returns an ElggPlugin object with the path $path.
  *
  * @param string $plugin_id The id (dir name) of the plugin. NOT the guid.
- * @return mixed ElggPlugin or false.
+ * @return ElggPlugin|false
  * @since 1.8.0
  */
 function elgg_get_plugin_from_id($plugin_id) {
@@ -360,7 +361,7 @@ function elgg_load_plugins() {
  *
  * @param string $status      The status of the plugins. active, inactive, or all.
  * @param mixed  $site_guid   Optional site guid
- * @return array
+ * @return ElggPlugin[]
  * @since 1.8.0
  * @access private
  */
@@ -861,9 +862,9 @@ function elgg_set_plugin_user_setting($name, $value, $user_guid = null, $plugin_
 /**
  * Unsets a user-specific plugin setting
  *
- * @param str $name      Name of the setting
+ * @param string $name      Name of the setting
  * @param int $user_guid Defaults to logged in user
- * @param str $plugin_id Defaults to contextual plugin name
+ * @param string $plugin_id Defaults to contextual plugin name
  *
  * @return bool
  * @since 1.8.0
@@ -1087,7 +1088,7 @@ function plugin_run_once() {
 /**
  * Runs unit tests for the entity objects.
  *
- * @param sting  $hook   unit_test
+ * @param string  $hook   unit_test
  * @param string $type   system
  * @param mixed  $value  Array of tests
  * @param mixed  $params Params
-- 
cgit v1.2.3


From 707df9db27cf2154910978427b9844448bcf931a Mon Sep 17 00:00:00 2001
From: Steve Clay <steve@mrclay.org>
Date: Mon, 4 Feb 2013 20:51:07 -0500
Subject: Small changes to remove static analysis noise and simplify flow

---
 engine/classes/ElggAutoP.php           | 11 ++++++-----
 engine/classes/ElggData.php            |  1 +
 engine/classes/ElggDiskFilestore.php   |  2 --
 engine/classes/ElggFile.php            |  4 +++-
 engine/classes/ElggGroup.php           |  2 +-
 engine/classes/ElggMenuBuilder.php     |  1 +
 engine/classes/ElggRelationship.php    |  2 ++
 engine/lib/admin.php                   |  2 +-
 engine/lib/annotations.php             |  1 +
 engine/lib/cache.php                   |  6 +++---
 engine/lib/configuration.php           |  2 +-
 engine/lib/cron.php                    |  1 -
 engine/lib/elgglib.php                 |  1 +
 engine/lib/export.php                  | 17 +++++++++--------
 engine/lib/location.php                |  2 +-
 engine/lib/plugins.php                 | 16 +++++++++-------
 engine/lib/relationships.php           |  3 +--
 engine/lib/river.php                   |  1 +
 engine/lib/sessions.php                |  2 +-
 engine/lib/sites.php                   |  2 +-
 engine/lib/statistics.php              |  3 ++-
 engine/lib/system_log.php              |  6 +++---
 engine/lib/tags.php                    |  1 +
 engine/lib/upgrades/create_upgrade.php |  3 ++-
 engine/lib/user_settings.php           |  1 +
 engine/lib/users.php                   | 16 ++++++++--------
 engine/lib/views.php                   |  6 +-----
 27 files changed, 62 insertions(+), 53 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/classes/ElggAutoP.php b/engine/classes/ElggAutoP.php
index 40600aa13..f3c7cc972 100644
--- a/engine/classes/ElggAutoP.php
+++ b/engine/classes/ElggAutoP.php
@@ -159,8 +159,9 @@ class ElggAutoP {
 			/* @var DOMElement $el */
 			$autops = $this->_xpath->query('./autop', $el);
 			if ($autops->length === 1) {
-				// strip w/ preg_replace later (faster than moving nodes out)
-				$autops->item(0)->setAttribute("r", "1");
+				$firstAutop = $autops->item(0);
+				/* @var DOMElement $firstAutop */
+				$firstAutop->setAttribute("r", "1");
 			}
 		}
 
@@ -220,12 +221,12 @@ class ElggAutoP {
 
 				$isElement = ($node->nodeType === XML_ELEMENT_NODE);
 				if ($isElement) {
-					$elName = $node->nodeName;
+					$isBlock = in_array($node->nodeName, $this->_blocks);
+				} else {
+					$isBlock = false;
 				}
-				$isBlock = ($isElement && in_array($elName, $this->_blocks));
 
 				if ($alterInline) {
-					$isInline = $isElement && ! $isBlock;
 					$isText = ($node->nodeType === XML_TEXT_NODE);
 					$isLastInline = (! $node->nextSibling
 								   || ($node->nextSibling->nodeType === XML_ELEMENT_NODE
diff --git a/engine/classes/ElggData.php b/engine/classes/ElggData.php
index a0df3c924..426248ca3 100644
--- a/engine/classes/ElggData.php
+++ b/engine/classes/ElggData.php
@@ -273,6 +273,7 @@ abstract class ElggData implements
 		if (array_key_exists($key, $this->attributes)) {
 			return $this->attributes[$key];
 		}
+		return null;
 	}
 
 	/**
diff --git a/engine/classes/ElggDiskFilestore.php b/engine/classes/ElggDiskFilestore.php
index 5483eed81..2d86e7c2d 100644
--- a/engine/classes/ElggDiskFilestore.php
+++ b/engine/classes/ElggDiskFilestore.php
@@ -316,8 +316,6 @@ class ElggDiskFilestore extends ElggFilestore {
 		} else {
 			return str_split($string);
 		}
-
-		return false;
 	}
 
 	/**
diff --git a/engine/classes/ElggFile.php b/engine/classes/ElggFile.php
index 86406d108..3f652ff19 100644
--- a/engine/classes/ElggFile.php
+++ b/engine/classes/ElggFile.php
@@ -127,9 +127,11 @@ class ElggFile extends ElggObject {
 	 * @param mixed $default A default. Useful to pass what the browser thinks it is.
 	 * @since 1.7.12
 	 *
+	 * @note If $file is provided, this may be called statically
+	 *
 	 * @return mixed Detected type on success, false on failure.
 	 */
-	static function detectMimeType($file = null, $default = null) {
+	public function detectMimeType($file = null, $default = null) {
 		if (!$file) {
 			if (isset($this) && $this->filename) {
 				$file = $this->filename;
diff --git a/engine/classes/ElggGroup.php b/engine/classes/ElggGroup.php
index d17fa4f1a..24bdee79e 100644
--- a/engine/classes/ElggGroup.php
+++ b/engine/classes/ElggGroup.php
@@ -284,7 +284,7 @@ class ElggGroup extends ElggEntity
 	 *
 	 * @return bool
 	 */
-	public function isMember($user = 0) {
+	public function isMember($user = null) {
 		if (!($user instanceof ElggUser)) {
 			$user = elgg_get_logged_in_user_entity();
 		}
diff --git a/engine/classes/ElggMenuBuilder.php b/engine/classes/ElggMenuBuilder.php
index 2fd5ad9c4..028eef15f 100644
--- a/engine/classes/ElggMenuBuilder.php
+++ b/engine/classes/ElggMenuBuilder.php
@@ -122,6 +122,7 @@ class ElggMenuBuilder {
 			// attach children to parents
 			$iteration = 0;
 			$current_gen = $parents;
+			$next_gen = null;
 			while (count($children) && $iteration < 5) {
 				foreach ($children as $index => $menu_item) {
 					$parent_name = $menu_item->getParentName();
diff --git a/engine/classes/ElggRelationship.php b/engine/classes/ElggRelationship.php
index 377a41093..d2e88882a 100644
--- a/engine/classes/ElggRelationship.php
+++ b/engine/classes/ElggRelationship.php
@@ -180,6 +180,8 @@ class ElggRelationship extends ElggData implements
 				return true;
 			}
 		}
+
+		return false;
 	}
 
 	// SYSTEM LOG INTERFACE ////////////////////////////////////////////////////////////
diff --git a/engine/lib/admin.php b/engine/lib/admin.php
index 3677a3b69..ec19a5476 100644
--- a/engine/lib/admin.php
+++ b/engine/lib/admin.php
@@ -346,7 +346,7 @@ function elgg_admin_add_plugin_settings_menu() {
 	$active_plugins = elgg_get_plugins('active');
 	if (!$active_plugins) {
 		// nothing added because no items
-		return FALSE;
+		return;
 	}
 
 	foreach ($active_plugins as $plugin) {
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index 9ba0491b2..3d94a1d55 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -542,6 +542,7 @@ function elgg_comment_url_handler(ElggAnnotation $comment) {
 	if ($entity) {
 		return $entity->getURL() . '#item-annotation-' . $comment->id;
 	}
+	return "";
 }
 
 /**
diff --git a/engine/lib/cache.php b/engine/lib/cache.php
index 5c917bb18..74644019c 100644
--- a/engine/lib/cache.php
+++ b/engine/lib/cache.php
@@ -125,7 +125,7 @@ function elgg_get_filepath_cache() {
  * @access private
  */
 function elgg_filepath_cache_reset() {
-	return elgg_reset_system_cache();
+	elgg_reset_system_cache();
 }
 /**
  * @access private
@@ -143,13 +143,13 @@ function elgg_filepath_cache_load($type) {
  * @access private
  */
 function elgg_enable_filepath_cache() {
-	return elgg_enable_system_cache();
+	elgg_enable_system_cache();
 }
 /**
  * @access private
  */
 function elgg_disable_filepath_cache() {
-	return elgg_disable_system_cache();
+	elgg_disable_system_cache();
 }
 
 /* Simplecache */
diff --git a/engine/lib/configuration.php b/engine/lib/configuration.php
index 851430127..a0f297f0c 100644
--- a/engine/lib/configuration.php
+++ b/engine/lib/configuration.php
@@ -182,7 +182,7 @@ function verify_installation() {
 	global $CONFIG;
 
 	if (isset($CONFIG->installed)) {
-		return $CONFIG->installed;
+		return;
 	}
 
 	try {
diff --git a/engine/lib/cron.php b/engine/lib/cron.php
index f2939bdd6..dd83a9849 100644
--- a/engine/lib/cron.php
+++ b/engine/lib/cron.php
@@ -52,7 +52,6 @@ function cron_page_handler($page) {
 	$params['time'] = time();
 
 	// Data to return to
-	$std_out = "";
 	$old_stdout = "";
 	ob_start();
 
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index 746fd8aa9..6a2ebf97b 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -1903,6 +1903,7 @@ function elgg_cacheable_view_page_handler($page, $type) {
 		echo $return;
 		return true;
 	}
+	return false;
 }
 
 /**
diff --git a/engine/lib/export.php b/engine/lib/export.php
index 31afc1b74..1996bc885 100644
--- a/engine/lib/export.php
+++ b/engine/lib/export.php
@@ -117,18 +117,19 @@ function _process_element(ODD $odd) {
 	global $IMPORTED_DATA, $IMPORTED_OBJECT_COUNTER;
 
 	// See if anyone handles this element, return true if it is.
+	$to_be_serialised = null;
 	if ($odd) {
 		$handled = elgg_trigger_plugin_hook("import", "all", array("element" => $odd), $to_be_serialised);
-	}
 
-	// If not, then see if any of its sub elements are handled
-	if ($handled) {
-		// Increment validation counter
-		$IMPORTED_OBJECT_COUNTER ++;
-		// Return the constructed object
-		$IMPORTED_DATA[] = $handled;
+		// If not, then see if any of its sub elements are handled
+		if ($handled) {
+			// Increment validation counter
+			$IMPORTED_OBJECT_COUNTER ++;
+			// Return the constructed object
+			$IMPORTED_DATA[] = $handled;
 
-		return true;
+			return true;
+		}
 	}
 
 	return false;
diff --git a/engine/lib/location.php b/engine/lib/location.php
index 5b889509b..b319bb3bb 100644
--- a/engine/lib/location.php
+++ b/engine/lib/location.php
@@ -101,7 +101,7 @@ function elgg_get_entities_from_location(array $options = array()) {
 	$long_min = $long - $long_distance;
 	$long_max = $long + $long_distance;
 
-	$where = array();
+	$wheres = array();
 	$wheres[] = "lat_name.string='geo:lat'";
 	$wheres[] = "lat_value.string >= $lat_min";
 	$wheres[] = "lat_value.string <= $lat_max";
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 3a42cb9b8..973ca4026 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -261,6 +261,8 @@ function elgg_get_max_plugin_priority() {
 	$data = get_data($q);
 	if ($data) {
 		$max = $data[0]->max;
+	} else {
+		$max = 1;
 	}
 
 	// can't have a priority of 0.
@@ -442,6 +444,7 @@ function elgg_set_plugin_priorities(array $order) {
 	// though we do start with 1
 	$order = array_values($order);
 
+	$missing_plugins = array();
 	foreach ($plugins as $plugin) {
 		$plugin_id = $plugin->getID();
 
@@ -640,19 +643,18 @@ function elgg_get_plugins_provides($type = null, $name = null) {
  * @access private
  */
 function elgg_check_plugins_provides($type, $name, $version = null, $comparison = 'ge') {
-	if (!$provided = elgg_get_plugins_provides($type, $name)) {
+	$provided = elgg_get_plugins_provides($type, $name);
+	if (!$provided) {
 		return array(
 			'status' => false,
 			'version' => ''
 		);
 	}
 
-	if ($provided) {
-		if ($version) {
-			$status = version_compare($provided['version'], $version, $comparison);
-		} else {
-			$status = true;
-		}
+	if ($version) {
+		$status = version_compare($provided['version'], $version, $comparison);
+	} else {
+		$status = true;
 	}
 
 	return array(
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 74954b4ff..6f18bda93 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -571,9 +571,8 @@ function import_relationship_plugin_hook($hook, $entity_type, $returnvalue, $par
 	if ($element instanceof ODDRelationship) {
 		$tmp = new ElggRelationship();
 		$tmp->import($element);
-
-		return $tmp;
 	}
+	return $tmp;
 }
 
 /**
diff --git a/engine/lib/river.php b/engine/lib/river.php
index 148fee051..6274887b5 100644
--- a/engine/lib/river.php
+++ b/engine/lib/river.php
@@ -500,6 +500,7 @@ function elgg_get_river_type_subtype_where_sql($table, $types, $subtypes, $pairs
 		return '';
 	}
 
+	$wheres = array();
 	$types_wheres = array();
 	$subtypes_wheres = array();
 
diff --git a/engine/lib/sessions.php b/engine/lib/sessions.php
index 72ca0a1c2..eb451f05a 100644
--- a/engine/lib/sessions.php
+++ b/engine/lib/sessions.php
@@ -616,7 +616,7 @@ function _elgg_session_destroy($id) {
 		global $sess_save_path;
 
 		$sess_file = "$sess_save_path/sess_$id";
-		return(@unlink($sess_file));
+		return (@unlink($sess_file));
 	}
 
 	return false;
diff --git a/engine/lib/sites.php b/engine/lib/sites.php
index fe9af8c7a..8ee3213d3 100644
--- a/engine/lib/sites.php
+++ b/engine/lib/sites.php
@@ -26,7 +26,7 @@ function elgg_get_site_entity($site_guid = 0) {
 		$site = get_entity($site_guid);
 	}
 	
-	if($site instanceof ElggSite){
+	if ($site instanceof ElggSite) {
 		$result = $site;
 	}
 
diff --git a/engine/lib/statistics.php b/engine/lib/statistics.php
index 5ee640549..0c9a3c945 100644
--- a/engine/lib/statistics.php
+++ b/engine/lib/statistics.php
@@ -101,9 +101,10 @@ function get_online_users() {
 	if ($objects) {
 		return elgg_view_entity_list($objects, array(
 			'count' => $count,
-			'limit' => 10
+			'limit' => 10,
 		));
 	}
+	return '';
 }
 
 /**
diff --git a/engine/lib/system_log.php b/engine/lib/system_log.php
index 8149d3fac..38bc4ba96 100644
--- a/engine/lib/system_log.php
+++ b/engine/lib/system_log.php
@@ -25,9 +25,9 @@
  * @param string    $ip_address The IP address.
  * @return mixed
  */
-function get_system_log($by_user = "", $event = "", $class = "", $type = "", $subtype = "",
-$limit = 10, $offset = 0, $count = false, $timebefore = 0, $timeafter = 0, $object_id = 0,
-$ip_address = false) {
+function get_system_log($by_user = "", $event = "", $class = "", $type = "", $subtype = "", $limit = 10,
+						$offset = 0, $count = false, $timebefore = 0, $timeafter = 0, $object_id = 0,
+						$ip_address = "") {
 
 	global $CONFIG;
 
diff --git a/engine/lib/tags.php b/engine/lib/tags.php
index a25bd7d33..586a9b9e4 100644
--- a/engine/lib/tags.php
+++ b/engine/lib/tags.php
@@ -172,6 +172,7 @@ function elgg_get_tags(array $options = array()) {
 	// catch for tags that were spaces
 	$wheres[] = "msv.string != ''";
 
+	$sanitised_tags = array();
 	foreach ($options['tag_names'] as $tag) {
 		$sanitised_tags[] = '"' . sanitise_string($tag) . '"';
 	}
diff --git a/engine/lib/upgrades/create_upgrade.php b/engine/lib/upgrades/create_upgrade.php
index 3652e18a2..f0fa9b594 100644
--- a/engine/lib/upgrades/create_upgrade.php
+++ b/engine/lib/upgrades/create_upgrade.php
@@ -93,7 +93,7 @@ if (!$h) {
 	die("Could not open file $upgrade_file");
 }
 
-if (!fputs($h, $upgrade_code)) {
+if (!fwrite($h, $upgrade_code)) {
 	die("Could not write to $upgrade_file");
 } else {
 	elgg_set_version_dot_php_version($upgrade_version);
@@ -130,6 +130,7 @@ function elgg_set_version_dot_php_version($version) {
 
 	fputs($h, $out);
 	fclose($h);
+	return true;
 }
 
 /**
diff --git a/engine/lib/user_settings.php b/engine/lib/user_settings.php
index e4069fb53..cca5359a4 100644
--- a/engine/lib/user_settings.php
+++ b/engine/lib/user_settings.php
@@ -332,6 +332,7 @@ function usersettings_page_handler($page) {
 		require $path;
 		return true;
 	}
+	return false;
 }
 
 /**
diff --git a/engine/lib/users.php b/engine/lib/users.php
index 22ce08e10..7a6245261 100644
--- a/engine/lib/users.php
+++ b/engine/lib/users.php
@@ -560,7 +560,7 @@ function get_user_by_username($username) {
 
 	// Caching
 	if ((isset($USERNAME_TO_GUID_MAP_CACHE[$username]))
-	&& (retrieve_cached_entity($USERNAME_TO_GUID_MAP_CACHE[$username]))) {
+			&& (retrieve_cached_entity($USERNAME_TO_GUID_MAP_CACHE[$username]))) {
 		return retrieve_cached_entity($USERNAME_TO_GUID_MAP_CACHE[$username]);
 	}
 
@@ -687,15 +687,14 @@ function send_new_password_request($user_guid) {
 		$code = generate_random_cleartext_password();
 		$user->setPrivateSetting('passwd_conf_code', $code);
 
-
 		// generate link
-		$link = $CONFIG->site->url . "resetpassword?u=$user_guid&c=$code";
+		$link = elgg_get_site_url() . "resetpassword?u=$user_guid&c=$code";
 
 		// generate email
 		$email = elgg_echo('email:resetreq:body', array($user->name, $_SERVER['REMOTE_ADDR'], $link));
 
-		return notify_user($user->guid, $CONFIG->site->guid,
-			elgg_echo('email:resetreq:subject'), $email, NULL, 'email');
+		return notify_user($user->guid, elgg_get_site_entity()->guid,
+			elgg_echo('email:resetreq:subject'), $email, array(), 'email');
 	}
 
 	return false;
@@ -760,7 +759,7 @@ function execute_new_password_request($user_guid, $conf_code) {
 				$email = elgg_echo('email:resetpassword:body', array($user->name, $password));
 
 				return notify_user($user->guid, $CONFIG->site->guid,
-					elgg_echo('email:resetpassword:subject'), $email, NULL, 'email');
+					elgg_echo('email:resetpassword:subject'), $email, array(), 'email');
 			}
 		}
 	}
@@ -1036,7 +1035,7 @@ function elgg_get_user_validation_status($user_guid) {
 		'metadata_name' => 'validated'
 	));
 	if ($md == false) {
-		return;
+		return null;
 	}
 
 	if ($md[0]->value) {
@@ -1208,7 +1207,8 @@ function set_last_login($user_guid) {
 function user_create_hook_add_site_relationship($event, $object_type, $object) {
 	global $CONFIG;
 
-	add_entity_relationship($object->getGUID(), 'member_of_site', $CONFIG->site->getGUID());
+	add_entity_relationship($object->getGUID(), 'member_of_site', elgg_get_site_entity()->guid);
+	return true;
 }
 
 /**
diff --git a/engine/lib/views.php b/engine/lib/views.php
index 9ee7ae00c..7d8347863 100644
--- a/engine/lib/views.php
+++ b/engine/lib/views.php
@@ -1451,17 +1451,13 @@ function elgg_get_views($dir, $base) {
  */
 function elgg_view_tree($view_root, $viewtype = "") {
 	global $CONFIG;
-	static $treecache;
+	static $treecache = array();
 
 	// Get viewtype
 	if (!$viewtype) {
 		$viewtype = elgg_get_viewtype();
 	}
 
-	// Has the treecache been initialised?
-	if (!isset($treecache)) {
-		$treecache = array();
-	}
 	// A little light internal caching
 	if (!empty($treecache[$view_root])) {
 		return $treecache[$view_root];
-- 
cgit v1.2.3


From 78e0ec583619cbb728cbe03df857c8219acaac7e Mon Sep 17 00:00:00 2001
From: Steve Clay <steve@mrclay.org>
Date: Mon, 4 Feb 2013 20:55:04 -0500
Subject: simplify flow, style

---
 engine/classes/ElggAttributeLoader.php |  8 ++++----
 engine/lib/annotations.php             |  2 +-
 engine/lib/entities.php                | 21 +++++++++++----------
 engine/lib/notification.php            |  2 +-
 engine/lib/objects.php                 |  2 +-
 engine/lib/plugins.php                 |  2 +-
 engine/lib/users.php                   |  4 ++--
 7 files changed, 21 insertions(+), 20 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/classes/ElggAttributeLoader.php b/engine/classes/ElggAttributeLoader.php
index 602bb8bae..2d1c1abde 100644
--- a/engine/classes/ElggAttributeLoader.php
+++ b/engine/classes/ElggAttributeLoader.php
@@ -148,11 +148,11 @@ class ElggAttributeLoader {
 				if (!is_callable($this->primary_loader)) {
 					throw new LogicException('Primary attribute loader must be callable');
 				}
-				if (!$this->requires_access_control) {
+				if ($this->requires_access_control) {
+					$fetched = (array) call_user_func($this->primary_loader, $row['guid']);
+				} else {
 					$ignoring_access = elgg_set_ignore_access();
-				}
-				$fetched = (array) call_user_func($this->primary_loader, $row['guid']);
-				if (!$this->requires_access_control) {
+					$fetched = (array) call_user_func($this->primary_loader, $row['guid']);
 					elgg_set_ignore_access($ignoring_access);
 				}
 				if (!$fetched) {
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index 3d94a1d55..a95aba8f8 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -469,7 +469,7 @@ function export_annotation_plugin_hook($hook, $entity_type, $returnvalue, $param
 
 	$result = elgg_get_annotations(array(
 		'guid' => $guid,
-		'limit' => 0
+		'limit' => 0,
 	));
 
 	if ($result) {
diff --git a/engine/lib/entities.php b/engine/lib/entities.php
index 0361ae195..e3535c741 100644
--- a/engine/lib/entities.php
+++ b/engine/lib/entities.php
@@ -1120,16 +1120,17 @@ function _elgg_fetch_entities_from_sql($sql) {
 	// Do secondary queries and merge rows
 	if ($lookup_types) {
 		$dbprefix = elgg_get_config('dbprefix');
-	}
-	foreach ($lookup_types as $type => $guids) {
-		$set = "(" . implode(',', $guids) . ")";
-		$sql = "SELECT * FROM {$dbprefix}{$type}s_entity WHERE guid IN $set";
-		$secondary_rows = get_data($sql);
-		if ($secondary_rows) {
-			foreach ($secondary_rows as $secondary_row) {
-				$key = $guid_to_key[$secondary_row->guid];
-				// cast to arrays to merge then cast back
-				$rows[$key] = (object)array_merge((array)$rows[$key], (array)$secondary_row);
+
+		foreach ($lookup_types as $type => $guids) {
+			$set = "(" . implode(',', $guids) . ")";
+			$sql = "SELECT * FROM {$dbprefix}{$type}s_entity WHERE guid IN $set";
+			$secondary_rows = get_data($sql);
+			if ($secondary_rows) {
+				foreach ($secondary_rows as $secondary_row) {
+					$key = $guid_to_key[$secondary_row->guid];
+					// cast to arrays to merge then cast back
+					$rows[$key] = (object)array_merge((array)$rows[$key], (array)$secondary_row);
+				}
 			}
 		}
 	}
diff --git a/engine/lib/notification.php b/engine/lib/notification.php
index 4191407fc..d72b1352a 100644
--- a/engine/lib/notification.php
+++ b/engine/lib/notification.php
@@ -264,7 +264,7 @@ array $params = NULL) {
 	$to = $to->email;
 
 	// From
-	$site = get_entity($CONFIG->site_guid);
+	$site = elgg_get_site_entity();
 	// If there's an email address, use it - but only if its not from a user.
 	if (!($from instanceof ElggUser) && $from->email) {
 		$from = $from->email;
diff --git a/engine/lib/objects.php b/engine/lib/objects.php
index 81b6b7f12..ff3cc733f 100644
--- a/engine/lib/objects.php
+++ b/engine/lib/objects.php
@@ -95,7 +95,7 @@ function get_object_sites($object_guid, $limit = 10, $offset = 0) {
 		'relationship_guid' => $object_guid,
 		'type' => 'site',
 		'limit' => $limit,
-		'offset' => $offset
+		'offset' => $offset,
 	));
 }
 
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 973ca4026..d6f03c795 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -139,7 +139,7 @@ function elgg_generate_plugin_entities() {
 			$index = $id_map[$plugin_id];
 			$plugin = $known_plugins[$index];
 			// was this plugin deleted and its entity disabled?
-			if ($plugin->enabled != 'yes') {
+			if (!$plugin->isEnabled()) {
 				$plugin->enable();
 				$plugin->deactivate();
 				$plugin->setPriority('last');
diff --git a/engine/lib/users.php b/engine/lib/users.php
index 7365a6b68..c4e06895d 100644
--- a/engine/lib/users.php
+++ b/engine/lib/users.php
@@ -1071,10 +1071,10 @@ function collections_submenu_items() {
  * @return bool
  * @access private
  */
-function friends_page_handler($page_elements, $handler) {
+function friends_page_handler($segments, $handler) {
 	elgg_set_context('friends');
 	
-	if (isset($page_elements[0]) && $user = get_user_by_username($page_elements[0])) {
+	if (isset($segments[0]) && $user = get_user_by_username($segments[0])) {
 		elgg_set_page_owner_guid($user->getGUID());
 	}
 	if (elgg_get_logged_in_user_guid() == elgg_get_page_owner_guid()) {
-- 
cgit v1.2.3


From 269d3621531a80b13221a2f6e663efe2ad20ccaa Mon Sep 17 00:00:00 2001
From: Steve Clay <steve@mrclay.org>
Date: Mon, 4 Feb 2013 20:59:06 -0500
Subject: remove unused code: vars, foreach keys, etc

---
 engine/classes/ElggEntity.php      |  2 --
 engine/classes/ElggFile.php        |  1 -
 engine/classes/ElggMenuBuilder.php |  1 -
 engine/lib/annotations.php         |  1 -
 engine/lib/cron.php                |  2 --
 engine/lib/database.php            | 16 ++++++++--------
 engine/lib/elgglib.php             | 12 +++---------
 engine/lib/export.php              |  4 ----
 engine/lib/filestore.php           |  2 --
 engine/lib/input.php               |  2 --
 engine/lib/languages.php           |  2 --
 engine/lib/metastrings.php         |  3 ---
 engine/lib/navigation.php          |  6 +++---
 engine/lib/notification.php        |  2 +-
 engine/lib/output.php              |  1 -
 engine/lib/plugins.php             |  2 --
 engine/lib/relationships.php       |  3 ---
 engine/lib/river.php               |  4 ----
 engine/lib/sessions.php            |  6 ------
 engine/lib/sites.php               |  4 ----
 engine/lib/upgrade.php             |  3 ---
 engine/lib/users.php               |  9 ---------
 22 files changed, 15 insertions(+), 73 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/classes/ElggEntity.php b/engine/classes/ElggEntity.php
index 0cb8e5f7c..f44e73023 100644
--- a/engine/classes/ElggEntity.php
+++ b/engine/classes/ElggEntity.php
@@ -1735,8 +1735,6 @@ abstract class ElggEntity extends ElggData implements
 	 * @return array
 	 */
 	public function getTags($tag_names = NULL) {
-		global $CONFIG;
-
 		if ($tag_names && !is_array($tag_names)) {
 			$tag_names = array($tag_names);
 		}
diff --git a/engine/classes/ElggFile.php b/engine/classes/ElggFile.php
index 3f652ff19..532db3617 100644
--- a/engine/classes/ElggFile.php
+++ b/engine/classes/ElggFile.php
@@ -365,7 +365,6 @@ class ElggFile extends ElggObject {
 		// need to get all filestore::* metadata because the rest are "parameters" that
 		// get passed to filestore::setParameters()
 		if ($this->guid) {
-			$db_prefix = elgg_get_config('dbprefix');
 			$options = array(
 				'guid' => $this->guid,
 				'where' => array("n.string LIKE 'filestore::%'"),
diff --git a/engine/classes/ElggMenuBuilder.php b/engine/classes/ElggMenuBuilder.php
index 028eef15f..6da951597 100644
--- a/engine/classes/ElggMenuBuilder.php
+++ b/engine/classes/ElggMenuBuilder.php
@@ -227,7 +227,6 @@ class ElggMenuBuilder {
 					if ($children) {
 						$stack = array_merge($stack, $children);
 					}
-					$p = count($stack);
 				}
 			}
 		}
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index a95aba8f8..e5566a00a 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -465,7 +465,6 @@ function export_annotation_plugin_hook($hook, $entity_type, $returnvalue, $param
 	}
 
 	$guid = (int)$params['guid'];
-	$name = $params['name'];
 
 	$result = elgg_get_annotations(array(
 		'guid' => $guid,
diff --git a/engine/lib/cron.php b/engine/lib/cron.php
index dd83a9849..4f3d05b93 100644
--- a/engine/lib/cron.php
+++ b/engine/lib/cron.php
@@ -30,8 +30,6 @@ function cron_init() {
  * @access private
  */
 function cron_page_handler($page) {
-	global $CONFIG;
-
 	if (!isset($page[0])) {
 		forward();
 	}
diff --git a/engine/lib/database.php b/engine/lib/database.php
index 18c30cb8e..dcf50545d 100644
--- a/engine/lib/database.php
+++ b/engine/lib/database.php
@@ -79,7 +79,7 @@ $dbcalls = 0;
  */
 function establish_db_link($dblinkname = "readwrite") {
 	// Get configuration, and globalise database link
-	global $CONFIG, $dblink, $DB_QUERY_CACHE, $dbcalls;
+	global $CONFIG, $dblink, $DB_QUERY_CACHE;
 
 	if ($dblinkname != "readwrite" && isset($CONFIG->db[$dblinkname])) {
 		if (is_array($CONFIG->db[$dblinkname])) {
@@ -137,7 +137,7 @@ function establish_db_link($dblinkname = "readwrite") {
  * @access private
  */
 function setup_db_connections() {
-	global $CONFIG, $dblink;
+	global $CONFIG;
 
 	if (!empty($CONFIG->db->split)) {
 		establish_db_link('read');
@@ -250,7 +250,7 @@ function explain_query($query, $link) {
  * @access private
  */
 function execute_query($query, $dblink) {
-	global $CONFIG, $dbcalls;
+	global $dbcalls;
 
 	if ($query == NULL) {
 		throw new DatabaseException(elgg_echo('DatabaseException:InvalidQuery'));
@@ -389,7 +389,7 @@ function get_data_row($query, $callback = "") {
  * @access private
  */
 function elgg_query_runner($query, $callback = null, $single = false) {
-	global $CONFIG, $DB_QUERY_CACHE;
+	global $DB_QUERY_CACHE;
 
 	// Since we want to cache results of running the callback, we need to
 	// need to namespace the query with the callback and single result request.
@@ -454,7 +454,7 @@ function elgg_query_runner($query, $callback = null, $single = false) {
  * @access private
  */
 function insert_data($query) {
-	global $CONFIG, $DB_QUERY_CACHE;
+	global $DB_QUERY_CACHE;
 
 	elgg_log("DB query $query", 'NOTICE');
 	
@@ -486,7 +486,7 @@ function insert_data($query) {
  * @access private
  */
 function update_data($query) {
-	global $CONFIG, $DB_QUERY_CACHE;
+	global $DB_QUERY_CACHE;
 
 	elgg_log("DB query $query", 'NOTICE');
 
@@ -517,7 +517,7 @@ function update_data($query) {
  * @access private
  */
 function delete_data($query) {
-	global $CONFIG, $DB_QUERY_CACHE;
+	global $DB_QUERY_CACHE;
 
 	elgg_log("DB query $query", 'NOTICE');
 
@@ -644,7 +644,7 @@ function run_sql_script($scriptlocation) {
 			$statement = str_replace("prefix_", $CONFIG->dbprefix, $statement);
 			if (!empty($statement)) {
 				try {
-					$result = update_data($statement);
+					update_data($statement);
 				} catch (DatabaseException $e) {
 					$errors[] = $e->getMessage();
 				}
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index 6a2ebf97b..4cac79a22 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -128,8 +128,6 @@ function elgg_load_library($name) {
  * @throws SecurityException
  */
 function forward($location = "", $reason = 'system') {
-	global $CONFIG;
-
 	if (!headers_sent()) {
 		if ($location === REFERER) {
 			$location = $_SERVER['HTTP_REFERER'];
@@ -385,7 +383,7 @@ function elgg_load_external_file($type, $name) {
 		$item->url = '';
 		$item->location = '';
 
-		$priority = $CONFIG->externals[$type]->add($item);
+		$CONFIG->externals[$type]->add($item);
 		$CONFIG->externals_map[$type][$name] = $item;
 	}
 }
@@ -563,7 +561,7 @@ function system_messages($message = null, $register = "success", $count = false)
 			return sizeof($_SESSION['msg'][$register]);
 		} else {
 			$count = 0;
-			foreach ($_SESSION['msg'] as $register => $submessages) {
+			foreach ($_SESSION['msg'] as $submessages) {
 				$count += sizeof($submessages);
 			}
 			return $count;
@@ -1294,8 +1292,6 @@ function elgg_deprecated_notice($msg, $dep_version, $backtrace_level = 1) {
  * @return string The current page URL.
  */
 function current_page_url() {
-	global $CONFIG;
-
 	$url = parse_url(elgg_get_site_url());
 
 	$page = $url['scheme'] . "://";
@@ -1489,8 +1485,6 @@ function elgg_http_add_url_query_elements($url, array $elements) {
  * @since 1.8.0
  */
 function elgg_http_url_is_identical($url1, $url2, $ignore_params = array('offset', 'limit')) {
-	global $CONFIG;
-
 	// if the server portion is missing but it starts with / then add the url in.
 	// @todo use elgg_normalize_url()
 	if (elgg_substr($url1, 0, 1) == '/') {
@@ -1629,7 +1623,7 @@ $sort_type = SORT_LOCALE_STRING) {
 
 	$sort = array();
 
-	foreach ($array as $k => $v) {
+	foreach ($array as $v) {
 		if (isset($v[$element])) {
 			$sort[] = strtolower($v[$element]);
 		} else {
diff --git a/engine/lib/export.php b/engine/lib/export.php
index 1996bc885..ecc894e63 100644
--- a/engine/lib/export.php
+++ b/engine/lib/export.php
@@ -40,8 +40,6 @@ function get_uuid_from_object($object) {
  * @return string
  */
 function guid_to_uuid($guid) {
-	global $CONFIG;
-
 	return elgg_get_site_url()  . "export/opendd/$guid/";
 }
 
@@ -53,8 +51,6 @@ function guid_to_uuid($guid) {
  * @return bool
  */
 function is_uuid_this_domain($uuid) {
-	global $CONFIG;
-
 	if (strpos($uuid, elgg_get_site_url()) === 0) {
 		return true;
 	}
diff --git a/engine/lib/filestore.php b/engine/lib/filestore.php
index 677fac931..a3c7ba439 100644
--- a/engine/lib/filestore.php
+++ b/engine/lib/filestore.php
@@ -308,8 +308,6 @@ function get_image_resize_parameters($width, $height, $options) {
 function file_delete($guid) {
 	if ($file = get_entity($guid)) {
 		if ($file->canEdit()) {
-			$container = get_entity($file->container_guid);
-
 			$thumbnail = $file->thumbnail;
 			$smallthumb = $file->smallthumb;
 			$largethumb = $file->largethumb;
diff --git a/engine/lib/input.php b/engine/lib/input.php
index 2d71fb77e..bbb9ff94d 100644
--- a/engine/lib/input.php
+++ b/engine/lib/input.php
@@ -266,10 +266,8 @@ function input_livesearch_page_handler($page) {
 	}
 
 	if (get_input('match_owner', false)) {
-		$owner_guid = $user->getGUID();
 		$owner_where = 'AND e.owner_guid = ' . $user->getGUID();
 	} else {
-		$owner_guid = null;
 		$owner_where = '';
 	}
 
diff --git a/engine/lib/languages.php b/engine/lib/languages.php
index 11722f744..3c231d964 100644
--- a/engine/lib/languages.php
+++ b/engine/lib/languages.php
@@ -104,8 +104,6 @@ function add_translation($country_code, $language_array) {
  * @return string The language code for the site/user or "en" if not set
  */
 function get_current_language() {
-	global $CONFIG;
-
 	$language = get_language();
 
 	if (!$language) {
diff --git a/engine/lib/metastrings.php b/engine/lib/metastrings.php
index 264d2ba2c..698c8c1a9 100644
--- a/engine/lib/metastrings.php
+++ b/engine/lib/metastrings.php
@@ -520,9 +520,6 @@ function elgg_get_metastring_sql($table, $names = null, $values = null,
 
 	$db_prefix = elgg_get_config('dbprefix');
 
-	// join counter for incremental joins.
-	$i = 1;
-
 	// binary forces byte-to-byte comparision of strings, making
 	// it case- and diacritical-mark- sensitive.
 	// only supported on values.
diff --git a/engine/lib/navigation.php b/engine/lib/navigation.php
index 0e8914bbb..118a7214c 100644
--- a/engine/lib/navigation.php
+++ b/engine/lib/navigation.php
@@ -152,7 +152,7 @@ function elgg_is_menu_item_registered($menu_name, $item_name) {
 		return false;
 	}
 
-	foreach ($CONFIG->menus[$menu_name] as $index => $menu_object) {
+	foreach ($CONFIG->menus[$menu_name] as $menu_object) {
 		/* @var ElggMenuItem $menu_object */
 		if ($menu_object->getName() == $item_name) {
 			return true;
@@ -313,8 +313,8 @@ function elgg_site_menu_setup($hook, $type, $return, $params) {
 	
 	// check if we have anything selected
 	$selected = false;
-	foreach ($return as $section_name => $section) {
-		foreach ($section as $key => $item) {
+	foreach ($return as $section) {
+		foreach ($section as $item) {
 			if ($item->getSelected()) {
 				$selected = true;
 				break 2;
diff --git a/engine/lib/notification.php b/engine/lib/notification.php
index d72b1352a..f0aff84e6 100644
--- a/engine/lib/notification.php
+++ b/engine/lib/notification.php
@@ -86,7 +86,7 @@ function unregister_notification_handler($method) {
  * @throws NotificationException
  */
 function notify_user($to, $from, $subject, $message, array $params = NULL, $methods_override = "") {
-	global $NOTIFICATION_HANDLERS, $CONFIG;
+	global $NOTIFICATION_HANDLERS;
 
 	// Sanitise
 	if (!is_array($to)) {
diff --git a/engine/lib/output.php b/engine/lib/output.php
index fefb94b3e..da8e1ab86 100644
--- a/engine/lib/output.php
+++ b/engine/lib/output.php
@@ -224,7 +224,6 @@ function elgg_normalize_url($url) {
 	$php_5_3_0_to_5_3_2 = version_compare(PHP_VERSION, '5.3.0', '>=') &&
 			version_compare(PHP_VERSION, '5.3.3', '<');
 
-	$validated = false;
 	if ($php_5_2_13_and_below || $php_5_3_0_to_5_3_2) {
 		$tmp_address = str_replace("-", "", $url);
 		$validated = filter_var($tmp_address, FILTER_VALIDATE_URL);
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index d6f03c795..0ea4404f3 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -309,8 +309,6 @@ function elgg_is_active_plugin($plugin_id, $site_guid = null) {
  * @access private
  */
 function elgg_load_plugins() {
-	global $CONFIG;
-
 	$plugins_path = elgg_get_plugins_path();
 	$start_flags =	ELGG_PLUGIN_INCLUDE_START
 					| ELGG_PLUGIN_REGISTER_VIEWS
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 6f18bda93..c1a7cc080 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -589,8 +589,6 @@ function import_relationship_plugin_hook($hook, $entity_type, $returnvalue, $par
  * @access private
  */
 function export_relationship_plugin_hook($hook, $entity_type, $returnvalue, $params) {
-	global $CONFIG;
-
 	// Sanity check values
 	if ((!is_array($params)) && (!isset($params['guid']))) {
 		throw new InvalidParameterException(elgg_echo('InvalidParameterException:GUIDNotForExport'));
@@ -626,7 +624,6 @@ function export_relationship_plugin_hook($hook, $entity_type, $returnvalue, $par
 function relationship_notification_hook($event, $type, $object) {
 	/* @var ElggRelationship $object */
 	$user_one = get_entity($object->guid_one);
-	$user_two = get_entity($object->guid_two);
 	/* @var ElggUser $user_one */
 
 	return notify_user($object->guid_two,
diff --git a/engine/lib/river.php b/engine/lib/river.php
index 6274887b5..f2ec1e101 100644
--- a/engine/lib/river.php
+++ b/engine/lib/river.php
@@ -664,10 +664,6 @@ function elgg_river_page_handler($page) {
 	}
 	set_input('page_type', $page_type);
 
-	// content filter code here
-	$entity_type = '';
-	$entity_subtype = '';
-
 	require_once("{$CONFIG->path}pages/river.php");
 	return true;
 }
diff --git a/engine/lib/sessions.php b/engine/lib/sessions.php
index 3dd95aa2f..a34c2045b 100644
--- a/engine/lib/sessions.php
+++ b/engine/lib/sessions.php
@@ -286,8 +286,6 @@ function check_rate_limit_exceeded($user_guid) {
  * @throws LoginException
  */
 function login(ElggUser $user, $persistent = false) {
-	global $CONFIG;
-
 	// User is banned, return false.
 	if ($user->isBanned()) {
 		throw new LoginException(elgg_echo('LoginException:BannedUser'));
@@ -334,8 +332,6 @@ function login(ElggUser $user, $persistent = false) {
  * @return bool
  */
 function logout() {
-	global $CONFIG;
-
 	if (isset($_SESSION['user'])) {
 		if (!elgg_trigger_event('logout', 'user', $_SESSION['user'])) {
 			return false;
@@ -618,8 +614,6 @@ function _elgg_session_destroy($id) {
 		$sess_file = "$sess_save_path/sess_$id";
 		return @unlink($sess_file);
 	}
-
-	return false;
 }
 
 /**
diff --git a/engine/lib/sites.php b/engine/lib/sites.php
index 8ee3213d3..3de0eccc2 100644
--- a/engine/lib/sites.php
+++ b/engine/lib/sites.php
@@ -118,8 +118,6 @@ function create_site_entity($guid, $name, $description, $url) {
  * @return bool
  */
 function add_site_user($site_guid, $user_guid) {
-	global $CONFIG;
-
 	$site_guid = (int)$site_guid;
 	$user_guid = (int)$user_guid;
 
@@ -150,8 +148,6 @@ function remove_site_user($site_guid, $user_guid) {
  * @return mixed
  */
 function add_site_object($site_guid, $object_guid) {
-	global $CONFIG;
-
 	$site_guid = (int)$site_guid;
 	$object_guid = (int)$object_guid;
 
diff --git a/engine/lib/upgrade.php b/engine/lib/upgrade.php
index ae4591b0b..2883dc509 100644
--- a/engine/lib/upgrade.php
+++ b/engine/lib/upgrade.php
@@ -17,8 +17,6 @@
  * @access private
  */
 function upgrade_code($version, $quiet = FALSE) {
-	global $CONFIG;
-
 	$version = (int) $version;
 	$upgrade_path = elgg_get_config('path') . 'engine/lib/upgrades/';
 	$processed_upgrades = elgg_get_processed_upgrades();
@@ -291,7 +289,6 @@ function elgg_upgrade_bootstrap_17_to_18() {
 		'2011010101.php',
 	);
 
-	$upgrades_17 = array();
 	$upgrade_files = elgg_get_upgrade_files();
 	$processed_upgrades = array();
 
diff --git a/engine/lib/users.php b/engine/lib/users.php
index c4e06895d..8e9086f57 100644
--- a/engine/lib/users.php
+++ b/engine/lib/users.php
@@ -343,8 +343,6 @@ function user_add_friend($user_guid, $friend_guid) {
  * @return bool Depending on success
  */
 function user_remove_friend($user_guid, $friend_guid) {
-	global $CONFIG;
-
 	$user_guid = (int) $user_guid;
 	$friend_guid = (int) $friend_guid;
 
@@ -675,8 +673,6 @@ function find_active_users($seconds = 600, $limit = 10, $offset = 0, $count = fa
  * @return bool
  */
 function send_new_password_request($user_guid) {
-	global $CONFIG;
-
 	$user_guid = (int)$user_guid;
 
 	$user = get_entity($user_guid);
@@ -916,9 +912,6 @@ function validate_email_address($address) {
 function register_user($username, $password, $name, $email,
 $allow_multiple_emails = false, $friend_guid = 0, $invitecode = '') {
 
-	// Load the configuration
-	global $CONFIG;
-
 	// no need to trim password.
 	$username = trim($username);
 	$name = trim(strip_tags($name));
@@ -1205,8 +1198,6 @@ function set_last_login($user_guid) {
  * @access private
  */
 function user_create_hook_add_site_relationship($event, $object_type, $object) {
-	global $CONFIG;
-
 	add_entity_relationship($object->getGUID(), 'member_of_site', elgg_get_site_entity()->guid);
 }
 
-- 
cgit v1.2.3


From 011485988a8fa734c2ed74fec21031b3beebbcfd Mon Sep 17 00:00:00 2001
From: Steve Clay <steve@mrclay.org>
Date: Mon, 4 Feb 2013 21:09:02 -0500
Subject: Lots of new @todos :(

---
 engine/classes/ElggDiskFilestore.php | 1 +
 engine/classes/ElggFile.php          | 3 +++
 engine/classes/ElggGroup.php         | 3 +++
 engine/classes/ElggMenuBuilder.php   | 2 ++
 engine/classes/ElggPlugin.php        | 2 ++
 engine/lib/annotations.php           | 1 +
 engine/lib/calendar.php              | 2 ++
 engine/lib/database.php              | 2 ++
 engine/lib/entities.php              | 3 +++
 engine/lib/input.php                 | 5 +++++
 engine/lib/metastrings.php           | 1 +
 engine/lib/notification.php          | 3 ++-
 engine/lib/plugins.php               | 2 ++
 engine/lib/system_log.php            | 2 ++
 14 files changed, 31 insertions(+), 1 deletion(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/classes/ElggDiskFilestore.php b/engine/classes/ElggDiskFilestore.php
index 2d86e7c2d..7374aad35 100644
--- a/engine/classes/ElggDiskFilestore.php
+++ b/engine/classes/ElggDiskFilestore.php
@@ -60,6 +60,7 @@ class ElggDiskFilestore extends ElggFilestore {
 
 		$path = substr($fullname, 0, $ls);
 		$name = substr($fullname, $ls);
+		// @todo $name is unused, remove it or do we need to fix something?
 
 		// Try and create the directory
 		try {
diff --git a/engine/classes/ElggFile.php b/engine/classes/ElggFile.php
index 532db3617..3e9c24c17 100644
--- a/engine/classes/ElggFile.php
+++ b/engine/classes/ElggFile.php
@@ -93,6 +93,7 @@ class ElggFile extends ElggObject {
 			$container_guid = $this->container_guid;
 		}
 		$fs = $this->getFilestore();
+		// @todo add getSize() to ElggFilestore
 		return $fs->getSize($prefix, $container_guid);
 	}
 
@@ -289,6 +290,7 @@ class ElggFile extends ElggObject {
 	public function seek($position) {
 		$fs = $this->getFilestore();
 
+		// @todo add seek() to ElggFilestore
 		return $fs->seek($this->handle, $position);
 	}
 
@@ -393,6 +395,7 @@ class ElggFile extends ElggObject {
 
 			$this->filestore = new $filestore();
 			$this->filestore->setParameters($parameters);
+			// @todo explain why $parameters will always be set here (PhpStorm complains)
 		}
 
 		// this means the entity hasn't been saved so fallback to default
diff --git a/engine/classes/ElggGroup.php b/engine/classes/ElggGroup.php
index 24bdee79e..61f699f1a 100644
--- a/engine/classes/ElggGroup.php
+++ b/engine/classes/ElggGroup.php
@@ -220,6 +220,7 @@ class ElggGroup extends ElggEntity
 	 * @return array|false
 	 */
 	public function getObjects($subtype = "", $limit = 10, $offset = 0) {
+		// @todo are we deprecating this method, too?
 		return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", $limit, $offset, false);
 	}
 
@@ -233,6 +234,7 @@ class ElggGroup extends ElggEntity
 	 * @return array|false
 	 */
 	public function getFriendsObjects($subtype = "", $limit = 10, $offset = 0) {
+		// @todo are we deprecating this method, too?
 		return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", $limit, $offset, false);
 	}
 
@@ -244,6 +246,7 @@ class ElggGroup extends ElggEntity
 	 * @return array|false
 	 */
 	public function countObjects($subtype = "") {
+		// @todo are we deprecating this method, too?
 		return get_objects_in_group($this->getGUID(), $subtype, 0, 0, "", 10, 0, true);
 	}
 
diff --git a/engine/classes/ElggMenuBuilder.php b/engine/classes/ElggMenuBuilder.php
index 6da951597..0dce02be4 100644
--- a/engine/classes/ElggMenuBuilder.php
+++ b/engine/classes/ElggMenuBuilder.php
@@ -274,6 +274,8 @@ class ElggMenuBuilder {
 	 * @param ElggMenuItem $a
 	 * @param ElggMenuItem $b
 	 * @return bool
+	 *
+	 * @todo deprecate this? weight seems to be deprecated
 	 */
 	public static function compareByWeight($a, $b) {
 		$aw = $a->getWeight();
diff --git a/engine/classes/ElggPlugin.php b/engine/classes/ElggPlugin.php
index 066fd9a79..ae447bddb 100644
--- a/engine/classes/ElggPlugin.php
+++ b/engine/classes/ElggPlugin.php
@@ -597,6 +597,8 @@ class ElggPlugin extends ElggObject {
 	 * Checks if this plugin can be activated on the current
 	 * Elgg installation.
 	 *
+	 * @todo remove $site_guid param or implement it
+	 *
 	 * @param mixed $site_guid Optional site guid
 	 * @return bool
 	 */
diff --git a/engine/lib/annotations.php b/engine/lib/annotations.php
index 41a736aa1..f40a2cc6f 100644
--- a/engine/lib/annotations.php
+++ b/engine/lib/annotations.php
@@ -17,6 +17,7 @@
  */
 function row_to_elggannotation($row) {
 	if (!($row instanceof stdClass)) {
+		// @todo should throw in this case?
 		return $row;
 	}
 
diff --git a/engine/lib/calendar.php b/engine/lib/calendar.php
index 9a06c5292..e6f95934c 100644
--- a/engine/lib/calendar.php
+++ b/engine/lib/calendar.php
@@ -39,6 +39,8 @@ function get_day_end($day = null, $month = null, $year = null) {
 /**
  * Return the notable entities for a given time period.
  *
+ * @todo this function also accepts an array(type => subtypes) for 3rd arg. Should we document this?
+ *
  * @param int     $start_time     The start time as a unix timestamp.
  * @param int     $end_time       The end time as a unix timestamp.
  * @param string  $type           The type of entity (eg "user", "object" etc)
diff --git a/engine/lib/database.php b/engine/lib/database.php
index dcf50545d..2b348366d 100644
--- a/engine/lib/database.php
+++ b/engine/lib/database.php
@@ -123,6 +123,8 @@ function establish_db_link($dblinkname = "readwrite") {
 
 	// Set up cache if global not initialized and query cache not turned off
 	if ((!$DB_QUERY_CACHE) && (!$db_cache_off)) {
+		// @todo everywhere else this is assigned to array(), making it dangerous to call
+		// object methods on this. We should consider making this an plain array
 		$DB_QUERY_CACHE = new ElggStaticVariableCache('db_query_cache');
 	}
 }
diff --git a/engine/lib/entities.php b/engine/lib/entities.php
index e3535c741..25c927ac6 100644
--- a/engine/lib/entities.php
+++ b/engine/lib/entities.php
@@ -1220,6 +1220,7 @@ function elgg_get_entity_type_subtype_where_sql($table, $types, $subtypes, $pair
 			if ($subtypes) {
 				foreach ($subtypes as $subtype) {
 					// check that the subtype is valid (with ELGG_ENTITIES_NO_VALUE being a valid subtype)
+					// @todo simplify this logic
 					if (ELGG_ENTITIES_NO_VALUE === $subtype || $subtype_id = get_subtype_id($type, $subtype)) {
 						$subtype_ids[] = (ELGG_ENTITIES_NO_VALUE === $subtype) ? ELGG_ENTITIES_NO_VALUE : $subtype_id;
 					} else {
@@ -1461,6 +1462,8 @@ function elgg_list_entities(array $options = array(), $getter = 'elgg_get_entiti
  *
  * @tip Use this to generate a list of archives by month for when entities were added or updated.
  *
+ * @todo document how to pass in array for $subtype
+ *
  * @warning Months are returned in the form YYYYMM.
  *
  * @param string $type           The type of entity
diff --git a/engine/lib/input.php b/engine/lib/input.php
index bbb9ff94d..2d9bae4dd 100644
--- a/engine/lib/input.php
+++ b/engine/lib/input.php
@@ -226,6 +226,8 @@ function elgg_clear_sticky_value($form_name, $variable) {
 /**
  * Page handler for autocomplete endpoint.
  *
+ * @todo split this into functions/objects, this is way too big
+ *
  * /livesearch?q=<query>
  *
  * Other options include:
@@ -288,6 +290,7 @@ function input_livesearch_page_handler($page) {
 
 				if ($entities = get_data($query)) {
 					foreach ($entities as $entity) {
+						// @todo use elgg_get_entities (don't query in a loop!)
 						$entity = get_entity($entity->guid);
 						/* @var ElggUser $entity */
 						if (!$entity) {
@@ -338,6 +341,7 @@ function input_livesearch_page_handler($page) {
 				";
 				if ($entities = get_data($query)) {
 					foreach ($entities as $entity) {
+						// @todo use elgg_get_entities (don't query in a loop!)
 						$entity = get_entity($entity->guid);
 						/* @var ElggGroup $entity */
 						if (!$entity) {
@@ -386,6 +390,7 @@ function input_livesearch_page_handler($page) {
 
 				if ($entities = get_data($query)) {
 					foreach ($entities as $entity) {
+						// @todo use elgg_get_entities (don't query in a loop!)
 						$entity = get_entity($entity->guid);
 						/* @var ElggUser $entity */
 						if (!$entity) {
diff --git a/engine/lib/metastrings.php b/engine/lib/metastrings.php
index 7e18597a6..76c4bd8c4 100644
--- a/engine/lib/metastrings.php
+++ b/engine/lib/metastrings.php
@@ -804,6 +804,7 @@ function elgg_delete_metastring_based_object_by_id($id, $type) {
 			}
 
 			if ($metabyname_memcache) {
+				// @todo why name_id? is that even populated?
 				$metabyname_memcache->delete("{$obj->entity_guid}:{$obj->name_id}");
 			}
 		}
diff --git a/engine/lib/notification.php b/engine/lib/notification.php
index f0aff84e6..56e591192 100644
--- a/engine/lib/notification.php
+++ b/engine/lib/notification.php
@@ -174,7 +174,8 @@ function get_user_notification_settings($user_guid = 0) {
 		$user_guid = elgg_get_logged_in_user_guid();
 	}
 
-	// @todo: holy crap, really?
+	// @todo: there should be a better way now that metadata is cached. E.g. just query for MD names, then
+	// query user object directly
 	$all_metadata = elgg_get_metadata(array(
 		'guid' => $user_guid,
 		'limit' => 0
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 0ea4404f3..f281b1416 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -91,7 +91,9 @@ function elgg_get_plugin_ids_in_dir($dir = null) {
  * @access private
  */
 function elgg_generate_plugin_entities() {
+	// @todo $site unused, can remove?
 	$site = get_config('site');
+
 	$dir = elgg_get_plugins_path();
 	$db_prefix = elgg_get_config('dbprefix');
 
diff --git a/engine/lib/system_log.php b/engine/lib/system_log.php
index 38bc4ba96..5a153afb2 100644
--- a/engine/lib/system_log.php
+++ b/engine/lib/system_log.php
@@ -10,6 +10,8 @@
 /**
  * Retrieve the system log based on a number of parameters.
  *
+ * @todo too many args, and the first arg is too confusing
+ *
  * @param int|array $by_user    The guid(s) of the user(s) who initiated the event.
  *                              Use 0 for unowned entries. Anything else falsey means anyone.
  * @param string    $event      The event you are searching on.
-- 
cgit v1.2.3


From a2ecf54d56d9f877e6f0f8ac6d841cee6187aac4 Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Fri, 15 Mar 2013 11:18:05 -0400
Subject: more coding standard fixes

---
 engine/classes/ElggEntity.php      | 11 +++++------
 engine/classes/ElggGroup.php       |  9 +++------
 engine/classes/ElggMenuBuilder.php | 12 ++++++------
 engine/classes/ElggObject.php      |  9 +++------
 engine/classes/ElggSite.php        | 12 ++++--------
 engine/classes/ElggTranslit.php    | 26 +++++++++++++-------------
 engine/classes/ElggUser.php        | 12 ++++--------
 engine/lib/configuration.php       |  4 ++--
 engine/lib/elgglib.php             |  6 +++---
 engine/lib/languages.php           |  3 +++
 engine/lib/location.php            |  2 +-
 engine/lib/metadata.php            |  4 ++--
 engine/lib/plugins.php             |  2 +-
 engine/lib/relationships.php       |  2 +-
 engine/lib/views.php               | 20 +++++++++++---------
 15 files changed, 62 insertions(+), 72 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/classes/ElggEntity.php b/engine/classes/ElggEntity.php
index f44e73023..5a63c7b15 100644
--- a/engine/classes/ElggEntity.php
+++ b/engine/classes/ElggEntity.php
@@ -375,12 +375,11 @@ abstract class ElggEntity extends ElggData implements
 			}
 
 			return $result;
-		}
-
-		// unsaved entity. store in temp array
-		// returning single entries instead of an array of 1 element is decided in
-		// getMetaData(), just like pulling from the db.
-		else {
+		} else {
+			// unsaved entity. store in temp array
+			// returning single entries instead of an array of 1 element is decided in
+			// getMetaData(), just like pulling from the db.
+			// 
 			// if overwrite, delete first
 			if (!$multiple || !isset($this->temp_metadata[$name])) {
 				$this->temp_metadata[$name] = array();
diff --git a/engine/classes/ElggGroup.php b/engine/classes/ElggGroup.php
index 61f699f1a..7ab0bfa48 100644
--- a/engine/classes/ElggGroup.php
+++ b/engine/classes/ElggGroup.php
@@ -48,21 +48,18 @@ class ElggGroup extends ElggEntity
 					$msg = elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid->guid));
 					throw new IOException($msg);
 				}
-
-			// Is $guid is an ElggGroup? Use a copy constructor
 			} else if ($guid instanceof ElggGroup) {
+				// $guid is an ElggGroup so this is a copy constructor
 				elgg_deprecated_notice('This type of usage of the ElggGroup 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 ElggGroup = ERROR!
 			} else if ($guid instanceof ElggEntity) {
+				// @todo why separate from else
 				throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggGroup'));
-
-			// Is it a GUID
 			} else if (is_numeric($guid)) {
+				// $guid is a GUID so load entity
 				if (!$this->load($guid)) {
 					throw new IOException(elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid)));
 				}
diff --git a/engine/classes/ElggMenuBuilder.php b/engine/classes/ElggMenuBuilder.php
index 639e34755..198018f3c 100644
--- a/engine/classes/ElggMenuBuilder.php
+++ b/engine/classes/ElggMenuBuilder.php
@@ -235,8 +235,8 @@ class ElggMenuBuilder {
 	/**
 	 * Compare two menu items by their display text
 	 *
-	 * @param ElggMenuItem $a
-	 * @param ElggMenuItem $b
+	 * @param ElggMenuItem $a Menu item
+	 * @param ElggMenuItem $b Menu item
 	 * @return bool
 	 */
 	public static function compareByText($a, $b) {
@@ -253,8 +253,8 @@ class ElggMenuBuilder {
 	/**
 	 * Compare two menu items by their identifiers
 	 *
-	 * @param ElggMenuItem $a
-	 * @param ElggMenuItem $b
+	 * @param ElggMenuItem $a Menu item
+	 * @param ElggMenuItem $b Menu item
 	 * @return bool
 	 */
 	public static function compareByName($a, $b) {
@@ -271,8 +271,8 @@ class ElggMenuBuilder {
 	/**
 	 * Compare two menu items by their priority
 	 *
-	 * @param ElggMenuItem $a
-	 * @param ElggMenuItem $b
+	 * @param ElggMenuItem $a Menu item
+	 * @param ElggMenuItem $b Menu item
 	 * @return bool
 	 *
 	 * @todo change name to compareByPriority
diff --git a/engine/classes/ElggObject.php b/engine/classes/ElggObject.php
index 6263f84f6..3cb76ffaf 100644
--- a/engine/classes/ElggObject.php
+++ b/engine/classes/ElggObject.php
@@ -66,21 +66,18 @@ class ElggObject extends ElggEntity {
 					$msg = elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid->guid));
 					throw new IOException($msg);
 				}
-
-			// Is $guid is an ElggObject? Use a copy constructor
 			} else if ($guid instanceof ElggObject) {
+				// $guid is an ElggObject so this is a copy constructor
 				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) {
+				// @todo remove - do not need separate exception
 				throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggObject'));
-
-			// Is it a GUID
 			} else if (is_numeric($guid)) {
+				// $guid is a GUID so load
 				if (!$this->load($guid)) {
 					throw new IOException(elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid)));
 				}
diff --git a/engine/classes/ElggSite.php b/engine/classes/ElggSite.php
index 1a34df195..deba5087e 100644
--- a/engine/classes/ElggSite.php
+++ b/engine/classes/ElggSite.php
@@ -77,28 +77,24 @@ class ElggSite extends ElggEntity {
 					$msg = elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid->guid));
 					throw new IOException($msg);
 				}
-
-			// Is $guid is an ElggSite? Use a copy constructor
 			} else if ($guid instanceof ElggSite) {
+				// $guid is an ElggSite so this is a copy constructor
 				elgg_deprecated_notice('This type of usage of the ElggSite 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 ElggSite = ERROR!
 			} else if ($guid instanceof ElggEntity) {
+				// @todo remove and just use else clause
 				throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggSite'));
-
-			// See if this is a URL
 			} else if (strpos($guid, "http") !== false) {
+				// url so retrieve by url
 				$guid = get_site_by_url($guid);
 				foreach ($guid->attributes as $key => $value) {
 					$this->attributes[$key] = $value;
 				}
-
-			// Is it a GUID
 			} else if (is_numeric($guid)) {
+				// $guid is a GUID so load
 				if (!$this->load($guid)) {
 					throw new IOException(elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid)));
 				}
diff --git a/engine/classes/ElggTranslit.php b/engine/classes/ElggTranslit.php
index 79116fc01..601965c11 100644
--- a/engine/classes/ElggTranslit.php
+++ b/engine/classes/ElggTranslit.php
@@ -58,15 +58,15 @@ class ElggTranslit {
 		// remove all ASCII except 0-9a-zA-Z, hyphen, underscore, and whitespace
 		// note: "x" modifier did not work with this pattern.
 		$string = preg_replace('~['
-			. '\x00-\x08'  # control chars
-			. '\x0b\x0c'   # vert tab, form feed
-			. '\x0e-\x1f'  # control chars
-			. '\x21-\x2c'  # ! ... ,
-			. '\x2e\x2f'   # . slash
-			. '\x3a-\x40'  # : ... @
-			. '\x5b-\x5e'  # [ ... ^
-			. '\x60'       # `
-			. '\x7b-\x7f'  # { ... DEL
+			. '\x00-\x08'  // control chars
+			. '\x0b\x0c'   // vert tab, form feed
+			. '\x0e-\x1f'  // control chars
+			. '\x21-\x2c'  // ! ... ,
+			. '\x2e\x2f'   // . slash
+			. '\x3a-\x40'  // : ... @
+			. '\x5b-\x5e'  // [ ... ^
+			. '\x60'       // `
+			. '\x7b-\x7f'  // { ... DEL
 			. ']~', '', $string);
 		$string = strtr($string, '', '');
 
@@ -80,10 +80,10 @@ class ElggTranslit {
 		// note: we cannot use [^0-9a-zA-Z] because that matches multibyte chars.
 		// note: "x" modifier did not work with this pattern.
 		$pattern = '~['
-			. '\x00-\x2f'  # controls ... slash
-			. '\x3a-\x40'  # : ... @
-			. '\x5b-\x60'  # [ ... `
-			. '\x7b-\x7f'  # { ... DEL
+			. '\x00-\x2f'  // controls ... slash
+			. '\x3a-\x40'  // : ... @
+			. '\x5b-\x60'  // [ ... `
+			. '\x7b-\x7f'  // { ... DEL
 			. ']+~x';
 
 		// ['internationalization', 'and', '日本語']
diff --git a/engine/classes/ElggUser.php b/engine/classes/ElggUser.php
index 6c1cdc1de..b80065b27 100644
--- a/engine/classes/ElggUser.php
+++ b/engine/classes/ElggUser.php
@@ -65,30 +65,26 @@ class ElggUser extends ElggEntity
 					$msg = elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid->guid));
 					throw new IOException($msg);
 				}
-
-			// See if this is a username
 			} else if (is_string($guid)) {
+				// $guid is a username
 				$user = get_user_by_username($guid);
 				if ($user) {
 					foreach ($user->attributes as $key => $value) {
 						$this->attributes[$key] = $value;
 					}
 				}
-
-			// Is $guid is an ElggUser? Use a copy constructor
 			} else if ($guid instanceof ElggUser) {
+				// $guid is an ElggUser so this is a copy constructor
 				elgg_deprecated_notice('This type of usage of the ElggUser 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 ElggUser = ERROR!
 			} else if ($guid instanceof ElggEntity) {
+				// @todo why have a special case here
 				throw new InvalidParameterException(elgg_echo('InvalidParameterException:NonElggUser'));
-
-			// Is it a GUID
 			} else if (is_numeric($guid)) {
+				// $guid is a GUID so load entity
 				if (!$this->load($guid)) {
 					throw new IOException(elgg_echo('IOException:FailedToLoadGUID', array(get_class(), $guid)));
 				}
diff --git a/engine/lib/configuration.php b/engine/lib/configuration.php
index a0f297f0c..55e5bbd36 100644
--- a/engine/lib/configuration.php
+++ b/engine/lib/configuration.php
@@ -486,9 +486,9 @@ function get_config($name, $site_guid = 0) {
 	// @todo these haven't really been implemented in Elgg 1.8. Complete in 1.9.
 	// show dep message
 	if ($new_name) {
-	//	$msg = "Config value $name has been renamed as $new_name";
+		//	$msg = "Config value $name has been renamed as $new_name";
 		$name = $new_name;
-	//	elgg_deprecated_notice($msg, $dep_version);
+		//	elgg_deprecated_notice($msg, $dep_version);
 	}
 
 	// decide from where to return the value
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index 74b70f9fb..281b23535 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -1383,8 +1383,8 @@ function elgg_http_build_url(array $parts, $html_encode = TRUE) {
  * add tokens to the action.  The form view automatically handles
  * tokens.
  *
- * @param string  $url         Full action URL
- * @param bool $html_encode HTML encode the url? (default: false)
+ * @param string $url         Full action URL
+ * @param bool   $html_encode HTML encode the url? (default: false)
  *
  * @return string URL with action tokens
  * @since 1.7.0
@@ -1446,7 +1446,7 @@ function elgg_http_remove_url_query_element($url, $element) {
  * Adds an element or elements to a URL's query string.
  *
  * @param string $url      The URL
- * @param array $elements Key/value pairs to add to the URL
+ * @param array  $elements Key/value pairs to add to the URL
  *
  * @return string The new URL with the query strings added
  * @since 1.7.0
diff --git a/engine/lib/languages.php b/engine/lib/languages.php
index 17db14d98..61ba91ddb 100644
--- a/engine/lib/languages.php
+++ b/engine/lib/languages.php
@@ -139,6 +139,9 @@ function get_language() {
 	return false;
 }
 
+/**
+ * @access private
+ */
 function _elgg_load_translations() {
 	global $CONFIG;
 
diff --git a/engine/lib/location.php b/engine/lib/location.php
index b319bb3bb..1534c7d7b 100644
--- a/engine/lib/location.php
+++ b/engine/lib/location.php
@@ -139,7 +139,7 @@ function elgg_get_entities_from_location(array $options = array()) {
 /**
  * Returns a viewable list of entities from location
  *
- * @param array $options
+ * @param array $options Options array
  *
  * @see elgg_list_entities()
  * @see elgg_get_entities_from_location()
diff --git a/engine/lib/metadata.php b/engine/lib/metadata.php
index 305e9918b..a1ebfa5f1 100644
--- a/engine/lib/metadata.php
+++ b/engine/lib/metadata.php
@@ -920,8 +920,8 @@ function elgg_get_metadata_cache() {
  * Invalidate the metadata cache based on options passed to various *_metadata functions
  *
  * @param string $action  Action performed on metadata. "delete", "disable", or "enable"
- *
- * @param array $options  Options passed to elgg_(delete|disable|enable)_metadata
+ * @param array  $options Options passed to elgg_(delete|disable|enable)_metadata
+ * @return void
  */
 function elgg_invalidate_metadata_cache($action, array $options) {
 	// remove as little as possible, optimizing for common cases
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index f281b1416..6fc000cf9 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -865,7 +865,7 @@ function elgg_set_plugin_user_setting($name, $value, $user_guid = null, $plugin_
  * Unsets a user-specific plugin setting
  *
  * @param string $name      Name of the setting
- * @param int $user_guid Defaults to logged in user
+ * @param int    $user_guid Defaults to logged in user
  * @param string $plugin_id Defaults to contextual plugin name
  *
  * @return bool
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index fe0b8364d..b0cd627fc 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -363,7 +363,7 @@ $relationship_guid = NULL, $inverse_relationship = FALSE) {
 /**
  * Returns a viewable list of entities by relationship
  *
- * @param array $options
+ * @param array $options Options array for retrieval of entities
  *
  * @see elgg_list_entities()
  * @see elgg_get_entities_from_relationship()
diff --git a/engine/lib/views.php b/engine/lib/views.php
index 7d8347863..c4b349fc6 100644
--- a/engine/lib/views.php
+++ b/engine/lib/views.php
@@ -1107,7 +1107,7 @@ function elgg_view_entity_annotations(ElggEntity $entity, $full_view = true) {
  * This is a shortcut for {@elgg_view page/elements/title}.
  *
  * @param string $title The page title
- * @param array $vars   View variables (was submenu be displayed? (deprecated))
+ * @param array  $vars  View variables (was submenu be displayed? (deprecated))
  *
  * @return string The HTML (etc)
  */
@@ -1179,7 +1179,7 @@ function elgg_view_comments($entity, $add_comment = true, array $vars = array())
  *
  * @param string $image The icon and other information
  * @param string $body  Description content
- * @param array $vars   Additional parameters for the view
+ * @param array  $vars  Additional parameters for the view
  *
  * @return string
  * @since 1.8.0
@@ -1236,15 +1236,17 @@ function elgg_view_river_item($item, array $vars = array()) {
 		// subject is disabled or subject/object deleted
 		return '';
 	}
+
+	// @todo this needs to be cleaned up
 	// Don't hide objects in closed groups that a user can see.
 	// see http://trac.elgg.org/ticket/4789
-//	else {
-//		// hide based on object's container
-//		$visibility = ElggGroupItemVisibility::factory($object->container_guid);
-//		if ($visibility->shouldHideItems) {
-//			return '';
-//		}
-//	}
+	//	else {
+	//		// hide based on object's container
+	//		$visibility = ElggGroupItemVisibility::factory($object->container_guid);
+	//		if ($visibility->shouldHideItems) {
+	//			return '';
+	//		}
+	//	}
 
 	$vars['item'] = $item;
 
-- 
cgit v1.2.3


From 36755bea9aefd7e8bf54deab7b29902f8733f9aa Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Sat, 16 Mar 2013 13:32:02 -0400
Subject: engine now is standards compliant

---
 engine/classes/ElggPlugin.php | 4 ++--
 engine/lib/plugins.php        | 8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/classes/ElggPlugin.php b/engine/classes/ElggPlugin.php
index ae447bddb..c1c46f272 100644
--- a/engine/classes/ElggPlugin.php
+++ b/engine/classes/ElggPlugin.php
@@ -649,8 +649,8 @@ class ElggPlugin extends ElggObject {
 			// Note: this will not run re-run the init hooks!
 			if ($return) {
 				if ($this->canReadFile('activate.php')) {
-					$flags = ELGG_PLUGIN_INCLUDE_START | ELGG_PLUGIN_REGISTER_CLASSES
-							| ELGG_PLUGIN_REGISTER_LANGUAGES | ELGG_PLUGIN_REGISTER_VIEWS;
+					$flags = ELGG_PLUGIN_INCLUDE_START | ELGG_PLUGIN_REGISTER_CLASSES |
+							ELGG_PLUGIN_REGISTER_LANGUAGES | ELGG_PLUGIN_REGISTER_VIEWS;
 
 					$this->start($flags);
 
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 6fc000cf9..74bce45fd 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -312,10 +312,10 @@ function elgg_is_active_plugin($plugin_id, $site_guid = null) {
  */
 function elgg_load_plugins() {
 	$plugins_path = elgg_get_plugins_path();
-	$start_flags =	ELGG_PLUGIN_INCLUDE_START
-					| ELGG_PLUGIN_REGISTER_VIEWS
-					| ELGG_PLUGIN_REGISTER_LANGUAGES
-					| ELGG_PLUGIN_REGISTER_CLASSES;
+	$start_flags = ELGG_PLUGIN_INCLUDE_START |
+					ELGG_PLUGIN_REGISTER_VIEWS |
+					ELGG_PLUGIN_REGISTER_LANGUAGES |
+					ELGG_PLUGIN_REGISTER_CLASSES;
 
 	if (!$plugins_path) {
 		return false;
-- 
cgit v1.2.3


From b3cf5a302d25b06421a055f280ca4f654bd8e6a7 Mon Sep 17 00:00:00 2001
From: beck24 <beck24@gmail.com>
Date: Sun, 13 Oct 2013 00:03:11 -0700
Subject: Fixes #6177 - refuse to deactive plugins used as dependencies

---
 engine/lib/plugins.php | 35 +++++++++++++++++++++++++++++++++++
 languages/en.php       |  2 ++
 2 files changed, 37 insertions(+)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 74bce45fd..f0d89e92d 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -1104,6 +1104,39 @@ function plugins_test($hook, $type, $value, $params) {
 	return $value;
 }
 
+function plugins_deactivate_dependency_check($event, $type, $params) {
+    $plugin_id = $params['plugin_entity']->getManifest()->getPluginID();
+    $plugin_name = $params['plugin_entity']->getManifest()->getName();
+  
+    $active_plugins = elgg_get_plugins();
+
+	$dependents = array();
+    foreach ($active_plugins as $plugin) {
+		$manifest = $plugin->getManifest();
+		$requires = $manifest->getRequires();
+    
+		foreach ($requires as $required) {
+			if ($required['type'] == 'plugin' && $required['name'] == $plugin_id) {
+				// there are active dependents
+				$dependents[$manifest->getPluginID()] = $plugin;
+			}
+		}
+    }
+    
+    if ($dependents) {
+		$list = '<ul>';
+		// construct error message and prevent disabling
+		foreach ($dependents as $dependent) {
+			$list .= '<li>' . $dependent->getManifest()->getName() . '</li>';
+		}
+		$list .= '</ul>';
+		
+		register_error(elgg_echo('ElggPlugin:Dependencies:ActiveDependent', array($plugin_name, $list)));
+		
+		return false;
+    }
+}
+
 /**
  * Initialize the plugin system
  * Listens to system init and registers actions
@@ -1115,6 +1148,8 @@ function plugin_init() {
 	run_function_once("plugin_run_once");
 
 	elgg_register_plugin_hook_handler('unit_test', 'system', 'plugins_test');
+	
+	elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
 
 	elgg_register_action("plugins/settings/save", '', 'admin');
 	elgg_register_action("plugins/usersettings/save");
diff --git a/languages/en.php b/languages/en.php
index 1721865f7..ad4831db7 100644
--- a/languages/en.php
+++ b/languages/en.php
@@ -105,6 +105,8 @@ $english = array(
 	'ElggPlugin:Dependencies:Priority:Before' => 'Before %s',
 	'ElggPlugin:Dependencies:Priority:Uninstalled' => '%s is not installed',
 	'ElggPlugin:Dependencies:Suggests:Unsatisfied' => 'Missing',
+	
+	'ElggPlugin:Dependencies:ActiveDependent' => 'There are other plugins that list %s as a dependency.  You must disable the following plugins before disabling this one: %s',
 
 	'ElggPlugin:InvalidAndDeactivated' => '%s is an invalid plugin and has been deactivated.',
 
-- 
cgit v1.2.3


From 634216f0978d037fb84ef8e68e4e4272752c22fb Mon Sep 17 00:00:00 2001
From: beck24 <beck24@gmail.com>
Date: Sun, 13 Oct 2013 00:19:46 -0700
Subject: whitespace fix

---
 engine/lib/plugins.php | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index f0d89e92d..e0aa705bb 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -1105,13 +1105,13 @@ function plugins_test($hook, $type, $value, $params) {
 }
 
 function plugins_deactivate_dependency_check($event, $type, $params) {
-    $plugin_id = $params['plugin_entity']->getManifest()->getPluginID();
-    $plugin_name = $params['plugin_entity']->getManifest()->getName();
-  
-    $active_plugins = elgg_get_plugins();
+	$plugin_id = $params['plugin_entity']->getManifest()->getPluginID();
+	$plugin_name = $params['plugin_entity']->getManifest()->getName();
+
+	$active_plugins = elgg_get_plugins();
 
 	$dependents = array();
-    foreach ($active_plugins as $plugin) {
+	foreach ($active_plugins as $plugin) {
 		$manifest = $plugin->getManifest();
 		$requires = $manifest->getRequires();
     
@@ -1121,9 +1121,9 @@ function plugins_deactivate_dependency_check($event, $type, $params) {
 				$dependents[$manifest->getPluginID()] = $plugin;
 			}
 		}
-    }
-    
-    if ($dependents) {
+	}
+
+	if ($dependents) {
 		$list = '<ul>';
 		// construct error message and prevent disabling
 		foreach ($dependents as $dependent) {
-- 
cgit v1.2.3


From 6da43b70ca0de807c0532adb0bba65405d3ffbc1 Mon Sep 17 00:00:00 2001
From: beck24 <beck24@gmail.com>
Date: Sun, 13 Oct 2013 21:51:02 -0700
Subject: move deactivate event registration to the user-triggered action

---
 actions/admin/plugins/deactivate.php | 3 +++
 engine/lib/plugins.php               | 2 --
 2 files changed, 3 insertions(+), 2 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/actions/admin/plugins/deactivate.php b/actions/admin/plugins/deactivate.php
index 354f4717d..adb86dd7a 100644
--- a/actions/admin/plugins/deactivate.php
+++ b/actions/admin/plugins/deactivate.php
@@ -10,6 +10,9 @@
  * @package Elgg.Core
  * @subpackage Administration.Plugins
  */
+ 
+ // prevent disabling plugins with active dependents
+ elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
 
 $plugin_guids = get_input('plugin_guids');
 
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index e0aa705bb..1b7ad5db9 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -1148,8 +1148,6 @@ function plugin_init() {
 	run_function_once("plugin_run_once");
 
 	elgg_register_plugin_hook_handler('unit_test', 'system', 'plugins_test');
-	
-	elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
 
 	elgg_register_action("plugins/settings/save", '', 'admin');
 	elgg_register_action("plugins/usersettings/save");
-- 
cgit v1.2.3


From db9153b12101da7836d6ef0d748fb11eee335d9b Mon Sep 17 00:00:00 2001
From: Matt Beckett <beck24@gmail.com>
Date: Wed, 23 Oct 2013 23:42:30 -0700
Subject: Revert "move deactivate event registration to the user-triggered
 action"

This reverts commit 6da43b70ca0de807c0532adb0bba65405d3ffbc1.
---
 actions/admin/plugins/deactivate.php | 3 ---
 engine/lib/plugins.php               | 2 ++
 2 files changed, 2 insertions(+), 3 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/actions/admin/plugins/deactivate.php b/actions/admin/plugins/deactivate.php
index adb86dd7a..354f4717d 100644
--- a/actions/admin/plugins/deactivate.php
+++ b/actions/admin/plugins/deactivate.php
@@ -10,9 +10,6 @@
  * @package Elgg.Core
  * @subpackage Administration.Plugins
  */
- 
- // prevent disabling plugins with active dependents
- elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
 
 $plugin_guids = get_input('plugin_guids');
 
diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 1b7ad5db9..e0aa705bb 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -1148,6 +1148,8 @@ function plugin_init() {
 	run_function_once("plugin_run_once");
 
 	elgg_register_plugin_hook_handler('unit_test', 'system', 'plugins_test');
+	
+	elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
 
 	elgg_register_action("plugins/settings/save", '', 'admin');
 	elgg_register_action("plugins/usersettings/save");
-- 
cgit v1.2.3


From 9762edd4305ab8e6523d2f8171a32688295f1c88 Mon Sep 17 00:00:00 2001
From: Matt Beckett <beck24@gmail.com>
Date: Wed, 23 Oct 2013 23:52:53 -0700
Subject: Added comments regarding deactivation due to error

---
 engine/lib/plugins.php | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index e0aa705bb..c296346fc 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -1149,6 +1149,8 @@ function plugin_init() {
 
 	elgg_register_plugin_hook_handler('unit_test', 'system', 'plugins_test');
 	
+	// note - plugins are booted by the time this handler is registered
+	// deactivation due to error may have already occurred
 	elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
 
 	elgg_register_action("plugins/settings/save", '', 'admin');
-- 
cgit v1.2.3


From 33260fd7a88e5e92fbee6ee0719ab4286e9ce221 Mon Sep 17 00:00:00 2001
From: Paweł Sroka <srokap@gmail.com>
Date: Sun, 27 Oct 2013 19:27:14 +0100
Subject: Refs #6117 - Added docs + changed plugins_deactivate_dependency_check
 to _plugins_deactivate_dependency_check

---
 engine/lib/plugins.php | 22 ++++++++++++++++------
 1 file changed, 16 insertions(+), 6 deletions(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index c296346fc..d5d3db466 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -1104,7 +1104,17 @@ function plugins_test($hook, $type, $value, $params) {
 	return $value;
 }
 
-function plugins_deactivate_dependency_check($event, $type, $params) {
+/**
+ * Checks on deactivate plugin event if disabling it won't create unmet dependencies and blocks disable in such case.
+ *
+ * @param string $event  deactivate
+ * @param string $type   plugin
+ * @param array  $params Parameters array containing entry with ELggPlugin instance under 'plugin_entity' key
+ * @return bool  false to block plugin deactivation action
+ *
+ * @access private
+ */
+function _plugins_deactivate_dependency_check($event, $type, $params) {
 	$plugin_id = $params['plugin_entity']->getManifest()->getPluginID();
 	$plugin_name = $params['plugin_entity']->getManifest()->getName();
 
@@ -1114,7 +1124,7 @@ function plugins_deactivate_dependency_check($event, $type, $params) {
 	foreach ($active_plugins as $plugin) {
 		$manifest = $plugin->getManifest();
 		$requires = $manifest->getRequires();
-    
+
 		foreach ($requires as $required) {
 			if ($required['type'] == 'plugin' && $required['name'] == $plugin_id) {
 				// there are active dependents
@@ -1130,11 +1140,11 @@ function plugins_deactivate_dependency_check($event, $type, $params) {
 			$list .= '<li>' . $dependent->getManifest()->getName() . '</li>';
 		}
 		$list .= '</ul>';
-		
+
 		register_error(elgg_echo('ElggPlugin:Dependencies:ActiveDependent', array($plugin_name, $list)));
-		
+
 		return false;
-    }
+	}
 }
 
 /**
@@ -1151,7 +1161,7 @@ function plugin_init() {
 	
 	// note - plugins are booted by the time this handler is registered
 	// deactivation due to error may have already occurred
-	elgg_register_event_handler('deactivate', 'plugin', 'plugins_deactivate_dependency_check');
+	elgg_register_event_handler('deactivate', 'plugin', '_plugins_deactivate_dependency_check');
 
 	elgg_register_action("plugins/settings/save", '', 'admin');
 	elgg_register_action("plugins/usersettings/save");
-- 
cgit v1.2.3