Elgg / Elgg

engine/classes/Elgg/Database/Annotations.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
 	 *
 	 * @param int $id The id of the annotation object being retrieved.
 	 *
-	 * @return \ElggAnnotation|false
+	 * @return \ElggExtender
 	 */
 	function get($id) {
 		return _elgg_get_metastring_based_object_from_id($id, 'annotation');

Indentation +383 added lines, -383 removed lines

@@ -12,439 +12,439 @@
  */
 class Annotations {
 
-	use \Elgg\TimeUsing;
+    use \Elgg\TimeUsing;
 	
-	/**
-	 * @var \Elgg\Database
-	 */
-	protected $db;
+    /**
+     * @var \Elgg\Database
+     */
+    protected $db;
 
-	/**
-	 * @var \ElggSession
-	 */
-	protected $session;
+    /**
+     * @var \ElggSession
+     */
+    protected $session;
 
-	/**
-	 * @var \Elgg\EventsService
-	 */
-	protected $events;
+    /**
+     * @var \Elgg\EventsService
+     */
+    protected $events;
 
-	/**
-	 * Constructor
-	 *
-	 * @param \Elgg\Database      $db      Database
-	 * @param \ElggSession        $session Session
-	 * @param \Elgg\EventsService $events  Events
-	 */
-	public function __construct(\Elgg\Database $db, \ElggSession $session, \Elgg\EventsService $events) {
-		$this->db = $db;
-		$this->session = $session;
-		$this->events = $events;
-	}
+    /**
+     * Constructor
+     *
+     * @param \Elgg\Database      $db      Database
+     * @param \ElggSession        $session Session
+     * @param \Elgg\EventsService $events  Events
+     */
+    public function __construct(\Elgg\Database $db, \ElggSession $session, \Elgg\EventsService $events) {
+        $this->db = $db;
+        $this->session = $session;
+        $this->events = $events;
+    }
 
-	/**
-	 * Get a specific annotation by its id.
-	 * If you want multiple annotation objects, use
-	 * {@link elgg_get_annotations()}.
-	 *
-	 * @param int $id The id of the annotation object being retrieved.
-	 *
-	 * @return \ElggAnnotation|false
-	 */
-	function get($id) {
-		return _elgg_get_metastring_based_object_from_id($id, 'annotation');
-	}
-	
-	/**
-	 * Deletes an annotation using its ID.
-	 *
-	 * @param int $id The annotation ID to delete.
-	 * @return bool
-	 */
-	function delete($id) {
-		$annotation = $this->get($id);
-		if (!$annotation) {
-			return false;
-		}
-		return $annotation->delete();
-	}
-	
-	/**
-	 * Create a new annotation.
-	 *
-	 * @param int    $entity_guid GUID of entity to be annotated
-	 * @param string $name        Name of annotation
-	 * @param string $value       Value of annotation
-	 * @param string $value_type  Type of value (default is auto detection)
-	 * @param int    $owner_guid  Owner of annotation (default is logged in user)
-	 * @param int    $access_id   Access level of annotation
-	 *
-	 * @return int|bool id on success or false on failure
-	 */
-	function create($entity_guid, $name, $value, $value_type = '', $owner_guid = 0, $access_id = ACCESS_PRIVATE) {
+    /**
+     * Get a specific annotation by its id.
+     * If you want multiple annotation objects, use
+     * {@link elgg_get_annotations()}.
+     *
+     * @param int $id The id of the annotation object being retrieved.
+     *
+     * @return \ElggAnnotation|false
+     */
+    function get($id) {
+        return _elgg_get_metastring_based_object_from_id($id, 'annotation');
+    }
+	
+    /**
+     * Deletes an annotation using its ID.
+     *
+     * @param int $id The annotation ID to delete.
+     * @return bool
+     */
+    function delete($id) {
+        $annotation = $this->get($id);
+        if (!$annotation) {
+            return false;
+        }
+        return $annotation->delete();
+    }
+	
+    /**
+     * Create a new annotation.
+     *
+     * @param int    $entity_guid GUID of entity to be annotated
+     * @param string $name        Name of annotation
+     * @param string $value       Value of annotation
+     * @param string $value_type  Type of value (default is auto detection)
+     * @param int    $owner_guid  Owner of annotation (default is logged in user)
+     * @param int    $access_id   Access level of annotation
+     *
+     * @return int|bool id on success or false on failure
+     */
+    function create($entity_guid, $name, $value, $value_type = '', $owner_guid = 0, $access_id = ACCESS_PRIVATE) {
 		
-		$result = false;
+        $result = false;
 	
-		$entity_guid = (int) $entity_guid;
-		$value_type = \ElggExtender::detectValueType($value, $value_type);
+        $entity_guid = (int) $entity_guid;
+        $value_type = \ElggExtender::detectValueType($value, $value_type);
 
-		$owner_guid = (int) $owner_guid;
-		if ($owner_guid == 0) {
-			$owner_guid = $this->session->getLoggedInUserGuid();
-		}
+        $owner_guid = (int) $owner_guid;
+        if ($owner_guid == 0) {
+            $owner_guid = $this->session->getLoggedInUserGuid();
+        }
 	
-		$access_id = (int) $access_id;
+        $access_id = (int) $access_id;
 		
-		// @todo we don't check that the entity is loaded which means the user may
-		// not have access to the entity
-		$entity = get_entity($entity_guid);
+        // @todo we don't check that the entity is loaded which means the user may
+        // not have access to the entity
+        $entity = get_entity($entity_guid);
 	
-		if ($this->events->trigger('annotate', $entity->type, $entity)) {
-			$sql = "INSERT INTO {$this->db->prefix}annotations
+        if ($this->events->trigger('annotate', $entity->type, $entity)) {
+            $sql = "INSERT INTO {$this->db->prefix}annotations
 				(entity_guid, name, value, value_type, owner_guid, time_created, access_id)
 				VALUES
 				(:entity_guid, :name, :value, :value_type, :owner_guid, :time_created, :access_id)";
 	
-			$result = $this->db->insertData($sql, [
-				':entity_guid' => $entity_guid,
-				':name' => $name,
-				':value' => $value,
-				':value_type' => $value_type,
-				':owner_guid' => $owner_guid,
-				':time_created' => $this->getCurrentTime()->getTimestamp(),
-				':access_id' => $access_id,
-			]);
+            $result = $this->db->insertData($sql, [
+                ':entity_guid' => $entity_guid,
+                ':name' => $name,
+                ':value' => $value,
+                ':value_type' => $value_type,
+                ':owner_guid' => $owner_guid,
+                ':time_created' => $this->getCurrentTime()->getTimestamp(),
+                ':access_id' => $access_id,
+            ]);
 				
-			if ($result !== false) {
-				$obj = elgg_get_annotation_from_id($result);
-				if ($this->events->trigger('create', 'annotation', $obj)) {
-					return $result;
-				} else {
-					// plugin returned false to reject annotation
-					elgg_delete_annotation_by_id($result);
-					return false;
-				}
-			}
-		}
-	
-		return $result;
-	}
-	
-	/**
-	 * Update an annotation.
-	 *
-	 * @param int    $annotation_id Annotation ID
-	 * @param string $name          Name of annotation
-	 * @param string $value         Value of annotation
-	 * @param string $value_type    Type of value
-	 * @param int    $owner_guid    Owner of annotation
-	 * @param int    $access_id     Access level of annotation
-	 *
-	 * @return bool
-	 */
-	function update($annotation_id, $name, $value, $value_type, $owner_guid, $access_id) {
+            if ($result !== false) {
+                $obj = elgg_get_annotation_from_id($result);
+                if ($this->events->trigger('create', 'annotation', $obj)) {
+                    return $result;
+                } else {
+                    // plugin returned false to reject annotation
+                    elgg_delete_annotation_by_id($result);
+                    return false;
+                }
+            }
+        }
+	
+        return $result;
+    }
+	
+    /**
+     * Update an annotation.
+     *
+     * @param int    $annotation_id Annotation ID
+     * @param string $name          Name of annotation
+     * @param string $value         Value of annotation
+     * @param string $value_type    Type of value
+     * @param int    $owner_guid    Owner of annotation
+     * @param int    $access_id     Access level of annotation
+     *
+     * @return bool
+     */
+    function update($annotation_id, $name, $value, $value_type, $owner_guid, $access_id) {
 
-		$annotation_id = (int) $annotation_id;
+        $annotation_id = (int) $annotation_id;
 	
-		$annotation = $this->get($annotation_id);
-		if (!$annotation) {
-			return false;
-		}
-		if (!$annotation->canEdit()) {
-			return false;
-		}
+        $annotation = $this->get($annotation_id);
+        if (!$annotation) {
+            return false;
+        }
+        if (!$annotation->canEdit()) {
+            return false;
+        }
 	
-		$name = trim($name);
-		$value_type = \ElggExtender::detectValueType($value, $value_type);
+        $name = trim($name);
+        $value_type = \ElggExtender::detectValueType($value, $value_type);
 	
-		$owner_guid = (int) $owner_guid;
-		if ($owner_guid == 0) {
-			$owner_guid = $this->session->getLoggedInUserGuid();
-		}
+        $owner_guid = (int) $owner_guid;
+        if ($owner_guid == 0) {
+            $owner_guid = $this->session->getLoggedInUserGuid();
+        }
 	
-		$access_id = (int) $access_id;
+        $access_id = (int) $access_id;
 				
-		$sql = "UPDATE {$this->db->prefix}annotations
+        $sql = "UPDATE {$this->db->prefix}annotations
 			(name, value, value_type, access_id, owner_guid)
 			VALUES
 			(:name, :value, :value_type, :access_id, :owner_guid)
 			WHERE id = :annotation_id";
 
-		$result = $this->db->updateData($sql, false, [
-			':name' => $name,
-			':value' => $value,
-			':value_type' => $value_type,
-			':access_id' => $access_id,
-			':owner_guid' => $owner_guid,
-			':annotation_id' => $annotation_id,
-		]);
+        $result = $this->db->updateData($sql, false, [
+            ':name' => $name,
+            ':value' => $value,
+            ':value_type' => $value_type,
+            ':access_id' => $access_id,
+            ':owner_guid' => $owner_guid,
+            ':annotation_id' => $annotation_id,
+        ]);
 			
-		if ($result !== false) {
-			// @todo add plugin hook that sends old and new annotation information before db access
-			$obj = $this->get($annotation_id);
-			$this->events->trigger('update', 'annotation', $obj);
-		}
-	
-		return $result;
-	}
-	
-	/**
-	 * Returns annotations.  Accepts all elgg_get_entities() options for entity
-	 * restraints.
-	 *
-	 * @see elgg_get_entities
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * annotation_names              => null|ARR Annotation names
-	 * annotation_values             => null|ARR Annotation values
-	 * annotation_ids                => null|ARR annotation ids
-	 * annotation_case_sensitive     => BOOL Overall Case sensitive
-	 * annotation_owner_guids        => null|ARR guids for annotation owners
-	 * annotation_created_time_lower => INT Lower limit for created time.
-	 * annotation_created_time_upper => INT Upper limit for created time.
-	 * annotation_calculation        => STR Perform the MySQL function on the annotation values returned.
-	 *                                   Do not confuse this "annotation_calculation" option with the
-	 *                                   "calculation" option to elgg_get_entities_from_annotation_calculation().
-	 *                                   The "annotation_calculation" option causes this function to
-	 *                                   return the result of performing a mathematical calculation on
-	 *                                   all annotations that match the query instead of \ElggAnnotation
-	 *                                   objects.
-	 *                                   See the docs for elgg_get_entities_from_annotation_calculation()
-	 *                                   for the proper use of the "calculation" option.
-	 *
-	 *
-	 * @return \ElggAnnotation[]|mixed
-	 */
-	function find(array $options = []) {
+        if ($result !== false) {
+            // @todo add plugin hook that sends old and new annotation information before db access
+            $obj = $this->get($annotation_id);
+            $this->events->trigger('update', 'annotation', $obj);
+        }
+	
+        return $result;
+    }
+	
+    /**
+     * Returns annotations.  Accepts all elgg_get_entities() options for entity
+     * restraints.
+     *
+     * @see elgg_get_entities
+     *
+     * @param array $options Array in format:
+     *
+     * annotation_names              => null|ARR Annotation names
+     * annotation_values             => null|ARR Annotation values
+     * annotation_ids                => null|ARR annotation ids
+     * annotation_case_sensitive     => BOOL Overall Case sensitive
+     * annotation_owner_guids        => null|ARR guids for annotation owners
+     * annotation_created_time_lower => INT Lower limit for created time.
+     * annotation_created_time_upper => INT Upper limit for created time.
+     * annotation_calculation        => STR Perform the MySQL function on the annotation values returned.
+     *                                   Do not confuse this "annotation_calculation" option with the
+     *                                   "calculation" option to elgg_get_entities_from_annotation_calculation().
+     *                                   The "annotation_calculation" option causes this function to
+     *                                   return the result of performing a mathematical calculation on
+     *                                   all annotations that match the query instead of \ElggAnnotation
+     *                                   objects.
+     *                                   See the docs for elgg_get_entities_from_annotation_calculation()
+     *                                   for the proper use of the "calculation" option.
+     *
+     *
+     * @return \ElggAnnotation[]|mixed
+     */
+    function find(array $options = []) {
 
-		// support shortcut of 'count' => true for 'annotation_calculation' => 'count'
-		if (isset($options['count']) && $options['count']) {
-			$options['annotation_calculation'] = 'count';
-			unset($options['count']);
-		}
+        // support shortcut of 'count' => true for 'annotation_calculation' => 'count'
+        if (isset($options['count']) && $options['count']) {
+            $options['annotation_calculation'] = 'count';
+            unset($options['count']);
+        }
 		
-		$options['metastring_type'] = 'annotations';
-		return _elgg_get_metastring_based_objects($options);
-	}
-	
-	/**
-	 * Deletes annotations based on $options.
-	 *
-	 * @warning Unlike elgg_get_annotations() this will not accept an empty options array!
-	 *          This requires at least one constraint: annotation_owner_guid(s),
-	 *          annotation_name(s), annotation_value(s), or guid(s) must be set.
-	 *
-	 * @param array $options An options array. {@link elgg_get_annotations()}
-	 * @return bool|null true on success, false on failure, null if no annotations to delete.
-	 */
-	function deleteAll(array $options) {
-		if (!_elgg_is_valid_options_for_batch_operation($options, 'annotation')) {
-			return false;
-		}
-	
-		$options['metastring_type'] = 'annotations';
-		return _elgg_batch_metastring_based_objects($options, 'elgg_batch_delete_callback', false);
-	}
-	
-	/**
-	 * Disables annotations based on $options.
-	 *
-	 * @warning Unlike elgg_get_annotations() this will not accept an empty options array!
-	 *
-	 * @param array $options An options array. {@link elgg_get_annotations()}
-	 * @return bool|null true on success, false on failure, null if no annotations disabled.
-	 */
-	function disableAll(array $options) {
-		if (!_elgg_is_valid_options_for_batch_operation($options, 'annotation')) {
-			return false;
-		}
+        $options['metastring_type'] = 'annotations';
+        return _elgg_get_metastring_based_objects($options);
+    }
+	
+    /**
+     * Deletes annotations based on $options.
+     *
+     * @warning Unlike elgg_get_annotations() this will not accept an empty options array!
+     *          This requires at least one constraint: annotation_owner_guid(s),
+     *          annotation_name(s), annotation_value(s), or guid(s) must be set.
+     *
+     * @param array $options An options array. {@link elgg_get_annotations()}
+     * @return bool|null true on success, false on failure, null if no annotations to delete.
+     */
+    function deleteAll(array $options) {
+        if (!_elgg_is_valid_options_for_batch_operation($options, 'annotation')) {
+            return false;
+        }
+	
+        $options['metastring_type'] = 'annotations';
+        return _elgg_batch_metastring_based_objects($options, 'elgg_batch_delete_callback', false);
+    }
+	
+    /**
+     * Disables annotations based on $options.
+     *
+     * @warning Unlike elgg_get_annotations() this will not accept an empty options array!
+     *
+     * @param array $options An options array. {@link elgg_get_annotations()}
+     * @return bool|null true on success, false on failure, null if no annotations disabled.
+     */
+    function disableAll(array $options) {
+        if (!_elgg_is_valid_options_for_batch_operation($options, 'annotation')) {
+            return false;
+        }
 		
-		// if we can see hidden (disabled) we need to use the offset
-		// otherwise we risk an infinite loop if there are more than 50
-		$inc_offset = access_get_show_hidden_status();
-	
-		$options['metastring_type'] = 'annotations';
-		return _elgg_batch_metastring_based_objects($options, 'elgg_batch_disable_callback', $inc_offset);
-	}
-	
-	/**
-	 * Enables annotations based on $options.
-	 *
-	 * @warning Unlike elgg_get_annotations() this will not accept an empty options array!
-	 *
-	 * @warning In order to enable annotations, you must first use
-	 * {@link access_show_hidden_entities()}.
-	 *
-	 * @param array $options An options array. {@link elgg_get_annotations()}
-	 * @return bool|null true on success, false on failure, null if no metadata enabled.
-	 */
-	function enableAll(array $options) {
-		if (!$options || !is_array($options)) {
-			return false;
-		}
-	
-		$options['metastring_type'] = 'annotations';
-		return _elgg_batch_metastring_based_objects($options, 'elgg_batch_enable_callback');
-	}
-	
-	/**
-	 * Returns entities based upon annotations.  Also accepts all options available
-	 * to elgg_get_entities() and elgg_get_entities_from_metadata().
-	 *
-	 * @see elgg_get_entities
-	 * @see elgg_get_entities_from_metadata
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * 	annotation_names => null|ARR annotations names
-	 *
-	 * 	annotation_values => null|ARR annotations values
-	 *
-	 * 	annotation_name_value_pairs => null|ARR (name = 'name', value => 'value',
-	 * 	'operator' => '=', 'case_sensitive' => true) entries.
-	 * 	Currently if multiple values are sent via an array (value => array('value1', 'value2')
-	 * 	the pair's operator will be forced to "IN".
-	 *
-	 * 	annotation_name_value_pairs_operator => null|STR The operator to use for combining
-	 *  (name = value) OPERATOR (name = value); default AND
-	 *
-	 * 	annotation_case_sensitive => BOOL Overall Case sensitive
-	 *
-	 *  order_by_annotation => null|ARR (array('name' => 'annotation_text1', 'direction' => ASC|DESC,
-	 *  'as' => text|integer),
-	 *
-	 *  Also supports array('name' => 'annotation_text1')
-	 *
-	 *  annotation_owner_guids => null|ARR guids for annotaiton owners
-	 *
-	 * @return mixed If count, int. If not count, array. false on errors.
-	 */
-	function getEntities(array $options = []) {
-		$defaults = [
-			'annotation_names'                      => ELGG_ENTITIES_ANY_VALUE,
-			'annotation_values'                     => ELGG_ENTITIES_ANY_VALUE,
-			'annotation_name_value_pairs'           => ELGG_ENTITIES_ANY_VALUE,
+        // if we can see hidden (disabled) we need to use the offset
+        // otherwise we risk an infinite loop if there are more than 50
+        $inc_offset = access_get_show_hidden_status();
+	
+        $options['metastring_type'] = 'annotations';
+        return _elgg_batch_metastring_based_objects($options, 'elgg_batch_disable_callback', $inc_offset);
+    }
+	
+    /**
+     * Enables annotations based on $options.
+     *
+     * @warning Unlike elgg_get_annotations() this will not accept an empty options array!
+     *
+     * @warning In order to enable annotations, you must first use
+     * {@link access_show_hidden_entities()}.
+     *
+     * @param array $options An options array. {@link elgg_get_annotations()}
+     * @return bool|null true on success, false on failure, null if no metadata enabled.
+     */
+    function enableAll(array $options) {
+        if (!$options || !is_array($options)) {
+            return false;
+        }
+	
+        $options['metastring_type'] = 'annotations';
+        return _elgg_batch_metastring_based_objects($options, 'elgg_batch_enable_callback');
+    }
+	
+    /**
+     * Returns entities based upon annotations.  Also accepts all options available
+     * to elgg_get_entities() and elgg_get_entities_from_metadata().
+     *
+     * @see elgg_get_entities
+     * @see elgg_get_entities_from_metadata
+     *
+     * @param array $options Array in format:
+     *
+     * 	annotation_names => null|ARR annotations names
+     *
+     * 	annotation_values => null|ARR annotations values
+     *
+     * 	annotation_name_value_pairs => null|ARR (name = 'name', value => 'value',
+     * 	'operator' => '=', 'case_sensitive' => true) entries.
+     * 	Currently if multiple values are sent via an array (value => array('value1', 'value2')
+     * 	the pair's operator will be forced to "IN".
+     *
+     * 	annotation_name_value_pairs_operator => null|STR The operator to use for combining
+     *  (name = value) OPERATOR (name = value); default AND
+     *
+     * 	annotation_case_sensitive => BOOL Overall Case sensitive
+     *
+     *  order_by_annotation => null|ARR (array('name' => 'annotation_text1', 'direction' => ASC|DESC,
+     *  'as' => text|integer),
+     *
+     *  Also supports array('name' => 'annotation_text1')
+     *
+     *  annotation_owner_guids => null|ARR guids for annotaiton owners
+     *
+     * @return mixed If count, int. If not count, array. false on errors.
+     */
+    function getEntities(array $options = []) {
+        $defaults = [
+            'annotation_names'                      => ELGG_ENTITIES_ANY_VALUE,
+            'annotation_values'                     => ELGG_ENTITIES_ANY_VALUE,
+            'annotation_name_value_pairs'           => ELGG_ENTITIES_ANY_VALUE,
 
-			'annotation_name_value_pairs_operator'  => 'AND',
-			'annotation_case_sensitive'             => true,
-			'order_by_annotation'                   => [],
+            'annotation_name_value_pairs_operator'  => 'AND',
+            'annotation_case_sensitive'             => true,
+            'order_by_annotation'                   => [],
 
-			'annotation_created_time_lower'         => ELGG_ENTITIES_ANY_VALUE,
-			'annotation_created_time_upper'         => ELGG_ENTITIES_ANY_VALUE,
-			'annotation_owner_guids'                => ELGG_ENTITIES_ANY_VALUE,
-		];
+            'annotation_created_time_lower'         => ELGG_ENTITIES_ANY_VALUE,
+            'annotation_created_time_upper'         => ELGG_ENTITIES_ANY_VALUE,
+            'annotation_owner_guids'                => ELGG_ENTITIES_ANY_VALUE,
+        ];
 	
-		$options = array_merge($defaults, $options);
+        $options = array_merge($defaults, $options);
 	
-		$singulars = ['annotation_name', 'annotation_value', 'annotation_name_value_pair', 'annotation_owner_guid'];
+        $singulars = ['annotation_name', 'annotation_value', 'annotation_name_value_pair', 'annotation_owner_guid'];
 	
-		$options = _elgg_normalize_plural_options_array($options, $singulars);
-		$options = _elgg_entities_get_metastrings_options('annotation', $options);
+        $options = _elgg_normalize_plural_options_array($options, $singulars);
+        $options = _elgg_entities_get_metastrings_options('annotation', $options);
 	
-		if (!$options) {
-			return false;
-		}
+        if (!$options) {
+            return false;
+        }
 		
-		$time_wheres = _elgg_get_entity_time_where_sql('n_table', $options['annotation_created_time_upper'],
-			$options['annotation_created_time_lower']);
+        $time_wheres = _elgg_get_entity_time_where_sql('n_table', $options['annotation_created_time_upper'],
+            $options['annotation_created_time_lower']);
 
-		if ($time_wheres) {
-			$options['wheres'][] = $time_wheres;
-		}
-	
-		return elgg_get_entities_from_metadata($options);
-	}
-	
-	/**
-	 * Get entities ordered by a mathematical calculation on annotation values
-	 *
-	 * @tip Note that this function uses { @link elgg_get_annotations() } to return a list of entities ordered by a mathematical
-	 * calculation on annotation values, and { @link elgg_get_entities_from_annotations() } to return a count of entities
-	 * if $options['count'] is set to a truthy value
-	 *
-	 * @param array $options An options array:
-	 * 	'calculation'            => The calculation to use. Must be a valid MySQL function.
-	 *                              Defaults to sum.  Result selected as 'annotation_calculation'.
-	 *                              Don't confuse this "calculation" option with the
-	 *                              "annotation_calculation" option to elgg_get_annotations().
-	 *                              This "calculation" option is applied to each entity's set of
-	 *                              annotations and is selected as annotation_calculation for that row.
-	 *                              See the docs for elgg_get_annotations() for proper use of the
-	 *                              "annotation_calculation" option.
-	 *	'order_by'               => The order for the sorting. Defaults to 'annotation_calculation desc'.
-	 *	'annotation_names'       => The names of annotations on the entity.
-	 *	'annotation_values'	     => The values of annotations on the entity.
-	 *
-	 * 	'metadata_names'         => The name of metadata on the entity.
-	 * 	'metadata_values'        => The value of metadata on the entitiy.
-	 * 	'callback'               => Callback function to pass each row through.
-	 *                              @tip This function is different from other ege* functions,
-	 *                              as it uses a metastring-based getter function { @link elgg_get_annotations() },
-	 *                              therefore the callback function should be a derivative of { @link entity_row_to_elggstar() }
-	 *                              and not of { @link row_to_annotation() }
-	 *
-	 * @return \ElggEntity[]|int An array or a count of entities
-	 * @see elgg_get_annotations()
-	 * @see elgg_get_entities_from_annotations()
-	 */
-	function getEntitiesFromCalculation($options) {
+        if ($time_wheres) {
+            $options['wheres'][] = $time_wheres;
+        }
+	
+        return elgg_get_entities_from_metadata($options);
+    }
+	
+    /**
+     * Get entities ordered by a mathematical calculation on annotation values
+     *
+     * @tip Note that this function uses { @link elgg_get_annotations() } to return a list of entities ordered by a mathematical
+     * calculation on annotation values, and { @link elgg_get_entities_from_annotations() } to return a count of entities
+     * if $options['count'] is set to a truthy value
+     *
+     * @param array $options An options array:
+     * 	'calculation'            => The calculation to use. Must be a valid MySQL function.
+     *                              Defaults to sum.  Result selected as 'annotation_calculation'.
+     *                              Don't confuse this "calculation" option with the
+     *                              "annotation_calculation" option to elgg_get_annotations().
+     *                              This "calculation" option is applied to each entity's set of
+     *                              annotations and is selected as annotation_calculation for that row.
+     *                              See the docs for elgg_get_annotations() for proper use of the
+     *                              "annotation_calculation" option.
+     *	'order_by'               => The order for the sorting. Defaults to 'annotation_calculation desc'.
+     *	'annotation_names'       => The names of annotations on the entity.
+     *	'annotation_values'	     => The values of annotations on the entity.
+     *
+     * 	'metadata_names'         => The name of metadata on the entity.
+     * 	'metadata_values'        => The value of metadata on the entitiy.
+     * 	'callback'               => Callback function to pass each row through.
+     *                              @tip This function is different from other ege* functions,
+     *                              as it uses a metastring-based getter function { @link elgg_get_annotations() },
+     *                              therefore the callback function should be a derivative of { @link entity_row_to_elggstar() }
+     *                              and not of { @link row_to_annotation() }
+     *
+     * @return \ElggEntity[]|int An array or a count of entities
+     * @see elgg_get_annotations()
+     * @see elgg_get_entities_from_annotations()
+     */
+    function getEntitiesFromCalculation($options) {
 		
-		if (isset($options['count']) && $options['count']) {
-			return elgg_get_entities_from_annotations($options);
-		}
+        if (isset($options['count']) && $options['count']) {
+            return elgg_get_entities_from_annotations($options);
+        }
 		
-		$db_prefix = $this->db->prefix;
-		$defaults = [
-			'calculation' => 'sum',
-			'order_by' => 'annotation_calculation desc'
-		];
+        $db_prefix = $this->db->prefix;
+        $defaults = [
+            'calculation' => 'sum',
+            'order_by' => 'annotation_calculation desc'
+        ];
 	
-		$options = array_merge($defaults, $options);
+        $options = array_merge($defaults, $options);
 	
-		$function = sanitize_string(elgg_extract('calculation', $options, 'sum', false));
+        $function = sanitize_string(elgg_extract('calculation', $options, 'sum', false));
 	
-		// you must cast this as an int or it sorts wrong.
-		$options['selects'][] = 'e.*';
-		$options['selects'][] = "$function(CAST(n_table.value AS signed)) AS annotation_calculation";
+        // you must cast this as an int or it sorts wrong.
+        $options['selects'][] = 'e.*';
+        $options['selects'][] = "$function(CAST(n_table.value AS signed)) AS annotation_calculation";
 	
-		// don't need access control because it's taken care of by elgg_get_annotations.
-		$options['group_by'] = 'n_table.entity_guid';
+        // don't need access control because it's taken care of by elgg_get_annotations.
+        $options['group_by'] = 'n_table.entity_guid';
 
-		// do not default to a callback function used in elgg_get_annotation()
-		if (!isset($options['callback'])) {
-			$options['callback'] = 'entity_row_to_elggstar';
-		}
+        // do not default to a callback function used in elgg_get_annotation()
+        if (!isset($options['callback'])) {
+            $options['callback'] = 'entity_row_to_elggstar';
+        }
 
-		return elgg_get_annotations($options);
-	}
-	
-	/**
-	 * Check to see if a user has already created an annotation on an object
-	 *
-	 * @param int    $entity_guid     Entity guid
-	 * @param string $annotation_type Type of annotation
-	 * @param int    $owner_guid      Defaults to logged in user.
-	 *
-	 * @return bool
-	 */
-	function exists($entity_guid, $annotation_type, $owner_guid = null) {
-	
-		if (!$owner_guid && !($owner_guid = $this->session->getLoggedInUserGuid())) {
-			return false;
-		}
+        return elgg_get_annotations($options);
+    }
+	
+    /**
+     * Check to see if a user has already created an annotation on an object
+     *
+     * @param int    $entity_guid     Entity guid
+     * @param string $annotation_type Type of annotation
+     * @param int    $owner_guid      Defaults to logged in user.
+     *
+     * @return bool
+     */
+    function exists($entity_guid, $annotation_type, $owner_guid = null) {
+	
+        if (!$owner_guid && !($owner_guid = $this->session->getLoggedInUserGuid())) {
+            return false;
+        }
 		
-		$sql = "SELECT id FROM {$this->db->prefix}annotations
+        $sql = "SELECT id FROM {$this->db->prefix}annotations
 				WHERE owner_guid = :owner_guid
 				AND entity_guid = :entity_guid
 				AND name = :annotation_type";
 
-		$result = $this->db->getDataRow($sql, null, [
-			':owner_guid' => (int) $owner_guid,
-			':entity_guid' => (int) $entity_guid,
-			':annotation_type' => $annotation_type,
-		]);
-	
-		return (bool) $result;
-	}
+        $result = $this->db->getDataRow($sql, null, [
+            ':owner_guid' => (int) $owner_guid,
+            ':entity_guid' => (int) $entity_guid,
+            ':annotation_type' => $annotation_type,
+        ]);
+	
+        return (bool) $result;
+    }
 }

engine/classes/Elgg/Http/Request.php

Doc Comments +1 added lines

@@ -105,6 +105,7 @@
 
 	/**
 	 * {@inheritdoc}
+	 * @return string
 	 */
 	public function getClientIp() {
 		$ip = parent::getClientIp();

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 namespace Elgg\Http;
 
 use Symfony\Component\HttpFoundation\Request as SymfonyRequest;
-use Elgg\Application;
 
 /**
  * Elgg HTTP request.

Indentation +162 added lines, -162 removed lines

@@ -11,166 +11,166 @@
  */
 class Request extends SymfonyRequest {
 
-	const REWRITE_TEST_TOKEN = '__testing_rewrite';
-	const REWRITE_TEST_OUTPUT = 'success';
-
-	/**
-	 * Get the Elgg URL segments
-	 *
-	 * @param bool $raw If true, the segments will not be HTML escaped
-	 *
-	 * @return string[]
-	 */
-	public function getUrlSegments($raw = false) {
-		$path = trim($this->getElggPath(), '/');
-		if (!$raw) {
-			$path = htmlspecialchars($path, ENT_QUOTES, 'UTF-8');
-		}
-		if (!$path) {
-			return [];
-		}
-
-		return explode('/', $path);
-	}
-
-	/**
-	 * Get a cloned request with new Elgg URL segments
-	 *
-	 * @param string[] $segments URL segments
-	 *
-	 * @return Request
-	 */
-	public function setUrlSegments(array $segments) {
-		$base_path = trim($this->getBasePath(), '/');
-		$server = $this->server->all();
-		$server['REQUEST_URI'] = "$base_path/" . implode('/', $segments);
-
-		return $this->duplicate(null, null, null, null, null, $server);
-	}
-
-	/**
-	 * Get first Elgg URL segment
-	 *
-	 * @see \Elgg\Http\Request::getUrlSegments()
-	 *
-	 * @return string
-	 */
-	public function getFirstUrlSegment() {
-		$segments = $this->getUrlSegments();
-		if ($segments) {
-			return array_shift($segments);
-		} else {
-			return '';
-		}
-	}
-
-	/**
-	 * Get the Request URI minus querystring
-	 *
-	 * @return string
-	 */
-	public function getElggPath() {
-		if (php_sapi_name() === 'cli-server') {
-			$path = $this->getRequestUri();
-		} else {
-			$path = $this->getPathInfo();
-		}
-		return preg_replace('~(\?.*)$~', '', $path);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getClientIp() {
-		$ip = parent::getClientIp();
-
-		if ($ip == $this->server->get('REMOTE_ADDR')) {
-			// try one more
-			$ip_addresses = $this->server->get('HTTP_X_REAL_IP');
-			if ($ip_addresses) {
-				$ip_addresses = explode(',', $ip_addresses);
-				return array_pop($ip_addresses);
-			}
-		}
-
-		return $ip;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function isXmlHttpRequest() {
-		return (strtolower($this->headers->get('X-Requested-With')) === 'xmlhttprequest'
-			|| $this->query->get('X-Requested-With') === 'XMLHttpRequest'
-			|| $this->request->get('X-Requested-With') === 'XMLHttpRequest');
-		// GET/POST check is necessary for jQuery.form and other iframe-based "ajax". #8735
-	}
-
-	/**
-	 * Sniff the Elgg site URL with trailing slash
-	 *
-	 * @return string
-	 */
-	public function sniffElggUrl() {
-		$base_url = $this->getBaseUrl();
-
-		// baseURL may end with the PHP script
-		if ('.php' === substr($base_url, -4)) {
-			$base_url = dirname($base_url);
-		}
-
-		return rtrim($this->getSchemeAndHttpHost() . $base_url, '/') . '/';
-	}
-
-	/**
-	 * Is the request for checking URL rewriting?
-	 *
-	 * @return bool
-	 */
-	public function isRewriteCheck() {
-		if ($this->getPathInfo() !== ('/' . self::REWRITE_TEST_TOKEN)) {
-			return false;
-		}
-
-		if (!$this->get(self::REWRITE_TEST_TOKEN)) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Is PHP running the CLI server front controller
-	 *
-	 * @return bool
-	 */
-	public function isCliServer() {
-		return php_sapi_name() === 'cli-server';
-	}
-
-	/**
-	 * Is the request pointing to a file that the CLI server can handle?
-	 *
-	 * @param string $root Root directory
-	 *
-	 * @return bool
-	 */
-	public function isCliServable($root) {
-		$file = rtrim($root, '\\/') . $this->getElggPath();
-		if (!is_file($file)) {
-			return false;
-		}
-
-		// http://php.net/manual/en/features.commandline.webserver.php
-		$extensions = ".3gp, .apk, .avi, .bmp, .css, .csv, .doc, .docx, .flac, .gif, .gz, .gzip, .htm, .html, .ics, .jpe, .jpeg, .jpg, .js, .kml, .kmz, .m4a, .mov, .mp3, .mp4, .mpeg, .mpg, .odp, .ods, .odt, .oga, .ogg, .ogv, .pdf, .pdf, .png, .pps, .pptx, .qt, .svg, .swf, .tar, .text, .tif, .txt, .wav, .webm, .wmv, .xls, .xlsx, .xml, .xsl, .xsd, and .zip";
-
-		// The CLI server routes ALL requests here (even existing files), so we have to check for these.
-		$ext = pathinfo($file, PATHINFO_EXTENSION);
-		if (!$ext) {
-			return false;
-		}
-
-		$ext = preg_quote($ext, '~');
-		return (bool) preg_match("~\\.{$ext}[,$]~", $extensions);
-	}
+    const REWRITE_TEST_TOKEN = '__testing_rewrite';
+    const REWRITE_TEST_OUTPUT = 'success';
+
+    /**
+     * Get the Elgg URL segments
+     *
+     * @param bool $raw If true, the segments will not be HTML escaped
+     *
+     * @return string[]
+     */
+    public function getUrlSegments($raw = false) {
+        $path = trim($this->getElggPath(), '/');
+        if (!$raw) {
+            $path = htmlspecialchars($path, ENT_QUOTES, 'UTF-8');
+        }
+        if (!$path) {
+            return [];
+        }
+
+        return explode('/', $path);
+    }
+
+    /**
+     * Get a cloned request with new Elgg URL segments
+     *
+     * @param string[] $segments URL segments
+     *
+     * @return Request
+     */
+    public function setUrlSegments(array $segments) {
+        $base_path = trim($this->getBasePath(), '/');
+        $server = $this->server->all();
+        $server['REQUEST_URI'] = "$base_path/" . implode('/', $segments);
+
+        return $this->duplicate(null, null, null, null, null, $server);
+    }
+
+    /**
+     * Get first Elgg URL segment
+     *
+     * @see \Elgg\Http\Request::getUrlSegments()
+     *
+     * @return string
+     */
+    public function getFirstUrlSegment() {
+        $segments = $this->getUrlSegments();
+        if ($segments) {
+            return array_shift($segments);
+        } else {
+            return '';
+        }
+    }
+
+    /**
+     * Get the Request URI minus querystring
+     *
+     * @return string
+     */
+    public function getElggPath() {
+        if (php_sapi_name() === 'cli-server') {
+            $path = $this->getRequestUri();
+        } else {
+            $path = $this->getPathInfo();
+        }
+        return preg_replace('~(\?.*)$~', '', $path);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getClientIp() {
+        $ip = parent::getClientIp();
+
+        if ($ip == $this->server->get('REMOTE_ADDR')) {
+            // try one more
+            $ip_addresses = $this->server->get('HTTP_X_REAL_IP');
+            if ($ip_addresses) {
+                $ip_addresses = explode(',', $ip_addresses);
+                return array_pop($ip_addresses);
+            }
+        }
+
+        return $ip;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isXmlHttpRequest() {
+        return (strtolower($this->headers->get('X-Requested-With')) === 'xmlhttprequest'
+            || $this->query->get('X-Requested-With') === 'XMLHttpRequest'
+            || $this->request->get('X-Requested-With') === 'XMLHttpRequest');
+        // GET/POST check is necessary for jQuery.form and other iframe-based "ajax". #8735
+    }
+
+    /**
+     * Sniff the Elgg site URL with trailing slash
+     *
+     * @return string
+     */
+    public function sniffElggUrl() {
+        $base_url = $this->getBaseUrl();
+
+        // baseURL may end with the PHP script
+        if ('.php' === substr($base_url, -4)) {
+            $base_url = dirname($base_url);
+        }
+
+        return rtrim($this->getSchemeAndHttpHost() . $base_url, '/') . '/';
+    }
+
+    /**
+     * Is the request for checking URL rewriting?
+     *
+     * @return bool
+     */
+    public function isRewriteCheck() {
+        if ($this->getPathInfo() !== ('/' . self::REWRITE_TEST_TOKEN)) {
+            return false;
+        }
+
+        if (!$this->get(self::REWRITE_TEST_TOKEN)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Is PHP running the CLI server front controller
+     *
+     * @return bool
+     */
+    public function isCliServer() {
+        return php_sapi_name() === 'cli-server';
+    }
+
+    /**
+     * Is the request pointing to a file that the CLI server can handle?
+     *
+     * @param string $root Root directory
+     *
+     * @return bool
+     */
+    public function isCliServable($root) {
+        $file = rtrim($root, '\\/') . $this->getElggPath();
+        if (!is_file($file)) {
+            return false;
+        }
+
+        // http://php.net/manual/en/features.commandline.webserver.php
+        $extensions = ".3gp, .apk, .avi, .bmp, .css, .csv, .doc, .docx, .flac, .gif, .gz, .gzip, .htm, .html, .ics, .jpe, .jpeg, .jpg, .js, .kml, .kmz, .m4a, .mov, .mp3, .mp4, .mpeg, .mpg, .odp, .ods, .odt, .oga, .ogg, .ogv, .pdf, .pdf, .png, .pps, .pptx, .qt, .svg, .swf, .tar, .text, .tif, .txt, .wav, .webm, .wmv, .xls, .xlsx, .xml, .xsl, .xsd, and .zip";
+
+        // The CLI server routes ALL requests here (even existing files), so we have to check for these.
+        $ext = pathinfo($file, PATHINFO_EXTENSION);
+        if (!$ext) {
+            return false;
+        }
+
+        $ext = preg_quote($ext, '~');
+        return (bool) preg_match("~\\.{$ext}[,$]~", $extensions);
+    }
 }

Spacing +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
 	public function setUrlSegments(array $segments) {
 		$base_path = trim($this->getBasePath(), '/');
 		$server = $this->server->all();
-		$server['REQUEST_URI'] = "$base_path/" . implode('/', $segments);
+		$server['REQUEST_URI'] = "$base_path/".implode('/', $segments);
 
 		return $this->duplicate(null, null, null, null, null, $server);
 	}
@@ -119,7 +119,7 @@ 
 			$base_url = dirname($base_url);
 		}
 
-		return rtrim($this->getSchemeAndHttpHost() . $base_url, '/') . '/';
+		return rtrim($this->getSchemeAndHttpHost().$base_url, '/').'/';
 	}
 
 	/**
@@ -128,7 +128,7 @@ 
 	 * @return bool
 	 */
 	public function isRewriteCheck() {
-		if ($this->getPathInfo() !== ('/' . self::REWRITE_TEST_TOKEN)) {
+		if ($this->getPathInfo() !== ('/'.self::REWRITE_TEST_TOKEN)) {
 			return false;
 		}
 
@@ -156,7 +156,7 @@ 
 	 * @return bool
 	 */
 	public function isCliServable($root) {
-		$file = rtrim($root, '\\/') . $this->getElggPath();
+		$file = rtrim($root, '\\/').$this->getElggPath();
 		if (!is_file($file)) {
 			return false;
 		}

engine/classes/ElggBatch.php

Doc Comments +1 added lines, -1 removed lines

@@ -174,7 +174,7 @@
 	 * @param array  $options    The options array to pass to the getter function. If limit is
 	 *                           not set, 10 is used as the default. In most cases that is not
 	 *                           what you want.
-	 * @param mixed  $callback   An optional callback function that all results will be passed
+	 * @param null|string  $callback   An optional callback function that all results will be passed
 	 *                           to upon load.  The callback needs to accept $result, $getter,
 	 *                           $options.
 	 * @param int    $chunk_size The number of entities to pull in before requesting more.

Spacing +1 added lines, -1 removed lines

@@ -450,7 +450,7 @@
 	public function count() {
 		if (!is_callable($this->getter)) {
 			$inspector = new \Elgg\Debug\Inspector();
-			throw new RuntimeException("Getter is not callable: " . $inspector->describeCallable($this->getter));
+			throw new RuntimeException("Getter is not callable: ".$inspector->describeCallable($this->getter));
 		}
 
 		$options = array_merge($this->options, ['count' => true]);

Indentation +384 added lines, -384 removed lines

@@ -72,389 +72,389 @@
  */
 class ElggBatch implements BatchResult {
 
-	/**
-	 * The objects to iterate over.
-	 *
-	 * @var array
-	 */
-	private $results = [];
-
-	/**
-	 * The function used to get results.
-	 *
-	 * @var callable
-	 */
-	private $getter = null;
-
-	/**
-	 * The given $options to alter and pass to the getter.
-	 *
-	 * @var array
-	 */
-	private $options = [];
-
-	/**
-	 * The number of results to grab at a time.
-	 *
-	 * @var int
-	 */
-	private $chunkSize = 25;
-
-	/**
-	 * A callback function to pass results through.
-	 *
-	 * @var callable
-	 */
-	private $callback = null;
-
-	/**
-	 * Start after this many results.
-	 *
-	 * @var int
-	 */
-	private $offset = 0;
-
-	/**
-	 * Stop after this many results.
-	 *
-	 * @var int
-	 */
-	private $limit = 0;
-
-	/**
-	 * Number of processed results.
-	 *
-	 * @var int
-	 */
-	private $retrievedResults = 0;
-
-	/**
-	 * The index of the current result within the current chunk
-	 *
-	 * @var int
-	 */
-	private $resultIndex = 0;
-
-	/**
-	 * The index of the current chunk
-	 *
-	 * @var int
-	 */
-	private $chunkIndex = 0;
-
-	/**
-	 * The number of results iterated through
-	 *
-	 * @var int
-	 */
-	private $processedResults = 0;
-
-	/**
-	 * Is the getter a valid callback
-	 *
-	 * @var bool
-	 */
-	private $validGetter = null;
-
-	/**
-	 * The result of running all entities through the callback function.
-	 *
-	 * @var mixed
-	 */
-	public $callbackResult = null;
-
-	/**
-	 * If false, offset will not be incremented. This is used for callbacks/loops that delete.
-	 *
-	 * @var bool
-	 */
-	private $incrementOffset = true;
-
-	/**
-	 * Entities that could not be instantiated during a fetch
-	 *
-	 * @var \stdClass[]
-	 */
-	private $incompleteEntities = [];
-
-	/**
-	 * Total number of incomplete entities fetched
-	 *
-	 * @var int
-	 */
-	private $totalIncompletes = 0;
-
-	/**
-	 * Batches operations on any elgg_get_*() or compatible function that supports
-	 * an options array.
-	 *
-	 * Instead of returning all objects in memory, it goes through $chunk_size
-	 * objects, then requests more from the server.  This avoids OOM errors.
-	 *
-	 * @param string $getter     The function used to get objects.  Usually
-	 *                           an elgg_get_*() function, but can be any valid PHP callback.
-	 * @param array  $options    The options array to pass to the getter function. If limit is
-	 *                           not set, 10 is used as the default. In most cases that is not
-	 *                           what you want.
-	 * @param mixed  $callback   An optional callback function that all results will be passed
-	 *                           to upon load.  The callback needs to accept $result, $getter,
-	 *                           $options.
-	 * @param int    $chunk_size The number of entities to pull in before requesting more.
-	 *                           You have to balance this between running out of memory in PHP
-	 *                           and hitting the db server too often.
-	 * @param bool   $inc_offset Increment the offset on each fetch. This must be false for
-	 *                           callbacks that delete rows. You can set this after the
-	 *                           object is created with {@link \ElggBatch::setIncrementOffset()}.
-	 */
-	public function __construct($getter, $options, $callback = null, $chunk_size = 25,
-			$inc_offset = true) {
+    /**
+     * The objects to iterate over.
+     *
+     * @var array
+     */
+    private $results = [];
+
+    /**
+     * The function used to get results.
+     *
+     * @var callable
+     */
+    private $getter = null;
+
+    /**
+     * The given $options to alter and pass to the getter.
+     *
+     * @var array
+     */
+    private $options = [];
+
+    /**
+     * The number of results to grab at a time.
+     *
+     * @var int
+     */
+    private $chunkSize = 25;
+
+    /**
+     * A callback function to pass results through.
+     *
+     * @var callable
+     */
+    private $callback = null;
+
+    /**
+     * Start after this many results.
+     *
+     * @var int
+     */
+    private $offset = 0;
+
+    /**
+     * Stop after this many results.
+     *
+     * @var int
+     */
+    private $limit = 0;
+
+    /**
+     * Number of processed results.
+     *
+     * @var int
+     */
+    private $retrievedResults = 0;
+
+    /**
+     * The index of the current result within the current chunk
+     *
+     * @var int
+     */
+    private $resultIndex = 0;
+
+    /**
+     * The index of the current chunk
+     *
+     * @var int
+     */
+    private $chunkIndex = 0;
+
+    /**
+     * The number of results iterated through
+     *
+     * @var int
+     */
+    private $processedResults = 0;
+
+    /**
+     * Is the getter a valid callback
+     *
+     * @var bool
+     */
+    private $validGetter = null;
+
+    /**
+     * The result of running all entities through the callback function.
+     *
+     * @var mixed
+     */
+    public $callbackResult = null;
+
+    /**
+     * If false, offset will not be incremented. This is used for callbacks/loops that delete.
+     *
+     * @var bool
+     */
+    private $incrementOffset = true;
+
+    /**
+     * Entities that could not be instantiated during a fetch
+     *
+     * @var \stdClass[]
+     */
+    private $incompleteEntities = [];
+
+    /**
+     * Total number of incomplete entities fetched
+     *
+     * @var int
+     */
+    private $totalIncompletes = 0;
+
+    /**
+     * Batches operations on any elgg_get_*() or compatible function that supports
+     * an options array.
+     *
+     * Instead of returning all objects in memory, it goes through $chunk_size
+     * objects, then requests more from the server.  This avoids OOM errors.
+     *
+     * @param string $getter     The function used to get objects.  Usually
+     *                           an elgg_get_*() function, but can be any valid PHP callback.
+     * @param array  $options    The options array to pass to the getter function. If limit is
+     *                           not set, 10 is used as the default. In most cases that is not
+     *                           what you want.
+     * @param mixed  $callback   An optional callback function that all results will be passed
+     *                           to upon load.  The callback needs to accept $result, $getter,
+     *                           $options.
+     * @param int    $chunk_size The number of entities to pull in before requesting more.
+     *                           You have to balance this between running out of memory in PHP
+     *                           and hitting the db server too often.
+     * @param bool   $inc_offset Increment the offset on each fetch. This must be false for
+     *                           callbacks that delete rows. You can set this after the
+     *                           object is created with {@link \ElggBatch::setIncrementOffset()}.
+     */
+    public function __construct($getter, $options, $callback = null, $chunk_size = 25,
+            $inc_offset = true) {
 		
-		$this->getter = $getter;
-		$this->options = $options;
-		$this->callback = $callback;
-		$this->chunkSize = $chunk_size;
-		$this->setIncrementOffset($inc_offset);
-
-		if ($this->chunkSize <= 0) {
-			$this->chunkSize = 25;
-		}
-
-		// store these so we can compare later
-		$this->offset = elgg_extract('offset', $options, 0);
-		$this->limit = elgg_extract('limit', $options, _elgg_config()->default_limit);
-
-		// if passed a callback, create a new \ElggBatch with the same options
-		// and pass each to the callback.
-		if ($callback && is_callable($callback)) {
-			$batch = new \ElggBatch($getter, $options, null, $chunk_size, $inc_offset);
-
-			$all_results = null;
-
-			foreach ($batch as $result) {
-				$result = call_user_func($callback, $result, $getter, $options);
-
-				if (!isset($all_results)) {
-					if ($result === true || $result === false || $result === null) {
-						$all_results = $result;
-					} else {
-						$all_results = [];
-					}
-				}
-
-				if (($result === true || $result === false || $result === null) && !is_array($all_results)) {
-					$all_results = $result && $all_results;
-				} else {
-					$all_results[] = $result;
-				}
-			}
-
-			$this->callbackResult = $all_results;
-		}
-	}
-
-	/**
-	 * Tell the process that an entity was incomplete during a fetch
-	 *
-	 * @param \stdClass $row
-	 *
-	 * @access private
-	 */
-	public function reportIncompleteEntity(\stdClass $row) {
-		$this->incompleteEntities[] = $row;
-	}
-
-	/**
-	 * Fetches the next chunk of results
-	 *
-	 * @return bool
-	 */
-	private function getNextResultsChunk() {
-
-		// always reset results.
-		$this->results = [];
-
-		if (!isset($this->validGetter)) {
-			$this->validGetter = is_callable($this->getter);
-		}
-
-		if (!$this->validGetter) {
-			return false;
-		}
-
-		$limit = $this->chunkSize;
-
-		// if someone passed limit = 0 they want everything.
-		if ($this->limit != 0) {
-			if ($this->retrievedResults >= $this->limit) {
-				return false;
-			}
-
-			// if original limit < chunk size, set limit to original limit
-			// else if the number of results we'll fetch if greater than the original limit
-			if ($this->limit < $this->chunkSize) {
-				$limit = $this->limit;
-			} elseif ($this->retrievedResults + $this->chunkSize > $this->limit) {
-				// set the limit to the number of results remaining in the original limit
-				$limit = $this->limit - $this->retrievedResults;
-			}
-		}
-
-		if ($this->incrementOffset) {
-			$offset = $this->offset + $this->retrievedResults;
-		} else {
-			$offset = $this->offset + $this->totalIncompletes;
-		}
-
-		$current_options = [
-			'limit' => $limit,
-			'offset' => $offset,
-			'__ElggBatch' => $this,
-		];
-
-		$options = array_merge($this->options, $current_options);
-
-		$this->incompleteEntities = [];
-		$this->results = call_user_func($this->getter, $options);
-
-		// batch result sets tend to be large; we don't want to cache these.
-		_elgg_services()->db->disableQueryCache();
-
-		$num_results = count($this->results);
-		$num_incomplete = count($this->incompleteEntities);
-
-		$this->totalIncompletes += $num_incomplete;
-
-		if ($this->incompleteEntities) {
-			// pad the front of the results with nulls representing the incompletes
-			array_splice($this->results, 0, 0, array_pad([], $num_incomplete, null));
-			// ...and skip past them
-			reset($this->results);
-			for ($i = 0; $i < $num_incomplete; $i++) {
-				next($this->results);
-			}
-		}
-
-		if ($this->results) {
-			$this->chunkIndex++;
-
-			// let the system know we've jumped past the nulls
-			$this->resultIndex = $num_incomplete;
-
-			$this->retrievedResults += ($num_results + $num_incomplete);
-			if ($num_results == 0) {
-				// This fetch was *all* incompletes! We need to fetch until we can either
-				// offer at least one row to iterate over, or give up.
-				return $this->getNextResultsChunk();
-			}
-			_elgg_services()->db->enableQueryCache();
-			return true;
-		} else {
-			_elgg_services()->db->enableQueryCache();
-			return false;
-		}
-	}
-
-	/**
-	 * Increment the offset from the original options array? Setting to
-	 * false is required for callbacks that delete rows.
-	 *
-	 * @param bool $increment Set to false when deleting data
-	 * @return void
-	 */
-	public function setIncrementOffset($increment = true) {
-		$this->incrementOffset = (bool) $increment;
-	}
-
-	/**
-	 * Implements Iterator
-	 */
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function rewind() {
-		$this->resultIndex = 0;
-		$this->retrievedResults = 0;
-		$this->processedResults = 0;
-
-		// only grab results if we haven't yet or we're crossing chunks
-		if ($this->chunkIndex == 0 || $this->limit > $this->chunkSize) {
-			$this->chunkIndex = 0;
-			$this->getNextResultsChunk();
-		}
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function current() {
-		return current($this->results);
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function key() {
-		return $this->processedResults;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function next() {
-		// if we'll be at the end.
-		if (($this->processedResults + 1) >= $this->limit && $this->limit > 0) {
-			$this->results = [];
-			return false;
-		}
-
-		// if we'll need new results.
-		if (($this->resultIndex + 1) >= $this->chunkSize) {
-			if (!$this->getNextResultsChunk()) {
-				$this->results = [];
-				return false;
-			}
-
-			$result = current($this->results);
-		} else {
-			// the function above resets the indexes, so only inc if not
-			// getting new set
-			$this->resultIndex++;
-			$result = next($this->results);
-		}
-
-		$this->processedResults++;
-		return $result;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function valid() {
-		if (!is_array($this->results)) {
-			return false;
-		}
-		$key = key($this->results);
-		return ($key !== null && $key !== false);
-	}
-
-	/**
-	 * Count the total results available at this moment.
-	 *
-	 * As this performs a separate query, the count returned may not match the number of results you can
-	 * fetch via iteration on a very active DB.
-	 *
-	 * @see Countable::count()
-	 * @return int
-	 */
-	public function count() {
-		if (!is_callable($this->getter)) {
-			$inspector = new \Elgg\Debug\Inspector();
-			throw new RuntimeException("Getter is not callable: " . $inspector->describeCallable($this->getter));
-		}
-
-		$options = array_merge($this->options, ['count' => true]);
-
-		return call_user_func($this->getter, $options);
-	}
+        $this->getter = $getter;
+        $this->options = $options;
+        $this->callback = $callback;
+        $this->chunkSize = $chunk_size;
+        $this->setIncrementOffset($inc_offset);
+
+        if ($this->chunkSize <= 0) {
+            $this->chunkSize = 25;
+        }
+
+        // store these so we can compare later
+        $this->offset = elgg_extract('offset', $options, 0);
+        $this->limit = elgg_extract('limit', $options, _elgg_config()->default_limit);
+
+        // if passed a callback, create a new \ElggBatch with the same options
+        // and pass each to the callback.
+        if ($callback && is_callable($callback)) {
+            $batch = new \ElggBatch($getter, $options, null, $chunk_size, $inc_offset);
+
+            $all_results = null;
+
+            foreach ($batch as $result) {
+                $result = call_user_func($callback, $result, $getter, $options);
+
+                if (!isset($all_results)) {
+                    if ($result === true || $result === false || $result === null) {
+                        $all_results = $result;
+                    } else {
+                        $all_results = [];
+                    }
+                }
+
+                if (($result === true || $result === false || $result === null) && !is_array($all_results)) {
+                    $all_results = $result && $all_results;
+                } else {
+                    $all_results[] = $result;
+                }
+            }
+
+            $this->callbackResult = $all_results;
+        }
+    }
+
+    /**
+     * Tell the process that an entity was incomplete during a fetch
+     *
+     * @param \stdClass $row
+     *
+     * @access private
+     */
+    public function reportIncompleteEntity(\stdClass $row) {
+        $this->incompleteEntities[] = $row;
+    }
+
+    /**
+     * Fetches the next chunk of results
+     *
+     * @return bool
+     */
+    private function getNextResultsChunk() {
+
+        // always reset results.
+        $this->results = [];
+
+        if (!isset($this->validGetter)) {
+            $this->validGetter = is_callable($this->getter);
+        }
+
+        if (!$this->validGetter) {
+            return false;
+        }
+
+        $limit = $this->chunkSize;
+
+        // if someone passed limit = 0 they want everything.
+        if ($this->limit != 0) {
+            if ($this->retrievedResults >= $this->limit) {
+                return false;
+            }
+
+            // if original limit < chunk size, set limit to original limit
+            // else if the number of results we'll fetch if greater than the original limit
+            if ($this->limit < $this->chunkSize) {
+                $limit = $this->limit;
+            } elseif ($this->retrievedResults + $this->chunkSize > $this->limit) {
+                // set the limit to the number of results remaining in the original limit
+                $limit = $this->limit - $this->retrievedResults;
+            }
+        }
+
+        if ($this->incrementOffset) {
+            $offset = $this->offset + $this->retrievedResults;
+        } else {
+            $offset = $this->offset + $this->totalIncompletes;
+        }
+
+        $current_options = [
+            'limit' => $limit,
+            'offset' => $offset,
+            '__ElggBatch' => $this,
+        ];
+
+        $options = array_merge($this->options, $current_options);
+
+        $this->incompleteEntities = [];
+        $this->results = call_user_func($this->getter, $options);
+
+        // batch result sets tend to be large; we don't want to cache these.
+        _elgg_services()->db->disableQueryCache();
+
+        $num_results = count($this->results);
+        $num_incomplete = count($this->incompleteEntities);
+
+        $this->totalIncompletes += $num_incomplete;
+
+        if ($this->incompleteEntities) {
+            // pad the front of the results with nulls representing the incompletes
+            array_splice($this->results, 0, 0, array_pad([], $num_incomplete, null));
+            // ...and skip past them
+            reset($this->results);
+            for ($i = 0; $i < $num_incomplete; $i++) {
+                next($this->results);
+            }
+        }
+
+        if ($this->results) {
+            $this->chunkIndex++;
+
+            // let the system know we've jumped past the nulls
+            $this->resultIndex = $num_incomplete;
+
+            $this->retrievedResults += ($num_results + $num_incomplete);
+            if ($num_results == 0) {
+                // This fetch was *all* incompletes! We need to fetch until we can either
+                // offer at least one row to iterate over, or give up.
+                return $this->getNextResultsChunk();
+            }
+            _elgg_services()->db->enableQueryCache();
+            return true;
+        } else {
+            _elgg_services()->db->enableQueryCache();
+            return false;
+        }
+    }
+
+    /**
+     * Increment the offset from the original options array? Setting to
+     * false is required for callbacks that delete rows.
+     *
+     * @param bool $increment Set to false when deleting data
+     * @return void
+     */
+    public function setIncrementOffset($increment = true) {
+        $this->incrementOffset = (bool) $increment;
+    }
+
+    /**
+     * Implements Iterator
+     */
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rewind() {
+        $this->resultIndex = 0;
+        $this->retrievedResults = 0;
+        $this->processedResults = 0;
+
+        // only grab results if we haven't yet or we're crossing chunks
+        if ($this->chunkIndex == 0 || $this->limit > $this->chunkSize) {
+            $this->chunkIndex = 0;
+            $this->getNextResultsChunk();
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function current() {
+        return current($this->results);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function key() {
+        return $this->processedResults;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function next() {
+        // if we'll be at the end.
+        if (($this->processedResults + 1) >= $this->limit && $this->limit > 0) {
+            $this->results = [];
+            return false;
+        }
+
+        // if we'll need new results.
+        if (($this->resultIndex + 1) >= $this->chunkSize) {
+            if (!$this->getNextResultsChunk()) {
+                $this->results = [];
+                return false;
+            }
+
+            $result = current($this->results);
+        } else {
+            // the function above resets the indexes, so only inc if not
+            // getting new set
+            $this->resultIndex++;
+            $result = next($this->results);
+        }
+
+        $this->processedResults++;
+        return $result;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function valid() {
+        if (!is_array($this->results)) {
+            return false;
+        }
+        $key = key($this->results);
+        return ($key !== null && $key !== false);
+    }
+
+    /**
+     * Count the total results available at this moment.
+     *
+     * As this performs a separate query, the count returned may not match the number of results you can
+     * fetch via iteration on a very active DB.
+     *
+     * @see Countable::count()
+     * @return int
+     */
+    public function count() {
+        if (!is_callable($this->getter)) {
+            $inspector = new \Elgg\Debug\Inspector();
+            throw new RuntimeException("Getter is not callable: " . $inspector->describeCallable($this->getter));
+        }
+
+        $options = array_merge($this->options, ['count' => true]);
+
+        return call_user_func($this->getter, $options);
+    }
 }

engine/classes/ElggData.php

Doc Comments +1 added lines, -1 removed lines

@@ -285,7 +285,7 @@
 	 *
 	 * @param int $offset Offset
 	 *
-	 * @return int
+	 * @return boolean
 	 */
 	public function offsetExists($offset) {
 		return array_key_exists($offset, $this->attributes);

Indentation +206 added lines, -206 removed lines

@@ -7,220 +7,220 @@
  * @subpackage DataModel
  */
 abstract class ElggData implements
-	Loggable,    // Can events related to this object class be logged
-	Iterator,    // Override foreach behaviour
-	\ArrayAccess // Override for array access
+    Loggable,    // Can events related to this object class be logged
+    Iterator,    // Override foreach behaviour
+    \ArrayAccess // Override for array access
 {
 
-	use \Elgg\TimeUsing;
+    use \Elgg\TimeUsing;
 	
-	/**
-	 * The main attributes of an entity.
-	 * Holds attributes to save to database
-	 * Blank entries for all database fields should be created by the constructor.
-	 * Subclasses should add to this in their constructors.
-	 * Any field not appearing in this will be viewed as metadata
-	 */
-	protected $attributes = [];
-
-	/**
-	 * Initialize the attributes array.
-	 *
-	 * This is vital to distinguish between metadata and base parameters.
-	 *
-	 * @return void
-	 */
-	protected function initializeAttributes() {
-		// Create attributes array if not already created
-		if (!is_array($this->attributes)) {
-			$this->attributes = [];
-		}
-
-		$this->attributes['time_created'] = null;
-	}
-
-	/**
-	 * Provides a pointer to the database object.
-	 *
-	 * @return \Elgg\Database The database where this data is (will be) stored.
-	 */
-	protected function getDatabase() {
-		return _elgg_services()->db;
-	}
-
-	/**
-	 * Test if property is set either as an attribute or metadata.
-	 *
-	 * @tip Use isset($entity->property)
-	 *
-	 * @param string $name The name of the attribute or metadata.
-	 *
-	 * @return bool
-	 */
-	public function __isset($name) {
-		return $this->$name !== null;
-	}
-
-	/**
-	 * Get a URL for this object
-	 *
-	 * @return string
-	 */
-	abstract public function getURL();
-
-	/**
-	 * Save this data to the appropriate database table.
-	 *
-	 * @return bool
-	 */
-	abstract public function save();
+    /**
+     * The main attributes of an entity.
+     * Holds attributes to save to database
+     * Blank entries for all database fields should be created by the constructor.
+     * Subclasses should add to this in their constructors.
+     * Any field not appearing in this will be viewed as metadata
+     */
+    protected $attributes = [];
+
+    /**
+     * Initialize the attributes array.
+     *
+     * This is vital to distinguish between metadata and base parameters.
+     *
+     * @return void
+     */
+    protected function initializeAttributes() {
+        // Create attributes array if not already created
+        if (!is_array($this->attributes)) {
+            $this->attributes = [];
+        }
+
+        $this->attributes['time_created'] = null;
+    }
+
+    /**
+     * Provides a pointer to the database object.
+     *
+     * @return \Elgg\Database The database where this data is (will be) stored.
+     */
+    protected function getDatabase() {
+        return _elgg_services()->db;
+    }
+
+    /**
+     * Test if property is set either as an attribute or metadata.
+     *
+     * @tip Use isset($entity->property)
+     *
+     * @param string $name The name of the attribute or metadata.
+     *
+     * @return bool
+     */
+    public function __isset($name) {
+        return $this->$name !== null;
+    }
+
+    /**
+     * Get a URL for this object
+     *
+     * @return string
+     */
+    abstract public function getURL();
+
+    /**
+     * Save this data to the appropriate database table.
+     *
+     * @return bool
+     */
+    abstract public function save();
 	
-	/**
-	 * Delete this data.
-	 *
-	 * @return bool
-	 */
-	abstract public function delete();
-
-	/**
-	 * Returns the UNIX epoch time that this entity was created
-	 *
-	 * @return int UNIX epoch time
-	 */
-	public function getTimeCreated() {
-		return $this->time_created;
-	}
-
-	/**
-	 * Get a plain old object copy for public consumption
-	 *
-	 * @return \stdClass
-	 */
-	abstract public function toObject();
-
-	/*
+    /**
+     * Delete this data.
+     *
+     * @return bool
+     */
+    abstract public function delete();
+
+    /**
+     * Returns the UNIX epoch time that this entity was created
+     *
+     * @return int UNIX epoch time
+     */
+    public function getTimeCreated() {
+        return $this->time_created;
+    }
+
+    /**
+     * Get a plain old object copy for public consumption
+     *
+     * @return \stdClass
+     */
+    abstract public function toObject();
+
+    /*
 	 * ITERATOR INTERFACE
 	 */
 
-	protected $valid = false;
-
-	/**
-	 * Iterator interface
-	 *
-	 * @see Iterator::rewind()
-	 *
-	 * @return void
-	 */
-	public function rewind() {
-		$this->valid = (false !== reset($this->attributes));
-	}
-
-	/**
-	 * Iterator interface
-	 *
-	 * @see Iterator::current()
-	 *
-	 * @return mixed
-	 */
-	public function current() {
-		return current($this->attributes);
-	}
-
-	/**
-	 * Iterator interface
-	 *
-	 * @see Iterator::key()
-	 *
-	 * @return string
-	 */
-	public function key() {
-		return key($this->attributes);
-	}
-
-	/**
-	 * Iterator interface
-	 *
-	 * @see Iterator::next()
-	 *
-	 * @return void
-	 */
-	public function next() {
-		$this->valid = (false !== next($this->attributes));
-	}
-
-	/**
-	 * Iterator interface
-	 *
-	 * @see Iterator::valid()
-	 *
-	 * @return bool
-	 */
-	public function valid() {
-		return $this->valid;
-	}
-
-	/*
+    protected $valid = false;
+
+    /**
+     * Iterator interface
+     *
+     * @see Iterator::rewind()
+     *
+     * @return void
+     */
+    public function rewind() {
+        $this->valid = (false !== reset($this->attributes));
+    }
+
+    /**
+     * Iterator interface
+     *
+     * @see Iterator::current()
+     *
+     * @return mixed
+     */
+    public function current() {
+        return current($this->attributes);
+    }
+
+    /**
+     * Iterator interface
+     *
+     * @see Iterator::key()
+     *
+     * @return string
+     */
+    public function key() {
+        return key($this->attributes);
+    }
+
+    /**
+     * Iterator interface
+     *
+     * @see Iterator::next()
+     *
+     * @return void
+     */
+    public function next() {
+        $this->valid = (false !== next($this->attributes));
+    }
+
+    /**
+     * Iterator interface
+     *
+     * @see Iterator::valid()
+     *
+     * @return bool
+     */
+    public function valid() {
+        return $this->valid;
+    }
+
+    /*
 	 * ARRAY ACCESS INTERFACE
 	 */
 
-	/**
-	 * Array access interface
-	 *
-	 * @see \ArrayAccess::offsetSet()
-	 *
-	 * @param mixed $key   Name
-	 * @param mixed $value Value
-	 *
-	 * @return void
-	 */
-	public function offsetSet($key, $value) {
-		if (array_key_exists($key, $this->attributes)) {
-			$this->attributes[$key] = $value;
-		}
-	}
-
-	/**
-	 * Array access interface
-	 *
-	 * @see \ArrayAccess::offsetGet()
-	 *
-	 * @param mixed $key Name
-	 *
-	 * @return mixed
-	 */
-	public function offsetGet($key) {
-		if (array_key_exists($key, $this->attributes)) {
-			return $this->attributes[$key];
-		}
-		return null;
-	}
-
-	/**
-	 * Array access interface
-	 *
-	 * @see \ArrayAccess::offsetUnset()
-	 *
-	 * @param mixed $key Name
-	 *
-	 * @return void
-	 */
-	public function offsetUnset($key) {
-		if (array_key_exists($key, $this->attributes)) {
-			// Full unsetting is dangerous for our objects
-			$this->attributes[$key] = "";
-		}
-	}
-
-	/**
-	 * Array access interface
-	 *
-	 * @see \ArrayAccess::offsetExists()
-	 *
-	 * @param int $offset Offset
-	 *
-	 * @return int
-	 */
-	public function offsetExists($offset) {
-		return array_key_exists($offset, $this->attributes);
-	}
+    /**
+     * Array access interface
+     *
+     * @see \ArrayAccess::offsetSet()
+     *
+     * @param mixed $key   Name
+     * @param mixed $value Value
+     *
+     * @return void
+     */
+    public function offsetSet($key, $value) {
+        if (array_key_exists($key, $this->attributes)) {
+            $this->attributes[$key] = $value;
+        }
+    }
+
+    /**
+     * Array access interface
+     *
+     * @see \ArrayAccess::offsetGet()
+     *
+     * @param mixed $key Name
+     *
+     * @return mixed
+     */
+    public function offsetGet($key) {
+        if (array_key_exists($key, $this->attributes)) {
+            return $this->attributes[$key];
+        }
+        return null;
+    }
+
+    /**
+     * Array access interface
+     *
+     * @see \ArrayAccess::offsetUnset()
+     *
+     * @param mixed $key Name
+     *
+     * @return void
+     */
+    public function offsetUnset($key) {
+        if (array_key_exists($key, $this->attributes)) {
+            // Full unsetting is dangerous for our objects
+            $this->attributes[$key] = "";
+        }
+    }
+
+    /**
+     * Array access interface
+     *
+     * @see \ArrayAccess::offsetExists()
+     *
+     * @param int $offset Offset
+     *
+     * @return int
+     */
+    public function offsetExists($offset) {
+        return array_key_exists($offset, $this->attributes);
+    }
 }

Spacing +2 added lines, -2 removed lines

@@ -7,8 +7,8 @@
  * @subpackage DataModel
  */
 abstract class ElggData implements
-	Loggable,    // Can events related to this object class be logged
-	Iterator,    // Override foreach behaviour
+	Loggable, // Can events related to this object class be logged
+	Iterator, // Override foreach behaviour
 	\ArrayAccess // Override for array access
 {
 

engine/classes/ElggPluginManifest.php

Doc Comments +2 added lines, -2 removed lines

@@ -142,7 +142,7 @@ 
 	/**
 	 * Load a manifest file, XmlElement or path to manifest.xml file
 	 *
-	 * @param mixed  $manifest  A string, XmlElement, or path of a manifest file.
+	 * @param string  $manifest  A string, XmlElement, or path of a manifest file.
 	 * @param string $plugin_id Optional ID of the owning plugin. Used to
 	 *                          fill in some values automatically.
 	 *
@@ -687,7 +687,7 @@ 
 	/**
 	 * Should this plugin be activated when Elgg is installed
 	 *
-	 *  @return bool
+	 *  @return boolean|null
 	 */
 	public function getActivateOnInstall() {
 		$activate = $this->parser->getAttribute('activate_on_install');

Spacing +1 added lines, -1 removed lines

@@ -187,7 +187,7 @@
 
 		$this->apiVersion = $version;
 
-		$parser_class_name = '\ElggPluginManifestParser' . str_replace('.', '', $this->apiVersion);
+		$parser_class_name = '\ElggPluginManifestParser'.str_replace('.', '', $this->apiVersion);
 
 		// @todo currently the autoloader freaks out if a class doesn't exist.
 		try {

Indentation +702 added lines, -702 removed lines

@@ -17,712 +17,712 @@
  */
 class ElggPluginManifest {
 
-	/**
-	 * The parser object
-	 *
-	 * @var \ElggPluginManifestParser18
-	 */
-	protected $parser;
-
-	/**
-	 * The root for plugin manifest namespaces.
-	 * This is in the format http://www.elgg.org/plugin_manifest/<version>
-	 */
-	protected $namespace_root = 'http://www.elgg.org/plugin_manifest/';
-
-	/**
-	 * The expected structure of a plugins requires element
-	 */
-	private $depsStructPlugin = [
-		'type' => '',
-		'name' => '',
-		'version' => '',
-		'comparison' => 'ge'
-	];
-
-	/**
-	 * The expected structure of a priority element
-	 */
-	private $depsStructPriority = [
-		'type' => '',
-		'priority' => '',
-		'plugin' => ''
-	];
-
-	/*
+    /**
+     * The parser object
+     *
+     * @var \ElggPluginManifestParser18
+     */
+    protected $parser;
+
+    /**
+     * The root for plugin manifest namespaces.
+     * This is in the format http://www.elgg.org/plugin_manifest/<version>
+     */
+    protected $namespace_root = 'http://www.elgg.org/plugin_manifest/';
+
+    /**
+     * The expected structure of a plugins requires element
+     */
+    private $depsStructPlugin = [
+        'type' => '',
+        'name' => '',
+        'version' => '',
+        'comparison' => 'ge'
+    ];
+
+    /**
+     * The expected structure of a priority element
+     */
+    private $depsStructPriority = [
+        'type' => '',
+        'priority' => '',
+        'plugin' => ''
+    ];
+
+    /*
 	 * The expected structure of elgg_release requires element
 	 */
-	private $depsStructElgg = [
-		'type' => '',
-		'version' => '',
-		'comparison' => 'ge'
-	];
-
-	/**
-	 * The expected structure of a requires php_version dependency element
-	 */
-	private $depsStructPhpVersion = [
-		'type' => '',
-		'version' => '',
-		'comparison' => 'ge'
-	];
-
-	/**
-	 * The expected structure of a requires php_ini dependency element
-	 */
-	private $depsStructPhpIni = [
-		'type' => '',
-		'name' => '',
-		'value' => '',
-		'comparison' => '='
-	];
-
-	/**
-	 * The expected structure of a requires php_extension dependency element
-	 */
-	private $depsStructPhpExtension = [
-		'type' => '',
-		'name' => '',
-		'version' => '',
-		'comparison' => '='
-	];
-
-	/**
-	 * The expected structure of a conflicts depedency element
-	 */
-	private $depsConflictsStruct = [
-		'type' => '',
-		'name' => '',
-		'version' => '',
-		'comparison' => '='
-	];
-
-	/**
-	 * The expected structure of a provides dependency element.
-	 */
-	private $depsProvidesStruct = [
-		'type' => '',
-		'name' => '',
-		'version' => ''
-	];
-
-	/**
-	 * The expected structure of a screenshot element
-	 */
-	private $screenshotStruct = [
-		'description' => '',
-		'path' => ''
-	];
-
-	/**
-	 * The expected structure of a contributor element
-	 */
-	private $contributorStruct = [
-		'name' => '',
-		'email' => '',
-		'website' => '',
-		'username' => '',
-		'description' => '',
-	];
-
-	/**
-	 * The API version of the manifest.
-	 *
-	 * @var int
-	 */
-	protected $apiVersion;
-
-	/**
-	 * The optional plugin id this manifest belongs to.
-	 *
-	 * @var string
-	 */
-	protected $pluginID;
-
-	/**
-	 * Load a manifest file, XmlElement or path to manifest.xml file
-	 *
-	 * @param mixed  $manifest  A string, XmlElement, or path of a manifest file.
-	 * @param string $plugin_id Optional ID of the owning plugin. Used to
-	 *                          fill in some values automatically.
-	 *
-	 * @throws PluginException
-	 */
-	public function __construct($manifest, $plugin_id = null) {
-		if ($plugin_id) {
-			$this->pluginID = $plugin_id;
-		}
-
-		// see if we need to construct the xml object.
-		if ($manifest instanceof \ElggXMLElement) {
-			$manifest_obj = $manifest;
-		} else {
-			$raw_xml = '';
-			if (substr(trim($manifest), 0, 1) == '<') {
-				// this is a string
-				$raw_xml = $manifest;
-			} elseif (is_file($manifest)) {
-				// this is a file
-				$raw_xml = file_get_contents($manifest);
-			}
-			if ($raw_xml) {
-				$manifest_obj = new \ElggXMLElement($raw_xml);
-			} else {
-				$manifest_obj = null;
-			}
-		}
-
-		if (!$manifest_obj) {
-			throw new \PluginException(_elgg_services()->translator->translate('PluginException:InvalidManifest',
-						[$this->getPluginID()]));
-		}
-
-		// set manifest api version
-		if (isset($manifest_obj->attributes['xmlns'])) {
-			$namespace = $manifest_obj->attributes['xmlns'];
-			$version = str_replace($this->namespace_root, '', $namespace);
-		} else {
-			$version = 1.7;
-		}
-
-		$this->apiVersion = $version;
-
-		$parser_class_name = '\ElggPluginManifestParser' . str_replace('.', '', $this->apiVersion);
-
-		// @todo currently the autoloader freaks out if a class doesn't exist.
-		try {
-			$class_exists = class_exists($parser_class_name);
-		} catch (Exception $e) {
-			$class_exists = false;
-		}
-
-		if ($class_exists) {
-			$this->parser = new $parser_class_name($manifest_obj, $this);
-		} else {
-			throw new \PluginException(_elgg_services()->translator->translate('PluginException:NoAvailableParser',
-							[$this->apiVersion, $this->getPluginID()]));
-		}
-
-		if (!$this->parser->parse()) {
-			throw new \PluginException(_elgg_services()->translator->translate('PluginException:ParserError',
-						[$this->apiVersion, $this->getPluginID()]));
-		}
-	}
-
-	/**
-	 * Returns the API version in use.
-	 *
-	 * @return int
-	 */
-	public function getApiVersion() {
-		return $this->apiVersion;
-	}
-
-	/**
-	 * Returns the plugin ID.
-	 *
-	 * @return string
-	 */
-	public function getPluginID() {
-		if ($this->pluginID) {
-			return $this->pluginID;
-		} else {
-			return _elgg_services()->translator->translate('unknown');
-		}
-	}
-
-	/**
-	 * Returns the manifest array.
-	 *
-	 * Used for backward compatibility.  Specific
-	 * methods should be called instead.
-	 *
-	 * @return array
-	 */
-	public function getManifest() {
-		return $this->parser->getManifest();
-	}
-
-	/***************************************
+    private $depsStructElgg = [
+        'type' => '',
+        'version' => '',
+        'comparison' => 'ge'
+    ];
+
+    /**
+     * The expected structure of a requires php_version dependency element
+     */
+    private $depsStructPhpVersion = [
+        'type' => '',
+        'version' => '',
+        'comparison' => 'ge'
+    ];
+
+    /**
+     * The expected structure of a requires php_ini dependency element
+     */
+    private $depsStructPhpIni = [
+        'type' => '',
+        'name' => '',
+        'value' => '',
+        'comparison' => '='
+    ];
+
+    /**
+     * The expected structure of a requires php_extension dependency element
+     */
+    private $depsStructPhpExtension = [
+        'type' => '',
+        'name' => '',
+        'version' => '',
+        'comparison' => '='
+    ];
+
+    /**
+     * The expected structure of a conflicts depedency element
+     */
+    private $depsConflictsStruct = [
+        'type' => '',
+        'name' => '',
+        'version' => '',
+        'comparison' => '='
+    ];
+
+    /**
+     * The expected structure of a provides dependency element.
+     */
+    private $depsProvidesStruct = [
+        'type' => '',
+        'name' => '',
+        'version' => ''
+    ];
+
+    /**
+     * The expected structure of a screenshot element
+     */
+    private $screenshotStruct = [
+        'description' => '',
+        'path' => ''
+    ];
+
+    /**
+     * The expected structure of a contributor element
+     */
+    private $contributorStruct = [
+        'name' => '',
+        'email' => '',
+        'website' => '',
+        'username' => '',
+        'description' => '',
+    ];
+
+    /**
+     * The API version of the manifest.
+     *
+     * @var int
+     */
+    protected $apiVersion;
+
+    /**
+     * The optional plugin id this manifest belongs to.
+     *
+     * @var string
+     */
+    protected $pluginID;
+
+    /**
+     * Load a manifest file, XmlElement or path to manifest.xml file
+     *
+     * @param mixed  $manifest  A string, XmlElement, or path of a manifest file.
+     * @param string $plugin_id Optional ID of the owning plugin. Used to
+     *                          fill in some values automatically.
+     *
+     * @throws PluginException
+     */
+    public function __construct($manifest, $plugin_id = null) {
+        if ($plugin_id) {
+            $this->pluginID = $plugin_id;
+        }
+
+        // see if we need to construct the xml object.
+        if ($manifest instanceof \ElggXMLElement) {
+            $manifest_obj = $manifest;
+        } else {
+            $raw_xml = '';
+            if (substr(trim($manifest), 0, 1) == '<') {
+                // this is a string
+                $raw_xml = $manifest;
+            } elseif (is_file($manifest)) {
+                // this is a file
+                $raw_xml = file_get_contents($manifest);
+            }
+            if ($raw_xml) {
+                $manifest_obj = new \ElggXMLElement($raw_xml);
+            } else {
+                $manifest_obj = null;
+            }
+        }
+
+        if (!$manifest_obj) {
+            throw new \PluginException(_elgg_services()->translator->translate('PluginException:InvalidManifest',
+                        [$this->getPluginID()]));
+        }
+
+        // set manifest api version
+        if (isset($manifest_obj->attributes['xmlns'])) {
+            $namespace = $manifest_obj->attributes['xmlns'];
+            $version = str_replace($this->namespace_root, '', $namespace);
+        } else {
+            $version = 1.7;
+        }
+
+        $this->apiVersion = $version;
+
+        $parser_class_name = '\ElggPluginManifestParser' . str_replace('.', '', $this->apiVersion);
+
+        // @todo currently the autoloader freaks out if a class doesn't exist.
+        try {
+            $class_exists = class_exists($parser_class_name);
+        } catch (Exception $e) {
+            $class_exists = false;
+        }
+
+        if ($class_exists) {
+            $this->parser = new $parser_class_name($manifest_obj, $this);
+        } else {
+            throw new \PluginException(_elgg_services()->translator->translate('PluginException:NoAvailableParser',
+                            [$this->apiVersion, $this->getPluginID()]));
+        }
+
+        if (!$this->parser->parse()) {
+            throw new \PluginException(_elgg_services()->translator->translate('PluginException:ParserError',
+                        [$this->apiVersion, $this->getPluginID()]));
+        }
+    }
+
+    /**
+     * Returns the API version in use.
+     *
+     * @return int
+     */
+    public function getApiVersion() {
+        return $this->apiVersion;
+    }
+
+    /**
+     * Returns the plugin ID.
+     *
+     * @return string
+     */
+    public function getPluginID() {
+        if ($this->pluginID) {
+            return $this->pluginID;
+        } else {
+            return _elgg_services()->translator->translate('unknown');
+        }
+    }
+
+    /**
+     * Returns the manifest array.
+     *
+     * Used for backward compatibility.  Specific
+     * methods should be called instead.
+     *
+     * @return array
+     */
+    public function getManifest() {
+        return $this->parser->getManifest();
+    }
+
+    /***************************************
 	 * Parsed and Normalized Manifest Data *
 	 ***************************************/
 
-	/**
-	 * Returns the plugin name
-	 *
-	 * @return string
-	 */
-	public function getName() {
-		$name = $this->parser->getAttribute('name');
-
-		if (!$name && $this->pluginID) {
-			$name = ucwords(str_replace('_', ' ', $this->pluginID));
-		}
-
-		return $name;
-	}
-
-	/**
-	 * Return the plugin ID required by the author. If getPluginID() does
-	 * not match this, the plugin should not be started.
-	 *
-	 * @return string empty string if not empty/not defined
-	 */
-	public function getID() {
-		return trim((string) $this->parser->getAttribute('id'));
-	}
-
-
-	/**
-	 * Return the description
-	 *
-	 * @return string
-	 */
-	public function getDescription() {
-		return $this->parser->getAttribute('description');
-	}
-
-	/**
-	 * Return the short description
-	 *
-	 * @return string
-	 */
-	public function getBlurb() {
-		$blurb = $this->parser->getAttribute('blurb');
-
-		if (!$blurb) {
-			$blurb = elgg_get_excerpt($this->getDescription());
-		}
-
-		return $blurb;
-	}
-
-	/**
-	 * Returns the license
-	 *
-	 * @return string
-	 */
-	public function getLicense() {
-		// license vs licence.  Use license.
-		$en_us = $this->parser->getAttribute('license');
-		if ($en_us) {
-			return $en_us;
-		} else {
-			return $this->parser->getAttribute('licence');
-		}
-	}
-
-	/**
-	 * Returns the repository url
-	 *
-	 * @return string
-	 */
-	public function getRepositoryURL() {
-		return $this->parser->getAttribute('repository');
-	}
-
-	/**
-	 * Returns the bug tracker page
-	 *
-	 * @return string
-	 */
-	public function getBugTrackerURL() {
-		return $this->parser->getAttribute('bugtracker');
-	}
-
-	/**
-	 * Returns the donations page
-	 *
-	 * @return string
-	 */
-	public function getDonationsPageURL() {
-		return $this->parser->getAttribute('donations');
-	}
-
-	/**
-	 * Returns the version of the plugin.
-	 *
-	 * @return float
-	 */
-	public function getVersion() {
-		return $this->parser->getAttribute('version');
-	}
-
-	/**
-	 * Returns the plugin author.
-	 *
-	 * @return string
-	 */
-	public function getAuthor() {
-		return $this->parser->getAttribute('author');
-	}
-
-	/**
-	 * Return the copyright
-	 *
-	 * @return string
-	 */
-	public function getCopyright() {
-		return $this->parser->getAttribute('copyright');
-	}
-
-	/**
-	 * Return the website
-	 *
-	 * @return string
-	 */
-	public function getWebsite() {
-		return $this->parser->getAttribute('website');
-	}
-
-	/**
-	 * Return the categories listed for this plugin
-	 *
-	 * @return array
-	 */
-	public function getCategories() {
-		$bundled_plugins = [
-			'activity',
-			'blog',
-			'bookmarks',
-			'ckeditor',
-			'custom_index',
-			'dashboard',
-			'developers',
-			'diagnostics',
-			'discussions',
-			'embed',
-			'externalpages',
-			'file',
-			'friends',
-			'friends_collections',
-			'garbagecollector',
-			'groups',
-			'invitefriends',
-			'legacy_urls',
-			'likes',
-			'logbrowser',
-			'login_as',
-			'logrotate',
-			'members',
-			'messageboard',
-			'messages',
-			'notifications',
-			'pages',
-			'profile',
-			'reportedcontent',
-			'search',
-			'site_notifications',
-			'tagcloud',
-			'thewire',
-			'uservalidationbyemail',
-			'web_services',
-		];
-
-		$cats = $this->parser->getAttribute('category');
-
-		if (!$cats) {
-			$cats = [];
-		}
-
-		if (in_array('bundled', $cats) && !in_array($this->getPluginID(), $bundled_plugins)) {
-			unset($cats[array_search('bundled', $cats)]);
-		}
-
-		return $cats;
-	}
-
-	/**
-	 * Return the screenshots listed.
-	 *
-	 * @return array
-	 */
-	public function getScreenshots() {
-		$ss = $this->parser->getAttribute('screenshot');
-
-		if (!$ss) {
-			$ss = [];
-		}
-
-		$normalized = [];
-		foreach ($ss as $s) {
-			$normalized[] = $this->buildStruct($this->screenshotStruct, $s);
-		}
-
-		return $normalized;
-	}
-
-	/**
-	 * Return the contributors listed.
-	 *
-	 * @return array
-	 */
-	public function getContributors() {
-		$ss = $this->parser->getAttribute('contributor');
-
-		if (!$ss) {
-			$ss = [];
-		}
-
-		$normalized = [];
-		foreach ($ss as $s) {
-			$normalized[] = $this->buildStruct($this->contributorStruct, $s);
-		}
-
-		return $normalized;
-	}
-
-	/**
-	 * Return the list of provides by this plugin.
-	 *
-	 * @return array
-	 */
-	public function getProvides() {
-		// normalize for 1.7
-		if ($this->getApiVersion() < 1.8) {
-			$provides = [];
-		} else {
-			$provides = $this->parser->getAttribute('provides');
-		}
-
-		if (!$provides) {
-			$provides = [];
-		}
-
-		// always provide ourself if we can
-		if ($this->pluginID) {
-			$provides[] = [
-				'type' => 'plugin',
-				'name' => $this->getPluginID(),
-				'version' => $this->getVersion()
-			];
-		}
-
-		$normalized = [];
-		foreach ($provides as $provide) {
-			$normalized[] = $this->buildStruct($this->depsProvidesStruct, $provide);
-		}
-
-		return $normalized;
-	}
-
-	/**
-	 * Returns the dependencies listed.
-	 *
-	 * @return array
-	 */
-	public function getRequires() {
-		$reqs = $this->parser->getAttribute('requires');
-
-		if (!$reqs) {
-			$reqs = [];
-		}
-
-		$normalized = [];
-		foreach ($reqs as $req) {
-			$normalized[] = $this->normalizeDep($req);
-		}
-
-		return $normalized;
-	}
-
-	/**
-	 * Returns the suggests elements.
-	 *
-	 * @return array
-	 */
-	public function getSuggests() {
-		$suggests = $this->parser->getAttribute('suggests');
-
-		if (!$suggests) {
-			$suggests = [];
-		}
-
-		$normalized = [];
-		foreach ($suggests as $suggest) {
-			$normalized[] = $this->normalizeDep($suggest);
-		}
-
-		return $normalized;
-	}
-
-	/**
-	 * Normalizes a dependency array using the defined structs.
-	 * Can be used with either requires or suggests.
-	 *
-	 * @param array $dep A dependency array.
-	 * @return array The normalized deps array.
-	 */
-	private function normalizeDep($dep) {
-		switch ($dep['type']) {
-			case 'elgg_release':
-				$struct = $this->depsStructElgg;
-				break;
-
-			case 'plugin':
-				$struct = $this->depsStructPlugin;
-				break;
-
-			case 'priority':
-				$struct = $this->depsStructPriority;
-				break;
-
-			case 'php_version':
-				$struct = $this->depsStructPhpVersion;
-				break;
-
-			case 'php_extension':
-				$struct = $this->depsStructPhpExtension;
-				break;
-
-			case 'php_ini':
-				$struct = $this->depsStructPhpIni;
-
-				// also normalize boolean values
-				if (isset($dep['value'])) {
-					switch (strtolower($dep['value'])) {
-						case 'yes':
-						case 'true':
-						case 'on':
-						case 1:
-							$dep['value'] = 1;
-							break;
-
-						case 'no':
-						case 'false':
-						case 'off':
-						case 0:
-						case '':
-							$dep['value'] = 0;
-							break;
-					}
-				}
-				break;
-			default:
-				// unrecognized so we just return the raw dependency
-				return $dep;
-		}
-
-		// @todo $struct may not have been defined...
-		$normalized_dep = $this->buildStruct($struct, $dep);
-
-		// normalize comparison operators
-		if (isset($normalized_dep['comparison'])) {
-			switch ($normalized_dep['comparison']) {
-				case '<':
-					$normalized_dep['comparison'] = 'lt';
-					break;
-
-				case '<=':
-					$normalized_dep['comparison'] = 'le';
-					break;
-
-				case '>':
-					$normalized_dep['comparison'] = 'gt';
-					break;
-
-				case '>=':
-					$normalized_dep['comparison'] = 'ge';
-					break;
-
-				case '==':
-				case 'eq':
-					$normalized_dep['comparison'] = '=';
-					break;
-
-				case '<>':
-				case 'ne':
-					$normalized_dep['comparison'] = '!=';
-					break;
-			}
-		}
-
-		return $normalized_dep;
-	}
-
-	/**
-	 * Returns the conflicts listed
-	 *
-	 * @return array
-	 */
-	public function getConflicts() {
-		// normalize for 1.7
-		if ($this->getApiVersion() < 1.8) {
-			$conflicts = [];
-		} else {
-			$conflicts = $this->parser->getAttribute('conflicts');
-		}
-
-		if (!$conflicts) {
-			$conflicts = [];
-		}
-
-		$normalized = [];
-
-		foreach ($conflicts as $conflict) {
-			$normalized[] = $this->buildStruct($this->depsConflictsStruct, $conflict);
-		}
-
-		return $normalized;
-	}
-
-	/**
-	 * Should this plugin be activated when Elgg is installed
-	 *
-	 *  @return bool
-	 */
-	public function getActivateOnInstall() {
-		$activate = $this->parser->getAttribute('activate_on_install');
-		switch (strtolower($activate)) {
-			case 'yes':
-			case 'true':
-			case 'on':
-			case 1:
-				return true;
-
-			case 'no':
-			case 'false':
-			case 'off':
-			case 0:
-			case '':
-				return false;
-		}
-	}
-
-	/**
-	 * Normalizes an array into the structure specified
-	 *
-	 * @param array $struct The struct to normalize $element to.
-	 * @param array $array  The array
-	 *
-	 * @return array
-	 */
-	protected function buildStruct(array $struct, array $array) {
-		$return = [];
-
-		foreach ($struct as $index => $default) {
-			$return[$index] = elgg_extract($index, $array, $default);
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Returns a category's friendly name. This can be localized by
-	 * defining the string 'admin:plugins:category:<category>'. If no
-	 * localization is found, returns the category with _ and - converted to ' '
-	 * and then ucwords()'d.
-	 *
-	 * @param string $category The category as defined in the manifest.
-	 * @return string A human-readable category
-	 */
-	static public function getFriendlyCategory($category) {
-		$cat_raw_string = "admin:plugins:category:$category";
-		if (_elgg_services()->translator->languageKeyExists($cat_raw_string)) {
-			return _elgg_services()->translator->translate($cat_raw_string);
-		}
+    /**
+     * Returns the plugin name
+     *
+     * @return string
+     */
+    public function getName() {
+        $name = $this->parser->getAttribute('name');
+
+        if (!$name && $this->pluginID) {
+            $name = ucwords(str_replace('_', ' ', $this->pluginID));
+        }
+
+        return $name;
+    }
+
+    /**
+     * Return the plugin ID required by the author. If getPluginID() does
+     * not match this, the plugin should not be started.
+     *
+     * @return string empty string if not empty/not defined
+     */
+    public function getID() {
+        return trim((string) $this->parser->getAttribute('id'));
+    }
+
+
+    /**
+     * Return the description
+     *
+     * @return string
+     */
+    public function getDescription() {
+        return $this->parser->getAttribute('description');
+    }
+
+    /**
+     * Return the short description
+     *
+     * @return string
+     */
+    public function getBlurb() {
+        $blurb = $this->parser->getAttribute('blurb');
+
+        if (!$blurb) {
+            $blurb = elgg_get_excerpt($this->getDescription());
+        }
+
+        return $blurb;
+    }
+
+    /**
+     * Returns the license
+     *
+     * @return string
+     */
+    public function getLicense() {
+        // license vs licence.  Use license.
+        $en_us = $this->parser->getAttribute('license');
+        if ($en_us) {
+            return $en_us;
+        } else {
+            return $this->parser->getAttribute('licence');
+        }
+    }
+
+    /**
+     * Returns the repository url
+     *
+     * @return string
+     */
+    public function getRepositoryURL() {
+        return $this->parser->getAttribute('repository');
+    }
+
+    /**
+     * Returns the bug tracker page
+     *
+     * @return string
+     */
+    public function getBugTrackerURL() {
+        return $this->parser->getAttribute('bugtracker');
+    }
+
+    /**
+     * Returns the donations page
+     *
+     * @return string
+     */
+    public function getDonationsPageURL() {
+        return $this->parser->getAttribute('donations');
+    }
+
+    /**
+     * Returns the version of the plugin.
+     *
+     * @return float
+     */
+    public function getVersion() {
+        return $this->parser->getAttribute('version');
+    }
+
+    /**
+     * Returns the plugin author.
+     *
+     * @return string
+     */
+    public function getAuthor() {
+        return $this->parser->getAttribute('author');
+    }
+
+    /**
+     * Return the copyright
+     *
+     * @return string
+     */
+    public function getCopyright() {
+        return $this->parser->getAttribute('copyright');
+    }
+
+    /**
+     * Return the website
+     *
+     * @return string
+     */
+    public function getWebsite() {
+        return $this->parser->getAttribute('website');
+    }
+
+    /**
+     * Return the categories listed for this plugin
+     *
+     * @return array
+     */
+    public function getCategories() {
+        $bundled_plugins = [
+            'activity',
+            'blog',
+            'bookmarks',
+            'ckeditor',
+            'custom_index',
+            'dashboard',
+            'developers',
+            'diagnostics',
+            'discussions',
+            'embed',
+            'externalpages',
+            'file',
+            'friends',
+            'friends_collections',
+            'garbagecollector',
+            'groups',
+            'invitefriends',
+            'legacy_urls',
+            'likes',
+            'logbrowser',
+            'login_as',
+            'logrotate',
+            'members',
+            'messageboard',
+            'messages',
+            'notifications',
+            'pages',
+            'profile',
+            'reportedcontent',
+            'search',
+            'site_notifications',
+            'tagcloud',
+            'thewire',
+            'uservalidationbyemail',
+            'web_services',
+        ];
+
+        $cats = $this->parser->getAttribute('category');
+
+        if (!$cats) {
+            $cats = [];
+        }
+
+        if (in_array('bundled', $cats) && !in_array($this->getPluginID(), $bundled_plugins)) {
+            unset($cats[array_search('bundled', $cats)]);
+        }
+
+        return $cats;
+    }
+
+    /**
+     * Return the screenshots listed.
+     *
+     * @return array
+     */
+    public function getScreenshots() {
+        $ss = $this->parser->getAttribute('screenshot');
+
+        if (!$ss) {
+            $ss = [];
+        }
+
+        $normalized = [];
+        foreach ($ss as $s) {
+            $normalized[] = $this->buildStruct($this->screenshotStruct, $s);
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Return the contributors listed.
+     *
+     * @return array
+     */
+    public function getContributors() {
+        $ss = $this->parser->getAttribute('contributor');
+
+        if (!$ss) {
+            $ss = [];
+        }
+
+        $normalized = [];
+        foreach ($ss as $s) {
+            $normalized[] = $this->buildStruct($this->contributorStruct, $s);
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Return the list of provides by this plugin.
+     *
+     * @return array
+     */
+    public function getProvides() {
+        // normalize for 1.7
+        if ($this->getApiVersion() < 1.8) {
+            $provides = [];
+        } else {
+            $provides = $this->parser->getAttribute('provides');
+        }
+
+        if (!$provides) {
+            $provides = [];
+        }
+
+        // always provide ourself if we can
+        if ($this->pluginID) {
+            $provides[] = [
+                'type' => 'plugin',
+                'name' => $this->getPluginID(),
+                'version' => $this->getVersion()
+            ];
+        }
+
+        $normalized = [];
+        foreach ($provides as $provide) {
+            $normalized[] = $this->buildStruct($this->depsProvidesStruct, $provide);
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Returns the dependencies listed.
+     *
+     * @return array
+     */
+    public function getRequires() {
+        $reqs = $this->parser->getAttribute('requires');
+
+        if (!$reqs) {
+            $reqs = [];
+        }
+
+        $normalized = [];
+        foreach ($reqs as $req) {
+            $normalized[] = $this->normalizeDep($req);
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Returns the suggests elements.
+     *
+     * @return array
+     */
+    public function getSuggests() {
+        $suggests = $this->parser->getAttribute('suggests');
+
+        if (!$suggests) {
+            $suggests = [];
+        }
+
+        $normalized = [];
+        foreach ($suggests as $suggest) {
+            $normalized[] = $this->normalizeDep($suggest);
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Normalizes a dependency array using the defined structs.
+     * Can be used with either requires or suggests.
+     *
+     * @param array $dep A dependency array.
+     * @return array The normalized deps array.
+     */
+    private function normalizeDep($dep) {
+        switch ($dep['type']) {
+            case 'elgg_release':
+                $struct = $this->depsStructElgg;
+                break;
+
+            case 'plugin':
+                $struct = $this->depsStructPlugin;
+                break;
+
+            case 'priority':
+                $struct = $this->depsStructPriority;
+                break;
+
+            case 'php_version':
+                $struct = $this->depsStructPhpVersion;
+                break;
+
+            case 'php_extension':
+                $struct = $this->depsStructPhpExtension;
+                break;
+
+            case 'php_ini':
+                $struct = $this->depsStructPhpIni;
+
+                // also normalize boolean values
+                if (isset($dep['value'])) {
+                    switch (strtolower($dep['value'])) {
+                        case 'yes':
+                        case 'true':
+                        case 'on':
+                        case 1:
+                            $dep['value'] = 1;
+                            break;
+
+                        case 'no':
+                        case 'false':
+                        case 'off':
+                        case 0:
+                        case '':
+                            $dep['value'] = 0;
+                            break;
+                    }
+                }
+                break;
+            default:
+                // unrecognized so we just return the raw dependency
+                return $dep;
+        }
+
+        // @todo $struct may not have been defined...
+        $normalized_dep = $this->buildStruct($struct, $dep);
+
+        // normalize comparison operators
+        if (isset($normalized_dep['comparison'])) {
+            switch ($normalized_dep['comparison']) {
+                case '<':
+                    $normalized_dep['comparison'] = 'lt';
+                    break;
+
+                case '<=':
+                    $normalized_dep['comparison'] = 'le';
+                    break;
+
+                case '>':
+                    $normalized_dep['comparison'] = 'gt';
+                    break;
+
+                case '>=':
+                    $normalized_dep['comparison'] = 'ge';
+                    break;
+
+                case '==':
+                case 'eq':
+                    $normalized_dep['comparison'] = '=';
+                    break;
+
+                case '<>':
+                case 'ne':
+                    $normalized_dep['comparison'] = '!=';
+                    break;
+            }
+        }
+
+        return $normalized_dep;
+    }
+
+    /**
+     * Returns the conflicts listed
+     *
+     * @return array
+     */
+    public function getConflicts() {
+        // normalize for 1.7
+        if ($this->getApiVersion() < 1.8) {
+            $conflicts = [];
+        } else {
+            $conflicts = $this->parser->getAttribute('conflicts');
+        }
+
+        if (!$conflicts) {
+            $conflicts = [];
+        }
+
+        $normalized = [];
+
+        foreach ($conflicts as $conflict) {
+            $normalized[] = $this->buildStruct($this->depsConflictsStruct, $conflict);
+        }
+
+        return $normalized;
+    }
+
+    /**
+     * Should this plugin be activated when Elgg is installed
+     *
+     *  @return bool
+     */
+    public function getActivateOnInstall() {
+        $activate = $this->parser->getAttribute('activate_on_install');
+        switch (strtolower($activate)) {
+            case 'yes':
+            case 'true':
+            case 'on':
+            case 1:
+                return true;
+
+            case 'no':
+            case 'false':
+            case 'off':
+            case 0:
+            case '':
+                return false;
+        }
+    }
+
+    /**
+     * Normalizes an array into the structure specified
+     *
+     * @param array $struct The struct to normalize $element to.
+     * @param array $array  The array
+     *
+     * @return array
+     */
+    protected function buildStruct(array $struct, array $array) {
+        $return = [];
+
+        foreach ($struct as $index => $default) {
+            $return[$index] = elgg_extract($index, $array, $default);
+        }
+
+        return $return;
+    }
+
+    /**
+     * Returns a category's friendly name. This can be localized by
+     * defining the string 'admin:plugins:category:<category>'. If no
+     * localization is found, returns the category with _ and - converted to ' '
+     * and then ucwords()'d.
+     *
+     * @param string $category The category as defined in the manifest.
+     * @return string A human-readable category
+     */
+    static public function getFriendlyCategory($category) {
+        $cat_raw_string = "admin:plugins:category:$category";
+        if (_elgg_services()->translator->languageKeyExists($cat_raw_string)) {
+            return _elgg_services()->translator->translate($cat_raw_string);
+        }
 		
-		$category = str_replace(['-', '_'], ' ', $category);
-		return ucwords($category);
-	}
+        $category = str_replace(['-', '_'], ' ', $category);
+        return ucwords($category);
+    }
 }

engine/classes/ElggPriorityList.php

Doc Comments +2 added lines, -2 removed lines

@@ -231,7 +231,7 @@ 
 	/**
 	 * Sort the elements if they haven't been sorted yet.
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function sortIfUnsorted() {
 		if (!$this->sorted) {
@@ -262,7 +262,7 @@ 
 	 *
 	 * @param mixed $element The element to check for.
 	 * @param bool  $strict  Use strict checking?
-	 * @return mixed False if the element doesn't exists, the priority if it does.
+	 * @return integer False if the element doesn't exists, the priority if it does.
 	 */
 	public function getPriority($element, $strict = false) {
 		return array_search($element, $this->elements, $strict);

Indentation +238 added lines, -238 removed lines

@@ -93,274 +93,274 @@
  * @subpackage Helpers
  */
 class ElggPriorityList
-	implements \Iterator, \Countable {
+    implements \Iterator, \Countable {
 
-	/**
-	 * The list of elements
-	 *
-	 * @var array
-	 */
-	private $elements = [];
+    /**
+     * The list of elements
+     *
+     * @var array
+     */
+    private $elements = [];
 
-	/**
-	 * Create a new priority list.
-	 *
-	 * @param array $elements An optional array of priorities => element
-	 */
-	public function __construct(array $elements = []) {
-		if ($elements) {
-			foreach ($elements as $priority => $element) {
-				$this->add($element, $priority);
-			}
-		}
-	}
+    /**
+     * Create a new priority list.
+     *
+     * @param array $elements An optional array of priorities => element
+     */
+    public function __construct(array $elements = []) {
+        if ($elements) {
+            foreach ($elements as $priority => $element) {
+                $this->add($element, $priority);
+            }
+        }
+    }
 
-	/**
-	 * Adds an element to the list.
-	 *
-	 * @warning This returns the priority at which the element was added, which can be 0. Use
-	 *          !== false to check for success.
-	 *
-	 * @param mixed $element  The element to add to the list.
-	 * @param mixed $priority Priority to add the element. In priority collisions, the original element
-	 *                        maintains its priority and the new element is to the next available
-	 *                        slot, taking into consideration all previously registered elements.
-	 *                        Negative elements are accepted.
-	 * @param bool  $exact    unused
-	 * @return int            The priority of the added element.
-	 * @todo remove $exact or implement it. Note we use variable name strict below.
-	 */
-	public function add($element, $priority = null, $exact = false) {
-		if ($priority !== null && !is_numeric($priority)) {
-			return false;
-		} else {
-			$priority = $this->getNextPriority($priority);
-		}
+    /**
+     * Adds an element to the list.
+     *
+     * @warning This returns the priority at which the element was added, which can be 0. Use
+     *          !== false to check for success.
+     *
+     * @param mixed $element  The element to add to the list.
+     * @param mixed $priority Priority to add the element. In priority collisions, the original element
+     *                        maintains its priority and the new element is to the next available
+     *                        slot, taking into consideration all previously registered elements.
+     *                        Negative elements are accepted.
+     * @param bool  $exact    unused
+     * @return int            The priority of the added element.
+     * @todo remove $exact or implement it. Note we use variable name strict below.
+     */
+    public function add($element, $priority = null, $exact = false) {
+        if ($priority !== null && !is_numeric($priority)) {
+            return false;
+        } else {
+            $priority = $this->getNextPriority($priority);
+        }
 
-		$this->elements[$priority] = $element;
-		$this->sorted = false;
-		return $priority;
-	}
+        $this->elements[$priority] = $element;
+        $this->sorted = false;
+        return $priority;
+    }
 
-	/**
-	 * Removes an element from the list.
-	 *
-	 * @warning The element must have the same attributes / values. If using $strict, it must have
-	 *          the same types. array(10) will fail in strict against array('10') (str vs int).
-	 *
-	 * @param mixed $element The element to remove from the list
-	 * @param bool  $strict  Whether to check the type of the element match
-	 * @return bool
-	 */
-	public function remove($element, $strict = false) {
-		$index = array_search($element, $this->elements, $strict);
-		if ($index !== false) {
-			unset($this->elements[$index]);
-			return true;
-		} else {
-			return false;
-		}
-	}
+    /**
+     * Removes an element from the list.
+     *
+     * @warning The element must have the same attributes / values. If using $strict, it must have
+     *          the same types. array(10) will fail in strict against array('10') (str vs int).
+     *
+     * @param mixed $element The element to remove from the list
+     * @param bool  $strict  Whether to check the type of the element match
+     * @return bool
+     */
+    public function remove($element, $strict = false) {
+        $index = array_search($element, $this->elements, $strict);
+        if ($index !== false) {
+            unset($this->elements[$index]);
+            return true;
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * Move an existing element to a new priority.
-	 *
-	 * @param mixed $element      The element to move
-	 * @param int   $new_priority The new priority for the element
-	 * @param bool  $strict       Whether to check the type of the element match
-	 * @return bool
-	 */
-	public function move($element, $new_priority, $strict = false) {
-		$new_priority = (int) $new_priority;
+    /**
+     * Move an existing element to a new priority.
+     *
+     * @param mixed $element      The element to move
+     * @param int   $new_priority The new priority for the element
+     * @param bool  $strict       Whether to check the type of the element match
+     * @return bool
+     */
+    public function move($element, $new_priority, $strict = false) {
+        $new_priority = (int) $new_priority;
 		
-		$current_priority = $this->getPriority($element, $strict);
-		if ($current_priority === false) {
-			return false;
-		}
+        $current_priority = $this->getPriority($element, $strict);
+        if ($current_priority === false) {
+            return false;
+        }
 
-		if ($current_priority == $new_priority) {
-			return true;
-		}
+        if ($current_priority == $new_priority) {
+            return true;
+        }
 
-		// move the actual element so strict operations still work
-		$element = $this->getElement($current_priority);
-		unset($this->elements[$current_priority]);
-		return $this->add($element, $new_priority);
-	}
+        // move the actual element so strict operations still work
+        $element = $this->getElement($current_priority);
+        unset($this->elements[$current_priority]);
+        return $this->add($element, $new_priority);
+    }
 
-	/**
-	 * Returns the elements
-	 *
-	 * @return array
-	 */
-	public function getElements() {
-		$this->sortIfUnsorted();
-		return $this->elements;
-	}
+    /**
+     * Returns the elements
+     *
+     * @return array
+     */
+    public function getElements() {
+        $this->sortIfUnsorted();
+        return $this->elements;
+    }
 
-	/**
-	 * Sort the elements optionally by a callback function.
-	 *
-	 * If no user function is provided the elements are sorted by priority registered.
-	 *
-	 * The callback function should accept the array of elements as the first
-	 * argument and should return a sorted array.
-	 *
-	 * This function can be called multiple times.
-	 *
-	 * @param callback $callback The callback for sorting. Numeric sorting is the default.
-	 * @return bool
-	 */
-	public function sort($callback = null) {
-		if (!$callback) {
-			ksort($this->elements, SORT_NUMERIC);
-		} else {
-			$sorted = call_user_func($callback, $this->elements);
+    /**
+     * Sort the elements optionally by a callback function.
+     *
+     * If no user function is provided the elements are sorted by priority registered.
+     *
+     * The callback function should accept the array of elements as the first
+     * argument and should return a sorted array.
+     *
+     * This function can be called multiple times.
+     *
+     * @param callback $callback The callback for sorting. Numeric sorting is the default.
+     * @return bool
+     */
+    public function sort($callback = null) {
+        if (!$callback) {
+            ksort($this->elements, SORT_NUMERIC);
+        } else {
+            $sorted = call_user_func($callback, $this->elements);
 
-			if (!$sorted) {
-				return false;
-			}
+            if (!$sorted) {
+                return false;
+            }
 
-			$this->elements = $sorted;
-		}
+            $this->elements = $sorted;
+        }
 		
-		$this->sorted = true;
-		return true;
-	}
+        $this->sorted = true;
+        return true;
+    }
 
-	/**
-	 * Sort the elements if they haven't been sorted yet.
-	 *
-	 * @return bool
-	 */
-	private function sortIfUnsorted() {
-		if (!$this->sorted) {
-			return $this->sort();
-		}
-	}
+    /**
+     * Sort the elements if they haven't been sorted yet.
+     *
+     * @return bool
+     */
+    private function sortIfUnsorted() {
+        if (!$this->sorted) {
+            return $this->sort();
+        }
+    }
 
-	/**
-	 * Returns the next priority available.
-	 *
-	 * @param int $near Make the priority as close to $near as possible.
-	 * @return int
-	 */
-	public function getNextPriority($near = 0) {
-		$near = (int) $near;
+    /**
+     * Returns the next priority available.
+     *
+     * @param int $near Make the priority as close to $near as possible.
+     * @return int
+     */
+    public function getNextPriority($near = 0) {
+        $near = (int) $near;
 		
-		while (array_key_exists($near, $this->elements)) {
-			$near++;
-		}
+        while (array_key_exists($near, $this->elements)) {
+            $near++;
+        }
 
-		return $near;
-	}
+        return $near;
+    }
 
-	/**
-	 * Returns the priority of an element if it exists in the list.
-	 *
-	 * @warning This can return 0 if the element's priority is 0.
-	 *
-	 * @param mixed $element The element to check for.
-	 * @param bool  $strict  Use strict checking?
-	 * @return mixed False if the element doesn't exists, the priority if it does.
-	 */
-	public function getPriority($element, $strict = false) {
-		return array_search($element, $this->elements, $strict);
-	}
+    /**
+     * Returns the priority of an element if it exists in the list.
+     *
+     * @warning This can return 0 if the element's priority is 0.
+     *
+     * @param mixed $element The element to check for.
+     * @param bool  $strict  Use strict checking?
+     * @return mixed False if the element doesn't exists, the priority if it does.
+     */
+    public function getPriority($element, $strict = false) {
+        return array_search($element, $this->elements, $strict);
+    }
 
-	/**
-	 * Returns the element at $priority.
-	 *
-	 * @param int $priority The priority
-	 * @return mixed The element or false on fail.
-	 */
-	public function getElement($priority) {
-		return (isset($this->elements[$priority])) ? $this->elements[$priority] : false;
-	}
+    /**
+     * Returns the element at $priority.
+     *
+     * @param int $priority The priority
+     * @return mixed The element or false on fail.
+     */
+    public function getElement($priority) {
+        return (isset($this->elements[$priority])) ? $this->elements[$priority] : false;
+    }
 
-	/**
-	 * Returns if the list contains $element.
-	 *
-	 * @param mixed $element The element to check.
-	 * @param bool  $strict  Use strict checking?
-	 * @return bool
-	 */
-	public function contains($element, $strict = false) {
-		return $this->getPriority($element, $strict) !== false;
-	}
+    /**
+     * Returns if the list contains $element.
+     *
+     * @param mixed $element The element to check.
+     * @param bool  $strict  Use strict checking?
+     * @return bool
+     */
+    public function contains($element, $strict = false) {
+        return $this->getPriority($element, $strict) !== false;
+    }
 
 	
-	/**********************
+    /**********************
 	 * Interface methods *
 	 **********************/
 
-	/**
-	 * Iterator
-	 */
+    /**
+     * Iterator
+     */
 
-	/**
-	 * PHP Iterator Interface
-	 *
-	 * @see Iterator::rewind()
-	 * @return void
-	 */
-	public function rewind() {
-		$this->sortIfUnsorted();
-		return reset($this->elements);
-	}
+    /**
+     * PHP Iterator Interface
+     *
+     * @see Iterator::rewind()
+     * @return void
+     */
+    public function rewind() {
+        $this->sortIfUnsorted();
+        return reset($this->elements);
+    }
 
-	/**
-	 * PHP Iterator Interface
-	 *
-	 * @see Iterator::current()
-	 * @return mixed
-	 */
-	public function current() {
-		$this->sortIfUnsorted();
-		return current($this->elements);
-	}
+    /**
+     * PHP Iterator Interface
+     *
+     * @see Iterator::current()
+     * @return mixed
+     */
+    public function current() {
+        $this->sortIfUnsorted();
+        return current($this->elements);
+    }
 
-	/**
-	 * PHP Iterator Interface
-	 *
-	 * @see Iterator::key()
-	 * @return int
-	 */
-	public function key() {
-		$this->sortIfUnsorted();
-		return key($this->elements);
-	}
+    /**
+     * PHP Iterator Interface
+     *
+     * @see Iterator::key()
+     * @return int
+     */
+    public function key() {
+        $this->sortIfUnsorted();
+        return key($this->elements);
+    }
 
-	/**
-	 * PHP Iterator Interface
-	 *
-	 * @see Iterator::next()
-	 * @return mixed
-	 */
-	public function next() {
-		$this->sortIfUnsorted();
-		return next($this->elements);
-	}
+    /**
+     * PHP Iterator Interface
+     *
+     * @see Iterator::next()
+     * @return mixed
+     */
+    public function next() {
+        $this->sortIfUnsorted();
+        return next($this->elements);
+    }
 
-	/**
-	 * PHP Iterator Interface
-	 *
-	 * @see Iterator::valid()
-	 * @return bool
-	 */
-	public function valid() {
-		$this->sortIfUnsorted();
-		$key = key($this->elements);
-		return ($key !== null && $key !== false);
-	}
+    /**
+     * PHP Iterator Interface
+     *
+     * @see Iterator::valid()
+     * @return bool
+     */
+    public function valid() {
+        $this->sortIfUnsorted();
+        $key = key($this->elements);
+        return ($key !== null && $key !== false);
+    }
 
-	/**
-	 * Countable interface
-	 *
-	 * @see Countable::count()
-	 * @return int
-	 */
-	public function count() {
-		return count($this->elements);
-	}
+    /**
+     * Countable interface
+     *
+     * @see Countable::count()
+     * @return int
+     */
+    public function count() {
+        return count($this->elements);
+    }
 }

engine/lib/access.php

Doc Comments +2 added lines, -2 removed lines

@@ -552,7 +552,7 @@ 
  * @param string $type
  * @param bool $value
  * @param array $params
- * @return true|null
+ * @return boolean|null
  * @access private
  */
 function elgg_override_permissions($hook, $type, $value, $params) {
@@ -589,7 +589,7 @@ 
  * @param string $type
  * @param array $value
  * @param array $params
- * @return array
+ * @return string[]
  *
  * @access private
  */

Indentation +117 added lines, -117 removed lines

@@ -44,7 +44,7 @@ 
  * @see elgg_get_ignore_access()
  */
 function elgg_set_ignore_access($ignore = true) {
-	return _elgg_services()->session->setIgnoreAccess($ignore);
+    return _elgg_services()->session->setIgnoreAccess($ignore);
 }
 
 /**
@@ -55,7 +55,7 @@ 
  * @see elgg_set_ignore_access()
  */
 function elgg_get_ignore_access() {
-	return _elgg_services()->session->getIgnoreAccess();
+    return _elgg_services()->session->getIgnoreAccess();
 }
 
 /**
@@ -74,7 +74,7 @@ 
  * @access private
  */
 function get_access_list($user_guid = 0, $ignored = 0, $flush = false) {
-	return _elgg_services()->accessCollections->getAccessList($user_guid, $flush);
+    return _elgg_services()->accessCollections->getAccessList($user_guid, $flush);
 }
 
 /**
@@ -103,7 +103,7 @@ 
  * @return array An array of access collections ids
  */
 function get_access_array($user_guid = 0, $ignored = 0, $flush = false) {
-	return _elgg_services()->accessCollections->getAccessArray($user_guid, $flush);
+    return _elgg_services()->accessCollections->getAccessArray($user_guid, $flush);
 }
 
 /**
@@ -119,26 +119,26 @@ 
  * @return int default access id (see ACCESS defines in elgglib.php)
  */
 function get_default_access(ElggUser $user = null, array $input_params = []) {
-	// site default access
-	$default_access = _elgg_config()->default_access;
-
-	// user default access if enabled
-	if (_elgg_config()->allow_user_default_access) {
-		$user = $user ? $user : _elgg_services()->session->getLoggedInUser();
-		if ($user) {
-			$user_access = $user->getPrivateSetting('elgg_default_access');
-			if ($user_access !== null) {
-				$default_access = $user_access;
-			}
-		}
-	}
-
-	$params = [
-		'user' => $user,
-		'default_access' => $default_access,
-		'input_params' => $input_params,
-	];
-	return _elgg_services()->hooks->trigger('default', 'access', $params, $default_access);
+    // site default access
+    $default_access = _elgg_config()->default_access;
+
+    // user default access if enabled
+    if (_elgg_config()->allow_user_default_access) {
+        $user = $user ? $user : _elgg_services()->session->getLoggedInUser();
+        if ($user) {
+            $user_access = $user->getPrivateSetting('elgg_default_access');
+            if ($user_access !== null) {
+                $default_access = $user_access;
+            }
+        }
+    }
+
+    $params = [
+        'user' => $user,
+        'default_access' => $default_access,
+        'input_params' => $input_params,
+    ];
+    return _elgg_services()->hooks->trigger('default', 'access', $params, $default_access);
 }
 
 /**
@@ -157,10 +157,10 @@ 
  * @return bool
  */
 function access_show_hidden_entities($show_hidden) {
-	global $ENTITY_SHOW_HIDDEN_OVERRIDE;
-	$current_value = $ENTITY_SHOW_HIDDEN_OVERRIDE;
-	$ENTITY_SHOW_HIDDEN_OVERRIDE = $show_hidden;
-	return $current_value;
+    global $ENTITY_SHOW_HIDDEN_OVERRIDE;
+    $current_value = $ENTITY_SHOW_HIDDEN_OVERRIDE;
+    $ENTITY_SHOW_HIDDEN_OVERRIDE = $show_hidden;
+    return $current_value;
 }
 
 /**
@@ -169,8 +169,8 @@ 
  * @return bool
  */
 function access_get_show_hidden_status() {
-	global $ENTITY_SHOW_HIDDEN_OVERRIDE;
-	return $ENTITY_SHOW_HIDDEN_OVERRIDE;
+    global $ENTITY_SHOW_HIDDEN_OVERRIDE;
+    return $ENTITY_SHOW_HIDDEN_OVERRIDE;
 }
 
 /**
@@ -213,7 +213,7 @@ 
  * @access private
  */
 function _elgg_get_access_where_sql(array $options = []) {
-	return _elgg_services()->accessCollections->getWhereSql($options);
+    return _elgg_services()->accessCollections->getWhereSql($options);
 }
 
 /**
@@ -236,7 +236,7 @@ 
  * @return bool
  */
 function has_access_to_entity($entity, $user = null) {
-	return _elgg_services()->accessCollections->hasAccessToEntity($entity, $user);
+    return _elgg_services()->accessCollections->hasAccessToEntity($entity, $user);
 }
 
 /**
@@ -266,7 +266,7 @@ 
  * @return array List of access permissions
  */
 function get_write_access_array($user_guid = 0, $ignored = 0, $flush = false, array $input_params = []) {
-	return _elgg_services()->accessCollections->getWriteAccessArray($user_guid, $flush, $input_params);
+    return _elgg_services()->accessCollections->getWriteAccessArray($user_guid, $flush, $input_params);
 }
 
 /**
@@ -284,7 +284,7 @@ 
  * @return bool
  */
 function can_edit_access_collection($collection_id, $user_guid = null) {
-	return _elgg_services()->accessCollections->canEdit($collection_id, $user_guid);
+    return _elgg_services()->accessCollections->canEdit($collection_id, $user_guid);
 }
 
 /**
@@ -306,7 +306,7 @@ 
  * @see delete_access_collection()
  */
 function create_access_collection($name, $owner_guid = 0) {
-	return _elgg_services()->accessCollections->create($name, $owner_guid);
+    return _elgg_services()->accessCollections->create($name, $owner_guid);
 }
 
 /**
@@ -326,7 +326,7 @@ 
  * @see remove_user_from_access_collection()
  */
 function update_access_collection($collection_id, $members) {
-	return _elgg_services()->accessCollections->update($collection_id, $members);
+    return _elgg_services()->accessCollections->update($collection_id, $members);
 }
 
 /**
@@ -339,7 +339,7 @@ 
  * @see update_access_collection()
  */
 function delete_access_collection($collection_id) {
-	return _elgg_services()->accessCollections->delete($collection_id);
+    return _elgg_services()->accessCollections->delete($collection_id);
 }
 
 /**
@@ -355,7 +355,7 @@ 
  * @return ElggAccessCollection|false
  */
 function get_access_collection($collection_id) {
-	return _elgg_services()->accessCollections->get($collection_id);
+    return _elgg_services()->accessCollections->get($collection_id);
 }
 
 /**
@@ -371,7 +371,7 @@ 
  * @see remove_user_from_access_collection()
  */
 function add_user_to_access_collection($user_guid, $collection_id) {
-	return _elgg_services()->accessCollections->addUser($user_guid, $collection_id);
+    return _elgg_services()->accessCollections->addUser($user_guid, $collection_id);
 }
 
 /**
@@ -387,7 +387,7 @@ 
  * @see remove_user_from_access_collection()
  */
 function remove_user_from_access_collection($user_guid, $collection_id) {
-	return _elgg_services()->accessCollections->removeUser($user_guid, $collection_id);
+    return _elgg_services()->accessCollections->removeUser($user_guid, $collection_id);
 }
 
 /**
@@ -400,7 +400,7 @@ 
  * @return \ElggAccessCollection[]|false
  */
 function get_user_access_collections($owner_guid) {
-	return _elgg_services()->accessCollections->getEntityCollections($owner_guid);
+    return _elgg_services()->accessCollections->getEntityCollections($owner_guid);
 }
 
 /**
@@ -414,21 +414,21 @@ 
  * @see add_user_to_access_collection()
  */
 function get_members_of_access_collection($collection_id, $guids_only = false, array $options = []) {
-	if (!isset($options['limit'])) {
-		$options['limit'] = 0;
-	}
-
-	if (!$guids_only) {
-		return _elgg_services()->accessCollections->getMembers($collection_id, $options);
-	}
-
-	$guids = [];
-	$options['callback'] = false;
-	$rows = _elgg_services()->accessCollections->getMembers($collection_id, $options);
-	foreach ($rows as $row) {
-		$guids[] = $row->guid;
-	}
-	return $guids;
+    if (!isset($options['limit'])) {
+        $options['limit'] = 0;
+    }
+
+    if (!$guids_only) {
+        return _elgg_services()->accessCollections->getMembers($collection_id, $options);
+    }
+
+    $guids = [];
+    $options['callback'] = false;
+    $rows = _elgg_services()->accessCollections->getMembers($collection_id, $options);
+    foreach ($rows as $row) {
+        $guids[] = $row->guid;
+    }
+    return $guids;
 }
 
 /**
@@ -444,25 +444,25 @@ 
  * @since 1.7.0
  */
 function elgg_get_entities_from_access_id(array $options = []) {
-	// restrict the resultset to access collection provided
-	if (!isset($options['access_id'])) {
-		return false;
-	}
-
-	// @todo add support for an array of collection_ids
-	$where = "e.access_id = '{$options['access_id']}'";
-	if (isset($options['wheres'])) {
-		if (is_array($options['wheres'])) {
-			$options['wheres'][] = $where;
-		} else {
-			$options['wheres'] = [$options['wheres'], $where];
-		}
-	} else {
-		$options['wheres'] = [$where];
-	}
-
-	// return entities with the desired options
-	return _elgg_services()->entityTable->getEntities($options);
+    // restrict the resultset to access collection provided
+    if (!isset($options['access_id'])) {
+        return false;
+    }
+
+    // @todo add support for an array of collection_ids
+    $where = "e.access_id = '{$options['access_id']}'";
+    if (isset($options['wheres'])) {
+        if (is_array($options['wheres'])) {
+            $options['wheres'][] = $where;
+        } else {
+            $options['wheres'] = [$options['wheres'], $where];
+        }
+    } else {
+        $options['wheres'] = [$where];
+    }
+
+    // return entities with the desired options
+    return _elgg_services()->entityTable->getEntities($options);
 }
 
 /**
@@ -476,7 +476,7 @@ 
  * @return string
  */
 function elgg_list_entities_from_access_id(array $options = []) {
-	return elgg_list_entities($options, 'elgg_get_entities_from_access_id');
+    return elgg_list_entities($options, 'elgg_get_entities_from_access_id');
 }
 
 /**
@@ -496,7 +496,7 @@ 
  * @since 1.7.0
  */
 function get_readable_access_level($entity_access_id) {
-	return _elgg_services()->accessCollections->getReadableAccessLevel($entity_access_id);
+    return _elgg_services()->accessCollections->getReadableAccessLevel($entity_access_id);
 }
 
 /**
@@ -515,13 +515,13 @@ 
  * @todo should this be a private function?
  */
 function elgg_check_access_overrides($user_guid = 0) {
-	if (!$user_guid || $user_guid <= 0) {
-		$is_admin = false;
-	} else {
-		$is_admin = elgg_is_admin_user($user_guid);
-	}
+    if (!$user_guid || $user_guid <= 0) {
+        $is_admin = false;
+    } else {
+        $is_admin = elgg_is_admin_user($user_guid);
+    }
 
-	return ($is_admin || _elgg_services()->session->getIgnoreAccess());
+    return ($is_admin || _elgg_services()->session->getIgnoreAccess());
 }
 
 /**
@@ -532,7 +532,7 @@ 
  * @return void
  */
 function access_init() {
-	_elgg_services()->accessCollections->markInitComplete();
+    _elgg_services()->accessCollections->markInitComplete();
 }
 
 /**
@@ -556,29 +556,29 @@ 
  * @access private
  */
 function elgg_override_permissions($hook, $type, $value, $params) {
-	$user = elgg_extract('user', $params);
-	if ($user) {
-		$user_guid = $user->guid;
-	} else {
-		$user_guid = _elgg_services()->session->getLoggedInUserGuid();
-	}
-
-	// don't do this so ignore access still works with no one logged in
-	//if (!$user instanceof \ElggUser) {
-	//	return false;
-	//}
-	// check for admin
-	if ($user_guid && elgg_is_admin_user($user_guid)) {
-		return true;
-	}
-
-	// check access overrides
-	if (elgg_check_access_overrides($user_guid)) {
-		return true;
-	}
-
-	// consult other hooks
-	return null;
+    $user = elgg_extract('user', $params);
+    if ($user) {
+        $user_guid = $user->guid;
+    } else {
+        $user_guid = _elgg_services()->session->getLoggedInUserGuid();
+    }
+
+    // don't do this so ignore access still works with no one logged in
+    //if (!$user instanceof \ElggUser) {
+    //	return false;
+    //}
+    // check for admin
+    if ($user_guid && elgg_is_admin_user($user_guid)) {
+        return true;
+    }
+
+    // check access overrides
+    if (elgg_check_access_overrides($user_guid)) {
+        return true;
+    }
+
+    // consult other hooks
+    return null;
 }
 
 /**
@@ -593,22 +593,22 @@ 
  * @access private
  */
 function access_test($hook, $type, $value, $params) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreAccessCollectionsTest.php';
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreAccessSQLTest.php';
-	return $value;
+    $value[] = Paths::elgg() . 'engine/tests/ElggCoreAccessCollectionsTest.php';
+    $value[] = Paths::elgg() . 'engine/tests/ElggCoreAccessSQLTest.php';
+    return $value;
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	// Tell the access functions the system has booted, plugins are loaded,
-	// and the user is logged in so it can start caching
-	$events->registerHandler('ready', 'system', 'access_init');
+    // Tell the access functions the system has booted, plugins are loaded,
+    // and the user is logged in so it can start caching
+    $events->registerHandler('ready', 'system', 'access_init');
 
-	// For overrided permissions
-	$hooks->registerHandler('permissions_check', 'all', 'elgg_override_permissions', 600);
-	$hooks->registerHandler('container_permissions_check', 'all', 'elgg_override_permissions', 600);
+    // For overrided permissions
+    $hooks->registerHandler('permissions_check', 'all', 'elgg_override_permissions', 600);
+    $hooks->registerHandler('container_permissions_check', 'all', 'elgg_override_permissions', 600);
 
-	$hooks->registerHandler('unit_test', 'system', 'access_test');
+    $hooks->registerHandler('unit_test', 'system', 'access_test');
 };

Spacing +2 added lines, -2 removed lines

@@ -593,8 +593,8 @@
  * @access private
  */
 function access_test($hook, $type, $value, $params) {
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreAccessCollectionsTest.php';
-	$value[] = Paths::elgg() . 'engine/tests/ElggCoreAccessSQLTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggCoreAccessCollectionsTest.php';
+	$value[] = Paths::elgg().'engine/tests/ElggCoreAccessSQLTest.php';
 	return $value;
 }
 

engine/lib/admin.php

Doc Comments +1 added lines, -1 removed lines

@@ -806,7 +806,7 @@
  * @param string $type
  * @param \ElggUser $user
  *
- * @return null|true
+ * @return boolean|null
  * @access private
  */
 function _elgg_add_admin_widgets($event, $type, $user) {

Spacing +3 added lines, -3 removed lines

@@ -546,7 +546,7 @@ 
 	foreach ($active_plugins as $plugin) {
 		$plugin_id = $plugin->getID();
 		
-		if (!elgg_view_exists("plugins/{$plugin_id}/settings") ) {
+		if (!elgg_view_exists("plugins/{$plugin_id}/settings")) {
 			continue;
 		}
 		$plugin_name = $plugin->getDisplayName();
@@ -624,10 +624,10 @@ 
 			forward('', '404');
 		}
 	} else {
-		$view = 'admin/' . implode('/', $page);
+		$view = 'admin/'.implode('/', $page);
 		$title = elgg_echo("admin:{$page[0]}");
 		if (count($page) > 1) {
-			$title .= ' : ' . elgg_echo('admin:' .  implode(':', $page));
+			$title .= ' : '.elgg_echo('admin:'.implode(':', $page));
 		}
 	}
 

Indentation +640 added lines, -640 removed lines

@@ -29,27 +29,27 @@ 
  * @since 1.8.0
  */
 function elgg_get_admins(array $options = []) {
-	$config = _elgg_config();
-
-	if (isset($options['joins'])) {
-		if (!is_array($options['joins'])) {
-			$options['joins'] = [$options['joins']];
-		}
-		$options['joins'][] = "join {$config->dbprefix}users_entity u on e.guid=u.guid";
-	} else {
-		$options['joins'] = ["join {$config->dbprefix}users_entity u on e.guid=u.guid"];
-	}
-
-	if (isset($options['wheres'])) {
-		if (!is_array($options['wheres'])) {
-			$options['wheres'] = [$options['wheres']];
-		}
-		$options['wheres'][] = "u.admin = 'yes'";
-	} else {
-		$options['wheres'][] = "u.admin = 'yes'";
-	}
-
-	return elgg_get_entities($options);
+    $config = _elgg_config();
+
+    if (isset($options['joins'])) {
+        if (!is_array($options['joins'])) {
+            $options['joins'] = [$options['joins']];
+        }
+        $options['joins'][] = "join {$config->dbprefix}users_entity u on e.guid=u.guid";
+    } else {
+        $options['joins'] = ["join {$config->dbprefix}users_entity u on e.guid=u.guid"];
+    }
+
+    if (isset($options['wheres'])) {
+        if (!is_array($options['wheres'])) {
+            $options['wheres'] = [$options['wheres']];
+        }
+        $options['wheres'][] = "u.admin = 'yes'";
+    } else {
+        $options['wheres'][] = "u.admin = 'yes'";
+    }
+
+    return elgg_get_entities($options);
 }
 
 /**
@@ -69,7 +69,7 @@ 
  * @since 1.8.0
  */
 function elgg_add_admin_notice($id, $message) {
-	return _elgg_services()->adminNotices->add($id, $message);
+    return _elgg_services()->adminNotices->add($id, $message);
 }
 
 /**
@@ -81,7 +81,7 @@ 
  * @since 1.8.0
  */
 function elgg_delete_admin_notice($id) {
-	return _elgg_services()->adminNotices->delete($id);
+    return _elgg_services()->adminNotices->delete($id);
 }
 
 /**
@@ -93,7 +93,7 @@ 
  * @since 1.8.0
  */
 function elgg_get_admin_notices(array $options = []) {
-	return _elgg_services()->adminNotices->find($options);
+    return _elgg_services()->adminNotices->find($options);
 }
 
 /**
@@ -105,7 +105,7 @@ 
  * @since 1.8.0
  */
 function elgg_admin_notice_exists($id) {
-	return _elgg_services()->adminNotices->exists($id);
+    return _elgg_services()->adminNotices->exists($id);
 }
 
 /**
@@ -117,17 +117,17 @@ 
  * @access private
  */
 function _elgg_create_notice_of_pending_upgrade($event, $type, $object) {
-	if ($object instanceof \ElggUpgrade) {
-		// Link to the Upgrades section
-		$link = elgg_view('output/url', [
-			'href' => 'admin/upgrades',
-			'text' => elgg_echo('admin:view_upgrades'),
-		]);
+    if ($object instanceof \ElggUpgrade) {
+        // Link to the Upgrades section
+        $link = elgg_view('output/url', [
+            'href' => 'admin/upgrades',
+            'text' => elgg_echo('admin:view_upgrades'),
+        ]);
 
-		$message = elgg_echo('admin:pending_upgrades');
+        $message = elgg_echo('admin:pending_upgrades');
 
-		elgg_add_admin_notice('pending_upgrades', "$message $link");
-	}
+        elgg_add_admin_notice('pending_upgrades', "$message $link");
+    }
 }
 
 /**
@@ -137,85 +137,85 @@ 
  */
 function _elgg_admin_init() {
 
-	elgg_register_css('elgg.admin', elgg_get_simplecache_url('admin.css'));
+    elgg_register_css('elgg.admin', elgg_get_simplecache_url('admin.css'));
 
-	elgg_extend_view('admin.css', 'lightbox/elgg-colorbox-theme/colorbox.css');
+    elgg_extend_view('admin.css', 'lightbox/elgg-colorbox-theme/colorbox.css');
 		
-	elgg_register_plugin_hook_handler('register', 'menu:admin_header', '_elgg_admin_header_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:admin_footer', '_elgg_admin_footer_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_admin_page_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_admin_page_menu_plugin_settings');
-
-	// maintenance mode
-	if (elgg_get_config('elgg_maintenance_mode', null)) {
-		elgg_register_plugin_hook_handler('route', 'all', '_elgg_admin_maintenance_handler', 600);
-		elgg_register_plugin_hook_handler('action', 'all', '_elgg_admin_maintenance_action_check', 600);
-		elgg_register_css('maintenance', elgg_get_simplecache_url('maintenance.css'));
-
-		elgg_register_menu_item('topbar', [
-			'name' => 'maintenance_mode',
-			'href' => 'admin/configure_utilities/maintenance',
-			'text' => elgg_echo('admin:maintenance_mode:indicator_menu_item'),
-			'priority' => 900,
-		]);
-	}
-
-	elgg_register_action('admin/user/ban', '', 'admin');
-	elgg_register_action('admin/user/unban', '', 'admin');
-	elgg_register_action('admin/user/delete', '', 'admin');
-	elgg_register_action('admin/user/resetpassword', '', 'admin');
-	elgg_register_action('admin/user/makeadmin', '', 'admin');
-	elgg_register_action('admin/user/removeadmin', '', 'admin');
-
-	elgg_register_action('admin/site/update_basic', '', 'admin');
-	elgg_register_action('admin/site/update_advanced', '', 'admin');
-	elgg_register_action('admin/site/flush_cache', '', 'admin');
-	elgg_register_action('admin/site/unlock_upgrade', '', 'admin');
-	elgg_register_action('admin/site/set_robots', '', 'admin');
-	elgg_register_action('admin/site/set_maintenance_mode', '', 'admin');
-
-	elgg_register_action('admin/upgrades/upgrade_database_guid_columns', '', 'admin');
-	elgg_register_action('admin/site/regenerate_secret', '', 'admin');
-	elgg_register_action('admin/upgrade', '', 'admin');
-
-	elgg_register_action('admin/menu/save', '', 'admin');
-
-	elgg_register_action('admin/delete_admin_notice', '', 'admin');
+    elgg_register_plugin_hook_handler('register', 'menu:admin_header', '_elgg_admin_header_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:admin_footer', '_elgg_admin_footer_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_admin_page_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_admin_page_menu_plugin_settings');
+
+    // maintenance mode
+    if (elgg_get_config('elgg_maintenance_mode', null)) {
+        elgg_register_plugin_hook_handler('route', 'all', '_elgg_admin_maintenance_handler', 600);
+        elgg_register_plugin_hook_handler('action', 'all', '_elgg_admin_maintenance_action_check', 600);
+        elgg_register_css('maintenance', elgg_get_simplecache_url('maintenance.css'));
+
+        elgg_register_menu_item('topbar', [
+            'name' => 'maintenance_mode',
+            'href' => 'admin/configure_utilities/maintenance',
+            'text' => elgg_echo('admin:maintenance_mode:indicator_menu_item'),
+            'priority' => 900,
+        ]);
+    }
+
+    elgg_register_action('admin/user/ban', '', 'admin');
+    elgg_register_action('admin/user/unban', '', 'admin');
+    elgg_register_action('admin/user/delete', '', 'admin');
+    elgg_register_action('admin/user/resetpassword', '', 'admin');
+    elgg_register_action('admin/user/makeadmin', '', 'admin');
+    elgg_register_action('admin/user/removeadmin', '', 'admin');
+
+    elgg_register_action('admin/site/update_basic', '', 'admin');
+    elgg_register_action('admin/site/update_advanced', '', 'admin');
+    elgg_register_action('admin/site/flush_cache', '', 'admin');
+    elgg_register_action('admin/site/unlock_upgrade', '', 'admin');
+    elgg_register_action('admin/site/set_robots', '', 'admin');
+    elgg_register_action('admin/site/set_maintenance_mode', '', 'admin');
+
+    elgg_register_action('admin/upgrades/upgrade_database_guid_columns', '', 'admin');
+    elgg_register_action('admin/site/regenerate_secret', '', 'admin');
+    elgg_register_action('admin/upgrade', '', 'admin');
+
+    elgg_register_action('admin/menu/save', '', 'admin');
+
+    elgg_register_action('admin/delete_admin_notice', '', 'admin');
 	
-	elgg_register_action('admin/security/settings', '', 'admin');
-
-	elgg_register_simplecache_view('admin.css');
-
-	// widgets
-	$widgets = ['online_users', 'new_users', 'content_stats', 'banned_users', 'admin_welcome', 'control_panel', 'cron_status'];
-	foreach ($widgets as $widget) {
-		elgg_register_widget_type(
-				$widget,
-				elgg_echo("admin:widget:$widget"),
-				elgg_echo("admin:widget:$widget:help"),
-				['admin']
-		);
-	}
-
-	// automatic adding of widgets for admin
-	elgg_register_event_handler('make_admin', 'user', '_elgg_add_admin_widgets');
+    elgg_register_action('admin/security/settings', '', 'admin');
+
+    elgg_register_simplecache_view('admin.css');
+
+    // widgets
+    $widgets = ['online_users', 'new_users', 'content_stats', 'banned_users', 'admin_welcome', 'control_panel', 'cron_status'];
+    foreach ($widgets as $widget) {
+        elgg_register_widget_type(
+                $widget,
+                elgg_echo("admin:widget:$widget"),
+                elgg_echo("admin:widget:$widget:help"),
+                ['admin']
+        );
+    }
+
+    // automatic adding of widgets for admin
+    elgg_register_event_handler('make_admin', 'user', '_elgg_add_admin_widgets');
 	
-	elgg_register_notification_event('user', '', ['make_admin', 'remove_admin']);
-	elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_admin_get_admin_subscribers_admin_action');
-	elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_admin_get_user_subscriber_admin_action');
-	elgg_register_plugin_hook_handler('prepare', 'notification:make_admin:user:', '_elgg_admin_prepare_admin_notification_make_admin');
-	elgg_register_plugin_hook_handler('prepare', 'notification:make_admin:user:', '_elgg_admin_prepare_user_notification_make_admin');
-	elgg_register_plugin_hook_handler('prepare', 'notification:remove_admin:user:', '_elgg_admin_prepare_admin_notification_remove_admin');
-	elgg_register_plugin_hook_handler('prepare', 'notification:remove_admin:user:', '_elgg_admin_prepare_user_notification_remove_admin');
+    elgg_register_notification_event('user', '', ['make_admin', 'remove_admin']);
+    elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_admin_get_admin_subscribers_admin_action');
+    elgg_register_plugin_hook_handler('get', 'subscriptions', '_elgg_admin_get_user_subscriber_admin_action');
+    elgg_register_plugin_hook_handler('prepare', 'notification:make_admin:user:', '_elgg_admin_prepare_admin_notification_make_admin');
+    elgg_register_plugin_hook_handler('prepare', 'notification:make_admin:user:', '_elgg_admin_prepare_user_notification_make_admin');
+    elgg_register_plugin_hook_handler('prepare', 'notification:remove_admin:user:', '_elgg_admin_prepare_admin_notification_remove_admin');
+    elgg_register_plugin_hook_handler('prepare', 'notification:remove_admin:user:', '_elgg_admin_prepare_user_notification_remove_admin');
 	
-	// Add notice about pending upgrades
-	elgg_register_event_handler('create', 'object', '_elgg_create_notice_of_pending_upgrade');
-
-	elgg_register_page_handler('admin', '_elgg_admin_page_handler');
-	elgg_register_page_handler('admin_plugin_text_file', '_elgg_admin_markdown_page_handler');
-	elgg_register_page_handler('robots.txt', '_elgg_robots_page_handler');
-	elgg_register_page_handler('phpinfo', '_elgg_phpinfo_page_handler');
-	elgg_register_page_handler('admin_plugins_refresh', '_elgg_ajax_plugins_update');
+    // Add notice about pending upgrades
+    elgg_register_event_handler('create', 'object', '_elgg_create_notice_of_pending_upgrade');
+
+    elgg_register_page_handler('admin', '_elgg_admin_page_handler');
+    elgg_register_page_handler('admin_plugin_text_file', '_elgg_admin_markdown_page_handler');
+    elgg_register_page_handler('robots.txt', '_elgg_robots_page_handler');
+    elgg_register_page_handler('phpinfo', '_elgg_phpinfo_page_handler');
+    elgg_register_page_handler('admin_plugins_refresh', '_elgg_ajax_plugins_update');
 }
 
 /**
@@ -225,13 +225,13 @@ 
  * @return Elgg\Http\OkResponse
  */
 function _elgg_ajax_plugins_update() {
-	elgg_admin_gatekeeper();
-	elgg_set_context('admin');
+    elgg_admin_gatekeeper();
+    elgg_set_context('admin');
 
-	return elgg_ok_response([
-		'list' => elgg_view('admin/plugins', ['list_only' => true]),
-		'sidebar' => elgg_view('admin/sidebar'),
-	]);
+    return elgg_ok_response([
+        'list' => elgg_view('admin/plugins', ['list_only' => true]),
+        'sidebar' => elgg_view('admin/sidebar'),
+    ]);
 }
 
 /**
@@ -248,52 +248,52 @@ 
  * @since 3.0
  */
 function _elgg_admin_header_menu($hook, $type, $return, $params) {
-	if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
-		return;
-	}
-
-	$admin = elgg_get_logged_in_user_entity();
-
-	$admin_icon = elgg_view_entity_icon($admin, 'tiny');
-	$admin_link = elgg_view('output/url', [
-		'href' => $admin->getURL(),
-		'text' => $admin->name,
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'admin_profile',
-		'href' => false,
-		'text' => "$admin_link $admin_icon",
-		'priority' => 1000,
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'admin_logout',
-		'href' => 'action/logout',
-		'text' => elgg_echo('logout'),
-		'is_trusted' => true,
-		'priority' => 900,
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'view_site',
-		'href' => elgg_get_site_url(),
-		'text' => elgg_echo('admin:view_site'),
-		'is_trusted' => true,
-		'priority' => 800,
-	]);
-
-	if (elgg_get_config('elgg_maintenance_mode')) {
-		$return[] = \ElggMenuItem::factory([
-			'name' => 'maintenance',
-			'href' => 'admin/configure_utilities/maintenance',
-			'text' => elgg_echo('admin:configure_utilities:maintenance'),
-			'link_class' => 'elgg-maintenance-mode-warning',
-			'priority' => 700,
-		]);
-	}
+    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
+        return;
+    }
+
+    $admin = elgg_get_logged_in_user_entity();
+
+    $admin_icon = elgg_view_entity_icon($admin, 'tiny');
+    $admin_link = elgg_view('output/url', [
+        'href' => $admin->getURL(),
+        'text' => $admin->name,
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'admin_profile',
+        'href' => false,
+        'text' => "$admin_link $admin_icon",
+        'priority' => 1000,
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'admin_logout',
+        'href' => 'action/logout',
+        'text' => elgg_echo('logout'),
+        'is_trusted' => true,
+        'priority' => 900,
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'view_site',
+        'href' => elgg_get_site_url(),
+        'text' => elgg_echo('admin:view_site'),
+        'is_trusted' => true,
+        'priority' => 800,
+    ]);
+
+    if (elgg_get_config('elgg_maintenance_mode')) {
+        $return[] = \ElggMenuItem::factory([
+            'name' => 'maintenance',
+            'href' => 'admin/configure_utilities/maintenance',
+            'text' => elgg_echo('admin:configure_utilities:maintenance'),
+            'link_class' => 'elgg-maintenance-mode-warning',
+            'priority' => 700,
+        ]);
+    }
 	
-	return $return;
+    return $return;
 }
 
 /**
@@ -310,35 +310,35 @@ 
  * @since 3.0
  */
 function _elgg_admin_footer_menu($hook, $type, $return, $params) {
-	if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
-		return;
-	}
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'faq',
-		'text' => elgg_echo('admin:footer:faq'),
-		'href' => 'http://learn.elgg.org/en/stable/appendix/faqs.html',
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'manual',
-		'text' => elgg_echo('admin:footer:manual'),
-		'href' => 'http://learn.elgg.org/en/stable/admin/index.html',
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'community_forums',
-		'text' => elgg_echo('admin:footer:community_forums'),
-		'href' => 'http://elgg.org/groups/all/',
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'blog',
-		'text' => elgg_echo('admin:footer:blog'),
-		'href' => 'https://elgg.org/blog/all',
-	]);
+    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
+        return;
+    }
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'faq',
+        'text' => elgg_echo('admin:footer:faq'),
+        'href' => 'http://learn.elgg.org/en/stable/appendix/faqs.html',
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'manual',
+        'text' => elgg_echo('admin:footer:manual'),
+        'href' => 'http://learn.elgg.org/en/stable/admin/index.html',
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'community_forums',
+        'text' => elgg_echo('admin:footer:community_forums'),
+        'href' => 'http://elgg.org/groups/all/',
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'blog',
+        'text' => elgg_echo('admin:footer:blog'),
+        'href' => 'https://elgg.org/blog/all',
+    ]);
 	
-	return $return;
+    return $return;
 }
 
 /**
@@ -354,148 +354,148 @@ 
  * @since 3.0
  */
 function _elgg_admin_page_menu(\Elgg\Hook $hook) {
-	if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
-		return;
-	}
+    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
+        return;
+    }
 	
-	$return = $hook->getValue();
-
-	// administer
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'dashboard',
-		'href' => 'admin',
-		'text' => elgg_echo('admin:dashboard'),
-		'priority' => 10,
-		'section' => 'administer',
-	]);
+    $return = $hook->getValue();
+
+    // administer
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'dashboard',
+        'href' => 'admin',
+        'text' => elgg_echo('admin:dashboard'),
+        'priority' => 10,
+        'section' => 'administer',
+    ]);
 	
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'plugins',
-		'href' => 'admin/plugins',
-		'text' => elgg_echo('admin:plugins'),
-		'priority' => 30,
-		'section' => 'administer',
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'users',
-		'text' => elgg_echo('admin:users'),
-		'priority' => 40,
-		'section' => 'administer',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'users:online',
-		'text' => elgg_echo('admin:users:online'),
-		'href' => 'admin/users/online',
-		'priority' => 10,
-		'section' => 'administer',
-		'parent_name' => 'users',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'users:admins',
-		'text' => elgg_echo('admin:users:admins'),
-		'href' => 'admin/users/admins',
-		'priority' => 20,
-		'section' => 'administer',
-		'parent_name' => 'users',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'users:newest',
-		'text' => elgg_echo('admin:users:newest'),
-		'href' => 'admin/users/newest',
-		'priority' => 30,
-		'section' => 'administer',
-		'parent_name' => 'users',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'users:add',
-		'text' => elgg_echo('admin:users:add'),
-		'href' => 'admin/users/add',
-		'priority' => 40,
-		'section' => 'administer',
-		'parent_name' => 'users',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'upgrades',
-		'href' => 'admin/upgrades',
-		'text' => elgg_echo('admin:upgrades'),
-		'priority' => 600,
-		'section' => 'administer',
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'plugins',
+        'href' => 'admin/plugins',
+        'text' => elgg_echo('admin:plugins'),
+        'priority' => 30,
+        'section' => 'administer',
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'users',
+        'text' => elgg_echo('admin:users'),
+        'priority' => 40,
+        'section' => 'administer',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'users:online',
+        'text' => elgg_echo('admin:users:online'),
+        'href' => 'admin/users/online',
+        'priority' => 10,
+        'section' => 'administer',
+        'parent_name' => 'users',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'users:admins',
+        'text' => elgg_echo('admin:users:admins'),
+        'href' => 'admin/users/admins',
+        'priority' => 20,
+        'section' => 'administer',
+        'parent_name' => 'users',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'users:newest',
+        'text' => elgg_echo('admin:users:newest'),
+        'href' => 'admin/users/newest',
+        'priority' => 30,
+        'section' => 'administer',
+        'parent_name' => 'users',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'users:add',
+        'text' => elgg_echo('admin:users:add'),
+        'href' => 'admin/users/add',
+        'priority' => 40,
+        'section' => 'administer',
+        'parent_name' => 'users',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'upgrades',
+        'href' => 'admin/upgrades',
+        'text' => elgg_echo('admin:upgrades'),
+        'priority' => 600,
+        'section' => 'administer',
+    ]);
 	
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'administer_utilities',
-		'text' => elgg_echo('admin:administer_utilities'),
-		'priority' => 50,
-		'section' => 'administer',
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'administer_utilities',
+        'text' => elgg_echo('admin:administer_utilities'),
+        'priority' => 50,
+        'section' => 'administer',
+    ]);
 	
-	// configure
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'settings:basic',
-		'href' => 'admin/settings/basic',
-		'text' => elgg_echo('admin:settings:basic'),
-		'priority' => 10,
-		'section' => 'configure',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'settings:advanced',
-		'href' => 'admin/settings/advanced',
-		'text' => elgg_echo('admin:settings:advanced'),
-		'priority' => 20,
-		'section' => 'configure',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'security',
-		'href' => 'admin/security',
-		'text' => elgg_echo('admin:security'),
-		'priority' => 30,
-		'section' => 'configure',
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'configure_utilities',
-		'text' => elgg_echo('admin:configure_utilities'),
-		'priority' => 600,
-		'section' => 'configure',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'configure_utilities:maintenance',
-		'text' => elgg_echo('admin:configure_utilities:maintenance'),
-		'href' => 'admin/configure_utilities/maintenance',
-		'section' => 'configure',
-		'parent_name' => 'configure_utilities',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'configure_utilities:menu_items',
-		'text' => elgg_echo('admin:configure_utilities:menu_items'),
-		'href' => 'admin/configure_utilities/menu_items',
-		'section' => 'configure',
-		'parent_name' => 'configure_utilities',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'configure_utilities:robots',
-		'text' => elgg_echo('admin:configure_utilities:robots'),
-		'href' => 'admin/configure_utilities/robots',
-		'section' => 'configure',
-		'parent_name' => 'configure_utilities',
-	]);
+    // configure
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'settings:basic',
+        'href' => 'admin/settings/basic',
+        'text' => elgg_echo('admin:settings:basic'),
+        'priority' => 10,
+        'section' => 'configure',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'settings:advanced',
+        'href' => 'admin/settings/advanced',
+        'text' => elgg_echo('admin:settings:advanced'),
+        'priority' => 20,
+        'section' => 'configure',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'security',
+        'href' => 'admin/security',
+        'text' => elgg_echo('admin:security'),
+        'priority' => 30,
+        'section' => 'configure',
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'configure_utilities',
+        'text' => elgg_echo('admin:configure_utilities'),
+        'priority' => 600,
+        'section' => 'configure',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'configure_utilities:maintenance',
+        'text' => elgg_echo('admin:configure_utilities:maintenance'),
+        'href' => 'admin/configure_utilities/maintenance',
+        'section' => 'configure',
+        'parent_name' => 'configure_utilities',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'configure_utilities:menu_items',
+        'text' => elgg_echo('admin:configure_utilities:menu_items'),
+        'href' => 'admin/configure_utilities/menu_items',
+        'section' => 'configure',
+        'parent_name' => 'configure_utilities',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'configure_utilities:robots',
+        'text' => elgg_echo('admin:configure_utilities:robots'),
+        'href' => 'admin/configure_utilities/robots',
+        'section' => 'configure',
+        'parent_name' => 'configure_utilities',
+    ]);
 	
-	// information
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'statistics',
-		'href' => 'admin/statistics',
-		'text' => elgg_echo('admin:statistics'),
-		'section' => 'information',
-	]);
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'server',
-		'href' => 'admin/server',
-		'text' => elgg_echo('admin:server'),
-		'section' => 'information',
-	]);
+    // information
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'statistics',
+        'href' => 'admin/statistics',
+        'text' => elgg_echo('admin:statistics'),
+        'section' => 'information',
+    ]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'server',
+        'href' => 'admin/server',
+        'text' => elgg_echo('admin:server'),
+        'section' => 'information',
+    ]);
 		
-	return $return;
+    return $return;
 }
 
 /**
@@ -511,56 +511,56 @@ 
  * @since 3.0
  */
 function _elgg_admin_page_menu_plugin_settings(\Elgg\Hook $hook) {
-	if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
-		return;
-	}
+    if (!elgg_in_context('admin') || !elgg_is_admin_logged_in()) {
+        return;
+    }
 	
-	// plugin settings
-	$active_plugins = elgg_get_plugins('active');
-	if (!$active_plugins) {
-		// nothing added because no items
-		return;
-	}
+    // plugin settings
+    $active_plugins = elgg_get_plugins('active');
+    if (!$active_plugins) {
+        // nothing added because no items
+        return;
+    }
 	
-	$plugins_with_settings = [];
+    $plugins_with_settings = [];
 	
-	foreach ($active_plugins as $plugin) {
-		$plugin_id = $plugin->getID();
+    foreach ($active_plugins as $plugin) {
+        $plugin_id = $plugin->getID();
 		
-		if (!elgg_view_exists("plugins/{$plugin_id}/settings") ) {
-			continue;
-		}
-		$plugin_name = $plugin->getDisplayName();
-		$plugins_with_settings[$plugin_name] = [
-			'name' => $plugin_id,
-			'href' => "admin/plugin_settings/$plugin_id",
-			'text' => $plugin_name,
-			'parent_name' => 'plugin_settings',
-			'section' => 'configure',
-		];
-	}
+        if (!elgg_view_exists("plugins/{$plugin_id}/settings") ) {
+            continue;
+        }
+        $plugin_name = $plugin->getDisplayName();
+        $plugins_with_settings[$plugin_name] = [
+            'name' => $plugin_id,
+            'href' => "admin/plugin_settings/$plugin_id",
+            'text' => $plugin_name,
+            'parent_name' => 'plugin_settings',
+            'section' => 'configure',
+        ];
+    }
 	
-	if (empty($plugins_with_settings)) {
-		return;
-	}
+    if (empty($plugins_with_settings)) {
+        return;
+    }
 
-	$return = $hook->getValue();
+    $return = $hook->getValue();
 	
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'plugin_settings',
-		'text' => elgg_echo('admin:plugin_settings'),
-		'section' => 'configure',
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'plugin_settings',
+        'text' => elgg_echo('admin:plugin_settings'),
+        'section' => 'configure',
+    ]);
 	
-	ksort($plugins_with_settings);
-	$priority = 0;
-	foreach ($plugins_with_settings as $plugin_item) {
-		$priority += 10;
-		$plugin_item['priority'] = $priority;
-		$return[] = \ElggMenuItem::factory($plugin_item);
-	}
+    ksort($plugins_with_settings);
+    $priority = 0;
+    foreach ($plugins_with_settings as $plugin_item) {
+        $priority += 10;
+        $plugin_item['priority'] = $priority;
+        $return[] = \ElggMenuItem::factory($plugin_item);
+    }
 	
-	return $return;
+    return $return;
 }
 
 /**
@@ -572,53 +572,53 @@ 
  * @access private
  */
 function _elgg_admin_page_handler($page) {
-	elgg_admin_gatekeeper();
-	elgg_set_context('admin');
-
-	elgg_unregister_css('elgg');
-	elgg_require_js('elgg/admin');
-
-	// default to dashboard
-	if (!isset($page[0]) || empty($page[0])) {
-		$page = ['dashboard'];
-	}
-
-	// was going to fix this in the page_handler() function but
-	// it's commented to explicitly return a string if there's a trailing /
-	if (empty($page[count($page) - 1])) {
-		array_pop($page);
-	}
-
-	$vars = ['page' => $page];
-
-	// special page for plugin settings since we create the form for them
-	if ($page[0] == 'plugin_settings') {
-		if (isset($page[1]) && (elgg_view_exists("plugins/{$page[1]}/settings"))) {
-			$view = 'admin/plugin_settings';
-			$plugin = elgg_get_plugin_from_id($page[1]);
-			$vars['plugin'] = $plugin;
-
-			$title = elgg_echo("admin:{$page[0]}");
-		} else {
-			forward('', '404');
-		}
-	} else {
-		$view = 'admin/' . implode('/', $page);
-		$title = elgg_echo("admin:{$page[0]}");
-		if (count($page) > 1) {
-			$title .= ' : ' . elgg_echo('admin:' .  implode(':', $page));
-		}
-	}
-
-	// gets content and prevents direct access to 'components' views
-	if ($page[0] == 'components' || !($content = elgg_view($view, $vars))) {
-		$title = elgg_echo('admin:unknown_section');
-		$content = elgg_echo('admin:unknown_section');
-	}
-
-	$body = elgg_view_layout('admin', ['content' => $content, 'title' => $title]);
-	echo elgg_view_page($title, $body, 'admin');
-	return true;
+    elgg_admin_gatekeeper();
+    elgg_set_context('admin');
+
+    elgg_unregister_css('elgg');
+    elgg_require_js('elgg/admin');
+
+    // default to dashboard
+    if (!isset($page[0]) || empty($page[0])) {
+        $page = ['dashboard'];
+    }
+
+    // was going to fix this in the page_handler() function but
+    // it's commented to explicitly return a string if there's a trailing /
+    if (empty($page[count($page) - 1])) {
+        array_pop($page);
+    }
+
+    $vars = ['page' => $page];
+
+    // special page for plugin settings since we create the form for them
+    if ($page[0] == 'plugin_settings') {
+        if (isset($page[1]) && (elgg_view_exists("plugins/{$page[1]}/settings"))) {
+            $view = 'admin/plugin_settings';
+            $plugin = elgg_get_plugin_from_id($page[1]);
+            $vars['plugin'] = $plugin;
+
+            $title = elgg_echo("admin:{$page[0]}");
+        } else {
+            forward('', '404');
+        }
+    } else {
+        $view = 'admin/' . implode('/', $page);
+        $title = elgg_echo("admin:{$page[0]}");
+        if (count($page) > 1) {
+            $title .= ' : ' . elgg_echo('admin:' .  implode(':', $page));
+        }
+    }
+
+    // gets content and prevents direct access to 'components' views
+    if ($page[0] == 'components' || !($content = elgg_view($view, $vars))) {
+        $title = elgg_echo('admin:unknown_section');
+        $content = elgg_echo('admin:unknown_section');
+    }
+
+    $body = elgg_view_layout('admin', ['content' => $content, 'title' => $title]);
+    echo elgg_view_page($title, $body, 'admin');
+    return true;
 }
 
 /**
@@ -638,13 +638,13 @@ 
  * @access private
  */
 function _elgg_admin_markdown_page_handler($pages) {
-	elgg_set_context('admin');
+    elgg_set_context('admin');
 
-	echo elgg_view_resource('admin/plugin_text_file', [
-		'plugin_id' => elgg_extract(0, $pages),
-		'filename' => elgg_extract(1, $pages),
-	]);
-	return true;
+    echo elgg_view_resource('admin/plugin_text_file', [
+        'plugin_id' => elgg_extract(0, $pages),
+        'filename' => elgg_extract(1, $pages),
+    ]);
+    return true;
 }
 
 /**
@@ -653,8 +653,8 @@ 
  * @access private
  */
 function _elgg_robots_page_handler() {
-	echo elgg_view_resource('robots.txt');
-	return true;
+    echo elgg_view_resource('robots.txt');
+    return true;
 }
 
 /**
@@ -663,8 +663,8 @@ 
  * @access private
  */
 function _elgg_phpinfo_page_handler() {
-	echo elgg_view_resource('phpinfo');
-	return true;
+    echo elgg_view_resource('phpinfo');
+    return true;
 }
 
 /**
@@ -676,20 +676,20 @@ 
  * @access private
  */
 function _elgg_admin_maintenance_allow_url($current_url) {
-	$site_path = preg_replace('~^https?~', '', elgg_get_site_url());
-	$current_path = preg_replace('~^https?~', '', $current_url);
-	if (0 === strpos($current_path, $site_path)) {
-		$current_path = ($current_path === $site_path) ? '' : substr($current_path, strlen($site_path));
-	} else {
-		$current_path = false;
-	}
-
-	// allow plugins to control access for specific URLs/paths
-	$params = [
-		'current_path' => $current_path,
-		'current_url' => $current_url,
-	];
-	return (bool) elgg_trigger_plugin_hook('maintenance:allow', 'url', $params, false);
+    $site_path = preg_replace('~^https?~', '', elgg_get_site_url());
+    $current_path = preg_replace('~^https?~', '', $current_url);
+    if (0 === strpos($current_path, $site_path)) {
+        $current_path = ($current_path === $site_path) ? '' : substr($current_path, strlen($site_path));
+    } else {
+        $current_path = false;
+    }
+
+    // allow plugins to control access for specific URLs/paths
+    $params = [
+        'current_path' => $current_path,
+        'current_url' => $current_url,
+    ];
+    return (bool) elgg_trigger_plugin_hook('maintenance:allow', 'url', $params, false);
 }
 
 /**
@@ -698,23 +698,23 @@ 
  * @access private
  */
 function _elgg_admin_maintenance_handler($hook, $type, $info) {
-	if (elgg_is_admin_logged_in()) {
-		return;
-	}
+    if (elgg_is_admin_logged_in()) {
+        return;
+    }
 
-	if ($info['identifier'] == 'action' && $info['segments'][0] == 'login') {
-		return;
-	}
+    if ($info['identifier'] == 'action' && $info['segments'][0] == 'login') {
+        return;
+    }
 
-	if (_elgg_admin_maintenance_allow_url(current_page_url())) {
-		return;
-	}
+    if (_elgg_admin_maintenance_allow_url(current_page_url())) {
+        return;
+    }
 
-	elgg_unregister_plugin_hook_handler('register', 'menu:login', '_elgg_login_menu_setup');
+    elgg_unregister_plugin_hook_handler('register', 'menu:login', '_elgg_login_menu_setup');
 
-	echo elgg_view_resource('maintenance');
+    echo elgg_view_resource('maintenance');
 
-	return false;
+    return false;
 }
 
 /**
@@ -727,34 +727,34 @@ 
  * @return bool
  */
 function _elgg_admin_maintenance_action_check($hook, $type) {
-	if (elgg_is_admin_logged_in()) {
-		return true;
-	}
+    if (elgg_is_admin_logged_in()) {
+        return true;
+    }
 
-	if ($type == 'login') {
-		$username = get_input('username');
+    if ($type == 'login') {
+        $username = get_input('username');
 
-		$user = get_user_by_username($username);
+        $user = get_user_by_username($username);
 
-		if (!$user) {
-			$users = get_user_by_email($username);
-			if ($users) {
-				$user = $users[0];
-			}
-		}
+        if (!$user) {
+            $users = get_user_by_email($username);
+            if ($users) {
+                $user = $users[0];
+            }
+        }
 
-		if ($user && $user->isAdmin()) {
-			return true;
-		}
-	}
+        if ($user && $user->isAdmin()) {
+            return true;
+        }
+    }
 
-	if (_elgg_admin_maintenance_allow_url(current_page_url())) {
-		return true;
-	}
+    if (_elgg_admin_maintenance_allow_url(current_page_url())) {
+        return true;
+    }
 
-	register_error(elgg_echo('actionunauthorized'));
+    register_error(elgg_echo('actionunauthorized'));
 
-	return false;
+    return false;
 }
 
 /**
@@ -768,30 +768,30 @@ 
  * @access private
  */
 function _elgg_add_admin_widgets($event, $type, $user) {
-	elgg_set_ignore_access(true);
-
-	// check if the user already has widgets
-	if (elgg_get_widgets($user->getGUID(), 'admin')) {
-		return true;
-	}
-
-	// In the form column => array of handlers in order, top to bottom
-	$adminWidgets = [
-		1 => ['control_panel', 'admin_welcome'],
-		2 => ['online_users', 'new_users', 'content_stats'],
-	];
-
-	foreach ($adminWidgets as $column => $handlers) {
-		foreach ($handlers as $position => $handler) {
-			$guid = elgg_create_widget($user->getGUID(), $handler, 'admin');
-			if ($guid) {
-				$widget = get_entity($guid);
-				/* @var \ElggWidget $widget */
-				$widget->move($column, $position);
-			}
-		}
-	}
-	elgg_set_ignore_access(false);
+    elgg_set_ignore_access(true);
+
+    // check if the user already has widgets
+    if (elgg_get_widgets($user->getGUID(), 'admin')) {
+        return true;
+    }
+
+    // In the form column => array of handlers in order, top to bottom
+    $adminWidgets = [
+        1 => ['control_panel', 'admin_welcome'],
+        2 => ['online_users', 'new_users', 'content_stats'],
+    ];
+
+    foreach ($adminWidgets as $column => $handlers) {
+        foreach ($handlers as $position => $handler) {
+            $guid = elgg_create_widget($user->getGUID(), $handler, 'admin');
+            if ($guid) {
+                $widget = get_entity($guid);
+                /* @var \ElggWidget $widget */
+                $widget->move($column, $position);
+            }
+        }
+    }
+    elgg_set_ignore_access(false);
 }
 
 /**
@@ -806,39 +806,39 @@ 
  */
 function _elgg_admin_get_admin_subscribers_admin_action($hook, $type, $return_value, $params) {
 	
-	if (!_elgg_config()->security_notify_admins) {
-		return;
-	}
+    if (!_elgg_config()->security_notify_admins) {
+        return;
+    }
 	
-	$event = elgg_extract('event', $params);
-	if (!($event instanceof \Elgg\Notifications\Event)) {
-		return;
-	}
+    $event = elgg_extract('event', $params);
+    if (!($event instanceof \Elgg\Notifications\Event)) {
+        return;
+    }
 	
-	if (!in_array($event->getAction(), ['make_admin', 'remove_admin'])) {
-		return;
-	}
+    if (!in_array($event->getAction(), ['make_admin', 'remove_admin'])) {
+        return;
+    }
 	
-	$user = $event->getObject();
-	if (!($user instanceof \ElggUser)) {
-		return;
-	}
+    $user = $event->getObject();
+    if (!($user instanceof \ElggUser)) {
+        return;
+    }
 	
-	/* @var $admin_batch \Elgg\BatchResult */
-	$admin_batch = elgg_get_admins([
-		'limit' => false,
-		'wheres' => [
-			"e.guid <> {$user->getGUID()}",
-		],
-		'batch' => true,
-	]);
+    /* @var $admin_batch \Elgg\BatchResult */
+    $admin_batch = elgg_get_admins([
+        'limit' => false,
+        'wheres' => [
+            "e.guid <> {$user->getGUID()}",
+        ],
+        'batch' => true,
+    ]);
 	
-	/* @var $admin \ElggUser */
-	foreach ($admin_batch as $admin) {
-		$return_value[$admin->getGUID()] = ['email'];
-	}
+    /* @var $admin \ElggUser */
+    foreach ($admin_batch as $admin) {
+        $return_value[$admin->getGUID()] = ['email'];
+    }
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -853,39 +853,39 @@ 
  */
 function _elgg_admin_prepare_admin_notification_make_admin($hook, $type, $return_value, $params) {
 	
-	if (!($return_value instanceof \Elgg\Notifications\Notification)) {
-		return;
-	}
+    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
+        return;
+    }
 	
-	$recipient = elgg_extract('recipient', $params);
-	$object = elgg_extract('object', $params);
-	$actor = elgg_extract('sender', $params);
-	$language = elgg_extract('language', $params);
+    $recipient = elgg_extract('recipient', $params);
+    $object = elgg_extract('object', $params);
+    $actor = elgg_extract('sender', $params);
+    $language = elgg_extract('language', $params);
 	
-	if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
-		return;
-	}
+    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
+        return;
+    }
 	
-	if ($recipient->getGUID() === $object->getGUID()) {
-		// recipient is the user being acted on, this is handled elsewhere
-		return;
-	}
+    if ($recipient->getGUID() === $object->getGUID()) {
+        // recipient is the user being acted on, this is handled elsewhere
+        return;
+    }
 	
-	$site = elgg_get_site_entity();
+    $site = elgg_get_site_entity();
 	
-	$return_value->subject = elgg_echo('admin:notification:make_admin:admin:subject', [$site->name], $language);
-	$return_value->body = elgg_echo('admin:notification:make_admin:admin:body', [
-		$recipient->name,
-		$actor->name,
-		$object->name,
-		$site->name,
-		$object->getURL(),
-		$site->getURL(),
-	], $language);
-
-	$return_value->url = elgg_normalize_url('admin/users/admins');
+    $return_value->subject = elgg_echo('admin:notification:make_admin:admin:subject', [$site->name], $language);
+    $return_value->body = elgg_echo('admin:notification:make_admin:admin:body', [
+        $recipient->name,
+        $actor->name,
+        $object->name,
+        $site->name,
+        $object->getURL(),
+        $site->getURL(),
+    ], $language);
+
+    $return_value->url = elgg_normalize_url('admin/users/admins');
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -900,39 +900,39 @@ 
  */
 function _elgg_admin_prepare_admin_notification_remove_admin($hook, $type, $return_value, $params) {
 	
-	if (!($return_value instanceof \Elgg\Notifications\Notification)) {
-		return;
-	}
+    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
+        return;
+    }
 	
-	$recipient = elgg_extract('recipient', $params);
-	$object = elgg_extract('object', $params);
-	$actor = elgg_extract('sender', $params);
-	$language = elgg_extract('language', $params);
+    $recipient = elgg_extract('recipient', $params);
+    $object = elgg_extract('object', $params);
+    $actor = elgg_extract('sender', $params);
+    $language = elgg_extract('language', $params);
 	
-	if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
-		return;
-	}
+    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
+        return;
+    }
 	
-	if ($recipient->getGUID() === $object->getGUID()) {
-		// recipient is the user being acted on, this is handled elsewhere
-		return;
-	}
+    if ($recipient->getGUID() === $object->getGUID()) {
+        // recipient is the user being acted on, this is handled elsewhere
+        return;
+    }
 	
-	$site = elgg_get_site_entity();
+    $site = elgg_get_site_entity();
 	
-	$return_value->subject = elgg_echo('admin:notification:remove_admin:admin:subject', [$site->name], $language);
-	$return_value->body = elgg_echo('admin:notification:remove_admin:admin:body', [
-		$recipient->name,
-		$actor->name,
-		$object->name,
-		$site->name,
-		$object->getURL(),
-		$site->getURL(),
-	], $language);
-
-	$return_value->url = elgg_normalize_url('admin/users/admins');
+    $return_value->subject = elgg_echo('admin:notification:remove_admin:admin:subject', [$site->name], $language);
+    $return_value->body = elgg_echo('admin:notification:remove_admin:admin:body', [
+        $recipient->name,
+        $actor->name,
+        $object->name,
+        $site->name,
+        $object->getURL(),
+        $site->getURL(),
+    ], $language);
+
+    $return_value->url = elgg_normalize_url('admin/users/admins');
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -947,27 +947,27 @@ 
  */
 function _elgg_admin_get_user_subscriber_admin_action($hook, $type, $return_value, $params) {
 	
-	if (!_elgg_config()->security_notify_user_admin) {
-		return;
-	}
+    if (!_elgg_config()->security_notify_user_admin) {
+        return;
+    }
 	
-	$event = elgg_extract('event', $params);
-	if (!($event instanceof \Elgg\Notifications\Event)) {
-		return;
-	}
+    $event = elgg_extract('event', $params);
+    if (!($event instanceof \Elgg\Notifications\Event)) {
+        return;
+    }
 	
-	if (!in_array($event->getAction(), ['make_admin', 'remove_admin'])) {
-		return;
-	}
+    if (!in_array($event->getAction(), ['make_admin', 'remove_admin'])) {
+        return;
+    }
 	
-	$user = $event->getObject();
-	if (!($user instanceof \ElggUser)) {
-		return;
-	}
+    $user = $event->getObject();
+    if (!($user instanceof \ElggUser)) {
+        return;
+    }
 	
-	$return_value[$user->getGUID()] = ['email'];
+    $return_value[$user->getGUID()] = ['email'];
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -982,37 +982,37 @@ 
  */
 function _elgg_admin_prepare_user_notification_make_admin($hook, $type, $return_value, $params) {
 	
-	if (!($return_value instanceof \Elgg\Notifications\Notification)) {
-		return;
-	}
+    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
+        return;
+    }
 	
-	$recipient = elgg_extract('recipient', $params);
-	$object = elgg_extract('object', $params);
-	$actor = elgg_extract('sender', $params);
-	$language = elgg_extract('language', $params);
+    $recipient = elgg_extract('recipient', $params);
+    $object = elgg_extract('object', $params);
+    $actor = elgg_extract('sender', $params);
+    $language = elgg_extract('language', $params);
 	
-	if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
-		return;
-	}
+    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
+        return;
+    }
 	
-	if ($recipient->getGUID() !== $object->getGUID()) {
-		// recipient is some other user, this is handled elsewhere
-		return;
-	}
+    if ($recipient->getGUID() !== $object->getGUID()) {
+        // recipient is some other user, this is handled elsewhere
+        return;
+    }
 	
-	$site = elgg_get_site_entity();
+    $site = elgg_get_site_entity();
 	
-	$return_value->subject = elgg_echo('admin:notification:make_admin:user:subject', [$site->name], $language);
-	$return_value->body = elgg_echo('admin:notification:make_admin:user:body', [
-		$recipient->name,
-		$actor->name,
-		$site->name,
-		$site->getURL(),
-	], $language);
-
-	$return_value->url = elgg_normalize_url('admin');
+    $return_value->subject = elgg_echo('admin:notification:make_admin:user:subject', [$site->name], $language);
+    $return_value->body = elgg_echo('admin:notification:make_admin:user:body', [
+        $recipient->name,
+        $actor->name,
+        $site->name,
+        $site->getURL(),
+    ], $language);
+
+    $return_value->url = elgg_normalize_url('admin');
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
@@ -1027,42 +1027,42 @@ 
  */
 function _elgg_admin_prepare_user_notification_remove_admin($hook, $type, $return_value, $params) {
 	
-	if (!($return_value instanceof \Elgg\Notifications\Notification)) {
-		return;
-	}
+    if (!($return_value instanceof \Elgg\Notifications\Notification)) {
+        return;
+    }
 	
-	$recipient = elgg_extract('recipient', $params);
-	$object = elgg_extract('object', $params);
-	$actor = elgg_extract('sender', $params);
-	$language = elgg_extract('language', $params);
+    $recipient = elgg_extract('recipient', $params);
+    $object = elgg_extract('object', $params);
+    $actor = elgg_extract('sender', $params);
+    $language = elgg_extract('language', $params);
 	
-	if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
-		return;
-	}
+    if (!($recipient instanceof ElggUser) || !($object instanceof ElggUser) || !($actor instanceof ElggUser)) {
+        return;
+    }
 	
-	if ($recipient->getGUID() !== $object->getGUID()) {
-		// recipient is some other user, this is handled elsewhere
-		return;
-	}
+    if ($recipient->getGUID() !== $object->getGUID()) {
+        // recipient is some other user, this is handled elsewhere
+        return;
+    }
 	
-	$site = elgg_get_site_entity();
+    $site = elgg_get_site_entity();
 	
-	$return_value->subject = elgg_echo('admin:notification:remove_admin:user:subject', [$site->name], $language);
-	$return_value->body = elgg_echo('admin:notification:remove_admin:user:body', [
-		$recipient->name,
-		$actor->name,
-		$site->name,
-		$site->getURL(),
-	], $language);
-
-	$return_value->url = false;
+    $return_value->subject = elgg_echo('admin:notification:remove_admin:user:subject', [$site->name], $language);
+    $return_value->body = elgg_echo('admin:notification:remove_admin:user:body', [
+        $recipient->name,
+        $actor->name,
+        $site->name,
+        $site->getURL(),
+    ], $language);
+
+    $return_value->url = false;
 	
-	return $return_value;
+    return $return_value;
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('init', 'system', '_elgg_admin_init');
+    $events->registerHandler('init', 'system', '_elgg_admin_init');
 };

engine/lib/annotations.php

Doc Comments +2 added lines, -2 removed lines

@@ -31,7 +31,7 @@ 
  *
  * @param int $id The id of the annotation object being retrieved.
  *
- * @return \ElggAnnotation|false
+ * @return ElggExtender
  */
 function elgg_get_annotation_from_id($id) {
 	return _elgg_services()->annotations->get($id);
@@ -329,7 +329,7 @@ 
  * @param string $hook
  * @param string $type
  * @param array  $tests
- * @return array
+ * @return string[]
  * @access private
  */
 function _elgg_annotations_test($hook, $type, $tests) {

Indentation +45 added lines, -45 removed lines

@@ -18,12 +18,12 @@ 
  * @access private
  */
 function row_to_elggannotation($row) {
-	if (!($row instanceof \stdClass)) {
-		// @todo should throw in this case?
-		return $row;
-	}
+    if (!($row instanceof \stdClass)) {
+        // @todo should throw in this case?
+        return $row;
+    }
 
-	return new \ElggAnnotation($row);
+    return new \ElggAnnotation($row);
 }
 
 /**
@@ -36,7 +36,7 @@ 
  * @return \ElggAnnotation|false
  */
 function elgg_get_annotation_from_id($id) {
-	return _elgg_services()->annotations->get($id);
+    return _elgg_services()->annotations->get($id);
 }
 
 /**
@@ -46,7 +46,7 @@ 
  * @return bool
  */
 function elgg_delete_annotation_by_id($id) {
-	return _elgg_services()->annotations->delete($id);
+    return _elgg_services()->annotations->delete($id);
 }
 
 /**
@@ -62,9 +62,9 @@ 
  * @return int|bool id on success or false on failure
  */
 function create_annotation($entity_guid, $name, $value, $value_type = '',
-		$owner_guid = 0, $access_id = ACCESS_PRIVATE) {
-	return _elgg_services()->annotations->create(
-		$entity_guid, $name, $value, $value_type, $owner_guid, $access_id);
+        $owner_guid = 0, $access_id = ACCESS_PRIVATE) {
+    return _elgg_services()->annotations->create(
+        $entity_guid, $name, $value, $value_type, $owner_guid, $access_id);
 }
 
 /**
@@ -80,7 +80,7 @@ 
  * @return bool
  */
 function update_annotation($annotation_id, $name, $value, $value_type, $owner_guid, $access_id) {
-	return _elgg_services()->annotations->update($annotation_id, $name, $value, $value_type, $owner_guid, $access_id);
+    return _elgg_services()->annotations->update($annotation_id, $name, $value, $value_type, $owner_guid, $access_id);
 }
 
 /**
@@ -113,7 +113,7 @@ 
  * @since 1.8.0
  */
 function elgg_get_annotations(array $options = []) {
-	return _elgg_services()->annotations->find($options);
+    return _elgg_services()->annotations->find($options);
 }
 
 /**
@@ -126,15 +126,15 @@ 
  * @since 1.8.0
  */
 function elgg_list_annotations($options) {
-	$defaults = [
-		'limit' => 25,
-		'offset' => (int) max(get_input('annoff', 0), 0),
-		'no_results' => '',
-	];
+    $defaults = [
+        'limit' => 25,
+        'offset' => (int) max(get_input('annoff', 0), 0),
+        'no_results' => '',
+    ];
 
-	$options = array_merge($defaults, $options);
+    $options = array_merge($defaults, $options);
 
-	return elgg_list_entities($options, 'elgg_get_annotations', 'elgg_view_annotation_list');
+    return elgg_list_entities($options, 'elgg_get_annotations', 'elgg_view_annotation_list');
 }
 
 /**
@@ -149,7 +149,7 @@ 
  * @since 1.8.0
  */
 function elgg_delete_annotations(array $options) {
-	return _elgg_services()->annotations->deleteAll($options);
+    return _elgg_services()->annotations->deleteAll($options);
 }
 
 /**
@@ -162,7 +162,7 @@ 
  * @since 1.8.0
  */
 function elgg_disable_annotations(array $options) {
-	return _elgg_services()->annotations->disableAll($options);
+    return _elgg_services()->annotations->disableAll($options);
 }
 
 /**
@@ -178,7 +178,7 @@ 
  * @since 1.8.0
  */
 function elgg_enable_annotations(array $options) {
-	return _elgg_services()->annotations->enableAll($options);
+    return _elgg_services()->annotations->enableAll($options);
 }
 
 /**
@@ -218,7 +218,7 @@ 
  * @since 1.7.0
  */
 function elgg_get_entities_from_annotations(array $options = []) {
-	return _elgg_services()->annotations->getEntities($options);
+    return _elgg_services()->annotations->getEntities($options);
 }
 
 /**
@@ -232,7 +232,7 @@ 
  * @return string
  */
 function elgg_list_entities_from_annotations($options = []) {
-	return elgg_list_entities($options, 'elgg_get_entities_from_annotations');
+    return elgg_list_entities($options, 'elgg_get_entities_from_annotations');
 }
 
 /**
@@ -268,7 +268,7 @@ 
  * @see elgg_get_entities_from_annotations()
  */
 function elgg_get_entities_from_annotation_calculation($options) {
-	return _elgg_services()->annotations->getEntitiesFromCalculation($options);
+    return _elgg_services()->annotations->getEntitiesFromCalculation($options);
 }
 
 /**
@@ -281,13 +281,13 @@ 
  * @return string
  */
 function elgg_list_entities_from_annotation_calculation($options) {
-	$defaults = [
-		'calculation' => 'sum',
-		'order_by' => 'annotation_calculation desc'
-	];
-	$options = array_merge($defaults, $options);
+    $defaults = [
+        'calculation' => 'sum',
+        'order_by' => 'annotation_calculation desc'
+    ];
+    $options = array_merge($defaults, $options);
 
-	return elgg_list_entities($options, 'elgg_get_entities_from_annotation_calculation');
+    return elgg_list_entities($options, 'elgg_get_entities_from_annotation_calculation');
 }
 
 /**
@@ -301,7 +301,7 @@ 
  * @since 1.8.0
  */
 function elgg_annotation_exists($entity_guid, $annotation_type, $owner_guid = null) {
-	return _elgg_services()->annotations->exists($entity_guid, $annotation_type, $owner_guid);
+    return _elgg_services()->annotations->exists($entity_guid, $annotation_type, $owner_guid);
 }
 
 /**
@@ -315,14 +315,14 @@ 
  * @access private
  */
 function _elgg_set_comment_url($hook, $type, $url, $params) {
-	$annotation = $params['extender'];
-	/* @var \ElggExtender $annotation */
-	if ($annotation->getSubtype() == 'generic_comment') {
-		$entity = $annotation->getEntity();
-		if ($entity) {
-			return $entity->getURL() . '#item-annotation-' . $annotation->id;
-		}
-	}
+    $annotation = $params['extender'];
+    /* @var \ElggExtender $annotation */
+    if ($annotation->getSubtype() == 'generic_comment') {
+        $entity = $annotation->getEntity();
+        if ($entity) {
+            return $entity->getURL() . '#item-annotation-' . $annotation->id;
+        }
+    }
 }
 
 /**
@@ -335,8 +335,8 @@ 
  * @access private
  */
 function _elgg_annotations_test($hook, $type, $tests) {
-	$tests[] = Paths::project() . 'engine/tests/ElggCoreAnnotationAPITest.php';
-	return $tests;
+    $tests[] = Paths::project() . 'engine/tests/ElggCoreAnnotationAPITest.php';
+    return $tests;
 }
 
 /**
@@ -344,13 +344,13 @@ 
  * @access private
  */
 function _elgg_annotations_init() {
-	elgg_register_plugin_hook_handler('extender:url', 'annotation', '_elgg_set_comment_url');
-	elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_annotations_test');
+    elgg_register_plugin_hook_handler('extender:url', 'annotation', '_elgg_set_comment_url');
+    elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_annotations_test');
 }
 
 /**
  * @see \Elgg\Application::loadCore Do not do work here. Just register for events.
  */
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('init', 'system', '_elgg_annotations_init');
+    $events->registerHandler('init', 'system', '_elgg_annotations_init');
 };

Spacing +2 added lines, -2 removed lines

@@ -320,7 +320,7 @@ 
 	if ($annotation->getSubtype() == 'generic_comment') {
 		$entity = $annotation->getEntity();
 		if ($entity) {
-			return $entity->getURL() . '#item-annotation-' . $annotation->id;
+			return $entity->getURL().'#item-annotation-'.$annotation->id;
 		}
 	}
 }
@@ -335,7 +335,7 @@ 
  * @access private
  */
 function _elgg_annotations_test($hook, $type, $tests) {
-	$tests[] = Paths::project() . 'engine/tests/ElggCoreAnnotationAPITest.php';
+	$tests[] = Paths::project().'engine/tests/ElggCoreAnnotationAPITest.php';
 	return $tests;
 }