Elgg / Elgg

engine/classes/Elgg/AttributeLoader.php

Doc Comments +2 added lines, -2 removed lines

@@ -131,7 +131,7 @@ 
 	 * Get primary attributes missing that are missing
 	 *
 	 * @param \stdClass $row Database row
-	 * @return array
+	 * @return boolean
 	 */
 	protected function isMissingPrimaries($row) {
 		return array_diff(self::$primary_attr_names, array_keys($row)) !== array();
@@ -141,7 +141,7 @@ 
 	 * Get secondary attributes that are missing
 	 *
 	 * @param \stdClass $row Database row
-	 * @return array
+	 * @return boolean
 	 */
 	protected function isMissingSecondaries($row) {
 		return array_diff($this->secondary_attr_names, array_keys($row)) !== array();

Indentation +269 added lines, -269 removed lines

@@ -11,275 +11,275 @@
  */
 class AttributeLoader {
 
-	/**
-	 * @var array names of attributes in all entities
-	 *
-	 * @todo require this to be injected and get it from \ElggEntity
-	 */
-	protected static $primary_attr_names = array(
-		'guid',
-		'type',
-		'subtype',
-		'owner_guid',
-		'container_guid',
-		'site_guid',
-		'access_id',
-		'time_created',
-		'time_updated',
-		'last_action',
-		'enabled',
-	);
-
-	/**
-	 * @var array names of attributes in all entities that should be stored as integer values
-	 */
-	protected static $integer_attr_names = array(
-		'guid',
-		'owner_guid',
-		'container_guid',
-		'site_guid',
-		'access_id',
-		'time_created',
-		'time_updated',
-		'last_action',
-		// \ElggUser
-		'prev_last_action',
-		'last_login',
-		'prev_last_login'
-	);
-
-	/**
-	 * @var array names of attributes in all entities that should be stored as null if empty
-	 */
-	protected static $null_attr_names = array(
-		'name',
-		'title',
-		'description',
-		'url',
-	);
-
-	/**
-	 * @var array names of secondary attributes required for the entity
-	 */
-	protected $secondary_attr_names = array();
-
-	/**
-	 * @var string entity type (not class) required for fetched primaries
-	 */
-	protected $required_type;
-
-	/**
-	 * @var array
-	 */
-	protected $initialized_attributes;
-
-	/**
-	 * @var string class of object being loaded
-	 */
-	protected $class;
-
-	/**
-	 * @var bool should access control be considered when fetching entity?
-	 */
-	public $requires_access_control = true;
-
-	/**
-	 * @var callable function used to load attributes from {prefix}entities table
-	 */
-	public $primary_loader = 'get_entity_as_row';
-
-	/**
-	 * @var callable function used to load attributes from secondary table
-	 */
-	public $secondary_loader = '';
-
-	/**
-	 * @var callable function used to load all necessary attributes
-	 */
-	public $full_loader = '';
-
-	/**
-	 * @var array retrieved values that are not attributes
-	 */
-	protected $additional_select_values = array();
-
-	/**
-	 * Constructor
-	 *
-	 * @param string $class             class of object being loaded
-	 * @param string $required_type     entity type this is being used to populate
-	 * @param array  $initialized_attrs attributes after initializeAttributes() has been run
-	 * @throws \InvalidArgumentException
-	 */
-	public function __construct($class, $required_type, array $initialized_attrs) {
-		if (!is_string($class)) {
-			throw new \InvalidArgumentException('$class must be a class name.');
-		}
-		$this->class = $class;
-
-		if (!is_string($required_type)) {
-			throw new \InvalidArgumentException('$requiredType must be a system entity type.');
-		}
-		$this->required_type = $required_type;
-
-		$this->initialized_attributes = $initialized_attrs;
-		$all_attr_names = array_keys($initialized_attrs);
-		$this->secondary_attr_names = array_diff($all_attr_names, self::$primary_attr_names);
-	}
-
-	/**
-	 * Get primary attributes missing that are missing
-	 *
-	 * @param \stdClass $row Database row
-	 * @return array
-	 */
-	protected function isMissingPrimaries($row) {
-		return array_diff(self::$primary_attr_names, array_keys($row)) !== array();
-	}
-
-	/**
-	 * Get secondary attributes that are missing
-	 *
-	 * @param \stdClass $row Database row
-	 * @return array
-	 */
-	protected function isMissingSecondaries($row) {
-		return array_diff($this->secondary_attr_names, array_keys($row)) !== array();
-	}
-
-	/**
-	 * Check that the type is correct
-	 *
-	 * @param \stdClass $row Database row
-	 * @return void
-	 * @throws \InvalidClassException
-	 */
-	protected function checkType($row) {
-		if ($row['type'] !== $this->required_type) {
-			$msg = "GUID:" . $row['guid'] . " is not a valid " . $this->class;
-			throw new \InvalidClassException($msg);
-		}
-	}
-
-	/**
-	 * Get values selected from the database that are not attributes
-	 *
-	 * @return array
-	 */
-	public function getAdditionalSelectValues() {
-		return $this->additional_select_values;
-	}
+    /**
+     * @var array names of attributes in all entities
+     *
+     * @todo require this to be injected and get it from \ElggEntity
+     */
+    protected static $primary_attr_names = array(
+        'guid',
+        'type',
+        'subtype',
+        'owner_guid',
+        'container_guid',
+        'site_guid',
+        'access_id',
+        'time_created',
+        'time_updated',
+        'last_action',
+        'enabled',
+    );
+
+    /**
+     * @var array names of attributes in all entities that should be stored as integer values
+     */
+    protected static $integer_attr_names = array(
+        'guid',
+        'owner_guid',
+        'container_guid',
+        'site_guid',
+        'access_id',
+        'time_created',
+        'time_updated',
+        'last_action',
+        // \ElggUser
+        'prev_last_action',
+        'last_login',
+        'prev_last_login'
+    );
+
+    /**
+     * @var array names of attributes in all entities that should be stored as null if empty
+     */
+    protected static $null_attr_names = array(
+        'name',
+        'title',
+        'description',
+        'url',
+    );
+
+    /**
+     * @var array names of secondary attributes required for the entity
+     */
+    protected $secondary_attr_names = array();
+
+    /**
+     * @var string entity type (not class) required for fetched primaries
+     */
+    protected $required_type;
+
+    /**
+     * @var array
+     */
+    protected $initialized_attributes;
+
+    /**
+     * @var string class of object being loaded
+     */
+    protected $class;
+
+    /**
+     * @var bool should access control be considered when fetching entity?
+     */
+    public $requires_access_control = true;
+
+    /**
+     * @var callable function used to load attributes from {prefix}entities table
+     */
+    public $primary_loader = 'get_entity_as_row';
+
+    /**
+     * @var callable function used to load attributes from secondary table
+     */
+    public $secondary_loader = '';
+
+    /**
+     * @var callable function used to load all necessary attributes
+     */
+    public $full_loader = '';
+
+    /**
+     * @var array retrieved values that are not attributes
+     */
+    protected $additional_select_values = array();
+
+    /**
+     * Constructor
+     *
+     * @param string $class             class of object being loaded
+     * @param string $required_type     entity type this is being used to populate
+     * @param array  $initialized_attrs attributes after initializeAttributes() has been run
+     * @throws \InvalidArgumentException
+     */
+    public function __construct($class, $required_type, array $initialized_attrs) {
+        if (!is_string($class)) {
+            throw new \InvalidArgumentException('$class must be a class name.');
+        }
+        $this->class = $class;
+
+        if (!is_string($required_type)) {
+            throw new \InvalidArgumentException('$requiredType must be a system entity type.');
+        }
+        $this->required_type = $required_type;
+
+        $this->initialized_attributes = $initialized_attrs;
+        $all_attr_names = array_keys($initialized_attrs);
+        $this->secondary_attr_names = array_diff($all_attr_names, self::$primary_attr_names);
+    }
+
+    /**
+     * Get primary attributes missing that are missing
+     *
+     * @param \stdClass $row Database row
+     * @return array
+     */
+    protected function isMissingPrimaries($row) {
+        return array_diff(self::$primary_attr_names, array_keys($row)) !== array();
+    }
+
+    /**
+     * Get secondary attributes that are missing
+     *
+     * @param \stdClass $row Database row
+     * @return array
+     */
+    protected function isMissingSecondaries($row) {
+        return array_diff($this->secondary_attr_names, array_keys($row)) !== array();
+    }
+
+    /**
+     * Check that the type is correct
+     *
+     * @param \stdClass $row Database row
+     * @return void
+     * @throws \InvalidClassException
+     */
+    protected function checkType($row) {
+        if ($row['type'] !== $this->required_type) {
+            $msg = "GUID:" . $row['guid'] . " is not a valid " . $this->class;
+            throw new \InvalidClassException($msg);
+        }
+    }
+
+    /**
+     * Get values selected from the database that are not attributes
+     *
+     * @return array
+     */
+    public function getAdditionalSelectValues() {
+        return $this->additional_select_values;
+    }
 	
-	/**
-	 * Get all required attributes for the entity, validating any that are passed in. Returns empty array
-	 * if can't be loaded (Check $failure_reason).
-	 *
-	 * This function splits loading between "primary" attributes (those in {prefix}entities table) and
-	 * "secondary" attributes (e.g. those in {prefix}objects_entity), but can load all at once if a
-	 * combined loader is available.
-	 *
-	 * @param mixed $row a row loaded from DB (array or \stdClass) or a GUID
-	 * @return array will be empty if failed to load all attributes (access control or entity doesn't exist)
-	 *
-	 * @throws \InvalidArgumentException|\LogicException|\IncompleteEntityException
-	 */
-	public function getRequiredAttributes($row) {
-		if (!is_array($row) && !($row instanceof \stdClass)) {
-			// assume row is the GUID
-			$row = array('guid' => $row);
-		}
-		$row = (array) $row;
-		if (empty($row['guid'])) {
-			throw new \InvalidArgumentException('$row must be or contain a GUID');
-		}
-
-		$was_missing_primaries = $this->isMissingPrimaries($row);
-		$was_missing_secondaries = $this->isMissingSecondaries($row);
-
-		// some types have a function to load all attributes at once, it should be faster
-		if (($was_missing_primaries || $was_missing_secondaries) && is_callable($this->full_loader)) {
-			$fetched = (array) call_user_func($this->full_loader, $row['guid']);
-			if (!$fetched) {
-				return array();
-			}
-			$row = array_merge($row, $fetched);
-			$this->checkType($row);
-		} else {
-			if ($was_missing_primaries) {
-				if (!is_callable($this->primary_loader)) {
-					throw new \LogicException('Primary attribute loader must be callable');
-				}
-				if ($this->requires_access_control) {
-					$fetched = (array) call_user_func($this->primary_loader, $row['guid']);
-				} else {
-					$ignoring_access = elgg_set_ignore_access();
-					$fetched = (array) call_user_func($this->primary_loader, $row['guid']);
-					elgg_set_ignore_access($ignoring_access);
-				}
-				if (!$fetched) {
-					return array();
-				}
-				$row = array_merge($row, $fetched);
-			}
-
-			// We must test type before trying to load the secondaries so that InvalidClassException
-			// gets thrown. Otherwise the secondary loader will fail and return false.
-			$this->checkType($row);
-
-			if ($was_missing_secondaries) {
-				if (!is_callable($this->secondary_loader)) {
-					throw new \LogicException('Secondary attribute loader must be callable');
-				}
-				$fetched = (array) call_user_func($this->secondary_loader, $row['guid']);
-				if (!$fetched) {
-					throw new \IncompleteEntityException("Secondary loader failed to return row for {$row['guid']}");
-				}
-				$row = array_merge($row, $fetched);
-			}
-		}
-
-		$row = $this->filterAddedColumns($row);
-
-		$row['subtype'] = (int)$row['subtype'];
-
-		// set to null when reading empty value, to match default empty value; See #5456
-		foreach (self::$null_attr_names as $key) {
-			if (isset($row[$key]) && !$row[$key]) {
-				$row[$key] = null;
-			}
-		}
-
-		// Note: If there are still missing attributes, we're running on a 1.7 or earlier schema. We let
-		// this pass so the upgrades can run.
-
-		// guid needs to be an int  https://github.com/elgg/elgg/issues/4111
-		foreach (self::$integer_attr_names as $key) {
-			if (isset($row[$key])) {
-				$row[$key] = (int) $row[$key];
-			}
-		}
-		return $row;
-	}
-
-	/**
-	 * Filter non-attribute keys into $this->additional_select_values
-	 *
-	 * @param array $row All columns from the query
-	 * @return array Columns acceptable for the entity's attributes
-	 */
-	protected function filterAddedColumns($row) {
-		// make an array with keys as acceptable attribute names
-		$acceptable_attrs = self::$primary_attr_names;
-		array_splice($acceptable_attrs, count($acceptable_attrs), 0, $this->secondary_attr_names);
-		$acceptable_attrs = array_combine($acceptable_attrs, $acceptable_attrs);
-
-		foreach ($row as $key => $val) {
-			if (!isset($acceptable_attrs[$key])) {
-				$this->additional_select_values[$key] = $val;
-				unset($row[$key]);
-			}
-		}
-		return $row;
-	}
+    /**
+     * Get all required attributes for the entity, validating any that are passed in. Returns empty array
+     * if can't be loaded (Check $failure_reason).
+     *
+     * This function splits loading between "primary" attributes (those in {prefix}entities table) and
+     * "secondary" attributes (e.g. those in {prefix}objects_entity), but can load all at once if a
+     * combined loader is available.
+     *
+     * @param mixed $row a row loaded from DB (array or \stdClass) or a GUID
+     * @return array will be empty if failed to load all attributes (access control or entity doesn't exist)
+     *
+     * @throws \InvalidArgumentException|\LogicException|\IncompleteEntityException
+     */
+    public function getRequiredAttributes($row) {
+        if (!is_array($row) && !($row instanceof \stdClass)) {
+            // assume row is the GUID
+            $row = array('guid' => $row);
+        }
+        $row = (array) $row;
+        if (empty($row['guid'])) {
+            throw new \InvalidArgumentException('$row must be or contain a GUID');
+        }
+
+        $was_missing_primaries = $this->isMissingPrimaries($row);
+        $was_missing_secondaries = $this->isMissingSecondaries($row);
+
+        // some types have a function to load all attributes at once, it should be faster
+        if (($was_missing_primaries || $was_missing_secondaries) && is_callable($this->full_loader)) {
+            $fetched = (array) call_user_func($this->full_loader, $row['guid']);
+            if (!$fetched) {
+                return array();
+            }
+            $row = array_merge($row, $fetched);
+            $this->checkType($row);
+        } else {
+            if ($was_missing_primaries) {
+                if (!is_callable($this->primary_loader)) {
+                    throw new \LogicException('Primary attribute loader must be callable');
+                }
+                if ($this->requires_access_control) {
+                    $fetched = (array) call_user_func($this->primary_loader, $row['guid']);
+                } else {
+                    $ignoring_access = elgg_set_ignore_access();
+                    $fetched = (array) call_user_func($this->primary_loader, $row['guid']);
+                    elgg_set_ignore_access($ignoring_access);
+                }
+                if (!$fetched) {
+                    return array();
+                }
+                $row = array_merge($row, $fetched);
+            }
+
+            // We must test type before trying to load the secondaries so that InvalidClassException
+            // gets thrown. Otherwise the secondary loader will fail and return false.
+            $this->checkType($row);
+
+            if ($was_missing_secondaries) {
+                if (!is_callable($this->secondary_loader)) {
+                    throw new \LogicException('Secondary attribute loader must be callable');
+                }
+                $fetched = (array) call_user_func($this->secondary_loader, $row['guid']);
+                if (!$fetched) {
+                    throw new \IncompleteEntityException("Secondary loader failed to return row for {$row['guid']}");
+                }
+                $row = array_merge($row, $fetched);
+            }
+        }
+
+        $row = $this->filterAddedColumns($row);
+
+        $row['subtype'] = (int)$row['subtype'];
+
+        // set to null when reading empty value, to match default empty value; See #5456
+        foreach (self::$null_attr_names as $key) {
+            if (isset($row[$key]) && !$row[$key]) {
+                $row[$key] = null;
+            }
+        }
+
+        // Note: If there are still missing attributes, we're running on a 1.7 or earlier schema. We let
+        // this pass so the upgrades can run.
+
+        // guid needs to be an int  https://github.com/elgg/elgg/issues/4111
+        foreach (self::$integer_attr_names as $key) {
+            if (isset($row[$key])) {
+                $row[$key] = (int) $row[$key];
+            }
+        }
+        return $row;
+    }
+
+    /**
+     * Filter non-attribute keys into $this->additional_select_values
+     *
+     * @param array $row All columns from the query
+     * @return array Columns acceptable for the entity's attributes
+     */
+    protected function filterAddedColumns($row) {
+        // make an array with keys as acceptable attribute names
+        $acceptable_attrs = self::$primary_attr_names;
+        array_splice($acceptable_attrs, count($acceptable_attrs), 0, $this->secondary_attr_names);
+        $acceptable_attrs = array_combine($acceptable_attrs, $acceptable_attrs);
+
+        foreach ($row as $key => $val) {
+            if (!isset($acceptable_attrs[$key])) {
+                $this->additional_select_values[$key] = $val;
+                unset($row[$key]);
+            }
+        }
+        return $row;
+    }
 }
 

Spacing +2 added lines, -2 removed lines

@@ -156,7 +156,7 @@ 
 	 */
 	protected function checkType($row) {
 		if ($row['type'] !== $this->required_type) {
-			$msg = "GUID:" . $row['guid'] . " is not a valid " . $this->class;
+			$msg = "GUID:".$row['guid']." is not a valid ".$this->class;
 			throw new \InvalidClassException($msg);
 		}
 	}
@@ -240,7 +240,7 @@ 
 
 		$row = $this->filterAddedColumns($row);
 
-		$row['subtype'] = (int)$row['subtype'];
+		$row['subtype'] = (int) $row['subtype'];
 
 		// set to null when reading empty value, to match default empty value; See #5456
 		foreach (self::$null_attr_names as $key) {

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 +424 added lines, -424 removed lines

@@ -12,481 +12,481 @@
  */
 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;
-		$time = $this->getCurrentTime()->getTimestamp();
+        $access_id = (int)$access_id;
+        $time = $this->getCurrentTime()->getTimestamp();
 	
-		$value_id = elgg_get_metastring_id($value);
-		if (!$value_id) {
-			return false;
-		}
+        $value_id = elgg_get_metastring_id($value);
+        if (!$value_id) {
+            return false;
+        }
 	
-		$name_id = elgg_get_metastring_id($name);
-		if (!$name_id) {
-			return false;
-		}
+        $name_id = elgg_get_metastring_id($name);
+        if (!$name_id) {
+            return false;
+        }
 	
-		// @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)) {
-			$result = $this->db->insertData("INSERT INTO {$this->db->prefix}annotations
+        if ($this->events->trigger('annotate', $entity->type, $entity)) {
+            $result = $this->db->insertData("INSERT INTO {$this->db->prefix}annotations
 				(entity_guid, name_id, value_id, value_type, owner_guid, time_created, access_id) VALUES
 				($entity_guid, $name_id, $value_id, '$value_type', $owner_guid, $time, $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;
 	
-		$value_id = elgg_get_metastring_id($value);
-		if (!$value_id) {
-			return false;
-		}
+        $value_id = elgg_get_metastring_id($value);
+        if (!$value_id) {
+            return false;
+        }
 	
-		$name_id = elgg_get_metastring_id($name);
-		if (!$name_id) {
-			return false;
-		}
+        $name_id = elgg_get_metastring_id($name);
+        if (!$name_id) {
+            return false;
+        }
 	
-		$result = $this->db->updateData("UPDATE {$this->db->prefix}annotations
+        $result = $this->db->updateData("UPDATE {$this->db->prefix}annotations
 			SET name_id = $name_id, value_id = $value_id, value_type = '$value_type',
 			access_id = $access_id, owner_guid = $owner_guid
 			WHERE 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 = array()) {
+        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 = array()) {
 
-		// 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 = array()) {
-		$defaults = array(
-			'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'					=> array(),
-	
-			'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);
-	
-		$singulars = array('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);
-	
-		if (!$options) {
-			return false;
-		}
-	
-		// because of performance issues support for ordering by maxtime has been dropped
-		// @see https://github.com/Elgg/Elgg/issues/6638
-		if (isset($options['order_by']) && preg_match('~\bmaxtime\b~i', $options['order_by'])) {
-			// check if the user provided maxtime
-			$deprecated = true;
-			if (isset($options['selects'])) {
-				$selects = $options['selects'];
-				if (!is_array($selects)) {
-					$selects = array($selects);
-				}
+        // 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 = array()) {
+        $defaults = array(
+            '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'					=> array(),
+	
+            '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);
+	
+        $singulars = array('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);
+	
+        if (!$options) {
+            return false;
+        }
+	
+        // because of performance issues support for ordering by maxtime has been dropped
+        // @see https://github.com/Elgg/Elgg/issues/6638
+        if (isset($options['order_by']) && preg_match('~\bmaxtime\b~i', $options['order_by'])) {
+            // check if the user provided maxtime
+            $deprecated = true;
+            if (isset($options['selects'])) {
+                $selects = $options['selects'];
+                if (!is_array($selects)) {
+                    $selects = array($selects);
+                }
 					
-				foreach ($selects as $select) {
-					if (preg_match('~\bmaxtime\b~i', $options['order_by'])) {
-						$deprecated = false;
-						break;
-					}
-				}
-			}
+                foreach ($selects as $select) {
+                    if (preg_match('~\bmaxtime\b~i', $options['order_by'])) {
+                        $deprecated = false;
+                        break;
+                    }
+                }
+            }
 		
-			// the user didn't provide maxtime
-			if ($deprecated) {
-				// special sorting for annotations
-				elgg_deprecated_notice(__FUNCTION__ . ": no longer orders by annotations by default. If you order"
-					. " by maxtime, you must provide that column via \$options['selects']. See"
-					. " https://github.com/Elgg/Elgg/issues/6638#issuecomment-41562034", "1.10");
+            // the user didn't provide maxtime
+            if ($deprecated) {
+                // special sorting for annotations
+                elgg_deprecated_notice(__FUNCTION__ . ": no longer orders by annotations by default. If you order"
+                    . " by maxtime, you must provide that column via \$options['selects']. See"
+                    . " https://github.com/Elgg/Elgg/issues/6638#issuecomment-41562034", "1.10");
 					
-				$options['selects'][] = "MAX(n_table.time_created) AS maxtime";
-				$options['group_by'] = 'n_table.entity_guid';
-			}
-		}
+                $options['selects'][] = "MAX(n_table.time_created) AS maxtime";
+                $options['group_by'] = 'n_table.entity_guid';
+            }
+        }
 		
-		$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 = array(
-			'calculation' => 'sum',
-			'order_by' => 'annotation_calculation desc'
-		);
+        $db_prefix = $this->db->prefix;
+        $defaults = array(
+            '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(a_msv.string AS signed)) AS annotation_calculation";
+        // you must cast this as an int or it sorts wrong.
+        $options['selects'][] = 'e.*';
+        $options['selects'][] = "$function(CAST(a_msv.string AS signed)) AS annotation_calculation";
 	
-		// need our own join to get the values because the lower level functions don't
-		// add all the joins if it's a different callback.
-		$options['joins'][] = "JOIN {$db_prefix}metastrings a_msv ON n_table.value_id = a_msv.id";
+        // need our own join to get the values because the lower level functions don't
+        // add all the joins if it's a different callback.
+        $options['joins'][] = "JOIN {$db_prefix}metastrings a_msv ON n_table.value_id = a_msv.id";
 	
-		// 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) {
+        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;
-		}
+        if (!$owner_guid && !($owner_guid = $this->session->getLoggedInUserGuid())) {
+            return false;
+        }
 	
-		$entity_guid = sanitize_int($entity_guid);
-		$owner_guid = sanitize_int($owner_guid);
-		$annotation_type = sanitize_string($annotation_type);
+        $entity_guid = sanitize_int($entity_guid);
+        $owner_guid = sanitize_int($owner_guid);
+        $annotation_type = sanitize_string($annotation_type);
 	
-		$sql = "SELECT a.id FROM {$this->db->prefix}annotations a" .
-				" JOIN {$this->db->prefix}metastrings m ON a.name_id = m.id" .
-				" WHERE a.owner_guid = $owner_guid AND a.entity_guid = $entity_guid" .
-				" AND m.string = '$annotation_type'";
+        $sql = "SELECT a.id FROM {$this->db->prefix}annotations a" .
+                " JOIN {$this->db->prefix}metastrings m ON a.name_id = m.id" .
+                " WHERE a.owner_guid = $owner_guid AND a.entity_guid = $entity_guid" .
+                " AND m.string = '$annotation_type'";
 	
-		if ($this->db->getDataRow($sql)) {
-			return true;
-		}
+        if ($this->db->getDataRow($sql)) {
+            return true;
+        }
 	
-		return false;
-	}
+        return false;
+    }
 }
\ No newline at end of file

Spacing +10 added lines, -10 removed lines

@@ -86,15 +86,15 @@ 
 	
 		$result = false;
 	
-		$entity_guid = (int)$entity_guid;
+		$entity_guid = (int) $entity_guid;
 		$value_type = \ElggExtender::detectValueType($value, $value_type);
 	
-		$owner_guid = (int)$owner_guid;
+		$owner_guid = (int) $owner_guid;
 		if ($owner_guid == 0) {
 			$owner_guid = $this->session->getLoggedInUserGuid();
 		}
 	
-		$access_id = (int)$access_id;
+		$access_id = (int) $access_id;
 		$time = $this->getCurrentTime()->getTimestamp();
 	
 		$value_id = elgg_get_metastring_id($value);
@@ -146,7 +146,7 @@ 
 	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) {
@@ -159,12 +159,12 @@ 
 		$name = trim($name);
 		$value_type = \ElggExtender::detectValueType($value, $value_type);
 	
-		$owner_guid = (int)$owner_guid;
+		$owner_guid = (int) $owner_guid;
 		if ($owner_guid == 0) {
 			$owner_guid = $this->session->getLoggedInUserGuid();
 		}
 	
-		$access_id = (int)$access_id;
+		$access_id = (int) $access_id;
 	
 		$value_id = elgg_get_metastring_id($value);
 		if (!$value_id) {
@@ -372,7 +372,7 @@ 
 			// the user didn't provide maxtime
 			if ($deprecated) {
 				// special sorting for annotations
-				elgg_deprecated_notice(__FUNCTION__ . ": no longer orders by annotations by default. If you order"
+				elgg_deprecated_notice(__FUNCTION__.": no longer orders by annotations by default. If you order"
 					. " by maxtime, you must provide that column via \$options['selects']. See"
 					. " https://github.com/Elgg/Elgg/issues/6638#issuecomment-41562034", "1.10");
 					
@@ -478,9 +478,9 @@ 
 		$owner_guid = sanitize_int($owner_guid);
 		$annotation_type = sanitize_string($annotation_type);
 	
-		$sql = "SELECT a.id FROM {$this->db->prefix}annotations a" .
-				" JOIN {$this->db->prefix}metastrings m ON a.name_id = m.id" .
-				" WHERE a.owner_guid = $owner_guid AND a.entity_guid = $entity_guid" .
+		$sql = "SELECT a.id FROM {$this->db->prefix}annotations a".
+				" JOIN {$this->db->prefix}metastrings m ON a.name_id = m.id".
+				" WHERE a.owner_guid = $owner_guid AND a.entity_guid = $entity_guid".
 				" AND m.string = '$annotation_type'";
 	
 		if ($this->db->getDataRow($sql)) {

engine/classes/Elgg/Database/MetadataTable.php

Doc Comments +3 added lines, -3 removed lines

@@ -76,7 +76,7 @@ 
 	 *
 	 * @param int $id The id of the metadata object being retrieved.
 	 *
-	 * @return \ElggMetadata|false  false if not found
+	 * @return \ElggExtender  false if not found
 	 */
 	function get($id) {
 		return _elgg_get_metastring_based_object_from_id($id, 'metadata');
@@ -767,7 +767,7 @@ 
 	 *
 	 * @param int $id Metadata ID
 	 *
-	 * @return mixed
+	 * @return string|false
 	 */
 	function getUrl($id) {
 		$extender = $this->get($id);
@@ -817,7 +817,7 @@ 
 	 * @param string      $object_type The type of object
 	 * @param \ElggEntity $object      The entity itself
 	 *
-	 * @return true
+	 * @return boolean
 	 * @access private Set as private in 1.9.0
 	 */
 	function handleUpdate($event, $object_type, $object) {

Indentation +782 added lines, -782 removed lines

@@ -20,233 +20,233 @@ 
  */
 class MetadataTable {
 
-	use \Elgg\TimeUsing;
+    use \Elgg\TimeUsing;
 
-	/** @var array */
-	protected $independents = array();
+    /** @var array */
+    protected $independents = array();
 	
-	/** @var Cache */
-	protected $cache;
+    /** @var Cache */
+    protected $cache;
 	
-	/** @var Database */
-	protected $db;
+    /** @var Database */
+    protected $db;
 	
-	/** @var EntityTable */
-	protected $entityTable;
+    /** @var EntityTable */
+    protected $entityTable;
 	
-	/** @var MetastringsTable */
-	protected $metastringsTable;
+    /** @var MetastringsTable */
+    protected $metastringsTable;
 	
-	/** @var Events */
-	protected $events;
+    /** @var Events */
+    protected $events;
 	
-	/** @var Session */
-	protected $session;
+    /** @var Session */
+    protected $session;
 	
-	/** @var string */
-	protected $table;
+    /** @var string */
+    protected $table;
 
-	/**
-	 * Constructor
-	 * 
-	 * @param Cache            $cache            A cache for this table
-	 * @param Database         $db               The Elgg database
-	 * @param EntityTable      $entityTable      The entities table
-	 * @param Events           $events           The events registry
-	 * @param MetastringsTable $metastringsTable The metastrings table
-	 * @param Session          $session          The session
-	 */
-	public function __construct(
-			Cache $cache,
-			Database $db,
-			EntityTable $entityTable,
-			Events $events,
-			MetastringsTable $metastringsTable,
-			Session $session) {
-		$this->cache = $cache;
-		$this->db = $db;
-		$this->entityTable = $entityTable;
-		$this->events = $events;
-		$this->metastringsTable = $metastringsTable;
-		$this->session = $session;
-		$this->table = $this->db->prefix . "metadata";
-	}
+    /**
+     * Constructor
+     * 
+     * @param Cache            $cache            A cache for this table
+     * @param Database         $db               The Elgg database
+     * @param EntityTable      $entityTable      The entities table
+     * @param Events           $events           The events registry
+     * @param MetastringsTable $metastringsTable The metastrings table
+     * @param Session          $session          The session
+     */
+    public function __construct(
+            Cache $cache,
+            Database $db,
+            EntityTable $entityTable,
+            Events $events,
+            MetastringsTable $metastringsTable,
+            Session $session) {
+        $this->cache = $cache;
+        $this->db = $db;
+        $this->entityTable = $entityTable;
+        $this->events = $events;
+        $this->metastringsTable = $metastringsTable;
+        $this->session = $session;
+        $this->table = $this->db->prefix . "metadata";
+    }
 
-	/**
-	 * Get a specific metadata object by its id.
-	 * If you want multiple metadata objects, use
-	 * {@link elgg_get_metadata()}.
-	 *
-	 * @param int $id The id of the metadata object being retrieved.
-	 *
-	 * @return \ElggMetadata|false  false if not found
-	 */
-	function get($id) {
-		return _elgg_get_metastring_based_object_from_id($id, 'metadata');
-	}
-	
-	/**
-	 * Deletes metadata using its ID.
-	 *
-	 * @param int $id The metadata ID to delete.
-	 * @return bool
-	 */
-	function delete($id) {
-		$metadata = $this->get($id);
+    /**
+     * Get a specific metadata object by its id.
+     * If you want multiple metadata objects, use
+     * {@link elgg_get_metadata()}.
+     *
+     * @param int $id The id of the metadata object being retrieved.
+     *
+     * @return \ElggMetadata|false  false if not found
+     */
+    function get($id) {
+        return _elgg_get_metastring_based_object_from_id($id, 'metadata');
+    }
+	
+    /**
+     * Deletes metadata using its ID.
+     *
+     * @param int $id The metadata ID to delete.
+     * @return bool
+     */
+    function delete($id) {
+        $metadata = $this->get($id);
 
-		return $metadata ? $metadata->delete() : false;
-	}
-	
-	/**
-	 * Create a new metadata object, or update an existing one.
-	 *
-	 * Metadata can be an array by setting allow_multiple to true, but it is an
-	 * indexed array with no control over the indexing.
-	 *
-	 * @param int    $entity_guid    The entity to attach the metadata to
-	 * @param string $name           Name of the metadata
-	 * @param string $value          Value of the metadata
-	 * @param string $value_type     'text', 'integer', or '' for automatic detection
-	 * @param int    $owner_guid     GUID of entity that owns the metadata. Default is logged in user.
-	 * @param int    $access_id      Default is ACCESS_PRIVATE
-	 * @param bool   $allow_multiple Allow multiple values for one key. Default is false
-	 *
-	 * @return int|false id of metadata or false if failure
-	 */
-	function create($entity_guid, $name, $value, $value_type = '', $owner_guid = 0,
-			$access_id = ACCESS_PRIVATE, $allow_multiple = false) {
+        return $metadata ? $metadata->delete() : false;
+    }
+	
+    /**
+     * Create a new metadata object, or update an existing one.
+     *
+     * Metadata can be an array by setting allow_multiple to true, but it is an
+     * indexed array with no control over the indexing.
+     *
+     * @param int    $entity_guid    The entity to attach the metadata to
+     * @param string $name           Name of the metadata
+     * @param string $value          Value of the metadata
+     * @param string $value_type     'text', 'integer', or '' for automatic detection
+     * @param int    $owner_guid     GUID of entity that owns the metadata. Default is logged in user.
+     * @param int    $access_id      Default is ACCESS_PRIVATE
+     * @param bool   $allow_multiple Allow multiple values for one key. Default is false
+     *
+     * @return int|false id of metadata or false if failure
+     */
+    function create($entity_guid, $name, $value, $value_type = '', $owner_guid = 0,
+            $access_id = ACCESS_PRIVATE, $allow_multiple = false) {
 
-		$entity_guid = (int)$entity_guid;
-		// name and value are encoded in add_metastring()
-		$value_type = \ElggExtender::detectValueType($value, trim($value_type));
-		$time = $this->getCurrentTime()->getTimestamp();
-		$owner_guid = (int)$owner_guid;
-		$allow_multiple = (boolean)$allow_multiple;
+        $entity_guid = (int)$entity_guid;
+        // name and value are encoded in add_metastring()
+        $value_type = \ElggExtender::detectValueType($value, trim($value_type));
+        $time = $this->getCurrentTime()->getTimestamp();
+        $owner_guid = (int)$owner_guid;
+        $allow_multiple = (boolean)$allow_multiple;
 	
-		if (!isset($value)) {
-			return false;
-		}
+        if (!isset($value)) {
+            return false;
+        }
 	
-		if ($owner_guid == 0) {
-			$owner_guid = $this->session->getLoggedInUserGuid();
-		}
+        if ($owner_guid == 0) {
+            $owner_guid = $this->session->getLoggedInUserGuid();
+        }
 	
-		$access_id = (int) $access_id;
+        $access_id = (int) $access_id;
 	
-		$query = "SELECT * FROM {$this->table}
+        $query = "SELECT * FROM {$this->table}
 			WHERE entity_guid = :entity_guid and name_id = :name_id LIMIT 1";
 
-		$params = [
-			':entity_guid' => $entity_guid,
-			':name_id' => $this->metastringsTable->getId($name)
-		];
+        $params = [
+            ':entity_guid' => $entity_guid,
+            ':name_id' => $this->metastringsTable->getId($name)
+        ];
 
-		$existing = $this->db->getDataRow($query, null, $params);
-		if ($existing && !$allow_multiple) {
-			$id = (int)$existing->id;
-			$result = $this->update($id, $name, $value, $value_type, $owner_guid, $access_id);
-	
-			if (!$result) {
-				return false;
-			}
-		} else {
-			// Support boolean types
-			if (is_bool($value)) {
-				$value = (int)$value;
-			}
-	
-			// Add the metastrings
-			$value_id = $this->metastringsTable->getId($value);
-			if (!$value_id) {
-				return false;
-			}
-	
-			$name_id = $this->metastringsTable->getId($name);
-			if (!$name_id) {
-				return false;
-			}
-	
-			// If ok then add it
-			$query = "INSERT INTO {$this->table}
+        $existing = $this->db->getDataRow($query, null, $params);
+        if ($existing && !$allow_multiple) {
+            $id = (int)$existing->id;
+            $result = $this->update($id, $name, $value, $value_type, $owner_guid, $access_id);
+	
+            if (!$result) {
+                return false;
+            }
+        } else {
+            // Support boolean types
+            if (is_bool($value)) {
+                $value = (int)$value;
+            }
+	
+            // Add the metastrings
+            $value_id = $this->metastringsTable->getId($value);
+            if (!$value_id) {
+                return false;
+            }
+	
+            $name_id = $this->metastringsTable->getId($name);
+            if (!$name_id) {
+                return false;
+            }
+	
+            // If ok then add it
+            $query = "INSERT INTO {$this->table}
 				(entity_guid, name_id, value_id, value_type, owner_guid, time_created, access_id)
 				VALUES (:entity_guid, :name_id, :value_id, :value_type, :owner_guid, :time_created, :access_id)";
 
-			$params = [
-				':entity_guid' => $entity_guid,
-				':name_id' => $name_id,
-				':value_id' => $value_id,
-				':value_type' => $value_type,
-				':owner_guid' => $owner_guid,
-				':time_created' => $time,
-				':access_id' => $access_id,
-			];
+            $params = [
+                ':entity_guid' => $entity_guid,
+                ':name_id' => $name_id,
+                ':value_id' => $value_id,
+                ':value_type' => $value_type,
+                ':owner_guid' => $owner_guid,
+                ':time_created' => $time,
+                ':access_id' => $access_id,
+            ];
 			
-			$id = $this->db->insertData($query, $params);
+            $id = $this->db->insertData($query, $params);
 			
-			if ($id !== false) {
-				$obj = $this->get($id);
-				if ($this->events->trigger('create', 'metadata', $obj)) {
+            if ($id !== false) {
+                $obj = $this->get($id);
+                if ($this->events->trigger('create', 'metadata', $obj)) {
 
-					$this->cache->clear($entity_guid);
-	
-					return $id;
-				} else {
-					$this->delete($id);
-				}
-			}
-		}
-	
-		return $id;
-	}
-	
-	/**
-	 * Update a specific piece of metadata.
-	 *
-	 * @param int    $id         ID of the metadata to update
-	 * @param string $name       Metadata name
-	 * @param string $value      Metadata value
-	 * @param string $value_type Value type
-	 * @param int    $owner_guid Owner guid
-	 * @param int    $access_id  Access ID
-	 *
-	 * @return bool
-	 */
-	function update($id, $name, $value, $value_type, $owner_guid, $access_id) {
-		$id = (int)$id;
-	
-		if (!$md = $this->get($id)) {
-			return false;
-		}
-		if (!$md->canEdit()) {
-			return false;
-		}
-	
-		$value_type = \ElggExtender::detectValueType($value, trim($value_type));
-	
-		$owner_guid = (int)$owner_guid;
-		if ($owner_guid == 0) {
-			$owner_guid = $this->session->getLoggedInUserGuid();
-		}
-	
-		$access_id = (int)$access_id;
-	
-		// Support boolean types (as integers)
-		if (is_bool($value)) {
-			$value = (int)$value;
-		}
-	
-		$value_id = $this->metastringsTable->getId($value);
-		if (!$value_id) {
-			return false;
-		}
-	
-		$name_id = $this->metastringsTable->getId($name);
-		if (!$name_id) {
-			return false;
-		}
-	
-		// If ok then add it
-		$query = "UPDATE {$this->table}
+                    $this->cache->clear($entity_guid);
+	
+                    return $id;
+                } else {
+                    $this->delete($id);
+                }
+            }
+        }
+	
+        return $id;
+    }
+	
+    /**
+     * Update a specific piece of metadata.
+     *
+     * @param int    $id         ID of the metadata to update
+     * @param string $name       Metadata name
+     * @param string $value      Metadata value
+     * @param string $value_type Value type
+     * @param int    $owner_guid Owner guid
+     * @param int    $access_id  Access ID
+     *
+     * @return bool
+     */
+    function update($id, $name, $value, $value_type, $owner_guid, $access_id) {
+        $id = (int)$id;
+	
+        if (!$md = $this->get($id)) {
+            return false;
+        }
+        if (!$md->canEdit()) {
+            return false;
+        }
+	
+        $value_type = \ElggExtender::detectValueType($value, trim($value_type));
+	
+        $owner_guid = (int)$owner_guid;
+        if ($owner_guid == 0) {
+            $owner_guid = $this->session->getLoggedInUserGuid();
+        }
+	
+        $access_id = (int)$access_id;
+	
+        // Support boolean types (as integers)
+        if (is_bool($value)) {
+            $value = (int)$value;
+        }
+	
+        $value_id = $this->metastringsTable->getId($value);
+        if (!$value_id) {
+            return false;
+        }
+	
+        $name_id = $this->metastringsTable->getId($name);
+        if (!$name_id) {
+            return false;
+        }
+	
+        // If ok then add it
+        $query = "UPDATE {$this->table}
 			SET name_id = :name_id,
 			    value_id = :value_id,
 				value_type = :value_type,
@@ -254,603 +254,603 @@ 
 			    owner_guid = :owner_guid
 			WHERE id = :id";
 
-		$params = [
-			':name_id' => $name_id,
-			':value_id' => $value_id,
-			':value_type' => $value_type,
-			':access_id' => $access_id,
-			':owner_guid' => $owner_guid,
-			':id' => $id,
-		];
+        $params = [
+            ':name_id' => $name_id,
+            ':value_id' => $value_id,
+            ':value_type' => $value_type,
+            ':access_id' => $access_id,
+            ':owner_guid' => $owner_guid,
+            ':id' => $id,
+        ];
 		
-		$result = $this->db->updateData($query, false, $params);
+        $result = $this->db->updateData($query, false, $params);
 		
-		if ($result !== false) {
-	
-			$this->cache->clear($md->entity_guid);
-	
-			// @todo this event tells you the metadata has been updated, but does not
-			// let you do anything about it. What is needed is a plugin hook before
-			// the update that passes old and new values.
-			$obj = $this->get($id);
-			$this->events->trigger('update', 'metadata', $obj);
-		}
-	
-		return $result;
-	}
-	
-	/**
-	 * This function creates metadata from an associative array of "key => value" pairs.
-	 *
-	 * To achieve an array for a single key, pass in the same key multiple times with
-	 * allow_multiple set to true. This creates an indexed array. It does not support
-	 * associative arrays and there is no guarantee on the ordering in the array.
-	 *
-	 * @param int    $entity_guid     The entity to attach the metadata to
-	 * @param array  $name_and_values Associative array - a value can be a string, number, bool
-	 * @param string $value_type      'text', 'integer', or '' for automatic detection
-	 * @param int    $owner_guid      GUID of entity that owns the metadata
-	 * @param int    $access_id       Default is ACCESS_PRIVATE
-	 * @param bool   $allow_multiple  Allow multiple values for one key. Default is false
-	 *
-	 * @return bool
-	 */
-	function createFromArray($entity_guid, array $name_and_values, $value_type, $owner_guid,
-			$access_id = ACCESS_PRIVATE, $allow_multiple = false) {
-	
-		foreach ($name_and_values as $k => $v) {
-			$result = $this->create($entity_guid, $k, $v, $value_type, $owner_guid,
-				$access_id, $allow_multiple);
-			if (!$result) {
-				return false;
-			}
-		}
-		return true;
-	}
-	
-	/**
-	 * Returns metadata.  Accepts all elgg_get_entities() options for entity
-	 * restraints.
-	 *
-	 * @see elgg_get_entities
-	 *
-	 * @warning 1.7's find_metadata() didn't support limits and returned all metadata.
-	 *          This function defaults to a limit of 25. There is probably not a reason
-	 *          for you to return all metadata unless you're exporting an entity,
-	 *          have other restraints in place, or are doing something horribly
-	 *          wrong in your code.
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * metadata_names               => null|ARR metadata names
-	 * metadata_values              => null|ARR metadata values
-	 * metadata_ids                 => null|ARR metadata ids
-	 * metadata_case_sensitive      => BOOL Overall Case sensitive
-	 * metadata_owner_guids         => null|ARR guids for metadata owners
-	 * metadata_created_time_lower  => INT Lower limit for created time.
-	 * metadata_created_time_upper  => INT Upper limit for created time.
-	 * metadata_calculation         => STR Perform the MySQL function on the metadata values returned.
-	 *                                   The "metadata_calculation" option causes this function to
-	 *                                   return the result of performing a mathematical calculation on
-	 *                                   all metadata that match the query instead of returning
-	 *                                   \ElggMetadata objects.
-	 *
-	 * @return \ElggMetadata[]|mixed
-	 */
-	function getAll(array $options = array()) {
-	
-		// @todo remove support for count shortcut - see #4393
-		// support shortcut of 'count' => true for 'metadata_calculation' => 'count'
-		if (isset($options['count']) && $options['count']) {
-			$options['metadata_calculation'] = 'count';
-			unset($options['count']);
-		}
-	
-		$options['metastring_type'] = 'metadata';
-		return _elgg_get_metastring_based_objects($options);
-	}
-	
-	/**
-	 * Deletes metadata based on $options.
-	 *
-	 * @warning Unlike elgg_get_metadata() this will not accept an empty options array!
-	 *          This requires at least one constraint: metadata_owner_guid(s),
-	 *          metadata_name(s), metadata_value(s), or guid(s) must be set.
-	 *
-	 * @param array $options An options array. {@link elgg_get_metadata()}
-	 * @return bool|null true on success, false on failure, null if no metadata to delete.
-	 */
-	function deleteAll(array $options) {
-		if (!_elgg_is_valid_options_for_batch_operation($options, 'metadata')) {
-			return false;
-		}
-		$options['metastring_type'] = 'metadata';
-		$result = _elgg_batch_metastring_based_objects($options, 'elgg_batch_delete_callback', false);
-	
-		// This moved last in case an object's constructor sets metadata. Currently the batch
-		// delete process has to create the entity to delete its metadata. See #5214
-		$this->cache->invalidateByOptions($options);
-	
-		return $result;
-	}
-	
-	/**
-	 * Disables metadata based on $options.
-	 *
-	 * @warning Unlike elgg_get_metadata() this will not accept an empty options array!
-	 *
-	 * @param array $options An options array. {@link elgg_get_metadata()}
-	 * @return bool|null true on success, false on failure, null if no metadata disabled.
-	 */
-	function disableAll(array $options) {
-		if (!_elgg_is_valid_options_for_batch_operation($options, 'metadata')) {
-			return false;
-		}
-	
-		$this->cache->invalidateByOptions($options);
-	
-		// 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'] = 'metadata';
-		return _elgg_batch_metastring_based_objects($options, 'elgg_batch_disable_callback', $inc_offset);
-	}
-	
-	/**
-	 * Enables metadata based on $options.
-	 *
-	 * @warning Unlike elgg_get_metadata() this will not accept an empty options array!
-	 *
-	 * @warning In order to enable metadata, you must first use
-	 * {@link access_show_hidden_entities()}.
-	 *
-	 * @param array $options An options array. {@link elgg_get_metadata()}
-	 * @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;
-		}
-	
-		$this->cache->invalidateByOptions($options);
-	
-		$options['metastring_type'] = 'metadata';
-		return _elgg_batch_metastring_based_objects($options, 'elgg_batch_enable_callback');
-	}
-	
-	/**
-	 * Returns entities based upon metadata.  Also accepts all
-	 * options available to elgg_get_entities().  Supports
-	 * the singular option shortcut.
-	 *
-	 * @note Using metadata_names and metadata_values results in a
-	 * "names IN (...) AND values IN (...)" clause.  This is subtly
-	 * differently than default multiple metadata_name_value_pairs, which use
-	 * "(name = value) AND (name = value)" clauses.
-	 *
-	 * When in doubt, use name_value_pairs.
-	 *
-	 * To ask for entities that do not have a metadata value, use a custom
-	 * where clause like this:
-	 *
-	 * 	$options['wheres'][] = "NOT EXISTS (
-	 *			SELECT 1 FROM {$dbprefix}metadata md
-	 *			WHERE md.entity_guid = e.guid
-	 *				AND md.name_id = $name_metastring_id
-	 *				AND md.value_id = $value_metastring_id)";
-	 *
-	 * Note the metadata name and value has been denormalized in the above example.
-	 *
-	 * @see elgg_get_entities
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * 	metadata_names => null|ARR metadata names
-	 *
-	 * 	metadata_values => null|ARR metadata values
-	 *
-	 * 	metadata_name_value_pairs => null|ARR (
-	 *                                         name => 'name',
-	 *                                         value => 'value',
-	 *                                         'operand' => '=',
-	 *                                         'case_sensitive' => true
-	 *                                        )
-	 *                               Currently if multiple values are sent via
-	 *                               an array (value => array('value1', 'value2')
-	 *                               the pair's operand will be forced to "IN".
-	 *                               If passing "IN" as the operand and a string as the value, 
-	 *                               the value must be a properly quoted and escaped string.
-	 *
-	 * 	metadata_name_value_pairs_operator => null|STR The operator to use for combining
-	 *                                        (name = value) OPERATOR (name = value); default AND
-	 *
-	 * 	metadata_case_sensitive => BOOL Overall Case sensitive
-	 *
-	 *  order_by_metadata => null|ARR array(
-	 *                                      'name' => 'metadata_text1',
-	 *                                      'direction' => ASC|DESC,
-	 *                                      'as' => text|integer
-	 *                                     )
-	 *                                Also supports array('name' => 'metadata_text1')
-	 *
-	 *  metadata_owner_guids => null|ARR guids for metadata owners
-	 *
-	 * @return \ElggEntity[]|mixed If count, int. If not count, array. false on errors.
-	 */
-	function getEntities(array $options = array()) {
-		$defaults = array(
-			'metadata_names'                     => ELGG_ENTITIES_ANY_VALUE,
-			'metadata_values'                    => ELGG_ENTITIES_ANY_VALUE,
-			'metadata_name_value_pairs'          => ELGG_ENTITIES_ANY_VALUE,
-	
-			'metadata_name_value_pairs_operator' => 'AND',
-			'metadata_case_sensitive'            => true,
-			'order_by_metadata'                  => array(),
-	
-			'metadata_owner_guids'               => ELGG_ENTITIES_ANY_VALUE,
-		);
-	
-		$options = array_merge($defaults, $options);
-	
-		$singulars = array('metadata_name', 'metadata_value',
-			'metadata_name_value_pair', 'metadata_owner_guid');
-	
-		$options = _elgg_normalize_plural_options_array($options, $singulars);
-	
-		if (!$options = _elgg_entities_get_metastrings_options('metadata', $options)) {
-			return false;
-		}
-	
-		return $this->entityTable->getEntities($options);
-	}
-	
-	/**
-	 * Returns metadata name and value SQL where for entities.
-	 * NB: $names and $values are not paired. Use $pairs for this.
-	 * Pairs default to '=' operand.
-	 *
-	 * This function is reused for annotations because the tables are
-	 * exactly the same.
-	 *
-	 * @param string     $e_table           Entities table name
-	 * @param string     $n_table           Normalized metastrings table name (Where entities,
-	 *                                    values, and names are joined. annotations / metadata)
-	 * @param array|null $names             Array of names
-	 * @param array|null $values            Array of values
-	 * @param array|null $pairs             Array of names / values / operands
-	 * @param string     $pair_operator     ("AND" or "OR") Operator to use to join the where clauses for pairs
-	 * @param bool       $case_sensitive    Case sensitive metadata names?
-	 * @param array|null $order_by_metadata Array of names / direction
-	 * @param array|null $owner_guids       Array of owner GUIDs
-	 *
-	 * @return false|array False on fail, array('joins', 'wheres')
-	 * @access private
-	 */
-	function getEntityMetadataWhereSql($e_table, $n_table, $names = null, $values = null,
-			$pairs = null, $pair_operator = 'AND', $case_sensitive = true, $order_by_metadata = null,
-			$owner_guids = null) {
-		// short circuit if nothing requested
-		// 0 is a valid (if not ill-conceived) metadata name.
-		// 0 is also a valid metadata value for false, null, or 0
-		// 0 is also a valid(ish) owner_guid
-		if ((!$names && $names !== 0)
-			&& (!$values && $values !== 0)
-			&& (!$pairs && $pairs !== 0)
-			&& (!$owner_guids && $owner_guids !== 0)
-			&& !$order_by_metadata) {
-			return '';
-		}
-	
-		// join counter for incremental joins.
-		$i = 1;
-	
-		// binary forces byte-to-byte comparision of strings, making
-		// it case- and diacritical-mark- sensitive.
-		// only supported on values.
-		$binary = ($case_sensitive) ? ' BINARY ' : '';
-	
-		$access = _elgg_get_access_where_sql(array(
-			'table_alias' => 'n_table',
-			'guid_column' => 'entity_guid',
-		));
-	
-		$return = array (
-			'joins' => array (),
-			'wheres' => array(),
-			'orders' => array()
-		);
-	
-		// will always want to join these tables if pulling metastrings.
-		$return['joins'][] = "JOIN {$this->db->prefix}{$n_table} n_table on
+        if ($result !== false) {
+	
+            $this->cache->clear($md->entity_guid);
+	
+            // @todo this event tells you the metadata has been updated, but does not
+            // let you do anything about it. What is needed is a plugin hook before
+            // the update that passes old and new values.
+            $obj = $this->get($id);
+            $this->events->trigger('update', 'metadata', $obj);
+        }
+	
+        return $result;
+    }
+	
+    /**
+     * This function creates metadata from an associative array of "key => value" pairs.
+     *
+     * To achieve an array for a single key, pass in the same key multiple times with
+     * allow_multiple set to true. This creates an indexed array. It does not support
+     * associative arrays and there is no guarantee on the ordering in the array.
+     *
+     * @param int    $entity_guid     The entity to attach the metadata to
+     * @param array  $name_and_values Associative array - a value can be a string, number, bool
+     * @param string $value_type      'text', 'integer', or '' for automatic detection
+     * @param int    $owner_guid      GUID of entity that owns the metadata
+     * @param int    $access_id       Default is ACCESS_PRIVATE
+     * @param bool   $allow_multiple  Allow multiple values for one key. Default is false
+     *
+     * @return bool
+     */
+    function createFromArray($entity_guid, array $name_and_values, $value_type, $owner_guid,
+            $access_id = ACCESS_PRIVATE, $allow_multiple = false) {
+	
+        foreach ($name_and_values as $k => $v) {
+            $result = $this->create($entity_guid, $k, $v, $value_type, $owner_guid,
+                $access_id, $allow_multiple);
+            if (!$result) {
+                return false;
+            }
+        }
+        return true;
+    }
+	
+    /**
+     * Returns metadata.  Accepts all elgg_get_entities() options for entity
+     * restraints.
+     *
+     * @see elgg_get_entities
+     *
+     * @warning 1.7's find_metadata() didn't support limits and returned all metadata.
+     *          This function defaults to a limit of 25. There is probably not a reason
+     *          for you to return all metadata unless you're exporting an entity,
+     *          have other restraints in place, or are doing something horribly
+     *          wrong in your code.
+     *
+     * @param array $options Array in format:
+     *
+     * metadata_names               => null|ARR metadata names
+     * metadata_values              => null|ARR metadata values
+     * metadata_ids                 => null|ARR metadata ids
+     * metadata_case_sensitive      => BOOL Overall Case sensitive
+     * metadata_owner_guids         => null|ARR guids for metadata owners
+     * metadata_created_time_lower  => INT Lower limit for created time.
+     * metadata_created_time_upper  => INT Upper limit for created time.
+     * metadata_calculation         => STR Perform the MySQL function on the metadata values returned.
+     *                                   The "metadata_calculation" option causes this function to
+     *                                   return the result of performing a mathematical calculation on
+     *                                   all metadata that match the query instead of returning
+     *                                   \ElggMetadata objects.
+     *
+     * @return \ElggMetadata[]|mixed
+     */
+    function getAll(array $options = array()) {
+	
+        // @todo remove support for count shortcut - see #4393
+        // support shortcut of 'count' => true for 'metadata_calculation' => 'count'
+        if (isset($options['count']) && $options['count']) {
+            $options['metadata_calculation'] = 'count';
+            unset($options['count']);
+        }
+	
+        $options['metastring_type'] = 'metadata';
+        return _elgg_get_metastring_based_objects($options);
+    }
+	
+    /**
+     * Deletes metadata based on $options.
+     *
+     * @warning Unlike elgg_get_metadata() this will not accept an empty options array!
+     *          This requires at least one constraint: metadata_owner_guid(s),
+     *          metadata_name(s), metadata_value(s), or guid(s) must be set.
+     *
+     * @param array $options An options array. {@link elgg_get_metadata()}
+     * @return bool|null true on success, false on failure, null if no metadata to delete.
+     */
+    function deleteAll(array $options) {
+        if (!_elgg_is_valid_options_for_batch_operation($options, 'metadata')) {
+            return false;
+        }
+        $options['metastring_type'] = 'metadata';
+        $result = _elgg_batch_metastring_based_objects($options, 'elgg_batch_delete_callback', false);
+	
+        // This moved last in case an object's constructor sets metadata. Currently the batch
+        // delete process has to create the entity to delete its metadata. See #5214
+        $this->cache->invalidateByOptions($options);
+	
+        return $result;
+    }
+	
+    /**
+     * Disables metadata based on $options.
+     *
+     * @warning Unlike elgg_get_metadata() this will not accept an empty options array!
+     *
+     * @param array $options An options array. {@link elgg_get_metadata()}
+     * @return bool|null true on success, false on failure, null if no metadata disabled.
+     */
+    function disableAll(array $options) {
+        if (!_elgg_is_valid_options_for_batch_operation($options, 'metadata')) {
+            return false;
+        }
+	
+        $this->cache->invalidateByOptions($options);
+	
+        // 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'] = 'metadata';
+        return _elgg_batch_metastring_based_objects($options, 'elgg_batch_disable_callback', $inc_offset);
+    }
+	
+    /**
+     * Enables metadata based on $options.
+     *
+     * @warning Unlike elgg_get_metadata() this will not accept an empty options array!
+     *
+     * @warning In order to enable metadata, you must first use
+     * {@link access_show_hidden_entities()}.
+     *
+     * @param array $options An options array. {@link elgg_get_metadata()}
+     * @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;
+        }
+	
+        $this->cache->invalidateByOptions($options);
+	
+        $options['metastring_type'] = 'metadata';
+        return _elgg_batch_metastring_based_objects($options, 'elgg_batch_enable_callback');
+    }
+	
+    /**
+     * Returns entities based upon metadata.  Also accepts all
+     * options available to elgg_get_entities().  Supports
+     * the singular option shortcut.
+     *
+     * @note Using metadata_names and metadata_values results in a
+     * "names IN (...) AND values IN (...)" clause.  This is subtly
+     * differently than default multiple metadata_name_value_pairs, which use
+     * "(name = value) AND (name = value)" clauses.
+     *
+     * When in doubt, use name_value_pairs.
+     *
+     * To ask for entities that do not have a metadata value, use a custom
+     * where clause like this:
+     *
+     * 	$options['wheres'][] = "NOT EXISTS (
+     *			SELECT 1 FROM {$dbprefix}metadata md
+     *			WHERE md.entity_guid = e.guid
+     *				AND md.name_id = $name_metastring_id
+     *				AND md.value_id = $value_metastring_id)";
+     *
+     * Note the metadata name and value has been denormalized in the above example.
+     *
+     * @see elgg_get_entities
+     *
+     * @param array $options Array in format:
+     *
+     * 	metadata_names => null|ARR metadata names
+     *
+     * 	metadata_values => null|ARR metadata values
+     *
+     * 	metadata_name_value_pairs => null|ARR (
+     *                                         name => 'name',
+     *                                         value => 'value',
+     *                                         'operand' => '=',
+     *                                         'case_sensitive' => true
+     *                                        )
+     *                               Currently if multiple values are sent via
+     *                               an array (value => array('value1', 'value2')
+     *                               the pair's operand will be forced to "IN".
+     *                               If passing "IN" as the operand and a string as the value, 
+     *                               the value must be a properly quoted and escaped string.
+     *
+     * 	metadata_name_value_pairs_operator => null|STR The operator to use for combining
+     *                                        (name = value) OPERATOR (name = value); default AND
+     *
+     * 	metadata_case_sensitive => BOOL Overall Case sensitive
+     *
+     *  order_by_metadata => null|ARR array(
+     *                                      'name' => 'metadata_text1',
+     *                                      'direction' => ASC|DESC,
+     *                                      'as' => text|integer
+     *                                     )
+     *                                Also supports array('name' => 'metadata_text1')
+     *
+     *  metadata_owner_guids => null|ARR guids for metadata owners
+     *
+     * @return \ElggEntity[]|mixed If count, int. If not count, array. false on errors.
+     */
+    function getEntities(array $options = array()) {
+        $defaults = array(
+            'metadata_names'                     => ELGG_ENTITIES_ANY_VALUE,
+            'metadata_values'                    => ELGG_ENTITIES_ANY_VALUE,
+            'metadata_name_value_pairs'          => ELGG_ENTITIES_ANY_VALUE,
+	
+            'metadata_name_value_pairs_operator' => 'AND',
+            'metadata_case_sensitive'            => true,
+            'order_by_metadata'                  => array(),
+	
+            'metadata_owner_guids'               => ELGG_ENTITIES_ANY_VALUE,
+        );
+	
+        $options = array_merge($defaults, $options);
+	
+        $singulars = array('metadata_name', 'metadata_value',
+            'metadata_name_value_pair', 'metadata_owner_guid');
+	
+        $options = _elgg_normalize_plural_options_array($options, $singulars);
+	
+        if (!$options = _elgg_entities_get_metastrings_options('metadata', $options)) {
+            return false;
+        }
+	
+        return $this->entityTable->getEntities($options);
+    }
+	
+    /**
+     * Returns metadata name and value SQL where for entities.
+     * NB: $names and $values are not paired. Use $pairs for this.
+     * Pairs default to '=' operand.
+     *
+     * This function is reused for annotations because the tables are
+     * exactly the same.
+     *
+     * @param string     $e_table           Entities table name
+     * @param string     $n_table           Normalized metastrings table name (Where entities,
+     *                                    values, and names are joined. annotations / metadata)
+     * @param array|null $names             Array of names
+     * @param array|null $values            Array of values
+     * @param array|null $pairs             Array of names / values / operands
+     * @param string     $pair_operator     ("AND" or "OR") Operator to use to join the where clauses for pairs
+     * @param bool       $case_sensitive    Case sensitive metadata names?
+     * @param array|null $order_by_metadata Array of names / direction
+     * @param array|null $owner_guids       Array of owner GUIDs
+     *
+     * @return false|array False on fail, array('joins', 'wheres')
+     * @access private
+     */
+    function getEntityMetadataWhereSql($e_table, $n_table, $names = null, $values = null,
+            $pairs = null, $pair_operator = 'AND', $case_sensitive = true, $order_by_metadata = null,
+            $owner_guids = null) {
+        // short circuit if nothing requested
+        // 0 is a valid (if not ill-conceived) metadata name.
+        // 0 is also a valid metadata value for false, null, or 0
+        // 0 is also a valid(ish) owner_guid
+        if ((!$names && $names !== 0)
+            && (!$values && $values !== 0)
+            && (!$pairs && $pairs !== 0)
+            && (!$owner_guids && $owner_guids !== 0)
+            && !$order_by_metadata) {
+            return '';
+        }
+	
+        // join counter for incremental joins.
+        $i = 1;
+	
+        // binary forces byte-to-byte comparision of strings, making
+        // it case- and diacritical-mark- sensitive.
+        // only supported on values.
+        $binary = ($case_sensitive) ? ' BINARY ' : '';
+	
+        $access = _elgg_get_access_where_sql(array(
+            'table_alias' => 'n_table',
+            'guid_column' => 'entity_guid',
+        ));
+	
+        $return = array (
+            'joins' => array (),
+            'wheres' => array(),
+            'orders' => array()
+        );
+	
+        // will always want to join these tables if pulling metastrings.
+        $return['joins'][] = "JOIN {$this->db->prefix}{$n_table} n_table on
 			{$e_table}.guid = n_table.entity_guid";
 	
-		$wheres = array();
-	
-		// get names wheres and joins
-		$names_where = '';
-		if ($names !== null) {
-			if (!is_array($names)) {
-				$names = array($names);
-			}
-	
-			$sanitised_names = array();
-			foreach ($names as $name) {
-				// normalise to 0.
-				if (!$name) {
-					$name = '0';
-				}
-				$sanitised_names[] = '\'' . $this->db->sanitizeString($name) . '\'';
-			}
-	
-			if ($names_str = implode(',', $sanitised_names)) {
-				$return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msn on n_table.name_id = msn.id";
-				$names_where = "(msn.string IN ($names_str))";
-			}
-		}
-	
-		// get values wheres and joins
-		$values_where = '';
-		if ($values !== null) {
-			if (!is_array($values)) {
-				$values = array($values);
-			}
-	
-			$sanitised_values = array();
-			foreach ($values as $value) {
-				// normalize to 0
-				if (!$value) {
-					$value = 0;
-				}
-				$sanitised_values[] = '\'' . $this->db->sanitizeString($value) . '\'';
-			}
-	
-			if ($values_str = implode(',', $sanitised_values)) {
-				$return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msv on n_table.value_id = msv.id";
-				$values_where = "({$binary}msv.string IN ($values_str))";
-			}
-		}
-	
-		if ($names_where && $values_where) {
-			$wheres[] = "($names_where AND $values_where AND $access)";
-		} elseif ($names_where) {
-			$wheres[] = "($names_where AND $access)";
-		} elseif ($values_where) {
-			$wheres[] = "($values_where AND $access)";
-		}
-	
-		// add pairs
-		// pairs must be in arrays.
-		if (is_array($pairs)) {
-			// check if this is an array of pairs or just a single pair.
-			if (isset($pairs['name']) || isset($pairs['value'])) {
-				$pairs = array($pairs);
-			}
-	
-			$pair_wheres = array();
-	
-			// @todo when the pairs are > 3 should probably split the query up to
-			// denormalize the strings table.
-	
-			foreach ($pairs as $index => $pair) {
-				// @todo move this elsewhere?
-				// support shortcut 'n' => 'v' method.
-				if (!is_array($pair)) {
-					$pair = array(
-						'name' => $index,
-						'value' => $pair
-					);
-				}
-	
-				// must have at least a name and value
-				if (!isset($pair['name']) || !isset($pair['value'])) {
-					// @todo should probably return false.
-					continue;
-				}
-	
-				// case sensitivity can be specified per pair.
-				// default to higher level setting.
-				if (isset($pair['case_sensitive'])) {
-					$pair_binary = ($pair['case_sensitive']) ? ' BINARY ' : '';
-				} else {
-					$pair_binary = $binary;
-				}
-	
-				if (isset($pair['operand'])) {
-					$operand = $this->db->sanitizeString($pair['operand']);
-				} else {
-					$operand = ' = ';
-				}
-	
-				// for comparing
-				$trimmed_operand = trim(strtolower($operand));
-	
-				$access = _elgg_get_access_where_sql(array(
-					'table_alias' => "n_table{$i}",
-					'guid_column' => 'entity_guid',
-				));
+        $wheres = array();
+	
+        // get names wheres and joins
+        $names_where = '';
+        if ($names !== null) {
+            if (!is_array($names)) {
+                $names = array($names);
+            }
+	
+            $sanitised_names = array();
+            foreach ($names as $name) {
+                // normalise to 0.
+                if (!$name) {
+                    $name = '0';
+                }
+                $sanitised_names[] = '\'' . $this->db->sanitizeString($name) . '\'';
+            }
+	
+            if ($names_str = implode(',', $sanitised_names)) {
+                $return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msn on n_table.name_id = msn.id";
+                $names_where = "(msn.string IN ($names_str))";
+            }
+        }
+	
+        // get values wheres and joins
+        $values_where = '';
+        if ($values !== null) {
+            if (!is_array($values)) {
+                $values = array($values);
+            }
+	
+            $sanitised_values = array();
+            foreach ($values as $value) {
+                // normalize to 0
+                if (!$value) {
+                    $value = 0;
+                }
+                $sanitised_values[] = '\'' . $this->db->sanitizeString($value) . '\'';
+            }
+	
+            if ($values_str = implode(',', $sanitised_values)) {
+                $return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msv on n_table.value_id = msv.id";
+                $values_where = "({$binary}msv.string IN ($values_str))";
+            }
+        }
+	
+        if ($names_where && $values_where) {
+            $wheres[] = "($names_where AND $values_where AND $access)";
+        } elseif ($names_where) {
+            $wheres[] = "($names_where AND $access)";
+        } elseif ($values_where) {
+            $wheres[] = "($values_where AND $access)";
+        }
+	
+        // add pairs
+        // pairs must be in arrays.
+        if (is_array($pairs)) {
+            // check if this is an array of pairs or just a single pair.
+            if (isset($pairs['name']) || isset($pairs['value'])) {
+                $pairs = array($pairs);
+            }
+	
+            $pair_wheres = array();
+	
+            // @todo when the pairs are > 3 should probably split the query up to
+            // denormalize the strings table.
+	
+            foreach ($pairs as $index => $pair) {
+                // @todo move this elsewhere?
+                // support shortcut 'n' => 'v' method.
+                if (!is_array($pair)) {
+                    $pair = array(
+                        'name' => $index,
+                        'value' => $pair
+                    );
+                }
+	
+                // must have at least a name and value
+                if (!isset($pair['name']) || !isset($pair['value'])) {
+                    // @todo should probably return false.
+                    continue;
+                }
+	
+                // case sensitivity can be specified per pair.
+                // default to higher level setting.
+                if (isset($pair['case_sensitive'])) {
+                    $pair_binary = ($pair['case_sensitive']) ? ' BINARY ' : '';
+                } else {
+                    $pair_binary = $binary;
+                }
+	
+                if (isset($pair['operand'])) {
+                    $operand = $this->db->sanitizeString($pair['operand']);
+                } else {
+                    $operand = ' = ';
+                }
+	
+                // for comparing
+                $trimmed_operand = trim(strtolower($operand));
+	
+                $access = _elgg_get_access_where_sql(array(
+                    'table_alias' => "n_table{$i}",
+                    'guid_column' => 'entity_guid',
+                ));
 
-				// certain operands can't work well with strings that can be interpreted as numbers
-				// for direct comparisons like IN, =, != we treat them as strings
-				// gt/lt comparisons need to stay unencapsulated because strings '5' > '15'
-				// see https://github.com/Elgg/Elgg/issues/7009
-				$num_safe_operands = array('>', '<', '>=', '<=');
-				$num_test_operand = trim(strtoupper($operand));
-	
-				if (is_numeric($pair['value']) && in_array($num_test_operand, $num_safe_operands)) {
-					$value = $this->db->sanitizeString($pair['value']);
-				} else if (is_bool($pair['value'])) {
-					$value = (int)$pair['value'];
-				} else if (is_array($pair['value'])) {
-					$values_array = array();
-	
-					foreach ($pair['value'] as $pair_value) {
-						if (is_numeric($pair_value) && !in_array($num_test_operand, $num_safe_operands)) {
-							$values_array[] = $this->db->sanitizeString($pair_value);
-						} else {
-							$values_array[] = "'" . $this->db->sanitizeString($pair_value) . "'";
-						}
-					}
-	
-					if ($values_array) {
-						$value = '(' . implode(', ', $values_array) . ')';
-					}
-	
-					// @todo allow support for non IN operands with array of values.
-					// will have to do more silly joins.
-					$operand = 'IN';
-				} else if ($trimmed_operand == 'in') {
-					$value = "({$pair['value']})";
-				} else {
-					$value = "'" . $this->db->sanitizeString($pair['value']) . "'";
-				}
-	
-				$name = $this->db->sanitizeString($pair['name']);
-	
-				// @todo The multiple joins are only needed when the operator is AND
-				$return['joins'][] = "JOIN {$this->db->prefix}{$n_table} n_table{$i}
+                // certain operands can't work well with strings that can be interpreted as numbers
+                // for direct comparisons like IN, =, != we treat them as strings
+                // gt/lt comparisons need to stay unencapsulated because strings '5' > '15'
+                // see https://github.com/Elgg/Elgg/issues/7009
+                $num_safe_operands = array('>', '<', '>=', '<=');
+                $num_test_operand = trim(strtoupper($operand));
+	
+                if (is_numeric($pair['value']) && in_array($num_test_operand, $num_safe_operands)) {
+                    $value = $this->db->sanitizeString($pair['value']);
+                } else if (is_bool($pair['value'])) {
+                    $value = (int)$pair['value'];
+                } else if (is_array($pair['value'])) {
+                    $values_array = array();
+	
+                    foreach ($pair['value'] as $pair_value) {
+                        if (is_numeric($pair_value) && !in_array($num_test_operand, $num_safe_operands)) {
+                            $values_array[] = $this->db->sanitizeString($pair_value);
+                        } else {
+                            $values_array[] = "'" . $this->db->sanitizeString($pair_value) . "'";
+                        }
+                    }
+	
+                    if ($values_array) {
+                        $value = '(' . implode(', ', $values_array) . ')';
+                    }
+	
+                    // @todo allow support for non IN operands with array of values.
+                    // will have to do more silly joins.
+                    $operand = 'IN';
+                } else if ($trimmed_operand == 'in') {
+                    $value = "({$pair['value']})";
+                } else {
+                    $value = "'" . $this->db->sanitizeString($pair['value']) . "'";
+                }
+	
+                $name = $this->db->sanitizeString($pair['name']);
+	
+                // @todo The multiple joins are only needed when the operator is AND
+                $return['joins'][] = "JOIN {$this->db->prefix}{$n_table} n_table{$i}
 					on {$e_table}.guid = n_table{$i}.entity_guid";
-				$return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msn{$i}
+                $return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msn{$i}
 					on n_table{$i}.name_id = msn{$i}.id";
-				$return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msv{$i}
+                $return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msv{$i}
 					on n_table{$i}.value_id = msv{$i}.id";
 	
-				$pair_wheres[] = "(msn{$i}.string = '$name' AND {$pair_binary}msv{$i}.string
+                $pair_wheres[] = "(msn{$i}.string = '$name' AND {$pair_binary}msv{$i}.string
 					$operand $value AND $access)";
 	
-				$i++;
-			}
-	
-			if ($where = implode(" $pair_operator ", $pair_wheres)) {
-				$wheres[] = "($where)";
-			}
-		}
-	
-		// add owner_guids
-		if ($owner_guids) {
-			if (is_array($owner_guids)) {
-				$sanitised = array_map('sanitise_int', $owner_guids);
-				$owner_str = implode(',', $sanitised);
-			} else {
-				$owner_str = (int)$owner_guids;
-			}
-	
-			$wheres[] = "(n_table.owner_guid IN ($owner_str))";
-		}
-	
-		if ($where = implode(' AND ', $wheres)) {
-			$return['wheres'][] = "($where)";
-		}
-	
-		if (is_array($order_by_metadata)) {
-			if ((count($order_by_metadata) > 0) && !isset($order_by_metadata[0])) {
-				// singleton, so fix
-				$order_by_metadata = array($order_by_metadata);
-			}
-			foreach ($order_by_metadata as $order_by) {
-				if (is_array($order_by) && isset($order_by['name'])) {
-					$name = $this->db->sanitizeString($order_by['name']);
-					if (isset($order_by['direction'])) {
-						$direction = $this->db->sanitizeString($order_by['direction']);
-					} else {
-						$direction = 'ASC';
-					}
-					$return['joins'][] = "JOIN {$this->db->prefix}{$n_table} n_table{$i}
+                $i++;
+            }
+	
+            if ($where = implode(" $pair_operator ", $pair_wheres)) {
+                $wheres[] = "($where)";
+            }
+        }
+	
+        // add owner_guids
+        if ($owner_guids) {
+            if (is_array($owner_guids)) {
+                $sanitised = array_map('sanitise_int', $owner_guids);
+                $owner_str = implode(',', $sanitised);
+            } else {
+                $owner_str = (int)$owner_guids;
+            }
+	
+            $wheres[] = "(n_table.owner_guid IN ($owner_str))";
+        }
+	
+        if ($where = implode(' AND ', $wheres)) {
+            $return['wheres'][] = "($where)";
+        }
+	
+        if (is_array($order_by_metadata)) {
+            if ((count($order_by_metadata) > 0) && !isset($order_by_metadata[0])) {
+                // singleton, so fix
+                $order_by_metadata = array($order_by_metadata);
+            }
+            foreach ($order_by_metadata as $order_by) {
+                if (is_array($order_by) && isset($order_by['name'])) {
+                    $name = $this->db->sanitizeString($order_by['name']);
+                    if (isset($order_by['direction'])) {
+                        $direction = $this->db->sanitizeString($order_by['direction']);
+                    } else {
+                        $direction = 'ASC';
+                    }
+                    $return['joins'][] = "JOIN {$this->db->prefix}{$n_table} n_table{$i}
 						on {$e_table}.guid = n_table{$i}.entity_guid";
-					$return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msn{$i}
+                    $return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msn{$i}
 						on n_table{$i}.name_id = msn{$i}.id";
-					$return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msv{$i}
+                    $return['joins'][] = "JOIN {$this->metastringsTable->getTableName()} msv{$i}
 						on n_table{$i}.value_id = msv{$i}.id";
 	
-					$access = _elgg_get_access_where_sql(array(
-						'table_alias' => "n_table{$i}",
-						'guid_column' => 'entity_guid',
-					));
-	
-					$return['wheres'][] = "(msn{$i}.string = '$name' AND $access)";
-					if (isset($order_by['as']) && $order_by['as'] == 'integer') {
-						$return['orders'][] = "CAST(msv{$i}.string AS SIGNED) $direction";
-					} else {
-						$return['orders'][] = "msv{$i}.string $direction";
-					}
-					$i++;
-				}
-			}
-		}
-	
-		return $return;
-	}
-	
-	/**
-	 * Get the URL for this metadata
-	 *
-	 * By default this links to the export handler in the current view.
-	 *
-	 * @param int $id Metadata ID
-	 *
-	 * @return mixed
-	 */
-	function getUrl($id) {
-		$extender = $this->get($id);
+                    $access = _elgg_get_access_where_sql(array(
+                        'table_alias' => "n_table{$i}",
+                        'guid_column' => 'entity_guid',
+                    ));
+	
+                    $return['wheres'][] = "(msn{$i}.string = '$name' AND $access)";
+                    if (isset($order_by['as']) && $order_by['as'] == 'integer') {
+                        $return['orders'][] = "CAST(msv{$i}.string AS SIGNED) $direction";
+                    } else {
+                        $return['orders'][] = "msv{$i}.string $direction";
+                    }
+                    $i++;
+                }
+            }
+        }
+	
+        return $return;
+    }
+	
+    /**
+     * Get the URL for this metadata
+     *
+     * By default this links to the export handler in the current view.
+     *
+     * @param int $id Metadata ID
+     *
+     * @return mixed
+     */
+    function getUrl($id) {
+        $extender = $this->get($id);
 
-		return $extender ? $extender->getURL() : false;
-	}
-	
-	/**
-	 * Mark entities with a particular type and subtype as having access permissions
-	 * that can be changed independently from their parent entity
-	 *
-	 * @param string $type    The type - object, user, etc
-	 * @param string $subtype The subtype; all subtypes by default
-	 *
-	 * @return void
-	 */
-	function registerMetadataAsIndependent($type, $subtype = '*') {
-		if (!isset($this->independents[$type])) {
-			$this->independents[$type] = array();
-		}
+        return $extender ? $extender->getURL() : false;
+    }
+	
+    /**
+     * Mark entities with a particular type and subtype as having access permissions
+     * that can be changed independently from their parent entity
+     *
+     * @param string $type    The type - object, user, etc
+     * @param string $subtype The subtype; all subtypes by default
+     *
+     * @return void
+     */
+    function registerMetadataAsIndependent($type, $subtype = '*') {
+        if (!isset($this->independents[$type])) {
+            $this->independents[$type] = array();
+        }
 		
-		$this->independents[$type][$subtype] = true;
-	}
-	
-	/**
-	 * Determines whether entities of a given type and subtype should not change
-	 * their metadata in line with their parent entity
-	 *
-	 * @param string $type    The type - object, user, etc
-	 * @param string $subtype The entity subtype
-	 *
-	 * @return bool
-	 */
-	function isMetadataIndependent($type, $subtype) {
-		if (empty($this->independents[$type])) {
-			return false;
-		}
+        $this->independents[$type][$subtype] = true;
+    }
+	
+    /**
+     * Determines whether entities of a given type and subtype should not change
+     * their metadata in line with their parent entity
+     *
+     * @param string $type    The type - object, user, etc
+     * @param string $subtype The entity subtype
+     *
+     * @return bool
+     */
+    function isMetadataIndependent($type, $subtype) {
+        if (empty($this->independents[$type])) {
+            return false;
+        }
 
-		return !empty($this->independents[$type][$subtype])
-			|| !empty($this->independents[$type]['*']);
-	}
-	
-	/**
-	 * When an entity is updated, resets the access ID on all of its child metadata
-	 *
-	 * @param string      $event       The name of the event
-	 * @param string      $object_type The type of object
-	 * @param \ElggEntity $object      The entity itself
-	 *
-	 * @return true
-	 * @access private Set as private in 1.9.0
-	 */
-	function handleUpdate($event, $object_type, $object) {
-		if ($object instanceof \ElggEntity) {
-			if (!$this->isMetadataIndependent($object->getType(), $object->getSubtype())) {
-				$access_id = (int)$object->access_id;
-				$guid = (int)$object->getGUID();
-				$query = "update {$this->table} set access_id = {$access_id} where entity_guid = {$guid}";
-				$this->db->updateData($query);
-			}
-		}
-		return true;
-	}
+        return !empty($this->independents[$type][$subtype])
+            || !empty($this->independents[$type]['*']);
+    }
+	
+    /**
+     * When an entity is updated, resets the access ID on all of its child metadata
+     *
+     * @param string      $event       The name of the event
+     * @param string      $object_type The type of object
+     * @param \ElggEntity $object      The entity itself
+     *
+     * @return true
+     * @access private Set as private in 1.9.0
+     */
+    function handleUpdate($event, $object_type, $object) {
+        if ($object instanceof \ElggEntity) {
+            if (!$this->isMetadataIndependent($object->getType(), $object->getSubtype())) {
+                $access_id = (int)$object->access_id;
+                $guid = (int)$object->getGUID();
+                $query = "update {$this->table} set access_id = {$access_id} where entity_guid = {$guid}";
+                $this->db->updateData($query);
+            }
+        }
+        return true;
+    }
 	
 }

Spacing +21 added lines, -21 removed lines

@@ -69,7 +69,7 @@ 
 		$this->events = $events;
 		$this->metastringsTable = $metastringsTable;
 		$this->session = $session;
-		$this->table = $this->db->prefix . "metadata";
+		$this->table = $this->db->prefix."metadata";
 	}
 
 	/**
@@ -116,12 +116,12 @@ 
 	function create($entity_guid, $name, $value, $value_type = '', $owner_guid = 0,
 			$access_id = ACCESS_PRIVATE, $allow_multiple = false) {
 
-		$entity_guid = (int)$entity_guid;
+		$entity_guid = (int) $entity_guid;
 		// name and value are encoded in add_metastring()
 		$value_type = \ElggExtender::detectValueType($value, trim($value_type));
 		$time = $this->getCurrentTime()->getTimestamp();
-		$owner_guid = (int)$owner_guid;
-		$allow_multiple = (boolean)$allow_multiple;
+		$owner_guid = (int) $owner_guid;
+		$allow_multiple = (boolean) $allow_multiple;
 	
 		if (!isset($value)) {
 			return false;
@@ -143,7 +143,7 @@ 
 
 		$existing = $this->db->getDataRow($query, null, $params);
 		if ($existing && !$allow_multiple) {
-			$id = (int)$existing->id;
+			$id = (int) $existing->id;
 			$result = $this->update($id, $name, $value, $value_type, $owner_guid, $access_id);
 	
 			if (!$result) {
@@ -152,7 +152,7 @@ 
 		} else {
 			// Support boolean types
 			if (is_bool($value)) {
-				$value = (int)$value;
+				$value = (int) $value;
 			}
 	
 			// Add the metastrings
@@ -212,7 +212,7 @@ 
 	 * @return bool
 	 */
 	function update($id, $name, $value, $value_type, $owner_guid, $access_id) {
-		$id = (int)$id;
+		$id = (int) $id;
 	
 		if (!$md = $this->get($id)) {
 			return false;
@@ -223,16 +223,16 @@ 
 	
 		$value_type = \ElggExtender::detectValueType($value, trim($value_type));
 	
-		$owner_guid = (int)$owner_guid;
+		$owner_guid = (int) $owner_guid;
 		if ($owner_guid == 0) {
 			$owner_guid = $this->session->getLoggedInUserGuid();
 		}
 	
-		$access_id = (int)$access_id;
+		$access_id = (int) $access_id;
 	
 		// Support boolean types (as integers)
 		if (is_bool($value)) {
-			$value = (int)$value;
+			$value = (int) $value;
 		}
 	
 		$value_id = $this->metastringsTable->getId($value);
@@ -555,8 +555,8 @@ 
 			'guid_column' => 'entity_guid',
 		));
 	
-		$return = array (
-			'joins' => array (),
+		$return = array(
+			'joins' => array(),
 			'wheres' => array(),
 			'orders' => array()
 		);
@@ -580,7 +580,7 @@ 
 				if (!$name) {
 					$name = '0';
 				}
-				$sanitised_names[] = '\'' . $this->db->sanitizeString($name) . '\'';
+				$sanitised_names[] = '\''.$this->db->sanitizeString($name).'\'';
 			}
 	
 			if ($names_str = implode(',', $sanitised_names)) {
@@ -602,7 +602,7 @@ 
 				if (!$value) {
 					$value = 0;
 				}
-				$sanitised_values[] = '\'' . $this->db->sanitizeString($value) . '\'';
+				$sanitised_values[] = '\''.$this->db->sanitizeString($value).'\'';
 			}
 	
 			if ($values_str = implode(',', $sanitised_values)) {
@@ -680,7 +680,7 @@ 
 				if (is_numeric($pair['value']) && in_array($num_test_operand, $num_safe_operands)) {
 					$value = $this->db->sanitizeString($pair['value']);
 				} else if (is_bool($pair['value'])) {
-					$value = (int)$pair['value'];
+					$value = (int) $pair['value'];
 				} else if (is_array($pair['value'])) {
 					$values_array = array();
 	
@@ -688,12 +688,12 @@ 
 						if (is_numeric($pair_value) && !in_array($num_test_operand, $num_safe_operands)) {
 							$values_array[] = $this->db->sanitizeString($pair_value);
 						} else {
-							$values_array[] = "'" . $this->db->sanitizeString($pair_value) . "'";
+							$values_array[] = "'".$this->db->sanitizeString($pair_value)."'";
 						}
 					}
 	
 					if ($values_array) {
-						$value = '(' . implode(', ', $values_array) . ')';
+						$value = '('.implode(', ', $values_array).')';
 					}
 	
 					// @todo allow support for non IN operands with array of values.
@@ -702,7 +702,7 @@ 
 				} else if ($trimmed_operand == 'in') {
 					$value = "({$pair['value']})";
 				} else {
-					$value = "'" . $this->db->sanitizeString($pair['value']) . "'";
+					$value = "'".$this->db->sanitizeString($pair['value'])."'";
 				}
 	
 				$name = $this->db->sanitizeString($pair['name']);
@@ -732,7 +732,7 @@ 
 				$sanitised = array_map('sanitise_int', $owner_guids);
 				$owner_str = implode(',', $sanitised);
 			} else {
-				$owner_str = (int)$owner_guids;
+				$owner_str = (int) $owner_guids;
 			}
 	
 			$wheres[] = "(n_table.owner_guid IN ($owner_str))";
@@ -844,8 +844,8 @@ 
 	function handleUpdate($event, $object_type, $object) {
 		if ($object instanceof \ElggEntity) {
 			if (!$this->isMetadataIndependent($object->getType(), $object->getSubtype())) {
-				$access_id = (int)$object->access_id;
-				$guid = (int)$object->getGUID();
+				$access_id = (int) $object->access_id;
+				$guid = (int) $object->getGUID();
 				$query = "update {$this->table} set access_id = {$access_id} where entity_guid = {$guid}";
 				$this->db->updateData($query);
 			}

engine/classes/Elgg/Database/SiteSecret.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 	 *
 	 * Note: Old secrets were hex encoded.
 	 *
-	 * @return mixed The site secret hash or false
+	 * @return string|false The site secret hash or false
 	 * @access private
 	 */
 	function init() {

Indentation +100 added lines, -100 removed lines

@@ -21,114 +21,114 @@
  */
 class SiteSecret {
 
-	/**
-	 * @var Datalist
-	 */
-	private $datalist;
+    /**
+     * @var Datalist
+     */
+    private $datalist;
 
-	/**
-	 * Constructor
-	 *
-	 * @param Datalist $datalist Datalist table
-	 */
-	public function __construct(Datalist $datalist) {
-		$this->datalist = $datalist;
-	}
+    /**
+     * Constructor
+     *
+     * @param Datalist $datalist Datalist table
+     */
+    public function __construct(Datalist $datalist) {
+        $this->datalist = $datalist;
+    }
 
-	/**
-	 * @var string
-	 */
-	private $test_secret = '';
+    /**
+     * @var string
+     */
+    private $test_secret = '';
 
-	/**
-	 * Set a secret to be used in testing
-	 *
-	 * @param string $secret Testing site secret. 32 alphanums starting with "z"
-	 * @return void
-	 */
-	public function setTestingSecret($secret) {
-		$this->test_secret = $secret;
-	}
+    /**
+     * Set a secret to be used in testing
+     *
+     * @param string $secret Testing site secret. 32 alphanums starting with "z"
+     * @return void
+     */
+    public function setTestingSecret($secret) {
+        $this->test_secret = $secret;
+    }
 
-	/**
-	 * Initialise the site secret (32 bytes: "z" to indicate format + 186-bit key in Base64 URL).
-	 *
-	 * Used during installation and saves as a datalist.
-	 *
-	 * Note: Old secrets were hex encoded.
-	 *
-	 * @return mixed The site secret hash or false
-	 * @access private
-	 */
-	function init() {
-		$secret = 'z' . _elgg_services()->crypto->getRandomString(31);
+    /**
+     * Initialise the site secret (32 bytes: "z" to indicate format + 186-bit key in Base64 URL).
+     *
+     * Used during installation and saves as a datalist.
+     *
+     * Note: Old secrets were hex encoded.
+     *
+     * @return mixed The site secret hash or false
+     * @access private
+     */
+    function init() {
+        $secret = 'z' . _elgg_services()->crypto->getRandomString(31);
 
-		if ($this->datalist->set('__site_secret__', $secret)) {
-			return $secret;
-		}
+        if ($this->datalist->set('__site_secret__', $secret)) {
+            return $secret;
+        }
 
-		return false;
-	}
+        return false;
+    }
 
-	/**
-	 * Returns the site secret.
-	 *
-	 * Used to generate difficult to guess hashes for sessions and action tokens.
-	 *
-	 * @param bool $raw If true, a binary key will be returned
-	 *
-	 * @return string Site secret.
-	 * @access private
-	 */
-	function get($raw = false) {
-		if ($this->test_secret) {
-			$secret = $this->test_secret;
-		} else {
-			$secret = $this->datalist->get('__site_secret__');
-		}
-		if (!$secret) {
-			$secret = $this->init();
-		}
+    /**
+     * Returns the site secret.
+     *
+     * Used to generate difficult to guess hashes for sessions and action tokens.
+     *
+     * @param bool $raw If true, a binary key will be returned
+     *
+     * @return string Site secret.
+     * @access private
+     */
+    function get($raw = false) {
+        if ($this->test_secret) {
+            $secret = $this->test_secret;
+        } else {
+            $secret = $this->datalist->get('__site_secret__');
+        }
+        if (!$secret) {
+            $secret = $this->init();
+        }
 
-		if ($raw) {
-			// try to return binary key
-			if ($secret[0] === 'z') {
-				// new keys are "z" + base64URL
-				$base64 = strtr(substr($secret, 1), '-_', '+/');
-				$key = base64_decode($base64);
-				if ($key !== false) {
-					// on failure, at least return string key :/
-					return $key;
-				}
-			} else {
-				// old keys are hex
-				return hex2bin($secret);
-			}
-		}
+        if ($raw) {
+            // try to return binary key
+            if ($secret[0] === 'z') {
+                // new keys are "z" + base64URL
+                $base64 = strtr(substr($secret, 1), '-_', '+/');
+                $key = base64_decode($base64);
+                if ($key !== false) {
+                    // on failure, at least return string key :/
+                    return $key;
+                }
+            } else {
+                // old keys are hex
+                return hex2bin($secret);
+            }
+        }
 
-		return $secret;
-	}
+        return $secret;
+    }
 
-	/**
-	 * Get the strength of the site secret
-	 *
-	 * If "weak" or "moderate" is returned, this assumes we're running on the same system that created
-	 * the key.
-	 *
-	 * @return string "strong", "moderate", or "weak"
-	 * @access private
-	 */
-	function getStrength() {
-		$secret = $this->get();
-		if ($secret[0] !== 'z') {
-			$rand_max = getrandmax();
-			if ($rand_max < pow(2, 16)) {
-				return 'weak';
-			}
-			if ($rand_max < pow(2, 32)) {
-				return 'moderate';
-			}
-		}
-		return 'strong';
-	}
+    /**
+     * Get the strength of the site secret
+     *
+     * If "weak" or "moderate" is returned, this assumes we're running on the same system that created
+     * the key.
+     *
+     * @return string "strong", "moderate", or "weak"
+     * @access private
+     */
+    function getStrength() {
+        $secret = $this->get();
+        if ($secret[0] !== 'z') {
+            $rand_max = getrandmax();
+            if ($rand_max < pow(2, 16)) {
+                return 'weak';
+            }
+            if ($rand_max < pow(2, 32)) {
+                return 'moderate';
+            }
+        }
+        return 'strong';
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
 	 * @access private
 	 */
 	function init() {
-		$secret = 'z' . _elgg_services()->crypto->getRandomString(31);
+		$secret = 'z'._elgg_services()->crypto->getRandomString(31);
 
 		if ($this->datalist->set('__site_secret__', $secret)) {
 			return $secret;

engine/classes/Elgg/Http/Request.php

Doc Comments +1 added lines

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

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
 	 */
 	public function setUrlSegments(array $segments) {
 		$query = $this->query->all();
-		$query[Application::GET_PATH_KEY] = '/' . implode('/', $segments);
+		$query[Application::GET_PATH_KEY] = '/'.implode('/', $segments);
 		return $this->duplicate($query);
 	}
 

Indentation +68 added lines, -68 removed lines

@@ -11,79 +11,79 @@
  */
 class Request extends SymfonyRequest {
 
-	/**
-	 * 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->query->get(Application::GET_PATH_KEY), '/');
-		if (!$raw) {
-			$path = htmlspecialchars($path, ENT_QUOTES, 'UTF-8');
-		}
-		if (!$path) {
-			return array();
-		}
+    /**
+     * 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->query->get(Application::GET_PATH_KEY), '/');
+        if (!$raw) {
+            $path = htmlspecialchars($path, ENT_QUOTES, 'UTF-8');
+        }
+        if (!$path) {
+            return array();
+        }
 
-		return explode('/', $path);
-	}
+        return explode('/', $path);
+    }
 
-	/**
-	 * Get a cloned request with new Elgg URL segments
-	 *
-	 * @param string[] $segments URL segments
-	 *
-	 * @return Request
-	 */
-	public function setUrlSegments(array $segments) {
-		$query = $this->query->all();
-		$query[Application::GET_PATH_KEY] = '/' . implode('/', $segments);
-		return $this->duplicate($query);
-	}
+    /**
+     * Get a cloned request with new Elgg URL segments
+     *
+     * @param string[] $segments URL segments
+     *
+     * @return Request
+     */
+    public function setUrlSegments(array $segments) {
+        $query = $this->query->all();
+        $query[Application::GET_PATH_KEY] = '/' . implode('/', $segments);
+        return $this->duplicate($query);
+    }
 
-	/**
-	 * 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 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 '';
+        }
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getClientIp() {
-		$ip = parent::getClientIp();
+    /**
+     * {@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);
-			}
-		}
+        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;
-	}
+        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
-	}
+    /**
+     * {@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
+    }
 }

engine/classes/Elgg/Notifications/NotificationsService.php

Doc Comments +6 added lines

@@ -59,6 +59,8 @@ 
 	/**
 	 * @see elgg_register_notification_event()
 	 * @access private
+	 * @param string $type
+	 * @param string $subtype
 	 */
 	public function registerEvent($type, $subtype, array $actions = array()) {
 
@@ -80,6 +82,8 @@ 
 	/**
 	 * @see elgg_unregister_notification_event()
 	 * @access private
+	 * @param string $type
+	 * @param string $subtype
 	 */
 	public function unregisterEvent($type, $subtype) {
 
@@ -102,6 +106,7 @@ 
 	/**
 	 * @see elgg_register_notification_method()
 	 * @access private
+	 * @param string $name
 	 */
 	public function registerMethod($name) {
 		$this->methods[$name] = $name;
@@ -110,6 +115,7 @@ 
 	/**
 	 * @see elgg_unregister_notification_method()
 	 * @access private
+	 * @param string $name
 	 */
 	public function unregisterMethod($name) {
 		if (isset($this->methods[$name])) {

Indentation +720 added lines, -720 removed lines

@@ -25,746 +25,746 @@
  */
 class NotificationsService {
 
-	const QUEUE_NAME = 'notifications';
+    const QUEUE_NAME = 'notifications';
 
-	/** @var SubscriptionsService */
-	protected $subscriptions;
+    /** @var SubscriptionsService */
+    protected $subscriptions;
 
-	/** @var Queue */
-	protected $queue;
+    /** @var Queue */
+    protected $queue;
 
-	/** @var PluginHooksService */
-	protected $hooks;
+    /** @var PluginHooksService */
+    protected $hooks;
 
-	/** @var ElggSession */
-	protected $session;
+    /** @var ElggSession */
+    protected $session;
 
-	/** @var Translator */
-	protected $translator;
+    /** @var Translator */
+    protected $translator;
 
-	/** @var EntityTable */
-	protected $entities;
+    /** @var EntityTable */
+    protected $entities;
 
-	/** @var Logger */
-	protected $logger;
+    /** @var Logger */
+    protected $logger;
 	
-	/** @var array Registered notification events */
-	protected $events = array();
-
-	/** @var array Registered notification methods */
-	protected $methods = array();
-
-	/** @var array Deprecated notification handlers */
-	protected $deprHandlers = array();
-
-	/** @var array Deprecated message subjects */
-	protected $deprSubjects = array();
-
-	/**
-	 * Constructor
-	 *
-	 * @param SubscriptionsService $subscriptions Subscription service
-	 * @param Queue                $queue         Queue
-	 * @param PluginHooksService   $hooks         Plugin hook service
-	 * @param ElggSession          $session       Session service
-	 * @param Translator           $translator    Translator
-	 * @param EntityTable          $entities      Entity table
-	 * @param Logger               $logger        Logger
-	 */
-	public function __construct(
-			SubscriptionsService $subscriptions,
-			Queue $queue, PluginHooksService $hooks,
-			ElggSession $session,
-			Translator $translator,
-			EntityTable $entities,
-			Logger $logger) {
-
-		$this->subscriptions = $subscriptions;
-		$this->queue = $queue;
-		$this->hooks = $hooks;
-		$this->session = $session;
-		$this->translator = $translator;
-		$this->entities = $entities;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * @see elgg_register_notification_event()
-	 * @access private
-	 */
-	public function registerEvent($type, $subtype, array $actions = array()) {
-
-		if (!isset($this->events[$type])) {
-			$this->events[$type] = array();
-		}
-		if (!isset($this->events[$type][$subtype])) {
-			$this->events[$type][$subtype] = array();
-		}
-
-		$action_list =& $this->events[$type][$subtype];
-		if ($actions) {
-			$action_list = array_unique(array_merge($action_list, $actions));
-		} elseif (!in_array('create', $action_list)) {
-			$action_list[] = 'create';
-		}
-	}
-
-	/**
-	 * @see elgg_unregister_notification_event()
-	 * @access private
-	 */
-	public function unregisterEvent($type, $subtype) {
-
-		if (!isset($this->events[$type]) || !isset($this->events[$type][$subtype])) {
-			return false;
-		}
-
-		unset($this->events[$type][$subtype]);
-
-		return true;
-	}
-
-	/**
-	 * @access private
-	 */
-	public function getEvents() {
-		return $this->events;
-	}
-
-	/**
-	 * @see elgg_register_notification_method()
-	 * @access private
-	 */
-	public function registerMethod($name) {
-		$this->methods[$name] = $name;
-	}
-
-	/**
-	 * @see elgg_unregister_notification_method()
-	 * @access private
-	 */
-	public function unregisterMethod($name) {
-		if (isset($this->methods[$name])) {
-			unset($this->methods[$name]);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * @access private
-	 */
-	public function getMethods() {
-		return $this->methods;
-	}
-
-	/**
-	 * Add a notification event to the queue
-	 *
-	 * @param string   $action Action name
-	 * @param string   $type   Type of the object of the action
-	 * @param ElggData $object The object of the action
-	 * @return void
-	 * @access private
-	 */
-	public function enqueueEvent($action, $type, $object) {
+    /** @var array Registered notification events */
+    protected $events = array();
+
+    /** @var array Registered notification methods */
+    protected $methods = array();
+
+    /** @var array Deprecated notification handlers */
+    protected $deprHandlers = array();
+
+    /** @var array Deprecated message subjects */
+    protected $deprSubjects = array();
+
+    /**
+     * Constructor
+     *
+     * @param SubscriptionsService $subscriptions Subscription service
+     * @param Queue                $queue         Queue
+     * @param PluginHooksService   $hooks         Plugin hook service
+     * @param ElggSession          $session       Session service
+     * @param Translator           $translator    Translator
+     * @param EntityTable          $entities      Entity table
+     * @param Logger               $logger        Logger
+     */
+    public function __construct(
+            SubscriptionsService $subscriptions,
+            Queue $queue, PluginHooksService $hooks,
+            ElggSession $session,
+            Translator $translator,
+            EntityTable $entities,
+            Logger $logger) {
+
+        $this->subscriptions = $subscriptions;
+        $this->queue = $queue;
+        $this->hooks = $hooks;
+        $this->session = $session;
+        $this->translator = $translator;
+        $this->entities = $entities;
+        $this->logger = $logger;
+    }
+
+    /**
+     * @see elgg_register_notification_event()
+     * @access private
+     */
+    public function registerEvent($type, $subtype, array $actions = array()) {
+
+        if (!isset($this->events[$type])) {
+            $this->events[$type] = array();
+        }
+        if (!isset($this->events[$type][$subtype])) {
+            $this->events[$type][$subtype] = array();
+        }
+
+        $action_list =& $this->events[$type][$subtype];
+        if ($actions) {
+            $action_list = array_unique(array_merge($action_list, $actions));
+        } elseif (!in_array('create', $action_list)) {
+            $action_list[] = 'create';
+        }
+    }
+
+    /**
+     * @see elgg_unregister_notification_event()
+     * @access private
+     */
+    public function unregisterEvent($type, $subtype) {
+
+        if (!isset($this->events[$type]) || !isset($this->events[$type][$subtype])) {
+            return false;
+        }
+
+        unset($this->events[$type][$subtype]);
+
+        return true;
+    }
+
+    /**
+     * @access private
+     */
+    public function getEvents() {
+        return $this->events;
+    }
+
+    /**
+     * @see elgg_register_notification_method()
+     * @access private
+     */
+    public function registerMethod($name) {
+        $this->methods[$name] = $name;
+    }
+
+    /**
+     * @see elgg_unregister_notification_method()
+     * @access private
+     */
+    public function unregisterMethod($name) {
+        if (isset($this->methods[$name])) {
+            unset($this->methods[$name]);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @access private
+     */
+    public function getMethods() {
+        return $this->methods;
+    }
+
+    /**
+     * Add a notification event to the queue
+     *
+     * @param string   $action Action name
+     * @param string   $type   Type of the object of the action
+     * @param ElggData $object The object of the action
+     * @return void
+     * @access private
+     */
+    public function enqueueEvent($action, $type, $object) {
 		
-		if ($object instanceof ElggData) {
-			$object_type = $object->getType();
-			$object_subtype = $object->getSubtype();
-
-			$registered = false;
-			if (!empty($this->events[$object_type][$object_subtype]) && in_array($action, $this->events[$object_type][$object_subtype])) {
-				$registered = true;
-			}
-
-			if ($registered) {
-				$params = array(
-					'action' => $action,
-					'object' => $object,
-				);
-				$registered = $this->hooks->trigger('enqueue', 'notification', $params, $registered);
-			}
-
-			if ($registered) {
-				$this->queue->enqueue(new SubscriptionNotificationEvent($object, $action));
-			}
-		}
-	}
-
-	/**
-	 * Pull notification events from queue until stop time is reached
-	 *
-	 * @param int  $stopTime The Unix time to stop sending notifications
-	 * @param bool $matrix   If true, will return delivery matrix instead of a notifications event count
-	 * @return int|array The number of notification events handled, or a delivery matrix
-	 * @access private
-	 */
-	public function processQueue($stopTime, $matrix = false) {
-
-		$this->subscriptions->methods = $this->methods;
-
-		$delivery_matrix = [];
-
-		$count = 0;
-
-		// @todo grab mutex
-
-		$ia = $this->session->setIgnoreAccess(true);
-
-		while (time() < $stopTime) {
-			// dequeue notification event
-			$event = $this->queue->dequeue();
-			/* @var $event NotificationEvent */
-
-			if (!$event) {
-				// queue is empty
-				break;
-			}
-
-			if (!$event instanceof NotificationEvent || !$event->getObject() || !$event->getActor()) {
-				// event object or actor have been deleted since the event was enqueued
-				continue;
-			}
+        if ($object instanceof ElggData) {
+            $object_type = $object->getType();
+            $object_subtype = $object->getSubtype();
+
+            $registered = false;
+            if (!empty($this->events[$object_type][$object_subtype]) && in_array($action, $this->events[$object_type][$object_subtype])) {
+                $registered = true;
+            }
+
+            if ($registered) {
+                $params = array(
+                    'action' => $action,
+                    'object' => $object,
+                );
+                $registered = $this->hooks->trigger('enqueue', 'notification', $params, $registered);
+            }
+
+            if ($registered) {
+                $this->queue->enqueue(new SubscriptionNotificationEvent($object, $action));
+            }
+        }
+    }
+
+    /**
+     * Pull notification events from queue until stop time is reached
+     *
+     * @param int  $stopTime The Unix time to stop sending notifications
+     * @param bool $matrix   If true, will return delivery matrix instead of a notifications event count
+     * @return int|array The number of notification events handled, or a delivery matrix
+     * @access private
+     */
+    public function processQueue($stopTime, $matrix = false) {
+
+        $this->subscriptions->methods = $this->methods;
+
+        $delivery_matrix = [];
+
+        $count = 0;
+
+        // @todo grab mutex
+
+        $ia = $this->session->setIgnoreAccess(true);
+
+        while (time() < $stopTime) {
+            // dequeue notification event
+            $event = $this->queue->dequeue();
+            /* @var $event NotificationEvent */
+
+            if (!$event) {
+                // queue is empty
+                break;
+            }
+
+            if (!$event instanceof NotificationEvent || !$event->getObject() || !$event->getActor()) {
+                // event object or actor have been deleted since the event was enqueued
+                continue;
+            }
 		
-			// test for usage of the deprecated override hook
-			if ($this->existsDeprecatedNotificationOverride($event)) {
-				continue;
-			}
+            // test for usage of the deprecated override hook
+            if ($this->existsDeprecatedNotificationOverride($event)) {
+                continue;
+            }
 
-			$subscriptions = $this->subscriptions->getSubscriptions($event);
+            $subscriptions = $this->subscriptions->getSubscriptions($event);
 			
-			// return false to stop the default notification sender
-			$params = [
-				'event' => $event,
-				'subscriptions' => $subscriptions
-			];
+            // return false to stop the default notification sender
+            $params = [
+                'event' => $event,
+                'subscriptions' => $subscriptions
+            ];
 			
-			$deliveries = [];
-			if ($this->hooks->trigger('send:before', 'notifications', $params, true)) {
-				$deliveries = $this->sendNotifications($event, $subscriptions);
-			}
-			$params['deliveries'] = $deliveries;
-			$this->hooks->trigger('send:after', 'notifications', $params);
-			$count++;
-
-			$delivery_matrix[$event->getDescription()] = $deliveries;
-		}
-
-		// release mutex
-
-		$this->session->setIgnoreAccess($ia);
-
-		return $matrix ? $delivery_matrix : $count;
-	}
-
-	/**
-	 * Sends the notifications based on subscriptions
-	 *
-	 * Returns an array in the form:
-	 * <code>
-	 * [
-	 *    25 => [
-	 *      'email' => true,
-	 *      'sms' => false,
-	 *    ],
-	 *    55 => [],
-	 * ]
-	 * </code>
-	 *
-	 * @param NotificationEvent $event         Notification event
-	 * @param array             $subscriptions Subscriptions for this event
-	 * @param array             $params        Default notification parameters
-	 * @return array
-	 * @access private
-	 */
-	protected function sendNotifications($event, $subscriptions, array $params = []) {
-
-		if (!$this->methods) {
-			return 0;
-		}
-
-		$result = [];
-		foreach ($subscriptions as $guid => $methods) {
-			foreach ($methods as $method) {
-				$result[$guid][$method] = false;
-				if (in_array($method, $this->methods)) {
-					$result[$guid][$method] = $this->sendNotification($event, $guid, $method, $params);
-				}
-			}
-		}
-
-		$this->logger->notice("Results for the notification event {$event->getDescription()}: " . print_r($result, true));
-		return $result;
-	}
-
-	/**
-	 * Notify a user via their preferences.
-	 *
-	 * Returns an array in the form:
-	 * <code>
-	 * [
-	 *    25 => [
-	 *      'email' => true,
-	 *      'sms' => false,
-	 *    ],
-	 *    55 => [],
-	 * ]
-	 * </code>
-	 *
-	 * @param ElggEntity  $sender     Sender of the notification
-	 * @param ElggUser[]  $recipients An array of entities to notify
-	 * @param array       $params     Notification parameters
-	 * 
-	 * @uses $params['subject']          string
-	 *                                   Default message subject
-	 * @uses $params['body']             string
-	 *                                   Default message body
-	 * @uses $params['object']           null|\ElggEntity|\ElggAnnotation
-	 *                                   The object that is triggering the notification.
-	 * @uses $params['action']           null|string
-	 *                                   Word that describes the action that is triggering the notification
-	 *                                  (e.g. "create" or "update"). Defaults to "notify_user"
-	 * @uses $params['summary']          null|string
-	 *                                   Summary that notification plugins can use alongside the notification title and body.
-	 * @uses $params['methods_override'] string|array
-	 *                                   A string, or an array of strings specifying the delivery
-	 *                                   methods to use - or leave blank for delivery using the
-	 *                                   user's chosen delivery methods.
-	 *
-	 * @return array
-	 * @access private
-	 */
-	public function sendInstantNotifications(\ElggEntity $sender, array $recipients = [], array $params = []) {
-
-		if (!$sender instanceof \ElggEntity) {
-			throw new InvalidArgumentException("Notification sender must be a valid entity");
-		}
+            $deliveries = [];
+            if ($this->hooks->trigger('send:before', 'notifications', $params, true)) {
+                $deliveries = $this->sendNotifications($event, $subscriptions);
+            }
+            $params['deliveries'] = $deliveries;
+            $this->hooks->trigger('send:after', 'notifications', $params);
+            $count++;
+
+            $delivery_matrix[$event->getDescription()] = $deliveries;
+        }
+
+        // release mutex
+
+        $this->session->setIgnoreAccess($ia);
+
+        return $matrix ? $delivery_matrix : $count;
+    }
+
+    /**
+     * Sends the notifications based on subscriptions
+     *
+     * Returns an array in the form:
+     * <code>
+     * [
+     *    25 => [
+     *      'email' => true,
+     *      'sms' => false,
+     *    ],
+     *    55 => [],
+     * ]
+     * </code>
+     *
+     * @param NotificationEvent $event         Notification event
+     * @param array             $subscriptions Subscriptions for this event
+     * @param array             $params        Default notification parameters
+     * @return array
+     * @access private
+     */
+    protected function sendNotifications($event, $subscriptions, array $params = []) {
+
+        if (!$this->methods) {
+            return 0;
+        }
+
+        $result = [];
+        foreach ($subscriptions as $guid => $methods) {
+            foreach ($methods as $method) {
+                $result[$guid][$method] = false;
+                if (in_array($method, $this->methods)) {
+                    $result[$guid][$method] = $this->sendNotification($event, $guid, $method, $params);
+                }
+            }
+        }
+
+        $this->logger->notice("Results for the notification event {$event->getDescription()}: " . print_r($result, true));
+        return $result;
+    }
+
+    /**
+     * Notify a user via their preferences.
+     *
+     * Returns an array in the form:
+     * <code>
+     * [
+     *    25 => [
+     *      'email' => true,
+     *      'sms' => false,
+     *    ],
+     *    55 => [],
+     * ]
+     * </code>
+     *
+     * @param ElggEntity  $sender     Sender of the notification
+     * @param ElggUser[]  $recipients An array of entities to notify
+     * @param array       $params     Notification parameters
+     * 
+     * @uses $params['subject']          string
+     *                                   Default message subject
+     * @uses $params['body']             string
+     *                                   Default message body
+     * @uses $params['object']           null|\ElggEntity|\ElggAnnotation
+     *                                   The object that is triggering the notification.
+     * @uses $params['action']           null|string
+     *                                   Word that describes the action that is triggering the notification
+     *                                  (e.g. "create" or "update"). Defaults to "notify_user"
+     * @uses $params['summary']          null|string
+     *                                   Summary that notification plugins can use alongside the notification title and body.
+     * @uses $params['methods_override'] string|array
+     *                                   A string, or an array of strings specifying the delivery
+     *                                   methods to use - or leave blank for delivery using the
+     *                                   user's chosen delivery methods.
+     *
+     * @return array
+     * @access private
+     */
+    public function sendInstantNotifications(\ElggEntity $sender, array $recipients = [], array $params = []) {
+
+        if (!$sender instanceof \ElggEntity) {
+            throw new InvalidArgumentException("Notification sender must be a valid entity");
+        }
 		
-		$deliveries = [];
+        $deliveries = [];
 
-		if (!$this->methods) {
-			return $deliveries;
-		}
+        if (!$this->methods) {
+            return $deliveries;
+        }
 		
-		$recipients = array_filter($recipients, function($e) {
-			return ($e instanceof \ElggUser);
-		});
+        $recipients = array_filter($recipients, function($e) {
+            return ($e instanceof \ElggUser);
+        });
 		
-		$object = elgg_extract('object', $params);
-		$action = elgg_extract('action', $params);
-
-		$methods_override = elgg_extract('methods_override', $params);
-		unset($params['methods_override']);
-		if ($methods_override && !is_array($methods_override)) {
-			$methods_override = [$methods_override];
-		}
-
-		$event = new InstantNotificationEvent($object, $action, $sender);
-
-		$params['event'] = $event;
-		$params['origin'] = Notification::ORIGIN_INSTANT;
-
-		$subscriptions = [];
-
-		foreach ($recipients as $recipient) {
-
-			// Are we overriding delivery?
-			$methods = $methods_override;
-			if (empty($methods)) {
-				$methods = [];
-				$user_settings = $recipient->getNotificationSettings();
-				foreach ($user_settings as $method => $enabled) {
-					if ($enabled) {
-						$methods[] = $method;
-					}
-				}
-			}
-
-			$subscriptions[$recipient->guid] = $methods;
-		}
-
-		$hook_params = [
-			'event' => $params['event'],
-			'origin' => $params['origin'],
-			'methods_override' => $methods_override,
-		];
-		$subscriptions = $this->hooks->trigger('get', 'subscriptions', $hook_params, $subscriptions);
+        $object = elgg_extract('object', $params);
+        $action = elgg_extract('action', $params);
+
+        $methods_override = elgg_extract('methods_override', $params);
+        unset($params['methods_override']);
+        if ($methods_override && !is_array($methods_override)) {
+            $methods_override = [$methods_override];
+        }
+
+        $event = new InstantNotificationEvent($object, $action, $sender);
+
+        $params['event'] = $event;
+        $params['origin'] = Notification::ORIGIN_INSTANT;
+
+        $subscriptions = [];
+
+        foreach ($recipients as $recipient) {
+
+            // Are we overriding delivery?
+            $methods = $methods_override;
+            if (empty($methods)) {
+                $methods = [];
+                $user_settings = $recipient->getNotificationSettings();
+                foreach ($user_settings as $method => $enabled) {
+                    if ($enabled) {
+                        $methods[] = $method;
+                    }
+                }
+            }
+
+            $subscriptions[$recipient->guid] = $methods;
+        }
+
+        $hook_params = [
+            'event' => $params['event'],
+            'origin' => $params['origin'],
+            'methods_override' => $methods_override,
+        ];
+        $subscriptions = $this->hooks->trigger('get', 'subscriptions', $hook_params, $subscriptions);
 		
-		$params['subscriptions'] = $subscriptions;
-
-		// return false to stop the default notification sender
-		if ($this->hooks->trigger('send:before', 'notifications', $params, true)) {
-			$deliveries = $this->sendNotifications($event, $subscriptions, $params);
-		}
-		$params['deliveries'] = $deliveries;
-		$this->hooks->trigger('send:after', 'notifications', $params);
-
-		return $deliveries;
-	}
-
-	/**
-	 * Send a notification to a subscriber
-	 *
-	 * @param NotificationEvent $event  The notification event
-	 * @param int               $guid   The guid of the subscriber
-	 * @param string            $method The notification method
-	 * @param array             $params Default notification params
-	 * @return bool
-	 * @access private
-	 */
-	protected function sendNotification(NotificationEvent $event, $guid, $method, array $params = []) {
-
-		$actor = $event->getActor();
-		$object = $event->getObject();
-
-		if ($event instanceof InstantNotificationEvent) {
-			$recipient = $this->entities->get($guid);
-			/* @var \ElggEntity $recipient */
-			$subject = elgg_extract('subject', $params, '');
-			$body = elgg_extract('body', $params, '');
-			$summary = elgg_extract('summary', $params, '');
-		} else {
-			$recipient = $this->entities->get($guid, 'user');
-			/* @var \ElggUser $recipient */
-			if (!$recipient || $recipient->isBanned()) {
-				return false;
-			}
+        $params['subscriptions'] = $subscriptions;
+
+        // return false to stop the default notification sender
+        if ($this->hooks->trigger('send:before', 'notifications', $params, true)) {
+            $deliveries = $this->sendNotifications($event, $subscriptions, $params);
+        }
+        $params['deliveries'] = $deliveries;
+        $this->hooks->trigger('send:after', 'notifications', $params);
+
+        return $deliveries;
+    }
+
+    /**
+     * Send a notification to a subscriber
+     *
+     * @param NotificationEvent $event  The notification event
+     * @param int               $guid   The guid of the subscriber
+     * @param string            $method The notification method
+     * @param array             $params Default notification params
+     * @return bool
+     * @access private
+     */
+    protected function sendNotification(NotificationEvent $event, $guid, $method, array $params = []) {
+
+        $actor = $event->getActor();
+        $object = $event->getObject();
+
+        if ($event instanceof InstantNotificationEvent) {
+            $recipient = $this->entities->get($guid);
+            /* @var \ElggEntity $recipient */
+            $subject = elgg_extract('subject', $params, '');
+            $body = elgg_extract('body', $params, '');
+            $summary = elgg_extract('summary', $params, '');
+        } else {
+            $recipient = $this->entities->get($guid, 'user');
+            /* @var \ElggUser $recipient */
+            if (!$recipient || $recipient->isBanned()) {
+                return false;
+            }
 		
-			if ($recipient->getGUID() == $event->getActorGUID()) {
-				// Content creators should not be receiving subscription
-				// notifications about their own content
-				return false;
-			}
+            if ($recipient->getGUID() == $event->getActorGUID()) {
+                // Content creators should not be receiving subscription
+                // notifications about their own content
+                return false;
+            }
 			
-			if (!$actor || !$object) {
-				return false;
-			}
-
-			if ($object instanceof ElggEntity && !has_access_to_entity($object, $recipient)) {
-				// Recipient does not have access to the notification object
-				// The access level may have changed since the event was enqueued
-				return false;
-			}
-
-			$subject = $this->getNotificationSubject($event, $recipient);
-			$body = $this->getNotificationBody($event, $recipient);
-			$summary = '';
+            if (!$actor || !$object) {
+                return false;
+            }
+
+            if ($object instanceof ElggEntity && !has_access_to_entity($object, $recipient)) {
+                // Recipient does not have access to the notification object
+                // The access level may have changed since the event was enqueued
+                return false;
+            }
+
+            $subject = $this->getNotificationSubject($event, $recipient);
+            $body = $this->getNotificationBody($event, $recipient);
+            $summary = '';
 			
-			$params['origin'] = Notification::ORIGIN_SUBSCRIPTIONS;
-		}
-
-		$language = $recipient->language;
-		$params['event'] = $event;
-		$params['method'] = $method;
-		$params['sender'] = $actor;
-		$params['recipient'] = $recipient;
-		$params['language'] = $language;
-		$params['object'] = $object;
-		$params['action'] = $event->getAction();
-
-		$notification = new Notification($actor, $recipient, $language, $subject, $body, $summary, $params);
-
-		$notification = $this->hooks->trigger('prepare', 'notification', $params, $notification);
-		if (!$notification instanceof Notification) {
-			throw new RuntimeException("'prepare','notification' hook must return an instance of " . Notification::class);
-		}
-
-		$type = 'notification:' . $event->getDescription();
-		if ($this->hooks->hasHandler('prepare', $type)) {
-			$notification = $this->hooks->trigger('prepare', $type, $params, $notification);
-			if (!$notification instanceof Notification) {
-				throw new RuntimeException("'prepare','$type' hook must return an instance of " . Notification::class);
-			}
-		} else {
-			// pre Elgg 1.9 notification message generation
-			$notification = $this->getDeprecatedNotificationBody($notification, $event, $method);
-		}
-
-		$notification = $this->hooks->trigger('format', "notification:$method", [], $notification);
-		if (!$notification instanceof Notification) {
-			throw new RuntimeException("'format','notification:$method' hook must return an instance of " . Notification::class);
-		}
-
-		if ($this->hooks->hasHandler('send', "notification:$method")) {
-			// return true to indicate the notification has been sent
-			$params = array(
-				'notification' => $notification,
-				'event' => $event,
-			);
-
-			$result = $this->hooks->trigger('send', "notification:$method", $params, false);
-			if ($this->logger->getLevel() == Logger::INFO) {
-				$logger_data = print_r((array) $notification->toObject(), true);
-				if ($result) {
-					$this->logger->info("Notification sent: " . $logger_data);
-				} else {
-					$this->logger->info("Notification was not sent: " . $logger_data);
-				}
-			}
-			return $result;
-		} else {
-			// pre Elgg 1.9 notification handler
-			$userGuid = $notification->getRecipientGUID();
-			$senderGuid = $notification->getSenderGUID();
-			$subject = $notification->subject;
-			$body = $notification->body;
-			$params = $notification->params;
-			return (bool) _elgg_notify_user($userGuid, $senderGuid, $subject, $body, $params, array($method));
-		}
-	}
-
-	/**
-	 * Get subject for the notification
-	 *
-	 * Plugins can define a subtype specific subject simply by providing a
-	 * translation for the string "notification:subject:<action>:<type>:<subtype".
-	 *
-	 * For example in mod/blog/languages/en.php:
-	 *
-	 *     'notification:subject:publish:object:blog' => '%s published a blog called %s'
-	 *
-	 * @param NotificationEvent $event     Notification event
-	 * @param ElggUser          $recipient Notification recipient
-	 * @return string Notification subject in the recipient's language
-	 */
-	private function getNotificationSubject(NotificationEvent $event, ElggUser $recipient) {
-		$actor = $event->getActor();
-		$object = $event->getObject();
-		/* @var \ElggObject $object */
-		$language = $recipient->language;
-
-		// Check custom notification subject for the action/type/subtype combination
-		$subject_key = "notification:{$event->getDescription()}:subject";
-		if ($this->translator->languageKeyExists($subject_key, $language)) {
-			if ($object instanceof \ElggEntity) {
-				$display_name = $object->getDisplayName();
-			} else {
-				$display_name = '';
-			}
-			return $this->translator->translate($subject_key, array(
-						$actor->name,
-						$display_name,
-							), $language);
-		}
-
-		// Fall back to default subject
-		return $this->translator->translate('notification:subject', array($actor->name), $language);
-	}
-
-	/**
-	 * Get body for the notification
-	 *
-	 * Plugin can define a subtype specific body simply by providing a
-	 * translation for the string "notification:body:<action>:<type>:<subtype".
-	 *
-	 * For example in mod/blog/languages/en.php:
-	 *
-	 *    'notification:body:publish:object:blog' => '
-	 *         Hi %s!
-	 *
-	 *         %s has created a new post called "%s" in the group %s.
-	 *
-	 *         It says:
-	 *
-	 *         "%s"
-	 *
-	 *         You can comment the post here:
-	 *         %s
-	 *     ',
-	 *
-	 * The arguments passed into the translation are:
-	 *     1. Recipient's name
-	 *     2. Name of the user who triggered the notification
-	 *     3. Title of the content
-	 *     4. Name of the content's container
-	 *     5. The actual content (entity's 'description' field)
-	 *     6. URL to the content
-	 *
-	 * Argument swapping can be used to change the order of the parameters.
-	 * See http://php.net/manual/en/function.sprintf.php#example-5427
-	 *
-	 * @param NotificationEvent $event     Notification event
-	 * @param ElggUser          $recipient Notification recipient
-	 * @return string Notification body in the recipient's language
-	 */
-	private function getNotificationBody(NotificationEvent $event, ElggUser $recipient) {
-		$actor = $event->getActor();
-		$object = $event->getObject();
-		/* @var \ElggObject $object */
-		$language = $recipient->language;
-
-		// Check custom notification body for the action/type/subtype combination
-		$body_key = "notification:{$event->getDescription()}:body";
-		if ($this->translator->languageKeyExists($body_key, $language)) {
-			if ($object instanceof \ElggEntity) {
-				$display_name = $object->getDisplayName();
-				$container_name = '';
-				$container = $object->getContainerEntity();
-				if ($container) {
-					$container_name = $container->getDisplayName();
-				}
-			} else {
-				$display_name = '';
-				$container_name = '';
-			}
-
-			return $this->translator->translate($body_key, array(
-						$recipient->name,
-						$actor->name,
-						$display_name,
-						$container_name,
-						$object->description,
-						$object->getURL(),
-							), $language);
-		}
-
-		// Fall back to default body
-		return $this->translator->translate('notification:body', array($object->getURL()), $language);
-	}
-
-	/**
-	 * Register a deprecated notification handler
-	 *
-	 * @param string $method  Method name
-	 * @param string $handler Handler callback
-	 * @return void
-	 */
-	public function registerDeprecatedHandler($method, $handler) {
-		$this->deprHandlers[$method] = $handler;
-	}
-
-	/**
-	 * Get a deprecated notification handler callback
-	 *
-	 * @param string $method Method name
-	 * @return callback|null
-	 */
-	public function getDeprecatedHandler($method) {
-		if (isset($this->deprHandlers[$method])) {
-			return $this->deprHandlers[$method];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Provides a way to incrementally wean Elgg's notifications code from the
-	 * global $NOTIFICATION_HANDLERS
-	 *
-	 * @return array
-	 */
-	public function getMethodsAsDeprecatedGlobal() {
-		$data = array();
-		foreach ($this->methods as $method) {
-			$data[$method] = 'empty';
-		}
-		return $data;
-	}
-
-	/**
-	 * Get the notification body using a pre-Elgg 1.9 plugin hook
-	 *
-	 * @param Notification      $notification Notification
-	 * @param NotificationEvent $event        Event
-	 * @param string            $method       Method
-	 * @return Notification
-	 */
-	protected function getDeprecatedNotificationBody(Notification $notification, NotificationEvent $event, $method) {
-		$entity = $event->getObject();
-		if (!$entity) {
-			return $notification;
-		}
-		$params = array(
-			'entity' => $entity,
-			'to_entity' => $notification->getRecipient(),
-			'method' => $method,
-		);
-		$subject = $this->getDeprecatedNotificationSubject($entity->getType(), $entity->getSubtype());
-		$string = $subject . ": " . $entity->getURL();
-		$body = $this->hooks->trigger('notify:entity:message', $entity->getType(), $params, $string);
-
-		if ($subject) {
-			$notification->subject = $subject;
-			$notification->body = $body;
-		}
-
-		return $notification;
-	}
-
-	/**
-	 * Set message subject for deprecated notification code
-	 *
-	 * @param string $type    Entity type
-	 * @param string $subtype Entity subtype
-	 * @param string $subject Subject line
-	 * @return void
-	 */
-	public function setDeprecatedNotificationSubject($type, $subtype, $subject) {
-		if ($type == '') {
-			$type = '__BLANK__';
-		}
-		if ($subtype == '') {
-			$subtype = '__BLANK__';
-		}
-
-		if (!isset($this->deprSubjects[$type])) {
-			$this->deprSubjects[$type] = array();
-		}
-
-		$this->deprSubjects[$type][$subtype] = $subject;
-	}
-
-	/**
-	 * Get the deprecated subject
-	 *
-	 * @param string $type    Entity type
-	 * @param string $subtype Entity subtype
-	 * @return string
-	 */
-	protected function getDeprecatedNotificationSubject($type, $subtype) {
-		if ($type == '') {
-			$type = '__BLANK__';
-		}
-		if ($subtype == '') {
-			$subtype = '__BLANK__';
-		}
-
-		if (!isset($this->deprSubjects[$type])) {
-			return '';
-		}
-
-		if (!isset($this->deprSubjects[$type][$subtype])) {
-			return '';
-		}
-
-		return $this->deprSubjects[$type][$subtype];
-	}
-
-	/**
-	 * Is someone using the deprecated override
-	 *
-	 * @param NotificationEvent $event Event
-	 * @return boolean
-	 */
-	protected function existsDeprecatedNotificationOverride(NotificationEvent $event) {
-		$entity = $event->getObject();
-		if (!elgg_instanceof($entity)) {
-			return false;
-		}
-		$params = array(
-			'event' => $event->getAction(),
-			'object_type' => $entity->getType(),
-			'object' => $entity,
-		);
-		$hookresult = $this->hooks->trigger('object:notifications', $entity->getType(), $params, false);
-		if ($hookresult === true) {
-			elgg_deprecated_notice("Using the plugin hook 'object:notifications' has been deprecated "
-				. "by the hook 'send:before', 'notifications'", 1.9);
-			return true;
-		} else {
-			return false;
-		}
-	}
+            $params['origin'] = Notification::ORIGIN_SUBSCRIPTIONS;
+        }
+
+        $language = $recipient->language;
+        $params['event'] = $event;
+        $params['method'] = $method;
+        $params['sender'] = $actor;
+        $params['recipient'] = $recipient;
+        $params['language'] = $language;
+        $params['object'] = $object;
+        $params['action'] = $event->getAction();
+
+        $notification = new Notification($actor, $recipient, $language, $subject, $body, $summary, $params);
+
+        $notification = $this->hooks->trigger('prepare', 'notification', $params, $notification);
+        if (!$notification instanceof Notification) {
+            throw new RuntimeException("'prepare','notification' hook must return an instance of " . Notification::class);
+        }
+
+        $type = 'notification:' . $event->getDescription();
+        if ($this->hooks->hasHandler('prepare', $type)) {
+            $notification = $this->hooks->trigger('prepare', $type, $params, $notification);
+            if (!$notification instanceof Notification) {
+                throw new RuntimeException("'prepare','$type' hook must return an instance of " . Notification::class);
+            }
+        } else {
+            // pre Elgg 1.9 notification message generation
+            $notification = $this->getDeprecatedNotificationBody($notification, $event, $method);
+        }
+
+        $notification = $this->hooks->trigger('format', "notification:$method", [], $notification);
+        if (!$notification instanceof Notification) {
+            throw new RuntimeException("'format','notification:$method' hook must return an instance of " . Notification::class);
+        }
+
+        if ($this->hooks->hasHandler('send', "notification:$method")) {
+            // return true to indicate the notification has been sent
+            $params = array(
+                'notification' => $notification,
+                'event' => $event,
+            );
+
+            $result = $this->hooks->trigger('send', "notification:$method", $params, false);
+            if ($this->logger->getLevel() == Logger::INFO) {
+                $logger_data = print_r((array) $notification->toObject(), true);
+                if ($result) {
+                    $this->logger->info("Notification sent: " . $logger_data);
+                } else {
+                    $this->logger->info("Notification was not sent: " . $logger_data);
+                }
+            }
+            return $result;
+        } else {
+            // pre Elgg 1.9 notification handler
+            $userGuid = $notification->getRecipientGUID();
+            $senderGuid = $notification->getSenderGUID();
+            $subject = $notification->subject;
+            $body = $notification->body;
+            $params = $notification->params;
+            return (bool) _elgg_notify_user($userGuid, $senderGuid, $subject, $body, $params, array($method));
+        }
+    }
+
+    /**
+     * Get subject for the notification
+     *
+     * Plugins can define a subtype specific subject simply by providing a
+     * translation for the string "notification:subject:<action>:<type>:<subtype".
+     *
+     * For example in mod/blog/languages/en.php:
+     *
+     *     'notification:subject:publish:object:blog' => '%s published a blog called %s'
+     *
+     * @param NotificationEvent $event     Notification event
+     * @param ElggUser          $recipient Notification recipient
+     * @return string Notification subject in the recipient's language
+     */
+    private function getNotificationSubject(NotificationEvent $event, ElggUser $recipient) {
+        $actor = $event->getActor();
+        $object = $event->getObject();
+        /* @var \ElggObject $object */
+        $language = $recipient->language;
+
+        // Check custom notification subject for the action/type/subtype combination
+        $subject_key = "notification:{$event->getDescription()}:subject";
+        if ($this->translator->languageKeyExists($subject_key, $language)) {
+            if ($object instanceof \ElggEntity) {
+                $display_name = $object->getDisplayName();
+            } else {
+                $display_name = '';
+            }
+            return $this->translator->translate($subject_key, array(
+                        $actor->name,
+                        $display_name,
+                            ), $language);
+        }
+
+        // Fall back to default subject
+        return $this->translator->translate('notification:subject', array($actor->name), $language);
+    }
+
+    /**
+     * Get body for the notification
+     *
+     * Plugin can define a subtype specific body simply by providing a
+     * translation for the string "notification:body:<action>:<type>:<subtype".
+     *
+     * For example in mod/blog/languages/en.php:
+     *
+     *    'notification:body:publish:object:blog' => '
+     *         Hi %s!
+     *
+     *         %s has created a new post called "%s" in the group %s.
+     *
+     *         It says:
+     *
+     *         "%s"
+     *
+     *         You can comment the post here:
+     *         %s
+     *     ',
+     *
+     * The arguments passed into the translation are:
+     *     1. Recipient's name
+     *     2. Name of the user who triggered the notification
+     *     3. Title of the content
+     *     4. Name of the content's container
+     *     5. The actual content (entity's 'description' field)
+     *     6. URL to the content
+     *
+     * Argument swapping can be used to change the order of the parameters.
+     * See http://php.net/manual/en/function.sprintf.php#example-5427
+     *
+     * @param NotificationEvent $event     Notification event
+     * @param ElggUser          $recipient Notification recipient
+     * @return string Notification body in the recipient's language
+     */
+    private function getNotificationBody(NotificationEvent $event, ElggUser $recipient) {
+        $actor = $event->getActor();
+        $object = $event->getObject();
+        /* @var \ElggObject $object */
+        $language = $recipient->language;
+
+        // Check custom notification body for the action/type/subtype combination
+        $body_key = "notification:{$event->getDescription()}:body";
+        if ($this->translator->languageKeyExists($body_key, $language)) {
+            if ($object instanceof \ElggEntity) {
+                $display_name = $object->getDisplayName();
+                $container_name = '';
+                $container = $object->getContainerEntity();
+                if ($container) {
+                    $container_name = $container->getDisplayName();
+                }
+            } else {
+                $display_name = '';
+                $container_name = '';
+            }
+
+            return $this->translator->translate($body_key, array(
+                        $recipient->name,
+                        $actor->name,
+                        $display_name,
+                        $container_name,
+                        $object->description,
+                        $object->getURL(),
+                            ), $language);
+        }
+
+        // Fall back to default body
+        return $this->translator->translate('notification:body', array($object->getURL()), $language);
+    }
+
+    /**
+     * Register a deprecated notification handler
+     *
+     * @param string $method  Method name
+     * @param string $handler Handler callback
+     * @return void
+     */
+    public function registerDeprecatedHandler($method, $handler) {
+        $this->deprHandlers[$method] = $handler;
+    }
+
+    /**
+     * Get a deprecated notification handler callback
+     *
+     * @param string $method Method name
+     * @return callback|null
+     */
+    public function getDeprecatedHandler($method) {
+        if (isset($this->deprHandlers[$method])) {
+            return $this->deprHandlers[$method];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Provides a way to incrementally wean Elgg's notifications code from the
+     * global $NOTIFICATION_HANDLERS
+     *
+     * @return array
+     */
+    public function getMethodsAsDeprecatedGlobal() {
+        $data = array();
+        foreach ($this->methods as $method) {
+            $data[$method] = 'empty';
+        }
+        return $data;
+    }
+
+    /**
+     * Get the notification body using a pre-Elgg 1.9 plugin hook
+     *
+     * @param Notification      $notification Notification
+     * @param NotificationEvent $event        Event
+     * @param string            $method       Method
+     * @return Notification
+     */
+    protected function getDeprecatedNotificationBody(Notification $notification, NotificationEvent $event, $method) {
+        $entity = $event->getObject();
+        if (!$entity) {
+            return $notification;
+        }
+        $params = array(
+            'entity' => $entity,
+            'to_entity' => $notification->getRecipient(),
+            'method' => $method,
+        );
+        $subject = $this->getDeprecatedNotificationSubject($entity->getType(), $entity->getSubtype());
+        $string = $subject . ": " . $entity->getURL();
+        $body = $this->hooks->trigger('notify:entity:message', $entity->getType(), $params, $string);
+
+        if ($subject) {
+            $notification->subject = $subject;
+            $notification->body = $body;
+        }
+
+        return $notification;
+    }
+
+    /**
+     * Set message subject for deprecated notification code
+     *
+     * @param string $type    Entity type
+     * @param string $subtype Entity subtype
+     * @param string $subject Subject line
+     * @return void
+     */
+    public function setDeprecatedNotificationSubject($type, $subtype, $subject) {
+        if ($type == '') {
+            $type = '__BLANK__';
+        }
+        if ($subtype == '') {
+            $subtype = '__BLANK__';
+        }
+
+        if (!isset($this->deprSubjects[$type])) {
+            $this->deprSubjects[$type] = array();
+        }
+
+        $this->deprSubjects[$type][$subtype] = $subject;
+    }
+
+    /**
+     * Get the deprecated subject
+     *
+     * @param string $type    Entity type
+     * @param string $subtype Entity subtype
+     * @return string
+     */
+    protected function getDeprecatedNotificationSubject($type, $subtype) {
+        if ($type == '') {
+            $type = '__BLANK__';
+        }
+        if ($subtype == '') {
+            $subtype = '__BLANK__';
+        }
+
+        if (!isset($this->deprSubjects[$type])) {
+            return '';
+        }
+
+        if (!isset($this->deprSubjects[$type][$subtype])) {
+            return '';
+        }
+
+        return $this->deprSubjects[$type][$subtype];
+    }
+
+    /**
+     * Is someone using the deprecated override
+     *
+     * @param NotificationEvent $event Event
+     * @return boolean
+     */
+    protected function existsDeprecatedNotificationOverride(NotificationEvent $event) {
+        $entity = $event->getObject();
+        if (!elgg_instanceof($entity)) {
+            return false;
+        }
+        $params = array(
+            'event' => $event->getAction(),
+            'object_type' => $entity->getType(),
+            'object' => $entity,
+        );
+        $hookresult = $this->hooks->trigger('object:notifications', $entity->getType(), $params, false);
+        if ($hookresult === true) {
+            elgg_deprecated_notice("Using the plugin hook 'object:notifications' has been deprecated "
+                . "by the hook 'send:before', 'notifications'", 1.9);
+            return true;
+        } else {
+            return false;
+        }
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -101,7 +101,7 @@ 
 			$this->events[$type][$subtype] = array();
 		}
 
-		$action_list =& $this->events[$type][$subtype];
+		$action_list = & $this->events[$type][$subtype];
 		if ($actions) {
 			$action_list = array_unique(array_merge($action_list, $actions));
 		} elseif (!in_array('create', $action_list)) {
@@ -294,7 +294,7 @@ 
 			}
 		}
 
-		$this->logger->notice("Results for the notification event {$event->getDescription()}: " . print_r($result, true));
+		$this->logger->notice("Results for the notification event {$event->getDescription()}: ".print_r($result, true));
 		return $result;
 	}
 
@@ -467,14 +467,14 @@ 
 
 		$notification = $this->hooks->trigger('prepare', 'notification', $params, $notification);
 		if (!$notification instanceof Notification) {
-			throw new RuntimeException("'prepare','notification' hook must return an instance of " . Notification::class);
+			throw new RuntimeException("'prepare','notification' hook must return an instance of ".Notification::class);
 		}
 
-		$type = 'notification:' . $event->getDescription();
+		$type = 'notification:'.$event->getDescription();
 		if ($this->hooks->hasHandler('prepare', $type)) {
 			$notification = $this->hooks->trigger('prepare', $type, $params, $notification);
 			if (!$notification instanceof Notification) {
-				throw new RuntimeException("'prepare','$type' hook must return an instance of " . Notification::class);
+				throw new RuntimeException("'prepare','$type' hook must return an instance of ".Notification::class);
 			}
 		} else {
 			// pre Elgg 1.9 notification message generation
@@ -483,7 +483,7 @@ 
 
 		$notification = $this->hooks->trigger('format', "notification:$method", [], $notification);
 		if (!$notification instanceof Notification) {
-			throw new RuntimeException("'format','notification:$method' hook must return an instance of " . Notification::class);
+			throw new RuntimeException("'format','notification:$method' hook must return an instance of ".Notification::class);
 		}
 
 		if ($this->hooks->hasHandler('send', "notification:$method")) {
@@ -497,9 +497,9 @@ 
 			if ($this->logger->getLevel() == Logger::INFO) {
 				$logger_data = print_r((array) $notification->toObject(), true);
 				if ($result) {
-					$this->logger->info("Notification sent: " . $logger_data);
+					$this->logger->info("Notification sent: ".$logger_data);
 				} else {
-					$this->logger->info("Notification was not sent: " . $logger_data);
+					$this->logger->info("Notification was not sent: ".$logger_data);
 				}
 			}
 			return $result;
@@ -681,7 +681,7 @@ 
 			'method' => $method,
 		);
 		$subject = $this->getDeprecatedNotificationSubject($entity->getType(), $entity->getSubtype());
-		$string = $subject . ": " . $entity->getURL();
+		$string = $subject.": ".$entity->getURL();
 		$body = $this->hooks->trigger('notify:entity:message', $entity->getType(), $params, $string);
 
 		if ($subject) {

engine/classes/Elgg/PersistentLoginService.php

Doc Comments +1 added lines, -1 removed lines

@@ -223,7 +223,7 @@
 	 * @param \DatabaseException $exception The exception to handle
 	 * @param string             $default   The value to return if the table doesn't exist yet
 	 * 
-	 * @return mixed
+	 * @return string|null
 	 *
 	 * @throws \DatabaseException
 	 */

Indentation +346 added lines, -346 removed lines

@@ -25,354 +25,354 @@
  */
 class PersistentLoginService {
 
-	/**
-	 * Constructor
-	 *
-	 * @param Database     $db            The DB service
-	 * @param \ElggSession $session       The Elgg session
-	 * @param \ElggCrypto  $crypto        The cryptography service
-	 * @param array        $cookie_config The persistent login cookie settings
-	 * @param string       $cookie_token  The token from the request cookie
-	 * @param int          $time          The current time
-	 */
-	public function __construct(
-			Database $db,
-			\ElggSession $session,
-			\ElggCrypto $crypto,
-			array $cookie_config,
-			$cookie_token,
-			$time = null) {
-		$this->db = $db;
-		$this->session = $session;
-		$this->crypto = $crypto;
-		$this->cookie_config = $cookie_config;
-		$this->cookie_token = $cookie_token;
-
-		$prefix = $this->db->prefix;
-		$this->table = "{$prefix}users_remember_me_cookies";
-		$this->time = is_numeric($time) ? (int)$time : time();
-	}
-
-	/**
-	 * Make the user's login persistent
-	 *
-	 * @param \ElggUser $user The user who logged in
-	 * 
-	 * @return void
-	 */
-	public function makeLoginPersistent(\ElggUser $user) {
-		$token = $this->generateToken();
-		$hash = $this->hashToken($token);
-
-		$this->storeHash($user, $hash);
-		$this->setCookie($token);
-		$this->setSession($token);
-	}
-
-	/**
-	 * Remove the persisted login token from client and server
-	 * 
-	 * @return void
-	 */
-	public function removePersistentLogin() {
-		if ($this->cookie_token) {
-			$client_hash = $this->hashToken($this->cookie_token);
-			$this->removeHash($client_hash);
-		}
-
-		$this->setCookie("");
-		$this->setSession("");
-	}
-
-	/**
-	 * Handle a password change
-	 *
-	 * @param \ElggUser $subject  The user whose password changed
-	 * @param \ElggUser $modifier The user who changed the password
-	 * 
-	 * @return void
-	 */
-	public function handlePasswordChange(\ElggUser $subject, \ElggUser $modifier = null) {
-		$this->removeAllHashes($subject);
-		if (!$modifier || ($modifier->guid !== $subject->guid) || !$this->cookie_token) {
-			return;
-		}
-
-		$this->makeLoginPersistent($modifier);
-	}
-
-	/**
-	 * Boot the persistent login session, possibly returning the user who should be
-	 * silently logged in.
-	 *
-	 * @return \ElggUser|null
-	 */
-	public function bootSession() {
-		if (!$this->cookie_token) {
-			return null;
-		}
-
-		// is this token good?
-		$cookie_hash = $this->hashToken($this->cookie_token);
-		$user = $this->getUserFromHash($cookie_hash);
-		if ($user) {
-			$this->setSession($this->cookie_token);
-			// note: if the token is legacy, we don't both replacing it here because
-			// it will be replaced during the next request boot
-			return $user;
-		} else {
-			if ($this->isLegacyToken($this->cookie_token)) {
-				// may be attempt to brute force legacy low-entropy tokens
-				call_user_func($this->_callable_sleep, 1);
-			}
-			$this->setCookie('');
-		}
-	}
-
-	/**
-	 * Replace the user's token if it's a legacy hexadecimal token
-	 *
-	 * @param \ElggUser $logged_in_user The logged in user
-	 * 
-	 * @return void
-	 */
-	public function replaceLegacyToken(\ElggUser $logged_in_user) {
-		if (!$this->cookie_token || !$this->isLegacyToken($this->cookie_token)) {
-			return;
-		}
-
-		// replace user's old weaker-entropy code with new one
-		$this->removeHash($this->hashToken($this->cookie_token));
-		$this->makeLoginPersistent($logged_in_user);
-	}
-
-	/**
-	 * Find a user with the given hash
-	 *
-	 * @param string $hash The hashed token
-	 * 
-	 * @return \ElggUser|null
-	 */
-	public function getUserFromHash($hash) {
-		if (!$hash) {
-			return null;
-		}
-
-		$hash = $this->db->sanitizeString($hash);
-		$query = "SELECT guid FROM {$this->table} WHERE code = '$hash'";
-		try {
-			$user_row = $this->db->getDataRow($query);
-		} catch (\DatabaseException $e) {
-			return $this->handleDbException($e);
-		}
-		if (!$user_row) {
-			return null;
-		}
-
-		$user = call_user_func($this->_callable_get_user, $user_row->guid);
-		return $user ? $user : null;
-	}
-
-	/**
-	 * Store a hash in the DB
-	 *
-	 * @param \ElggUser $user The user for whom we're storing the hash
-	 * @param string    $hash The hashed token
-	 * 
-	 * @return void
-	 */
-	protected function storeHash(\ElggUser $user, $hash) {
-		// This prevents inserting the same hash twice, which seems to be happening in some rare cases
-		// and for unknown reasons. See https://github.com/Elgg/Elgg/issues/8104
-		$this->removeHash($hash);
-
-		$time = time();
-		$hash = $this->db->sanitizeString($hash);
-
-		$query = "
+    /**
+     * Constructor
+     *
+     * @param Database     $db            The DB service
+     * @param \ElggSession $session       The Elgg session
+     * @param \ElggCrypto  $crypto        The cryptography service
+     * @param array        $cookie_config The persistent login cookie settings
+     * @param string       $cookie_token  The token from the request cookie
+     * @param int          $time          The current time
+     */
+    public function __construct(
+            Database $db,
+            \ElggSession $session,
+            \ElggCrypto $crypto,
+            array $cookie_config,
+            $cookie_token,
+            $time = null) {
+        $this->db = $db;
+        $this->session = $session;
+        $this->crypto = $crypto;
+        $this->cookie_config = $cookie_config;
+        $this->cookie_token = $cookie_token;
+
+        $prefix = $this->db->prefix;
+        $this->table = "{$prefix}users_remember_me_cookies";
+        $this->time = is_numeric($time) ? (int)$time : time();
+    }
+
+    /**
+     * Make the user's login persistent
+     *
+     * @param \ElggUser $user The user who logged in
+     * 
+     * @return void
+     */
+    public function makeLoginPersistent(\ElggUser $user) {
+        $token = $this->generateToken();
+        $hash = $this->hashToken($token);
+
+        $this->storeHash($user, $hash);
+        $this->setCookie($token);
+        $this->setSession($token);
+    }
+
+    /**
+     * Remove the persisted login token from client and server
+     * 
+     * @return void
+     */
+    public function removePersistentLogin() {
+        if ($this->cookie_token) {
+            $client_hash = $this->hashToken($this->cookie_token);
+            $this->removeHash($client_hash);
+        }
+
+        $this->setCookie("");
+        $this->setSession("");
+    }
+
+    /**
+     * Handle a password change
+     *
+     * @param \ElggUser $subject  The user whose password changed
+     * @param \ElggUser $modifier The user who changed the password
+     * 
+     * @return void
+     */
+    public function handlePasswordChange(\ElggUser $subject, \ElggUser $modifier = null) {
+        $this->removeAllHashes($subject);
+        if (!$modifier || ($modifier->guid !== $subject->guid) || !$this->cookie_token) {
+            return;
+        }
+
+        $this->makeLoginPersistent($modifier);
+    }
+
+    /**
+     * Boot the persistent login session, possibly returning the user who should be
+     * silently logged in.
+     *
+     * @return \ElggUser|null
+     */
+    public function bootSession() {
+        if (!$this->cookie_token) {
+            return null;
+        }
+
+        // is this token good?
+        $cookie_hash = $this->hashToken($this->cookie_token);
+        $user = $this->getUserFromHash($cookie_hash);
+        if ($user) {
+            $this->setSession($this->cookie_token);
+            // note: if the token is legacy, we don't both replacing it here because
+            // it will be replaced during the next request boot
+            return $user;
+        } else {
+            if ($this->isLegacyToken($this->cookie_token)) {
+                // may be attempt to brute force legacy low-entropy tokens
+                call_user_func($this->_callable_sleep, 1);
+            }
+            $this->setCookie('');
+        }
+    }
+
+    /**
+     * Replace the user's token if it's a legacy hexadecimal token
+     *
+     * @param \ElggUser $logged_in_user The logged in user
+     * 
+     * @return void
+     */
+    public function replaceLegacyToken(\ElggUser $logged_in_user) {
+        if (!$this->cookie_token || !$this->isLegacyToken($this->cookie_token)) {
+            return;
+        }
+
+        // replace user's old weaker-entropy code with new one
+        $this->removeHash($this->hashToken($this->cookie_token));
+        $this->makeLoginPersistent($logged_in_user);
+    }
+
+    /**
+     * Find a user with the given hash
+     *
+     * @param string $hash The hashed token
+     * 
+     * @return \ElggUser|null
+     */
+    public function getUserFromHash($hash) {
+        if (!$hash) {
+            return null;
+        }
+
+        $hash = $this->db->sanitizeString($hash);
+        $query = "SELECT guid FROM {$this->table} WHERE code = '$hash'";
+        try {
+            $user_row = $this->db->getDataRow($query);
+        } catch (\DatabaseException $e) {
+            return $this->handleDbException($e);
+        }
+        if (!$user_row) {
+            return null;
+        }
+
+        $user = call_user_func($this->_callable_get_user, $user_row->guid);
+        return $user ? $user : null;
+    }
+
+    /**
+     * Store a hash in the DB
+     *
+     * @param \ElggUser $user The user for whom we're storing the hash
+     * @param string    $hash The hashed token
+     * 
+     * @return void
+     */
+    protected function storeHash(\ElggUser $user, $hash) {
+        // This prevents inserting the same hash twice, which seems to be happening in some rare cases
+        // and for unknown reasons. See https://github.com/Elgg/Elgg/issues/8104
+        $this->removeHash($hash);
+
+        $time = time();
+        $hash = $this->db->sanitizeString($hash);
+
+        $query = "
 			INSERT INTO {$this->table} (code, guid, timestamp)
 		    VALUES ('$hash', {$user->guid}, $time)
 		";
-		try {
-			$this->db->insertData($query);
-		} catch (\DatabaseException $e) {
-			$this->handleDbException($e);
-		}
-	}
-
-	/**
-	 * Remove a hash from the DB
-	 *
-	 * @param string $hash The hashed token to remove (unused before 1.9)
-	 * @return void
-	 */
-	protected function removeHash($hash) {
-		$hash = $this->db->sanitizeString($hash);
-
-		$query = "DELETE FROM {$this->table} WHERE code = '$hash'";
-		try {
-			$this->db->deleteData($query);
-		} catch (\DatabaseException $e) {
-			$this->handleDbException($e);
-		}
-	}
-
-	/**
-	 * Swallow a schema not upgraded exception, otherwise rethrow it
-	 *
-	 * @param \DatabaseException $exception The exception to handle
-	 * @param string             $default   The value to return if the table doesn't exist yet
-	 * 
-	 * @return mixed
-	 *
-	 * @throws \DatabaseException
-	 */
-	protected function handleDbException(\DatabaseException $exception, $default = null) {
-		if (false !== strpos($exception->getMessage(), "users_remember_me_cookies' doesn't exist")) {
-			// schema has not been updated so we swallow this exception
-			return $default;
-		} else {
-			throw $exception;
-		}
-	}
-
-	/**
-	 * Remove all the hashes associated with a user
-	 *
-	 * @param \ElggUser $user The user for whom we're removing hashes
-	 * 
-	 * @return void
-	 */
-	protected function removeAllHashes(\ElggUser $user) {
-		$query = "DELETE FROM {$this->table} WHERE guid = '{$user->guid}'";
-		try {
-			$this->db->deleteData($query);
-		} catch (\DatabaseException $e) {
-			$this->handleDbException($e);
-		}
-	}
-
-	/**
-	 * Create a hash from the token
-	 *
-	 * @param string $token The token to hash
-	 * 
-	 * @return string
-	 */
-	protected function hashToken($token) {
-		// note: with user passwords, you'd want legit password hashing, but since these are randomly
-		// generated and long tokens, rainbow tables aren't any help.
-		return md5($token);
-	}
-
-	/**
-	 * Store the token in the client cookie (or remove the cookie)
-	 *
-	 * @param string $token Empty string to remove cookie
-	 * 
-	 * @return void
-	 */
-	protected function setCookie($token) {
-		$cookie = new \ElggCookie($this->cookie_config['name']);
-		foreach (array('expire', 'path', 'domain', 'secure', 'httponly') as $key) {
-			$cookie->$key = $this->cookie_config[$key];
-		}
-		$cookie->value = $token;
-		if (!$token) {
-			$cookie->expire = $this->time - (86400 * 30);
-		}
-		call_user_func($this->_callable_elgg_set_cookie, $cookie);
-	}
-
-	/**
-	 * Store the token in the session (or remove it from the session)
-	 *
-	 * @param string $token The token to store in session. Empty string to remove.
-	 * 
-	 * @return void
-	 */
-	protected function setSession($token) {
-		if ($token) {
-			$this->session->set('code', $token);
-		} else {
-			$this->session->remove('code');
-		}
-	}
-
-	/**
-	 * Generate a random token (base 64 URL)
-	 *
-	 * The first char is always "z" to indicate the value has more entropy than the
-	 * previously generated ones.
-	 *
-	 * @return string
-	 */
-	protected function generateToken() {
-		return 'z' . $this->crypto->getRandomString(31);
-	}
-
-	/**
-	 * Is the given token a legacy MD5 hash?
-	 *
-	 * @param string $token The token to analyze
-	 * 
-	 * @return bool
-	 */
-	protected function isLegacyToken($token) {
-		return (isset($token[0]) && $token[0] !== 'z');
-	}
-
-	/**
-	 * @var Database
-	 */
-	protected $db;
-
-	/**
-	 * @var string
-	 */
-	protected $table;
-
-	/**
-	 * @var array
-	 */
-	protected $cookie_config;
-
-	/**
-	 * @var string
-	 */
-	protected $cookie_token;
-
-	/**
-	 * @var \ElggSession
-	 */
-	protected $session;
-
-	/**
-	 * @var \ElggCrypto
-	 */
-	protected $crypto;
-
-	/**
-	 * @var int
-	 */
-	protected $time;
-
-	/**
-	 * DO NOT USE. For unit test mocking
-	 * @access private
-	 */
-	public $_callable_get_user = 'get_user';
-
-	/**
-	 * DO NOT USE. For unit test mocking
-	 * @access private
-	 */
-	public $_callable_elgg_set_cookie = 'elgg_set_cookie';
-
-	/**
-	 * DO NOT USE. For unit test mocking
-	 * @access private
-	 */
-	public $_callable_sleep = 'sleep';
+        try {
+            $this->db->insertData($query);
+        } catch (\DatabaseException $e) {
+            $this->handleDbException($e);
+        }
+    }
+
+    /**
+     * Remove a hash from the DB
+     *
+     * @param string $hash The hashed token to remove (unused before 1.9)
+     * @return void
+     */
+    protected function removeHash($hash) {
+        $hash = $this->db->sanitizeString($hash);
+
+        $query = "DELETE FROM {$this->table} WHERE code = '$hash'";
+        try {
+            $this->db->deleteData($query);
+        } catch (\DatabaseException $e) {
+            $this->handleDbException($e);
+        }
+    }
+
+    /**
+     * Swallow a schema not upgraded exception, otherwise rethrow it
+     *
+     * @param \DatabaseException $exception The exception to handle
+     * @param string             $default   The value to return if the table doesn't exist yet
+     * 
+     * @return mixed
+     *
+     * @throws \DatabaseException
+     */
+    protected function handleDbException(\DatabaseException $exception, $default = null) {
+        if (false !== strpos($exception->getMessage(), "users_remember_me_cookies' doesn't exist")) {
+            // schema has not been updated so we swallow this exception
+            return $default;
+        } else {
+            throw $exception;
+        }
+    }
+
+    /**
+     * Remove all the hashes associated with a user
+     *
+     * @param \ElggUser $user The user for whom we're removing hashes
+     * 
+     * @return void
+     */
+    protected function removeAllHashes(\ElggUser $user) {
+        $query = "DELETE FROM {$this->table} WHERE guid = '{$user->guid}'";
+        try {
+            $this->db->deleteData($query);
+        } catch (\DatabaseException $e) {
+            $this->handleDbException($e);
+        }
+    }
+
+    /**
+     * Create a hash from the token
+     *
+     * @param string $token The token to hash
+     * 
+     * @return string
+     */
+    protected function hashToken($token) {
+        // note: with user passwords, you'd want legit password hashing, but since these are randomly
+        // generated and long tokens, rainbow tables aren't any help.
+        return md5($token);
+    }
+
+    /**
+     * Store the token in the client cookie (or remove the cookie)
+     *
+     * @param string $token Empty string to remove cookie
+     * 
+     * @return void
+     */
+    protected function setCookie($token) {
+        $cookie = new \ElggCookie($this->cookie_config['name']);
+        foreach (array('expire', 'path', 'domain', 'secure', 'httponly') as $key) {
+            $cookie->$key = $this->cookie_config[$key];
+        }
+        $cookie->value = $token;
+        if (!$token) {
+            $cookie->expire = $this->time - (86400 * 30);
+        }
+        call_user_func($this->_callable_elgg_set_cookie, $cookie);
+    }
+
+    /**
+     * Store the token in the session (or remove it from the session)
+     *
+     * @param string $token The token to store in session. Empty string to remove.
+     * 
+     * @return void
+     */
+    protected function setSession($token) {
+        if ($token) {
+            $this->session->set('code', $token);
+        } else {
+            $this->session->remove('code');
+        }
+    }
+
+    /**
+     * Generate a random token (base 64 URL)
+     *
+     * The first char is always "z" to indicate the value has more entropy than the
+     * previously generated ones.
+     *
+     * @return string
+     */
+    protected function generateToken() {
+        return 'z' . $this->crypto->getRandomString(31);
+    }
+
+    /**
+     * Is the given token a legacy MD5 hash?
+     *
+     * @param string $token The token to analyze
+     * 
+     * @return bool
+     */
+    protected function isLegacyToken($token) {
+        return (isset($token[0]) && $token[0] !== 'z');
+    }
+
+    /**
+     * @var Database
+     */
+    protected $db;
+
+    /**
+     * @var string
+     */
+    protected $table;
+
+    /**
+     * @var array
+     */
+    protected $cookie_config;
+
+    /**
+     * @var string
+     */
+    protected $cookie_token;
+
+    /**
+     * @var \ElggSession
+     */
+    protected $session;
+
+    /**
+     * @var \ElggCrypto
+     */
+    protected $crypto;
+
+    /**
+     * @var int
+     */
+    protected $time;
+
+    /**
+     * DO NOT USE. For unit test mocking
+     * @access private
+     */
+    public $_callable_get_user = 'get_user';
+
+    /**
+     * DO NOT USE. For unit test mocking
+     * @access private
+     */
+    public $_callable_elgg_set_cookie = 'elgg_set_cookie';
+
+    /**
+     * DO NOT USE. For unit test mocking
+     * @access private
+     */
+    public $_callable_sleep = 'sleep';
 }
 

Spacing +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
 
 		$prefix = $this->db->prefix;
 		$this->table = "{$prefix}users_remember_me_cookies";
-		$this->time = is_numeric($time) ? (int)$time : time();
+		$this->time = is_numeric($time) ? (int) $time : time();
 	}
 
 	/**
@@ -308,7 +308,7 @@ 
 	 * @return string
 	 */
 	protected function generateToken() {
-		return 'z' . $this->crypto->getRandomString(31);
+		return 'z'.$this->crypto->getRandomString(31);
 	}
 
 	/**

engine/classes/Elgg/Translit.php

Doc Comments +2 added lines, -2 removed lines

@@ -120,7 +120,7 @@ 
 	/**
 	 * Get array of UTF-8 (NFC) character replacements.
 	 *
-	 * @return array
+	 * @return string
 	 */
 	static public function getAsciiTranslitMap() {
 		return array(
@@ -253,7 +253,7 @@ 
 	/**
 	 * Tests that "normalizer_normalize" exists and works
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	static public function hasNormalizerSupport() {
 		static $ret = null;

Indentation +223 added lines, -223 removed lines

@@ -30,240 +30,240 @@
  */
 class Translit {
 
-	/**
-	 * Create a version of a string for embedding in a URL
-	 *
-	 * @param string $string    A UTF-8 string
-	 * @param string $separator The character to separate words with
-	 * @return string
-	 */
-	static public function urlize($string, $separator = '-') {
-		// Iñtërnâtiônàlizætiøn, AND 日本語!
+    /**
+     * Create a version of a string for embedding in a URL
+     *
+     * @param string $string    A UTF-8 string
+     * @param string $separator The character to separate words with
+     * @return string
+     */
+    static public function urlize($string, $separator = '-') {
+        // Iñtërnâtiônàlizætiøn, AND 日本語!
 
-		// try to force combined chars because the translit map and others expect it
-		if (self::hasNormalizerSupport()) {
-			$nfc = normalizer_normalize($string);
-			if (is_string($nfc)) {
-				$string = $nfc;
-			}
-		}
-		// Internationalization, AND 日本語!
-		$string = self::transliterateAscii($string);
+        // try to force combined chars because the translit map and others expect it
+        if (self::hasNormalizerSupport()) {
+            $nfc = normalizer_normalize($string);
+            if (is_string($nfc)) {
+                $string = $nfc;
+            }
+        }
+        // Internationalization, AND 日本語!
+        $string = self::transliterateAscii($string);
 
-		// allow HTML tags in titles
-		$string = preg_replace('~<([a-zA-Z][^>]*)>~', ' $1 ', $string);
+        // allow HTML tags in titles
+        $string = preg_replace('~<([a-zA-Z][^>]*)>~', ' $1 ', $string);
 
-		// more substitutions
-		// @todo put these somewhere else
-		$string = strtr($string, array(
-			// currency
-			"\xE2\x82\xAC" /* € */ => ' E ',
-			"\xC2\xA3" /* £ */ => ' GBP ',
-		));
+        // more substitutions
+        // @todo put these somewhere else
+        $string = strtr($string, array(
+            // currency
+            "\xE2\x82\xAC" /* € */ => ' E ',
+            "\xC2\xA3" /* £ */ => ' GBP ',
+        ));
 
-		// remove all ASCII except 0-9a-zA-Z, hyphen, underscore, and whitespace
-		// note: "x" modifier did not work with this pattern.
-		$string = preg_replace('~['
-			. '\x00-\x08'  // control chars
-			. '\x0b\x0c'   // vert tab, form feed
-			. '\x0e-\x1f'  // control chars
-			. '\x21-\x2c'  // ! ... ,
-			. '\x2e\x2f'   // . slash
-			. '\x3a-\x40'  // : ... @
-			. '\x5b-\x5e'  // [ ... ^
-			. '\x60'       // `
-			. '\x7b-\x7f'  // { ... DEL
-			. ']~', '', $string);
-		$string = strtr($string, '', '');
+        // remove all ASCII except 0-9a-zA-Z, hyphen, underscore, and whitespace
+        // note: "x" modifier did not work with this pattern.
+        $string = preg_replace('~['
+            . '\x00-\x08'  // control chars
+            . '\x0b\x0c'   // vert tab, form feed
+            . '\x0e-\x1f'  // control chars
+            . '\x21-\x2c'  // ! ... ,
+            . '\x2e\x2f'   // . slash
+            . '\x3a-\x40'  // : ... @
+            . '\x5b-\x5e'  // [ ... ^
+            . '\x60'       // `
+            . '\x7b-\x7f'  // { ... DEL
+            . ']~', '', $string);
+        $string = strtr($string, '', '');
 
-		// internationalization, and 日本語!
-		// note: not using elgg_strtolower to keep this class portable
-		$string = is_callable('mb_strtolower') ? mb_strtolower($string, 'UTF-8') : strtolower($string);
+        // internationalization, and 日本語!
+        // note: not using elgg_strtolower to keep this class portable
+        $string = is_callable('mb_strtolower') ? mb_strtolower($string, 'UTF-8') : strtolower($string);
 
-		// split by ASCII chars not in 0-9a-zA-Z
-		// note: we cannot use [^0-9a-zA-Z] because that matches multibyte chars.
-		// note: "x" modifier did not work with this pattern.
-		$pattern = '~['
-			. '\x00-\x2f'  // controls ... slash
-			. '\x3a-\x40'  // : ... @
-			. '\x5b-\x60'  // [ ... `
-			. '\x7b-\x7f'  // { ... DEL
-			. ']+~x';
+        // split by ASCII chars not in 0-9a-zA-Z
+        // note: we cannot use [^0-9a-zA-Z] because that matches multibyte chars.
+        // note: "x" modifier did not work with this pattern.
+        $pattern = '~['
+            . '\x00-\x2f'  // controls ... slash
+            . '\x3a-\x40'  // : ... @
+            . '\x5b-\x60'  // [ ... `
+            . '\x7b-\x7f'  // { ... DEL
+            . ']+~x';
 
-		// ['internationalization', 'and', '日本語']
-		$words = preg_split($pattern, $string, -1, PREG_SPLIT_NO_EMPTY);
+        // ['internationalization', 'and', '日本語']
+        $words = preg_split($pattern, $string, -1, PREG_SPLIT_NO_EMPTY);
 
-		// ['internationalization', 'and', '%E6%97%A5%E6%9C%AC%E8%AA%9E']
-		$words = array_map('urlencode', $words);
+        // ['internationalization', 'and', '%E6%97%A5%E6%9C%AC%E8%AA%9E']
+        $words = array_map('urlencode', $words);
 
-		// internationalization-and-%E6%97%A5%E6%9C%AC%E8%AA%9E
-		return implode($separator, $words);
-	}
+        // internationalization-and-%E6%97%A5%E6%9C%AC%E8%AA%9E
+        return implode($separator, $words);
+    }
 
-	/**
-	 * Transliterate Western multibyte chars to ASCII
-	 *
-	 * @param string $utf8 a UTF-8 string
-	 * @return string
-	 */
-	static public function transliterateAscii($utf8) {
-		static $map = null;
-		if (!preg_match('/[\x80-\xff]/', $utf8)) {
-			return $utf8;
-		}
-		if (null === $map) {
-			$map = self::getAsciiTranslitMap();
-		}
-		return strtr($utf8, $map);
-	}
+    /**
+     * Transliterate Western multibyte chars to ASCII
+     *
+     * @param string $utf8 a UTF-8 string
+     * @return string
+     */
+    static public function transliterateAscii($utf8) {
+        static $map = null;
+        if (!preg_match('/[\x80-\xff]/', $utf8)) {
+            return $utf8;
+        }
+        if (null === $map) {
+            $map = self::getAsciiTranslitMap();
+        }
+        return strtr($utf8, $map);
+    }
 
-	/**
-	 * Get array of UTF-8 (NFC) character replacements.
-	 *
-	 * @return array
-	 */
-	static public function getAsciiTranslitMap() {
-		return array(
-			// Decompositions for Latin-1 Supplement
-			"\xC2\xAA" /* ª */ => 'a', "\xC2\xBA" /* º */ => 'o', "\xC3\x80" /* À */ => 'A',
-			"\xC3\x81" /* Á */ => 'A', "\xC3\x82" /* Â */ => 'A', "\xC3\x83" /* Ã */ => 'A',
-			"\xC3\x84" /* Ä */ => 'A', "\xC3\x85" /* Å */ => 'A', "\xC3\x86" /* Æ */ => 'AE',
-			"\xC3\x87" /* Ç */ => 'C', "\xC3\x88" /* È */ => 'E', "\xC3\x89" /* É */ => 'E',
-			"\xC3\x8A" /* Ê */ => 'E', "\xC3\x8B" /* Ë */ => 'E', "\xC3\x8C" /* Ì */ => 'I',
-			"\xC3\x8D" /* Í */ => 'I', "\xC3\x8E" /* Î */ => 'I', "\xC3\x8F" /* Ï */ => 'I',
-			"\xC3\x90" /* Ð */ => 'D', "\xC3\x91" /* Ñ */ => 'N', "\xC3\x92" /* Ò */ => 'O',
-			"\xC3\x93" /* Ó */ => 'O', "\xC3\x94" /* Ô */ => 'O', "\xC3\x95" /* Õ */ => 'O',
-			"\xC3\x96" /* Ö */ => 'O', "\xC3\x99" /* Ù */ => 'U', "\xC3\x9A" /* Ú */ => 'U',
-			"\xC3\x9B" /* Û */ => 'U', "\xC3\x9C" /* Ü */ => 'U', "\xC3\x9D" /* Ý */ => 'Y',
-			"\xC3\x9E" /* Þ */ => 'TH', "\xC3\x9F" /* ß */ => 'ss', "\xC3\xA0" /* à */ => 'a',
-			"\xC3\xA1" /* á */ => 'a', "\xC3\xA2" /* â */ => 'a', "\xC3\xA3" /* ã */ => 'a',
-			"\xC3\xA4" /* ä */ => 'a', "\xC3\xA5" /* å */ => 'a', "\xC3\xA6" /* æ */ => 'ae',
-			"\xC3\xA7" /* ç */ => 'c', "\xC3\xA8" /* è */ => 'e', "\xC3\xA9" /* é */ => 'e',
-			"\xC3\xAA" /* ê */ => 'e', "\xC3\xAB" /* ë */ => 'e', "\xC3\xAC" /* ì */ => 'i',
-			"\xC3\xAD" /* í */ => 'i', "\xC3\xAE" /* î */ => 'i', "\xC3\xAF" /* ï */ => 'i',
-			"\xC3\xB0" /* ð */ => 'd', "\xC3\xB1" /* ñ */ => 'n', "\xC3\xB2" /* ò */ => 'o',
-			"\xC3\xB3" /* ó */ => 'o', "\xC3\xB4" /* ô */ => 'o', "\xC3\xB5" /* õ */ => 'o',
-			"\xC3\xB6" /* ö */ => 'o', "\xC3\xB8" /* ø */ => 'o', "\xC3\xB9" /* ù */ => 'u',
-			"\xC3\xBA" /* ú */ => 'u', "\xC3\xBB" /* û */ => 'u', "\xC3\xBC" /* ü */ => 'u',
-			"\xC3\xBD" /* ý */ => 'y', "\xC3\xBE" /* þ */ => 'th', "\xC3\xBF" /* ÿ */ => 'y',
-			"\xC3\x98" /* Ø */ => 'O',
-			// Decompositions for Latin Extended-A
-			"\xC4\x80" /* Ā */ => 'A', "\xC4\x81" /* ā */ => 'a', "\xC4\x82" /* Ă */ => 'A',
-			"\xC4\x83" /* ă */ => 'a', "\xC4\x84" /* Ą */ => 'A', "\xC4\x85" /* ą */ => 'a',
-			"\xC4\x86" /* Ć */ => 'C', "\xC4\x87" /* ć */ => 'c', "\xC4\x88" /* Ĉ */ => 'C',
-			"\xC4\x89" /* ĉ */ => 'c', "\xC4\x8A" /* Ċ */ => 'C', "\xC4\x8B" /* ċ */ => 'c',
-			"\xC4\x8C" /* Č */ => 'C', "\xC4\x8D" /* č */ => 'c', "\xC4\x8E" /* Ď */ => 'D',
-			"\xC4\x8F" /* ď */ => 'd', "\xC4\x90" /* Đ */ => 'D', "\xC4\x91" /* đ */ => 'd',
-			"\xC4\x92" /* Ē */ => 'E', "\xC4\x93" /* ē */ => 'e', "\xC4\x94" /* Ĕ */ => 'E',
-			"\xC4\x95" /* ĕ */ => 'e', "\xC4\x96" /* Ė */ => 'E', "\xC4\x97" /* ė */ => 'e',
-			"\xC4\x98" /* Ę */ => 'E', "\xC4\x99" /* ę */ => 'e', "\xC4\x9A" /* Ě */ => 'E',
-			"\xC4\x9B" /* ě */ => 'e', "\xC4\x9C" /* Ĝ */ => 'G', "\xC4\x9D" /* ĝ */ => 'g',
-			"\xC4\x9E" /* Ğ */ => 'G', "\xC4\x9F" /* ğ */ => 'g', "\xC4\xA0" /* Ġ */ => 'G',
-			"\xC4\xA1" /* ġ */ => 'g', "\xC4\xA2" /* Ģ */ => 'G', "\xC4\xA3" /* ģ */ => 'g',
-			"\xC4\xA4" /* Ĥ */ => 'H', "\xC4\xA5" /* ĥ */ => 'h', "\xC4\xA6" /* Ħ */ => 'H',
-			"\xC4\xA7" /* ħ */ => 'h', "\xC4\xA8" /* Ĩ */ => 'I', "\xC4\xA9" /* ĩ */ => 'i',
-			"\xC4\xAA" /* Ī */ => 'I', "\xC4\xAB" /* ī */ => 'i', "\xC4\xAC" /* Ĭ */ => 'I',
-			"\xC4\xAD" /* ĭ */ => 'i', "\xC4\xAE" /* Į */ => 'I', "\xC4\xAF" /* į */ => 'i',
-			"\xC4\xB0" /* İ */ => 'I', "\xC4\xB1" /* ı */ => 'i', "\xC4\xB2" /* IJ */ => 'IJ',
-			"\xC4\xB3" /* ij */ => 'ij', "\xC4\xB4" /* Ĵ */ => 'J', "\xC4\xB5" /* ĵ */ => 'j',
-			"\xC4\xB6" /* Ķ */ => 'K', "\xC4\xB7" /* ķ */ => 'k', "\xC4\xB8" /* ĸ */ => 'k',
-			"\xC4\xB9" /* Ĺ */ => 'L', "\xC4\xBA" /* ĺ */ => 'l', "\xC4\xBB" /* Ļ */ => 'L',
-			"\xC4\xBC" /* ļ */ => 'l', "\xC4\xBD" /* Ľ */ => 'L', "\xC4\xBE" /* ľ */ => 'l',
-			"\xC4\xBF" /* Ŀ */ => 'L', "\xC5\x80" /* ŀ */ => 'l', "\xC5\x81" /* Ł */ => 'L',
-			"\xC5\x82" /* ł */ => 'l', "\xC5\x83" /* Ń */ => 'N', "\xC5\x84" /* ń */ => 'n',
-			"\xC5\x85" /* Ņ */ => 'N', "\xC5\x86" /* ņ */ => 'n', "\xC5\x87" /* Ň */ => 'N',
-			"\xC5\x88" /* ň */ => 'n', "\xC5\x89" /* ʼn */ => 'N', "\xC5\x8A" /* Ŋ */ => 'n',
-			"\xC5\x8B" /* ŋ */ => 'N', "\xC5\x8C" /* Ō */ => 'O', "\xC5\x8D" /* ō */ => 'o',
-			"\xC5\x8E" /* Ŏ */ => 'O', "\xC5\x8F" /* ŏ */ => 'o', "\xC5\x90" /* Ő */ => 'O',
-			"\xC5\x91" /* ő */ => 'o', "\xC5\x92" /* Œ */ => 'OE', "\xC5\x93" /* œ */ => 'oe',
-			"\xC5\x94" /* Ŕ */ => 'R', "\xC5\x95" /* ŕ */ => 'r', "\xC5\x96" /* Ŗ */ => 'R',
-			"\xC5\x97" /* ŗ */ => 'r', "\xC5\x98" /* Ř */ => 'R', "\xC5\x99" /* ř */ => 'r',
-			"\xC5\x9A" /* Ś */ => 'S', "\xC5\x9B" /* ś */ => 's', "\xC5\x9C" /* Ŝ */ => 'S',
-			"\xC5\x9D" /* ŝ */ => 's', "\xC5\x9E" /* Ş */ => 'S', "\xC5\x9F" /* ş */ => 's',
-			"\xC5\xA0" /* Š */ => 'S', "\xC5\xA1" /* š */ => 's', "\xC5\xA2" /* Ţ */ => 'T',
-			"\xC5\xA3" /* ţ */ => 't', "\xC5\xA4" /* Ť */ => 'T', "\xC5\xA5" /* ť */ => 't',
-			"\xC5\xA6" /* Ŧ */ => 'T', "\xC5\xA7" /* ŧ */ => 't', "\xC5\xA8" /* Ũ */ => 'U',
-			"\xC5\xA9" /* ũ */ => 'u', "\xC5\xAA" /* Ū */ => 'U', "\xC5\xAB" /* ū */ => 'u',
-			"\xC5\xAC" /* Ŭ */ => 'U', "\xC5\xAD" /* ŭ */ => 'u', "\xC5\xAE" /* Ů */ => 'U',
-			"\xC5\xAF" /* ů */ => 'u', "\xC5\xB0" /* Ű */ => 'U', "\xC5\xB1" /* ű */ => 'u',
-			"\xC5\xB2" /* Ų */ => 'U', "\xC5\xB3" /* ų */ => 'u', "\xC5\xB4" /* Ŵ */ => 'W',
-			"\xC5\xB5" /* ŵ */ => 'w', "\xC5\xB6" /* Ŷ */ => 'Y', "\xC5\xB7" /* ŷ */ => 'y',
-			"\xC5\xB8" /* Ÿ */ => 'Y', "\xC5\xB9" /* Ź */ => 'Z', "\xC5\xBA" /* ź */ => 'z',
-			"\xC5\xBB" /* Ż */ => 'Z', "\xC5\xBC" /* ż */ => 'z', "\xC5\xBD" /* Ž */ => 'Z',
-			"\xC5\xBE" /* ž */ => 'z', "\xC5\xBF" /* ſ */ => 's',
-			// Decompositions for Latin Extended-B
-			"\xC8\x98" /* Ș */ => 'S', "\xC8\x99" /* ș */ => 's',
-			"\xC8\x9A" /* Ț */ => 'T', "\xC8\x9B" /* ț */ => 't',
-			// unmarked
-			"\xC6\xA0" /* Ơ */ => 'O', "\xC6\xA1" /* ơ */ => 'o',
-			"\xC6\xAF" /* Ư */ => 'U', "\xC6\xB0" /* ư */ => 'u',
-			// grave accent
-			"\xE1\xBA\xA6" /* Ầ */ => 'A', "\xE1\xBA\xA7" /* ầ */ => 'a',
-			"\xE1\xBA\xB0" /* Ằ */ => 'A', "\xE1\xBA\xB1" /* ằ */ => 'a',
-			"\xE1\xBB\x80" /* Ề */ => 'E', "\xE1\xBB\x81" /* ề */ => 'e',
-			"\xE1\xBB\x92" /* Ồ */ => 'O', "\xE1\xBB\x93" /* ồ */ => 'o',
-			"\xE1\xBB\x9C" /* Ờ */ => 'O', "\xE1\xBB\x9D" /* ờ */ => 'o',
-			"\xE1\xBB\xAA" /* Ừ */ => 'U', "\xE1\xBB\xAB" /* ừ */ => 'u',
-			"\xE1\xBB\xB2" /* Ỳ */ => 'Y', "\xE1\xBB\xB3" /* ỳ */ => 'y',
-			// hook
-			"\xE1\xBA\xA2" /* Ả */ => 'A', "\xE1\xBA\xA3" /* ả */ => 'a',
-			"\xE1\xBA\xA8" /* Ẩ */ => 'A', "\xE1\xBA\xA9" /* ẩ */ => 'a',
-			"\xE1\xBA\xB2" /* Ẳ */ => 'A', "\xE1\xBA\xB3" /* ẳ */ => 'a',
-			"\xE1\xBA\xBA" /* Ẻ */ => 'E', "\xE1\xBA\xBB" /* ẻ */ => 'e',
-			"\xE1\xBB\x82" /* Ể */ => 'E', "\xE1\xBB\x83" /* ể */ => 'e',
-			"\xE1\xBB\x88" /* Ỉ */ => 'I', "\xE1\xBB\x89" /* ỉ */ => 'i',
-			"\xE1\xBB\x8E" /* Ỏ */ => 'O', "\xE1\xBB\x8F" /* ỏ */ => 'o',
-			"\xE1\xBB\x94" /* Ổ */ => 'O', "\xE1\xBB\x95" /* ổ */ => 'o',
-			"\xE1\xBB\x9E" /* Ở */ => 'O', "\xE1\xBB\x9F" /* ở */ => 'o',
-			"\xE1\xBB\xA6" /* Ủ */ => 'U', "\xE1\xBB\xA7" /* ủ */ => 'u',
-			"\xE1\xBB\xAC" /* Ử */ => 'U', "\xE1\xBB\xAD" /* ử */ => 'u',
-			"\xE1\xBB\xB6" /* Ỷ */ => 'Y', "\xE1\xBB\xB7" /* ỷ */ => 'y',
-			// tilde
-			"\xE1\xBA\xAA" /* Ẫ */ => 'A', "\xE1\xBA\xAB" /* ẫ */ => 'a',
-			"\xE1\xBA\xB4" /* Ẵ */ => 'A', "\xE1\xBA\xB5" /* ẵ */ => 'a',
-			"\xE1\xBA\xBC" /* Ẽ */ => 'E', "\xE1\xBA\xBD" /* ẽ */ => 'e',
-			"\xE1\xBB\x84" /* Ễ */ => 'E', "\xE1\xBB\x85" /* ễ */ => 'e',
-			"\xE1\xBB\x96" /* Ỗ */ => 'O', "\xE1\xBB\x97" /* ỗ */ => 'o',
-			"\xE1\xBB\xA0" /* Ỡ */ => 'O', "\xE1\xBB\xA1" /* ỡ */ => 'o',
-			"\xE1\xBB\xAE" /* Ữ */ => 'U', "\xE1\xBB\xAF" /* ữ */ => 'u',
-			"\xE1\xBB\xB8" /* Ỹ */ => 'Y', "\xE1\xBB\xB9" /* ỹ */ => 'y',
-			// acute accent
-			"\xE1\xBA\xA4" /* Ấ */ => 'A', "\xE1\xBA\xA5" /* ấ */ => 'a',
-			"\xE1\xBA\xAE" /* Ắ */ => 'A', "\xE1\xBA\xAF" /* ắ */ => 'a',
-			"\xE1\xBA\xBE" /* Ế */ => 'E', "\xE1\xBA\xBF" /* ế */ => 'e',
-			"\xE1\xBB\x90" /* Ố */ => 'O', "\xE1\xBB\x91" /* ố */ => 'o',
-			"\xE1\xBB\x9A" /* Ớ */ => 'O', "\xE1\xBB\x9B" /* ớ */ => 'o',
-			"\xE1\xBB\xA8" /* Ứ */ => 'U', "\xE1\xBB\xA9" /* ứ */ => 'u',
-			// dot below
-			"\xE1\xBA\xA0" /* Ạ */ => 'A', "\xE1\xBA\xA1" /* ạ */ => 'a',
-			"\xE1\xBA\xAC" /* Ậ */ => 'A', "\xE1\xBA\xAD" /* ậ */ => 'a',
-			"\xE1\xBA\xB6" /* Ặ */ => 'A', "\xE1\xBA\xB7" /* ặ */ => 'a',
-			"\xE1\xBA\xB8" /* Ẹ */ => 'E', "\xE1\xBA\xB9" /* ẹ */ => 'e',
-			"\xE1\xBB\x86" /* Ệ */ => 'E', "\xE1\xBB\x87" /* ệ */ => 'e',
-			"\xE1\xBB\x8A" /* Ị */ => 'I', "\xE1\xBB\x8B" /* ị */ => 'i',
-			"\xE1\xBB\x8C" /* Ọ */ => 'O', "\xE1\xBB\x8D" /* ọ */ => 'o',
-			"\xE1\xBB\x98" /* Ộ */ => 'O', "\xE1\xBB\x99" /* ộ */ => 'o',
-			"\xE1\xBB\xA2" /* Ợ */ => 'O', "\xE1\xBB\xA3" /* ợ */ => 'o',
-			"\xE1\xBB\xA4" /* Ụ */ => 'U', "\xE1\xBB\xA5" /* ụ */ => 'u',
-			"\xE1\xBB\xB0" /* Ự */ => 'U', "\xE1\xBB\xB1" /* ự */ => 'u',
-			"\xE1\xBB\xB4" /* Ỵ */ => 'Y', "\xE1\xBB\xB5" /* ỵ */ => 'y',
-		);
-	}
+    /**
+     * Get array of UTF-8 (NFC) character replacements.
+     *
+     * @return array
+     */
+    static public function getAsciiTranslitMap() {
+        return array(
+            // Decompositions for Latin-1 Supplement
+            "\xC2\xAA" /* ª */ => 'a', "\xC2\xBA" /* º */ => 'o', "\xC3\x80" /* À */ => 'A',
+            "\xC3\x81" /* Á */ => 'A', "\xC3\x82" /* Â */ => 'A', "\xC3\x83" /* Ã */ => 'A',
+            "\xC3\x84" /* Ä */ => 'A', "\xC3\x85" /* Å */ => 'A', "\xC3\x86" /* Æ */ => 'AE',
+            "\xC3\x87" /* Ç */ => 'C', "\xC3\x88" /* È */ => 'E', "\xC3\x89" /* É */ => 'E',
+            "\xC3\x8A" /* Ê */ => 'E', "\xC3\x8B" /* Ë */ => 'E', "\xC3\x8C" /* Ì */ => 'I',
+            "\xC3\x8D" /* Í */ => 'I', "\xC3\x8E" /* Î */ => 'I', "\xC3\x8F" /* Ï */ => 'I',
+            "\xC3\x90" /* Ð */ => 'D', "\xC3\x91" /* Ñ */ => 'N', "\xC3\x92" /* Ò */ => 'O',
+            "\xC3\x93" /* Ó */ => 'O', "\xC3\x94" /* Ô */ => 'O', "\xC3\x95" /* Õ */ => 'O',
+            "\xC3\x96" /* Ö */ => 'O', "\xC3\x99" /* Ù */ => 'U', "\xC3\x9A" /* Ú */ => 'U',
+            "\xC3\x9B" /* Û */ => 'U', "\xC3\x9C" /* Ü */ => 'U', "\xC3\x9D" /* Ý */ => 'Y',
+            "\xC3\x9E" /* Þ */ => 'TH', "\xC3\x9F" /* ß */ => 'ss', "\xC3\xA0" /* à */ => 'a',
+            "\xC3\xA1" /* á */ => 'a', "\xC3\xA2" /* â */ => 'a', "\xC3\xA3" /* ã */ => 'a',
+            "\xC3\xA4" /* ä */ => 'a', "\xC3\xA5" /* å */ => 'a', "\xC3\xA6" /* æ */ => 'ae',
+            "\xC3\xA7" /* ç */ => 'c', "\xC3\xA8" /* è */ => 'e', "\xC3\xA9" /* é */ => 'e',
+            "\xC3\xAA" /* ê */ => 'e', "\xC3\xAB" /* ë */ => 'e', "\xC3\xAC" /* ì */ => 'i',
+            "\xC3\xAD" /* í */ => 'i', "\xC3\xAE" /* î */ => 'i', "\xC3\xAF" /* ï */ => 'i',
+            "\xC3\xB0" /* ð */ => 'd', "\xC3\xB1" /* ñ */ => 'n', "\xC3\xB2" /* ò */ => 'o',
+            "\xC3\xB3" /* ó */ => 'o', "\xC3\xB4" /* ô */ => 'o', "\xC3\xB5" /* õ */ => 'o',
+            "\xC3\xB6" /* ö */ => 'o', "\xC3\xB8" /* ø */ => 'o', "\xC3\xB9" /* ù */ => 'u',
+            "\xC3\xBA" /* ú */ => 'u', "\xC3\xBB" /* û */ => 'u', "\xC3\xBC" /* ü */ => 'u',
+            "\xC3\xBD" /* ý */ => 'y', "\xC3\xBE" /* þ */ => 'th', "\xC3\xBF" /* ÿ */ => 'y',
+            "\xC3\x98" /* Ø */ => 'O',
+            // Decompositions for Latin Extended-A
+            "\xC4\x80" /* Ā */ => 'A', "\xC4\x81" /* ā */ => 'a', "\xC4\x82" /* Ă */ => 'A',
+            "\xC4\x83" /* ă */ => 'a', "\xC4\x84" /* Ą */ => 'A', "\xC4\x85" /* ą */ => 'a',
+            "\xC4\x86" /* Ć */ => 'C', "\xC4\x87" /* ć */ => 'c', "\xC4\x88" /* Ĉ */ => 'C',
+            "\xC4\x89" /* ĉ */ => 'c', "\xC4\x8A" /* Ċ */ => 'C', "\xC4\x8B" /* ċ */ => 'c',
+            "\xC4\x8C" /* Č */ => 'C', "\xC4\x8D" /* č */ => 'c', "\xC4\x8E" /* Ď */ => 'D',
+            "\xC4\x8F" /* ď */ => 'd', "\xC4\x90" /* Đ */ => 'D', "\xC4\x91" /* đ */ => 'd',
+            "\xC4\x92" /* Ē */ => 'E', "\xC4\x93" /* ē */ => 'e', "\xC4\x94" /* Ĕ */ => 'E',
+            "\xC4\x95" /* ĕ */ => 'e', "\xC4\x96" /* Ė */ => 'E', "\xC4\x97" /* ė */ => 'e',
+            "\xC4\x98" /* Ę */ => 'E', "\xC4\x99" /* ę */ => 'e', "\xC4\x9A" /* Ě */ => 'E',
+            "\xC4\x9B" /* ě */ => 'e', "\xC4\x9C" /* Ĝ */ => 'G', "\xC4\x9D" /* ĝ */ => 'g',
+            "\xC4\x9E" /* Ğ */ => 'G', "\xC4\x9F" /* ğ */ => 'g', "\xC4\xA0" /* Ġ */ => 'G',
+            "\xC4\xA1" /* ġ */ => 'g', "\xC4\xA2" /* Ģ */ => 'G', "\xC4\xA3" /* ģ */ => 'g',
+            "\xC4\xA4" /* Ĥ */ => 'H', "\xC4\xA5" /* ĥ */ => 'h', "\xC4\xA6" /* Ħ */ => 'H',
+            "\xC4\xA7" /* ħ */ => 'h', "\xC4\xA8" /* Ĩ */ => 'I', "\xC4\xA9" /* ĩ */ => 'i',
+            "\xC4\xAA" /* Ī */ => 'I', "\xC4\xAB" /* ī */ => 'i', "\xC4\xAC" /* Ĭ */ => 'I',
+            "\xC4\xAD" /* ĭ */ => 'i', "\xC4\xAE" /* Į */ => 'I', "\xC4\xAF" /* į */ => 'i',
+            "\xC4\xB0" /* İ */ => 'I', "\xC4\xB1" /* ı */ => 'i', "\xC4\xB2" /* IJ */ => 'IJ',
+            "\xC4\xB3" /* ij */ => 'ij', "\xC4\xB4" /* Ĵ */ => 'J', "\xC4\xB5" /* ĵ */ => 'j',
+            "\xC4\xB6" /* Ķ */ => 'K', "\xC4\xB7" /* ķ */ => 'k', "\xC4\xB8" /* ĸ */ => 'k',
+            "\xC4\xB9" /* Ĺ */ => 'L', "\xC4\xBA" /* ĺ */ => 'l', "\xC4\xBB" /* Ļ */ => 'L',
+            "\xC4\xBC" /* ļ */ => 'l', "\xC4\xBD" /* Ľ */ => 'L', "\xC4\xBE" /* ľ */ => 'l',
+            "\xC4\xBF" /* Ŀ */ => 'L', "\xC5\x80" /* ŀ */ => 'l', "\xC5\x81" /* Ł */ => 'L',
+            "\xC5\x82" /* ł */ => 'l', "\xC5\x83" /* Ń */ => 'N', "\xC5\x84" /* ń */ => 'n',
+            "\xC5\x85" /* Ņ */ => 'N', "\xC5\x86" /* ņ */ => 'n', "\xC5\x87" /* Ň */ => 'N',
+            "\xC5\x88" /* ň */ => 'n', "\xC5\x89" /* ʼn */ => 'N', "\xC5\x8A" /* Ŋ */ => 'n',
+            "\xC5\x8B" /* ŋ */ => 'N', "\xC5\x8C" /* Ō */ => 'O', "\xC5\x8D" /* ō */ => 'o',
+            "\xC5\x8E" /* Ŏ */ => 'O', "\xC5\x8F" /* ŏ */ => 'o', "\xC5\x90" /* Ő */ => 'O',
+            "\xC5\x91" /* ő */ => 'o', "\xC5\x92" /* Œ */ => 'OE', "\xC5\x93" /* œ */ => 'oe',
+            "\xC5\x94" /* Ŕ */ => 'R', "\xC5\x95" /* ŕ */ => 'r', "\xC5\x96" /* Ŗ */ => 'R',
+            "\xC5\x97" /* ŗ */ => 'r', "\xC5\x98" /* Ř */ => 'R', "\xC5\x99" /* ř */ => 'r',
+            "\xC5\x9A" /* Ś */ => 'S', "\xC5\x9B" /* ś */ => 's', "\xC5\x9C" /* Ŝ */ => 'S',
+            "\xC5\x9D" /* ŝ */ => 's', "\xC5\x9E" /* Ş */ => 'S', "\xC5\x9F" /* ş */ => 's',
+            "\xC5\xA0" /* Š */ => 'S', "\xC5\xA1" /* š */ => 's', "\xC5\xA2" /* Ţ */ => 'T',
+            "\xC5\xA3" /* ţ */ => 't', "\xC5\xA4" /* Ť */ => 'T', "\xC5\xA5" /* ť */ => 't',
+            "\xC5\xA6" /* Ŧ */ => 'T', "\xC5\xA7" /* ŧ */ => 't', "\xC5\xA8" /* Ũ */ => 'U',
+            "\xC5\xA9" /* ũ */ => 'u', "\xC5\xAA" /* Ū */ => 'U', "\xC5\xAB" /* ū */ => 'u',
+            "\xC5\xAC" /* Ŭ */ => 'U', "\xC5\xAD" /* ŭ */ => 'u', "\xC5\xAE" /* Ů */ => 'U',
+            "\xC5\xAF" /* ů */ => 'u', "\xC5\xB0" /* Ű */ => 'U', "\xC5\xB1" /* ű */ => 'u',
+            "\xC5\xB2" /* Ų */ => 'U', "\xC5\xB3" /* ų */ => 'u', "\xC5\xB4" /* Ŵ */ => 'W',
+            "\xC5\xB5" /* ŵ */ => 'w', "\xC5\xB6" /* Ŷ */ => 'Y', "\xC5\xB7" /* ŷ */ => 'y',
+            "\xC5\xB8" /* Ÿ */ => 'Y', "\xC5\xB9" /* Ź */ => 'Z', "\xC5\xBA" /* ź */ => 'z',
+            "\xC5\xBB" /* Ż */ => 'Z', "\xC5\xBC" /* ż */ => 'z', "\xC5\xBD" /* Ž */ => 'Z',
+            "\xC5\xBE" /* ž */ => 'z', "\xC5\xBF" /* ſ */ => 's',
+            // Decompositions for Latin Extended-B
+            "\xC8\x98" /* Ș */ => 'S', "\xC8\x99" /* ș */ => 's',
+            "\xC8\x9A" /* Ț */ => 'T', "\xC8\x9B" /* ț */ => 't',
+            // unmarked
+            "\xC6\xA0" /* Ơ */ => 'O', "\xC6\xA1" /* ơ */ => 'o',
+            "\xC6\xAF" /* Ư */ => 'U', "\xC6\xB0" /* ư */ => 'u',
+            // grave accent
+            "\xE1\xBA\xA6" /* Ầ */ => 'A', "\xE1\xBA\xA7" /* ầ */ => 'a',
+            "\xE1\xBA\xB0" /* Ằ */ => 'A', "\xE1\xBA\xB1" /* ằ */ => 'a',
+            "\xE1\xBB\x80" /* Ề */ => 'E', "\xE1\xBB\x81" /* ề */ => 'e',
+            "\xE1\xBB\x92" /* Ồ */ => 'O', "\xE1\xBB\x93" /* ồ */ => 'o',
+            "\xE1\xBB\x9C" /* Ờ */ => 'O', "\xE1\xBB\x9D" /* ờ */ => 'o',
+            "\xE1\xBB\xAA" /* Ừ */ => 'U', "\xE1\xBB\xAB" /* ừ */ => 'u',
+            "\xE1\xBB\xB2" /* Ỳ */ => 'Y', "\xE1\xBB\xB3" /* ỳ */ => 'y',
+            // hook
+            "\xE1\xBA\xA2" /* Ả */ => 'A', "\xE1\xBA\xA3" /* ả */ => 'a',
+            "\xE1\xBA\xA8" /* Ẩ */ => 'A', "\xE1\xBA\xA9" /* ẩ */ => 'a',
+            "\xE1\xBA\xB2" /* Ẳ */ => 'A', "\xE1\xBA\xB3" /* ẳ */ => 'a',
+            "\xE1\xBA\xBA" /* Ẻ */ => 'E', "\xE1\xBA\xBB" /* ẻ */ => 'e',
+            "\xE1\xBB\x82" /* Ể */ => 'E', "\xE1\xBB\x83" /* ể */ => 'e',
+            "\xE1\xBB\x88" /* Ỉ */ => 'I', "\xE1\xBB\x89" /* ỉ */ => 'i',
+            "\xE1\xBB\x8E" /* Ỏ */ => 'O', "\xE1\xBB\x8F" /* ỏ */ => 'o',
+            "\xE1\xBB\x94" /* Ổ */ => 'O', "\xE1\xBB\x95" /* ổ */ => 'o',
+            "\xE1\xBB\x9E" /* Ở */ => 'O', "\xE1\xBB\x9F" /* ở */ => 'o',
+            "\xE1\xBB\xA6" /* Ủ */ => 'U', "\xE1\xBB\xA7" /* ủ */ => 'u',
+            "\xE1\xBB\xAC" /* Ử */ => 'U', "\xE1\xBB\xAD" /* ử */ => 'u',
+            "\xE1\xBB\xB6" /* Ỷ */ => 'Y', "\xE1\xBB\xB7" /* ỷ */ => 'y',
+            // tilde
+            "\xE1\xBA\xAA" /* Ẫ */ => 'A', "\xE1\xBA\xAB" /* ẫ */ => 'a',
+            "\xE1\xBA\xB4" /* Ẵ */ => 'A', "\xE1\xBA\xB5" /* ẵ */ => 'a',
+            "\xE1\xBA\xBC" /* Ẽ */ => 'E', "\xE1\xBA\xBD" /* ẽ */ => 'e',
+            "\xE1\xBB\x84" /* Ễ */ => 'E', "\xE1\xBB\x85" /* ễ */ => 'e',
+            "\xE1\xBB\x96" /* Ỗ */ => 'O', "\xE1\xBB\x97" /* ỗ */ => 'o',
+            "\xE1\xBB\xA0" /* Ỡ */ => 'O', "\xE1\xBB\xA1" /* ỡ */ => 'o',
+            "\xE1\xBB\xAE" /* Ữ */ => 'U', "\xE1\xBB\xAF" /* ữ */ => 'u',
+            "\xE1\xBB\xB8" /* Ỹ */ => 'Y', "\xE1\xBB\xB9" /* ỹ */ => 'y',
+            // acute accent
+            "\xE1\xBA\xA4" /* Ấ */ => 'A', "\xE1\xBA\xA5" /* ấ */ => 'a',
+            "\xE1\xBA\xAE" /* Ắ */ => 'A', "\xE1\xBA\xAF" /* ắ */ => 'a',
+            "\xE1\xBA\xBE" /* Ế */ => 'E', "\xE1\xBA\xBF" /* ế */ => 'e',
+            "\xE1\xBB\x90" /* Ố */ => 'O', "\xE1\xBB\x91" /* ố */ => 'o',
+            "\xE1\xBB\x9A" /* Ớ */ => 'O', "\xE1\xBB\x9B" /* ớ */ => 'o',
+            "\xE1\xBB\xA8" /* Ứ */ => 'U', "\xE1\xBB\xA9" /* ứ */ => 'u',
+            // dot below
+            "\xE1\xBA\xA0" /* Ạ */ => 'A', "\xE1\xBA\xA1" /* ạ */ => 'a',
+            "\xE1\xBA\xAC" /* Ậ */ => 'A', "\xE1\xBA\xAD" /* ậ */ => 'a',
+            "\xE1\xBA\xB6" /* Ặ */ => 'A', "\xE1\xBA\xB7" /* ặ */ => 'a',
+            "\xE1\xBA\xB8" /* Ẹ */ => 'E', "\xE1\xBA\xB9" /* ẹ */ => 'e',
+            "\xE1\xBB\x86" /* Ệ */ => 'E', "\xE1\xBB\x87" /* ệ */ => 'e',
+            "\xE1\xBB\x8A" /* Ị */ => 'I', "\xE1\xBB\x8B" /* ị */ => 'i',
+            "\xE1\xBB\x8C" /* Ọ */ => 'O', "\xE1\xBB\x8D" /* ọ */ => 'o',
+            "\xE1\xBB\x98" /* Ộ */ => 'O', "\xE1\xBB\x99" /* ộ */ => 'o',
+            "\xE1\xBB\xA2" /* Ợ */ => 'O', "\xE1\xBB\xA3" /* ợ */ => 'o',
+            "\xE1\xBB\xA4" /* Ụ */ => 'U', "\xE1\xBB\xA5" /* ụ */ => 'u',
+            "\xE1\xBB\xB0" /* Ự */ => 'U', "\xE1\xBB\xB1" /* ự */ => 'u',
+            "\xE1\xBB\xB4" /* Ỵ */ => 'Y', "\xE1\xBB\xB5" /* ỵ */ => 'y',
+        );
+    }
 
-	/**
-	 * Tests that "normalizer_normalize" exists and works
-	 *
-	 * @return bool
-	 */
-	static public function hasNormalizerSupport() {
-		static $ret = null;
-		if (null === $ret) {
-			$form_c = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
-			$form_d = "A\xCC\x8A"; // A followed by 'COMBINING RING ABOVE' (U+030A)
-			$ret = (function_exists('normalizer_normalize')
-				&& $form_c === normalizer_normalize($form_d));
-		}
-		return $ret;
-	}
+    /**
+     * Tests that "normalizer_normalize" exists and works
+     *
+     * @return bool
+     */
+    static public function hasNormalizerSupport() {
+        static $ret = null;
+        if (null === $ret) {
+            $form_c = "\xC3\x85"; // 'LATIN CAPITAL LETTER A WITH RING ABOVE' (U+00C5)
+            $form_d = "A\xCC\x8A"; // A followed by 'COMBINING RING ABOVE' (U+030A)
+            $ret = (function_exists('normalizer_normalize')
+                && $form_c === normalizer_normalize($form_d));
+        }
+        return $ret;
+    }
 }
 

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.

Indentation +417 added lines, -417 removed lines

@@ -72,422 +72,422 @@
  */
 class ElggBatch implements BatchResult {
 
-	/**
-	 * The objects to iterate over.
-	 *
-	 * @var array
-	 */
-	private $results = array();
-
-	/**
-	 * 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 = array();
-
-	/**
-	 * 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 = array();
-
-	/**
-	 * 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 = array();
+
+    /**
+     * 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 = array();
+
+    /**
+     * 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 = array();
+
+    /**
+     * 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_get_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 = array();
-					}
-				}
-
-				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 = array();
-
-		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 = array(
-			'limit' => $limit,
-			'offset' => $offset,
-			'__ElggBatch' => $this,
-		);
-
-		$options = array_merge($this->options, $current_options);
-
-		$this->incompleteEntities = array();
-		$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(array(), $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 = array();
-			return false;
-		}
-
-		// if we'll need new results.
-		if (($this->resultIndex + 1) >= $this->chunkSize) {
-			if (!$this->getNextResultsChunk()) {
-				$this->results = array();
-				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);
-	}
-
-	/**
-	 * Read a property
-	 *
-	 * @param string $name
-	 * @return mixed
-	 * @access private
-	 */
-	public function __get($name) {
-		if ($name === 'options') {
-			elgg_deprecated_notice("The ElggBatch 'options' property is private and should not be used", "2.3");
-			return $this->options;
-		}
-
-		_elgg_services()->logger->warn("Read of non-existent property '$name'");
-		return null;
-	}
-
-	/**
-	 * Write a property
-	 *
-	 * @param string $name
-	 * @param mixed  $value
-	 * @return void
-	 * @access private
-	 */
-	public function __set($name, $value) {
-		if ($name === 'options') {
-			elgg_deprecated_notice("The ElggBatch 'options' property is private and should not be used", "2.3");
-		}
-
-		$this->{$name} = $value;
-	}
+        $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_get_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 = array();
+                    }
+                }
+
+                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 = array();
+
+        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 = array(
+            'limit' => $limit,
+            'offset' => $offset,
+            '__ElggBatch' => $this,
+        );
+
+        $options = array_merge($this->options, $current_options);
+
+        $this->incompleteEntities = array();
+        $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(array(), $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 = array();
+            return false;
+        }
+
+        // if we'll need new results.
+        if (($this->resultIndex + 1) >= $this->chunkSize) {
+            if (!$this->getNextResultsChunk()) {
+                $this->results = array();
+                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);
+    }
+
+    /**
+     * Read a property
+     *
+     * @param string $name
+     * @return mixed
+     * @access private
+     */
+    public function __get($name) {
+        if ($name === 'options') {
+            elgg_deprecated_notice("The ElggBatch 'options' property is private and should not be used", "2.3");
+            return $this->options;
+        }
+
+        _elgg_services()->logger->warn("Read of non-existent property '$name'");
+        return null;
+    }
+
+    /**
+     * Write a property
+     *
+     * @param string $name
+     * @param mixed  $value
+     * @return void
+     * @access private
+     */
+    public function __set($name, $value) {
+        if ($name === 'options') {
+            elgg_deprecated_notice("The ElggBatch 'options' property is private and should not be used", "2.3");
+        }
+
+        $this->{$name} = $value;
+    }
 }

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