Elgg / Elgg

engine/classes/ElggEntity.php

Indentation +1954 added lines, -1954 removed lines

@@ -40,2033 +40,2033 @@
  * @property       string $location       A location of the entity
  */
 abstract class ElggEntity extends \ElggData implements
-	Locatable, // Geocoding interface
-	\Elgg\EntityIcon // Icon interface
+    Locatable, // Geocoding interface
+    \Elgg\EntityIcon // Icon interface
 {
 	
-	/**
-	 * If set, overrides the value of getURL()
-	 */
-	protected $url_override;
-
-	/**
-	 * Holds metadata until entity is saved.  Once the entity is saved,
-	 * metadata are written immediately to the database.
-	 */
-	protected $temp_metadata = [];
-
-	/**
-	 * Holds annotations until entity is saved.  Once the entity is saved,
-	 * annotations are written immediately to the database.
-	 */
-	protected $temp_annotations = [];
-
-	/**
-	 * Holds private settings until entity is saved. Once the entity is saved,
-	 * private settings are written immediately to the database.
-	 */
-	protected $temp_private_settings = [];
-
-	/**
-	 * Volatile data structure for this object, allows for storage of data
-	 * in-memory that isn't sync'd back to the metadata table.
-	 */
-	protected $volatile = [];
-
-	/**
-	 * Holds the original (persisted) attribute values that have been changed but not yet saved.
-	 */
-	protected $orig_attributes = [];
+    /**
+     * If set, overrides the value of getURL()
+     */
+    protected $url_override;
+
+    /**
+     * Holds metadata until entity is saved.  Once the entity is saved,
+     * metadata are written immediately to the database.
+     */
+    protected $temp_metadata = [];
+
+    /**
+     * Holds annotations until entity is saved.  Once the entity is saved,
+     * annotations are written immediately to the database.
+     */
+    protected $temp_annotations = [];
+
+    /**
+     * Holds private settings until entity is saved. Once the entity is saved,
+     * private settings are written immediately to the database.
+     */
+    protected $temp_private_settings = [];
+
+    /**
+     * Volatile data structure for this object, allows for storage of data
+     * in-memory that isn't sync'd back to the metadata table.
+     */
+    protected $volatile = [];
+
+    /**
+     * Holds the original (persisted) attribute values that have been changed but not yet saved.
+     */
+    protected $orig_attributes = [];
 	
-	/**
-	 * Initialize the attributes array.
-	 *
-	 * This is vital to distinguish between metadata and base parameters.
-	 *
-	 * @return void
-	 */
-	protected function initializeAttributes() {
-		parent::initializeAttributes();
-
-		$this->attributes['guid'] = null;
-		$this->attributes['type'] = null;
-		$this->attributes['subtype'] = null;
-
-		$this->attributes['owner_guid'] = _elgg_services()->session->getLoggedInUserGuid();
-		$this->attributes['container_guid'] = _elgg_services()->session->getLoggedInUserGuid();
-
-		$this->attributes['access_id'] = ACCESS_PRIVATE;
-		$this->attributes['time_updated'] = null;
-		$this->attributes['last_action'] = null;
-		$this->attributes['enabled'] = "yes";
-	}
-
-	/**
-	 * Clone an entity
-	 *
-	 * Resets the guid so that the entity can be saved as a distinct entity from
-	 * the original. Creation time will be set when this new entity is saved.
-	 * The owner and container guids come from the original entity. The clone
-	 * method copies metadata but does not copy annotations or private settings.
-	 *
-	 * @note metadata will have its owner and access id set when the entity is saved
-	 * and it will be the same as that of the entity.
-	 *
-	 * @return void
-	 */
-	public function __clone() {
-		$orig_entity = get_entity($this->guid);
-		if (!$orig_entity) {
-			_elgg_services()->logger->error("Failed to clone entity with GUID $this->guid");
-			return;
-		}
-
-		$metadata_array = elgg_get_metadata([
-			'guid' => $this->guid,
-			'limit' => 0
-		]);
-
-		$this->attributes['guid'] = "";
-
-		$this->attributes['subtype'] = $orig_entity->getSubtype();
-
-		// copy metadata over to new entity - slightly convoluted due to
-		// handling of metadata arrays
-		if (is_array($metadata_array)) {
-			// create list of metadata names
-			$metadata_names = [];
-			foreach ($metadata_array as $metadata) {
-				$metadata_names[] = $metadata['name'];
-			}
-			// arrays are stored with multiple enties per name
-			$metadata_names = array_unique($metadata_names);
-
-			// move the metadata over
-			foreach ($metadata_names as $name) {
-				$this->__set($name, $orig_entity->$name);
-			}
-		}
-	}
-
-	/**
-	 * Set an attribute or metadata value for this entity
-	 *
-	 * Anything that is not an attribute is saved as metadata.
-	 *
-	 * @warning Metadata set this way will inherit the entity's owner and
-	 * access ID. If you want more control over metadata, use \ElggEntity::setMetadata()
-	 *
-	 * @param string $name  Name of the attribute or metadata
-	 * @param mixed  $value The value to be set
-	 * @return void
-	 * @see \ElggEntity::setMetadata()
-	 */
-	public function __set($name, $value) {
-		if ($this->$name === $value) {
-			// quick return if value is not changing
-			return;
-		}
-
-		if (array_key_exists($name, $this->attributes)) {
-			// if an attribute is 1 (integer) and it's set to "1" (string), don't consider that a change.
-			if (is_int($this->attributes[$name])
-					&& is_string($value)
-					&& ((string) $this->attributes[$name] === $value)) {
-				return;
-			}
-
-			// Due to https://github.com/Elgg/Elgg/pull/5456#issuecomment-17785173, certain attributes
-			// will store empty strings as null in the DB. In the somewhat common case that we're re-setting
-			// the value to empty string, don't consider this a change.
-			if (in_array($name, ['title', 'name', 'description'])
-					&& $this->attributes[$name] === null
-					&& $value === "") {
-				return;
-			}
-
-			// keep original values
-			if ($this->guid && !array_key_exists($name, $this->orig_attributes)) {
-				$this->orig_attributes[$name] = $this->attributes[$name];
-			}
-
-			// Certain properties should not be manually changed!
-			switch ($name) {
-				case 'guid':
-				case 'time_updated':
-				case 'last_action':
-					return;
-					break;
-				case 'access_id':
-				case 'owner_guid':
-				case 'container_guid':
-					if ($value !== null) {
-						$this->attributes[$name] = (int) $value;
-					} else {
-						$this->attributes[$name] = null;
-					}
-					break;
-				default:
-					$this->attributes[$name] = $value;
-					break;
-			}
-			return;
-		}
-
-		$this->setMetadata($name, $value);
-	}
-
-	/**
-	 * Get the original values of attribute(s) that have been modified since the entity was persisted.
-	 *
-	 * @return array
-	 */
-	public function getOriginalAttributes() {
-		return $this->orig_attributes;
-	}
-
-	/**
-	 * Get an attribute or metadata value
-	 *
-	 * If the name matches an attribute, the attribute is returned. If metadata
-	 * does not exist with that name, a null is returned.
-	 *
-	 * This only returns an array if there are multiple values for a particular
-	 * $name key.
-	 *
-	 * @param string $name Name of the attribute or metadata
-	 * @return mixed
-	 */
-	public function __get($name) {
-		if (array_key_exists($name, $this->attributes)) {
-			if ($name === 'subtype' && $this->attributes['guid']) {
-				_elgg_services()->logger->warn('Reading ->subtype on a persisted entity is unreliable.');
-			}
-			return $this->attributes[$name];
-		}
-
-		return $this->getMetadata($name);
-	}
-
-	/**
-	 * Get the entity's display name
-	 *
-	 * @return string The title or name of this entity.
-	 */
-	abstract public function getDisplayName();
-
-	/**
-	 * Sets the title or name of this entity.
-	 *
-	 * @param string $displayName The title or name of this entity.
-	 * @return void
-	 */
-	abstract public function setDisplayName($displayName);
-
-	/**
-	 * Return the value of a piece of metadata.
-	 *
-	 * @param string $name Name
-	 *
-	 * @return mixed The value, or null if not found.
-	 */
-	public function getMetadata($name) {
-		$guid = $this->getGUID();
-
-		if (!$guid) {
-			if (isset($this->temp_metadata[$name])) {
-				// md is returned as an array only if more than 1 entry
-				if (count($this->temp_metadata[$name]) == 1) {
-					return $this->temp_metadata[$name][0];
-				} else {
-					return $this->temp_metadata[$name];
-				}
-			} else {
-				return null;
-			}
-		}
-
-		// upon first cache miss, just load/cache all the metadata and retry.
-		// if this works, the rest of this function may not be needed!
-		$cache = _elgg_services()->metadataCache;
-		if ($cache->isLoaded($guid)) {
-			return $cache->getSingle($guid, $name);
-		} else {
-			$cache->populateFromEntities([$guid]);
-			// in case ignore_access was on, we have to check again...
-			if ($cache->isLoaded($guid)) {
-				return $cache->getSingle($guid, $name);
-			}
-		}
-
-		$md = elgg_get_metadata([
-			'guid' => $guid,
-			'metadata_name' => $name,
-			'limit' => 0,
-			'distinct' => false,
-		]);
-
-		$value = null;
-
-		if ($md && !is_array($md)) {
-			$value = $md->value;
-		} elseif (count($md) == 1) {
-			$value = $md[0]->value;
-		} else if ($md && is_array($md)) {
-			$value = metadata_array_to_values($md);
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Unset a property from metadata or attribute.
-	 *
-	 * @warning If you use this to unset an attribute, you must save the object!
-	 *
-	 * @param string $name The name of the attribute or metadata.
-	 *
-	 * @return void
-	 * @todo some attributes should be set to null or other default values
-	 */
-	public function __unset($name) {
-		if (array_key_exists($name, $this->attributes)) {
-			$this->attributes[$name] = "";
-		} else {
-			$this->deleteMetadata($name);
-		}
-	}
-
-	/**
-	 * Set metadata on this entity.
-	 *
-	 * Plugin developers usually want to use the magic set method ($entity->name = 'value').
-	 * Use this method if you want to explicitly set the owner or access of the metadata.
-	 * You cannot set the owner/access before the entity has been saved.
-	 *
-	 * @param string $name       Name of the metadata
-	 * @param mixed  $value      Value of the metadata (doesn't support assoc arrays)
-	 * @param string $value_type 'text', 'integer', or '' for automatic detection
-	 * @param bool   $multiple   Allow multiple values for a single name.
-	 *                           Does not support associative arrays.
-	 * @param int    $owner_guid GUID of entity that owns the metadata.
-	 *                           Default is owner of entity.
-	 * @param int    $access_id  Who can read the metadata relative to the owner (deprecated).
-	 *                           Default is the access level of the entity. Use ACCESS_PUBLIC for
-	 *                           compatibility with Elgg 3.0
-	 *
-	 * @return bool
-	 * @throws InvalidArgumentException
-	 */
-	public function setMetadata($name, $value, $value_type = '', $multiple = false, $owner_guid = 0, $access_id = null) {
-
-		// normalize value to an array that we will loop over
-		// remove indexes if value already an array.
-		if (is_array($value)) {
-			$value = array_values($value);
-		} else {
-			$value = [$value];
-		}
-
-		// saved entity. persist md to db.
-		if ($this->guid) {
-			// if overwriting, delete first.
-			if (!$multiple) {
-				$options = [
-					'guid' => $this->getGUID(),
-					'metadata_name' => $name,
-					'limit' => 0
-				];
-				// @todo in 1.9 make this return false if can't add metadata
-				// https://github.com/elgg/elgg/issues/4520
-				//
-				// need to remove access restrictions right now to delete
-				// because this is the expected behavior
-				$ia = elgg_set_ignore_access(true);
-				if (false === elgg_delete_metadata($options)) {
-					return false;
-				}
-				elgg_set_ignore_access($ia);
-			}
-
-			$owner_guid = $owner_guid ? (int) $owner_guid : $this->owner_guid;
-
-			if ($access_id === null) {
-				$access_id = $this->access_id;
-			} elseif ($access_id != ACCESS_PUBLIC) {
-				$access_id = (int) $access_id;
-				elgg_deprecated_notice('Setting $access_id to a value other than ACCESS_PUBLIC is deprecated. '
-					. 'All metadata will be public in 3.0.', '2.3');
-			}
-
-			// add new md
-			$result = true;
-			foreach ($value as $value_tmp) {
-				// at this point $value is appended because it was cleared above if needed.
-				$md_id = _elgg_services()->metadataTable->create($this->guid, $name, $value_tmp, $value_type,
-						$owner_guid, $access_id, true);
-				if (!$md_id) {
-					return false;
-				}
-			}
-
-			return $result;
-		} else {
-			// unsaved entity. store in temp array
-
-			// returning single entries instead of an array of 1 element is decided in
-			// getMetaData(), just like pulling from the db.
-
-			if ($owner_guid != 0 || $access_id !== null) {
-				$msg = "owner guid and access id cannot be used in \ElggEntity::setMetadata() until entity is saved.";
-				throw new \InvalidArgumentException($msg);
-			}
-
-			// if overwrite, delete first
-			if (!$multiple || !isset($this->temp_metadata[$name])) {
-				$this->temp_metadata[$name] = [];
-			}
-
-			// add new md
-			$this->temp_metadata[$name] = array_merge($this->temp_metadata[$name], $value);
-			return true;
-		}
-	}
-
-	/**
-	 * Deletes all metadata on this object (metadata.entity_guid = $this->guid).
-	 * If you pass a name, only metadata matching that name will be deleted.
-	 *
-	 * @warning Calling this with no $name will clear all metadata on the entity.
-	 *
-	 * @param null|string $name The name of the metadata to remove.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function deleteMetadata($name = null) {
-
-		if (!$this->guid) {
-			return false;
-		}
-
-		$options = [
-			'guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['metadata_name'] = $name;
-		}
-
-		return elgg_delete_metadata($options);
-	}
-
-	/**
-	 * Deletes all metadata owned by this object (metadata.owner_guid = $this->guid).
-	 * If you pass a name, only metadata matching that name will be deleted.
-	 *
-	 * @param null|string $name The name of metadata to delete.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function deleteOwnedMetadata($name = null) {
-		// access is turned off for this because they might
-		// no longer have access to an entity they created metadata on.
-		$ia = elgg_set_ignore_access(true);
-		$options = [
-			'metadata_owner_guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['metadata_name'] = $name;
-		}
-
-		$r = elgg_delete_metadata($options);
-		elgg_set_ignore_access($ia);
-		return $r;
-	}
-
-	/**
-	 * Disables metadata for this entity, optionally based on name.
-	 *
-	 * @param string $name An options name of metadata to disable.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function disableMetadata($name = '') {
-		$options = [
-			'guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['metadata_name'] = $name;
-		}
-
-		return elgg_disable_metadata($options);
-	}
-
-	/**
-	 * Enables metadata for this entity, optionally based on name.
-	 *
-	 * @warning Before calling this, you must use {@link access_show_hidden_entities()}
-	 *
-	 * @param string $name An options name of metadata to enable.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function enableMetadata($name = '') {
-		$options = [
-			'guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['metadata_name'] = $name;
-		}
-
-		return elgg_enable_metadata($options);
-	}
-
-	/**
-	 * Get a piece of volatile (non-persisted) data on this entity.
-	 *
-	 * @param string $name The name of the volatile data
-	 *
-	 * @return mixed The value or null if not found.
-	 */
-	public function getVolatileData($name) {
-		return array_key_exists($name, $this->volatile) ? $this->volatile[$name] : null;
-	}
-
-	/**
-	 * Set a piece of volatile (non-persisted) data on this entity
-	 *
-	 * @param string $name  Name
-	 * @param mixed  $value Value
-	 *
-	 * @return void
-	 */
-	public function setVolatileData($name, $value) {
-		$this->volatile[$name] = $value;
-	}
-
-	/**
-	 * Cache the entity in a persisted cache
-	 *
-	 * @param ElggSharedMemoryCache $cache       Memcache or null cache
-	 * @param int                   $last_action Last action time
-	 *
-	 * @return void
-	 * @access private
-	 * @internal
-	 */
-	public function storeInPersistedCache(\ElggSharedMemoryCache $cache, $last_action = 0) {
-		$tmp = $this->volatile;
-
-		// don't store volatile data
-		$this->volatile = [];
-		if ($last_action) {
-			$this->attributes['last_action'] = (int) $last_action;
-		}
-		$cache->save($this->guid, $this);
-
-		$this->volatile = $tmp;
-	}
-
-	/**
-	 * Remove all relationships to and from this entity.
-	 * If you pass a relationship name, only relationships matching that name
-	 * will be deleted.
-	 *
-	 * @warning Calling this with no $relationship will clear all relationships
-	 * for this entity.
-	 *
-	 * @param null|string $relationship The name of the relationship to remove.
-	 * @return bool
-	 * @see \ElggEntity::addRelationship()
-	 * @see \ElggEntity::removeRelationship()
-	 */
-	public function deleteRelationships($relationship = null) {
-		$relationship = (string) $relationship;
-		$result = remove_entity_relationships($this->getGUID(), $relationship);
-		return $result && remove_entity_relationships($this->getGUID(), $relationship, true);
-	}
-
-	/**
-	 * Add a relationship between this an another entity.
-	 *
-	 * @tip Read the relationship like "This entity is a $relationship of $guid_two."
-	 *
-	 * @param int    $guid_two     GUID of the target entity of the relationship.
-	 * @param string $relationship The type of relationship.
-	 *
-	 * @return bool
-	 * @see \ElggEntity::removeRelationship()
-	 * @see \ElggEntity::deleteRelationships()
-	 */
-	public function addRelationship($guid_two, $relationship) {
-		return add_entity_relationship($this->getGUID(), $relationship, $guid_two);
-	}
-
-	/**
-	 * Remove a relationship
-	 *
-	 * @param int    $guid_two     GUID of the target entity of the relationship.
-	 * @param string $relationship The type of relationship.
-	 *
-	 * @return bool
-	 * @see \ElggEntity::addRelationship()
-	 * @see \ElggEntity::deleteRelationships()
-	 */
-	public function removeRelationship($guid_two, $relationship) {
-		return remove_entity_relationship($this->getGUID(), $relationship, $guid_two);
-	}
-
-	/**
-	 * Adds a private setting to this entity.
-	 *
-	 * Private settings are similar to metadata but will not
-	 * be searched and there are fewer helper functions for them.
-	 *
-	 * @param string $name  Name of private setting
-	 * @param mixed  $value Value of private setting
-	 *
-	 * @return bool
-	 */
-	public function setPrivateSetting($name, $value) {
-		if ((int) $this->guid > 0) {
-			return set_private_setting($this->getGUID(), $name, $value);
-		} else {
-			$this->temp_private_settings[$name] = $value;
-			return true;
-		}
-	}
-
-	/**
-	 * Returns a private setting value
-	 *
-	 * @param string $name Name of the private setting
-	 *
-	 * @return mixed Null if the setting does not exist
-	 */
-	public function getPrivateSetting($name) {
-		if ((int) ($this->guid) > 0) {
-			return get_private_setting($this->getGUID(), $name);
-		} else {
-			if (isset($this->temp_private_settings[$name])) {
-				return $this->temp_private_settings[$name];
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * Removes private setting
-	 *
-	 * @param string $name Name of the private setting
-	 *
-	 * @return bool
-	 */
-	public function removePrivateSetting($name) {
-		return remove_private_setting($this->getGUID(), $name);
-	}
-
-	/**
-	 * Deletes all annotations on this object (annotations.entity_guid = $this->guid).
-	 * If you pass a name, only annotations matching that name will be deleted.
-	 *
-	 * @warning Calling this with no or empty arguments will clear all annotations on the entity.
-	 *
-	 * @param null|string $name The annotations name to remove.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function deleteAnnotations($name = null) {
-		$options = [
-			'guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['annotation_name'] = $name;
-		}
-
-		return elgg_delete_annotations($options);
-	}
-
-	/**
-	 * Deletes all annotations owned by this object (annotations.owner_guid = $this->guid).
-	 * If you pass a name, only annotations matching that name will be deleted.
-	 *
-	 * @param null|string $name The name of annotations to delete.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function deleteOwnedAnnotations($name = null) {
-		// access is turned off for this because they might
-		// no longer have access to an entity they created annotations on.
-		$ia = elgg_set_ignore_access(true);
-		$options = [
-			'annotation_owner_guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['annotation_name'] = $name;
-		}
-
-		$r = elgg_delete_annotations($options);
-		elgg_set_ignore_access($ia);
-		return $r;
-	}
-
-	/**
-	 * Disables annotations for this entity, optionally based on name.
-	 *
-	 * @param string $name An options name of annotations to disable.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function disableAnnotations($name = '') {
-		$options = [
-			'guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['annotation_name'] = $name;
-		}
-
-		return elgg_disable_annotations($options);
-	}
-
-	/**
-	 * Enables annotations for this entity, optionally based on name.
-	 *
-	 * @warning Before calling this, you must use {@link access_show_hidden_entities()}
-	 *
-	 * @param string $name An options name of annotations to enable.
-	 * @return bool
-	 * @since 1.8
-	 */
-	public function enableAnnotations($name = '') {
-		$options = [
-			'guid' => $this->guid,
-			'limit' => 0
-		];
-		if ($name) {
-			$options['annotation_name'] = $name;
-		}
-
-		return elgg_enable_annotations($options);
-	}
-
-	/**
-	 * Helper function to return annotation calculation results
-	 *
-	 * @param string $name        The annotation name.
-	 * @param string $calculation A valid MySQL function to run its values through
-	 * @return mixed
-	 */
-	private function getAnnotationCalculation($name, $calculation) {
-		$options = [
-			'guid' => $this->getGUID(),
-			'distinct' => false,
-			'annotation_name' => $name,
-			'annotation_calculation' => $calculation
-		];
-
-		return elgg_get_annotations($options);
-	}
-
-	/**
-	 * Adds an annotation to an entity.
-	 *
-	 * @warning By default, annotations are private.
-	 *
-	 * @warning Annotating an unsaved entity more than once with the same name
-	 *          will only save the last annotation.
-	 *
-	 * @param string $name       Annotation name
-	 * @param mixed  $value      Annotation value
-	 * @param int    $access_id  Access ID
-	 * @param int    $owner_guid GUID of the annotation owner
-	 * @param string $vartype    The type of annotation value
-	 *
-	 * @return bool|int Returns int if an annotation is saved
-	 */
-	public function annotate($name, $value, $access_id = ACCESS_PRIVATE, $owner_guid = 0, $vartype = "") {
-		if ((int) $this->guid > 0) {
-			return create_annotation($this->getGUID(), $name, $value, $vartype, $owner_guid, $access_id);
-		} else {
-			$this->temp_annotations[$name] = $value;
-		}
-		return true;
-	}
-
-	/**
-	 * Gets an array of annotations.
-	 *
-	 * To retrieve annotations on an unsaved entity, pass array('name' => [annotation name])
-	 * as the options array.
-	 *
-	 * @param array $options Array of options for elgg_get_annotations() except guid.
-	 *
-	 * @return array
-	 * @see elgg_get_annotations()
-	 */
-	public function getAnnotations(array $options = []) {
-		if ($this->guid) {
-			$options['guid'] = $this->guid;
-
-			return elgg_get_annotations($options);
-		} else {
-			$name = elgg_extract('annotation_name', $options, '');
-
-			if (isset($this->temp_annotations[$name])) {
-				return [$this->temp_annotations[$name]];
-			}
-		}
-
-		return [];
-	}
-
-	/**
-	 * Count annotations.
-	 *
-	 * @param string $name The type of annotation.
-	 *
-	 * @return int
-	 */
-	public function countAnnotations($name = "") {
-		return $this->getAnnotationCalculation($name, 'count');
-	}
-
-	/**
-	 * Get the average of an integer type annotation.
-	 *
-	 * @param string $name Annotation name
-	 *
-	 * @return int
-	 */
-	public function getAnnotationsAvg($name) {
-		return $this->getAnnotationCalculation($name, 'avg');
-	}
-
-	/**
-	 * Get the sum of integer type annotations of a given name.
-	 *
-	 * @param string $name Annotation name
-	 *
-	 * @return int
-	 */
-	public function getAnnotationsSum($name) {
-		return $this->getAnnotationCalculation($name, 'sum');
-	}
-
-	/**
-	 * Get the minimum of integer type annotations of given name.
-	 *
-	 * @param string $name Annotation name
-	 *
-	 * @return int
-	 */
-	public function getAnnotationsMin($name) {
-		return $this->getAnnotationCalculation($name, 'min');
-	}
-
-	/**
-	 * Get the maximum of integer type annotations of a given name.
-	 *
-	 * @param string $name Annotation name
-	 *
-	 * @return int
-	 */
-	public function getAnnotationsMax($name) {
-		return $this->getAnnotationCalculation($name, 'max');
-	}
-
-	/**
-	 * Count the number of comments attached to this entity.
-	 *
-	 * @return int Number of comments
-	 * @since 1.8.0
-	 */
-	public function countComments() {
-		$params = ['entity' => $this];
-		$num = _elgg_services()->hooks->trigger('comments:count', $this->getType(), $params);
-
-		if (is_int($num)) {
-			return $num;
-		} else {
-			return elgg_get_entities([
-				'type' => 'object',
-				'subtype' => 'comment',
-				'container_guid' => $this->getGUID(),
-				'count' => true,
-				'distinct' => false,
-			]);
-		}
-	}
-
-	/**
-	 * Gets an array of entities with a relationship to this entity.
-	 *
-	 * @param array $options Options array. See elgg_get_entities_from_relationship()
-	 *                       for a list of options. 'relationship_guid' is set to
-	 *                       this entity.
-	 *
-	 * @return array|false An array of entities or false on failure
-	 * @see elgg_get_entities_from_relationship()
-	 */
-	public function getEntitiesFromRelationship(array $options = []) {
-		$options['relationship_guid'] = $this->guid;
-		return elgg_get_entities_from_relationship($options);
-	}
-
-	/**
-	 * Gets the number of entities from a specific relationship type
-	 *
-	 * @param string $relationship         Relationship type (eg "friends")
-	 * @param bool   $inverse_relationship Invert relationship
-	 *
-	 * @return int|false The number of entities or false on failure
-	 */
-	public function countEntitiesFromRelationship($relationship, $inverse_relationship = false) {
-		return elgg_get_entities_from_relationship([
-			'relationship' => $relationship,
-			'relationship_guid' => $this->getGUID(),
-			'inverse_relationship' => $inverse_relationship,
-			'count' => true
-		]);
-	}
-
-	/**
-	 * Can a user edit this entity?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check plugin hook.
-	 *
-	 * @param int $user_guid The user GUID, optionally (default: logged in user)
-	 *
-	 * @return bool Whether this entity is editable by the given user.
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canEdit($user_guid = 0) {
-		return _elgg_services()->userCapabilities->canEdit($this, $user_guid);
-	}
-
-	/**
-	 * Can a user delete this entity?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check:delete plugin hook.
-	 *
-	 * @param int $user_guid The user GUID, optionally (default: logged in user)
-	 *
-	 * @return bool Whether this entity is deletable by the given user.
-	 * @since 1.11
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canDelete($user_guid = 0) {
-		return _elgg_services()->userCapabilities->canDelete($this, $user_guid);
-	}
-
-	/**
-	 * Can a user edit metadata on this entity?
-	 *
-	 * If no specific metadata is passed, it returns whether the user can
-	 * edit any metadata on the entity.
-	 *
-	 * @tip Can be overridden by by registering for the permissions_check:metadata
-	 * plugin hook.
-	 *
-	 * @param \ElggMetadata $metadata  The piece of metadata to specifically check or null for any metadata
-	 * @param int           $user_guid The user GUID, optionally (default: logged in user)
-	 *
-	 * @return bool
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canEditMetadata($metadata = null, $user_guid = 0) {
-		return _elgg_services()->userCapabilities->canEditMetadata($this, $user_guid, $metadata);
-	}
-
-	/**
-	 * Can a user add an entity to this container
-	 *
-	 * @param int    $user_guid The GUID of the user creating the entity (0 for logged in user).
-	 * @param string $type      The type of entity we're looking to write
-	 * @param string $subtype   The subtype of the entity we're looking to write
-	 *
-	 * @return bool
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canWriteToContainer($user_guid = 0, $type = 'all', $subtype = 'all') {
-		return _elgg_services()->userCapabilities->canWriteToContainer($this, $user_guid, $type, $subtype);
-	}
-
-	/**
-	 * Can a user comment on an entity?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check:comment,
-	 * <entity type> plugin hook.
-	 *
-	 * @param int  $user_guid User guid (default is logged in user)
-	 * @param bool $default   Default permission
-	 * @return bool
-	 */
-	public function canComment($user_guid = 0, $default = null) {
-		return _elgg_services()->userCapabilities->canComment($this, $user_guid, $default);
-	}
-
-	/**
-	 * Can a user annotate an entity?
-	 *
-	 * @tip Can be overridden by registering for the plugin hook [permissions_check:annotate:<name>,
-	 * <entity type>] or [permissions_check:annotate, <entity type>]. The hooks are called in that order.
-	 *
-	 * @tip If you want logged out users to annotate an object, do not call
-	 * canAnnotate(). It's easier than using the plugin hook.
-	 *
-	 * @param int    $user_guid       User guid (default is logged in user)
-	 * @param string $annotation_name The name of the annotation (default is unspecified)
-	 *
-	 * @return bool
-	 */
-	public function canAnnotate($user_guid = 0, $annotation_name = '') {
-		return _elgg_services()->userCapabilities->canAnnotate($this, $user_guid, $annotation_name);
-	}
-
-	/**
-	 * Returns the access_id.
-	 *
-	 * @return int The access ID
-	 */
-	public function getAccessID() {
-		return $this->access_id;
-	}
-
-	/**
-	 * Returns the guid.
-	 *
-	 * @return int|null GUID
-	 */
-	public function getGUID() {
-		return $this->guid;
-	}
-
-	/**
-	 * Returns the entity type
-	 *
-	 * @return string The entity type
-	 */
-	public function getType() {
-		return $this->type;
-	}
-
-	/**
-	 * Get the entity subtype
-	 *
-	 * @return string The entity subtype
-	 */
-	public function getSubtype() {
-		// If this object hasn't been saved, then return the subtype string.
-		if ($this->attributes['guid']) {
-			return get_subtype_from_id($this->attributes['subtype']);
-		}
-		return $this->attributes['subtype'];
-	}
-
-	/**
-	 * Get the guid of the entity's owner.
-	 *
-	 * @return int The owner GUID
-	 */
-	public function getOwnerGUID() {
-		return (int) $this->owner_guid;
-	}
-
-	/**
-	 * Gets the \ElggEntity that owns this entity.
-	 *
-	 * @return \ElggEntity The owning entity
-	 */
-	public function getOwnerEntity() {
-		return get_entity($this->owner_guid);
-	}
-
-	/**
-	 * Set the container for this object.
-	 *
-	 * @param int $container_guid The ID of the container.
-	 *
-	 * @return bool
-	 */
-	public function setContainerGUID($container_guid) {
-		return $this->container_guid = (int) $container_guid;
-	}
-
-	/**
-	 * Gets the container GUID for this entity.
-	 *
-	 * @return int
-	 */
-	public function getContainerGUID() {
-		return (int) $this->container_guid;
-	}
-
-	/**
-	 * Get the container entity for this object.
-	 *
-	 * @return \ElggEntity
-	 * @since 1.8.0
-	 */
-	public function getContainerEntity() {
-		return get_entity($this->getContainerGUID());
-	}
-
-	/**
-	 * Returns the UNIX epoch time that this entity was last updated
-	 *
-	 * @return int UNIX epoch time
-	 */
-	public function getTimeUpdated() {
-		return $this->time_updated;
-	}
-
-	/**
-	 * Gets the URL for this entity.
-	 *
-	 * Plugins can register for the 'entity:url', <type> plugin hook to
-	 * customize the url for an entity.
-	 *
-	 * @return string The URL of the entity
-	 */
-	public function getURL() {
-		$url = _elgg_services()->hooks->trigger('entity:url', $this->getType(), ['entity' => $this]);
+    /**
+     * Initialize the attributes array.
+     *
+     * This is vital to distinguish between metadata and base parameters.
+     *
+     * @return void
+     */
+    protected function initializeAttributes() {
+        parent::initializeAttributes();
+
+        $this->attributes['guid'] = null;
+        $this->attributes['type'] = null;
+        $this->attributes['subtype'] = null;
+
+        $this->attributes['owner_guid'] = _elgg_services()->session->getLoggedInUserGuid();
+        $this->attributes['container_guid'] = _elgg_services()->session->getLoggedInUserGuid();
+
+        $this->attributes['access_id'] = ACCESS_PRIVATE;
+        $this->attributes['time_updated'] = null;
+        $this->attributes['last_action'] = null;
+        $this->attributes['enabled'] = "yes";
+    }
+
+    /**
+     * Clone an entity
+     *
+     * Resets the guid so that the entity can be saved as a distinct entity from
+     * the original. Creation time will be set when this new entity is saved.
+     * The owner and container guids come from the original entity. The clone
+     * method copies metadata but does not copy annotations or private settings.
+     *
+     * @note metadata will have its owner and access id set when the entity is saved
+     * and it will be the same as that of the entity.
+     *
+     * @return void
+     */
+    public function __clone() {
+        $orig_entity = get_entity($this->guid);
+        if (!$orig_entity) {
+            _elgg_services()->logger->error("Failed to clone entity with GUID $this->guid");
+            return;
+        }
+
+        $metadata_array = elgg_get_metadata([
+            'guid' => $this->guid,
+            'limit' => 0
+        ]);
+
+        $this->attributes['guid'] = "";
+
+        $this->attributes['subtype'] = $orig_entity->getSubtype();
+
+        // copy metadata over to new entity - slightly convoluted due to
+        // handling of metadata arrays
+        if (is_array($metadata_array)) {
+            // create list of metadata names
+            $metadata_names = [];
+            foreach ($metadata_array as $metadata) {
+                $metadata_names[] = $metadata['name'];
+            }
+            // arrays are stored with multiple enties per name
+            $metadata_names = array_unique($metadata_names);
+
+            // move the metadata over
+            foreach ($metadata_names as $name) {
+                $this->__set($name, $orig_entity->$name);
+            }
+        }
+    }
+
+    /**
+     * Set an attribute or metadata value for this entity
+     *
+     * Anything that is not an attribute is saved as metadata.
+     *
+     * @warning Metadata set this way will inherit the entity's owner and
+     * access ID. If you want more control over metadata, use \ElggEntity::setMetadata()
+     *
+     * @param string $name  Name of the attribute or metadata
+     * @param mixed  $value The value to be set
+     * @return void
+     * @see \ElggEntity::setMetadata()
+     */
+    public function __set($name, $value) {
+        if ($this->$name === $value) {
+            // quick return if value is not changing
+            return;
+        }
+
+        if (array_key_exists($name, $this->attributes)) {
+            // if an attribute is 1 (integer) and it's set to "1" (string), don't consider that a change.
+            if (is_int($this->attributes[$name])
+                    && is_string($value)
+                    && ((string) $this->attributes[$name] === $value)) {
+                return;
+            }
+
+            // Due to https://github.com/Elgg/Elgg/pull/5456#issuecomment-17785173, certain attributes
+            // will store empty strings as null in the DB. In the somewhat common case that we're re-setting
+            // the value to empty string, don't consider this a change.
+            if (in_array($name, ['title', 'name', 'description'])
+                    && $this->attributes[$name] === null
+                    && $value === "") {
+                return;
+            }
+
+            // keep original values
+            if ($this->guid && !array_key_exists($name, $this->orig_attributes)) {
+                $this->orig_attributes[$name] = $this->attributes[$name];
+            }
+
+            // Certain properties should not be manually changed!
+            switch ($name) {
+                case 'guid':
+                case 'time_updated':
+                case 'last_action':
+                    return;
+                    break;
+                case 'access_id':
+                case 'owner_guid':
+                case 'container_guid':
+                    if ($value !== null) {
+                        $this->attributes[$name] = (int) $value;
+                    } else {
+                        $this->attributes[$name] = null;
+                    }
+                    break;
+                default:
+                    $this->attributes[$name] = $value;
+                    break;
+            }
+            return;
+        }
+
+        $this->setMetadata($name, $value);
+    }
+
+    /**
+     * Get the original values of attribute(s) that have been modified since the entity was persisted.
+     *
+     * @return array
+     */
+    public function getOriginalAttributes() {
+        return $this->orig_attributes;
+    }
+
+    /**
+     * Get an attribute or metadata value
+     *
+     * If the name matches an attribute, the attribute is returned. If metadata
+     * does not exist with that name, a null is returned.
+     *
+     * This only returns an array if there are multiple values for a particular
+     * $name key.
+     *
+     * @param string $name Name of the attribute or metadata
+     * @return mixed
+     */
+    public function __get($name) {
+        if (array_key_exists($name, $this->attributes)) {
+            if ($name === 'subtype' && $this->attributes['guid']) {
+                _elgg_services()->logger->warn('Reading ->subtype on a persisted entity is unreliable.');
+            }
+            return $this->attributes[$name];
+        }
+
+        return $this->getMetadata($name);
+    }
+
+    /**
+     * Get the entity's display name
+     *
+     * @return string The title or name of this entity.
+     */
+    abstract public function getDisplayName();
+
+    /**
+     * Sets the title or name of this entity.
+     *
+     * @param string $displayName The title or name of this entity.
+     * @return void
+     */
+    abstract public function setDisplayName($displayName);
+
+    /**
+     * Return the value of a piece of metadata.
+     *
+     * @param string $name Name
+     *
+     * @return mixed The value, or null if not found.
+     */
+    public function getMetadata($name) {
+        $guid = $this->getGUID();
+
+        if (!$guid) {
+            if (isset($this->temp_metadata[$name])) {
+                // md is returned as an array only if more than 1 entry
+                if (count($this->temp_metadata[$name]) == 1) {
+                    return $this->temp_metadata[$name][0];
+                } else {
+                    return $this->temp_metadata[$name];
+                }
+            } else {
+                return null;
+            }
+        }
+
+        // upon first cache miss, just load/cache all the metadata and retry.
+        // if this works, the rest of this function may not be needed!
+        $cache = _elgg_services()->metadataCache;
+        if ($cache->isLoaded($guid)) {
+            return $cache->getSingle($guid, $name);
+        } else {
+            $cache->populateFromEntities([$guid]);
+            // in case ignore_access was on, we have to check again...
+            if ($cache->isLoaded($guid)) {
+                return $cache->getSingle($guid, $name);
+            }
+        }
+
+        $md = elgg_get_metadata([
+            'guid' => $guid,
+            'metadata_name' => $name,
+            'limit' => 0,
+            'distinct' => false,
+        ]);
+
+        $value = null;
+
+        if ($md && !is_array($md)) {
+            $value = $md->value;
+        } elseif (count($md) == 1) {
+            $value = $md[0]->value;
+        } else if ($md && is_array($md)) {
+            $value = metadata_array_to_values($md);
+        }
+
+        return $value;
+    }
+
+    /**
+     * Unset a property from metadata or attribute.
+     *
+     * @warning If you use this to unset an attribute, you must save the object!
+     *
+     * @param string $name The name of the attribute or metadata.
+     *
+     * @return void
+     * @todo some attributes should be set to null or other default values
+     */
+    public function __unset($name) {
+        if (array_key_exists($name, $this->attributes)) {
+            $this->attributes[$name] = "";
+        } else {
+            $this->deleteMetadata($name);
+        }
+    }
+
+    /**
+     * Set metadata on this entity.
+     *
+     * Plugin developers usually want to use the magic set method ($entity->name = 'value').
+     * Use this method if you want to explicitly set the owner or access of the metadata.
+     * You cannot set the owner/access before the entity has been saved.
+     *
+     * @param string $name       Name of the metadata
+     * @param mixed  $value      Value of the metadata (doesn't support assoc arrays)
+     * @param string $value_type 'text', 'integer', or '' for automatic detection
+     * @param bool   $multiple   Allow multiple values for a single name.
+     *                           Does not support associative arrays.
+     * @param int    $owner_guid GUID of entity that owns the metadata.
+     *                           Default is owner of entity.
+     * @param int    $access_id  Who can read the metadata relative to the owner (deprecated).
+     *                           Default is the access level of the entity. Use ACCESS_PUBLIC for
+     *                           compatibility with Elgg 3.0
+     *
+     * @return bool
+     * @throws InvalidArgumentException
+     */
+    public function setMetadata($name, $value, $value_type = '', $multiple = false, $owner_guid = 0, $access_id = null) {
+
+        // normalize value to an array that we will loop over
+        // remove indexes if value already an array.
+        if (is_array($value)) {
+            $value = array_values($value);
+        } else {
+            $value = [$value];
+        }
+
+        // saved entity. persist md to db.
+        if ($this->guid) {
+            // if overwriting, delete first.
+            if (!$multiple) {
+                $options = [
+                    'guid' => $this->getGUID(),
+                    'metadata_name' => $name,
+                    'limit' => 0
+                ];
+                // @todo in 1.9 make this return false if can't add metadata
+                // https://github.com/elgg/elgg/issues/4520
+                //
+                // need to remove access restrictions right now to delete
+                // because this is the expected behavior
+                $ia = elgg_set_ignore_access(true);
+                if (false === elgg_delete_metadata($options)) {
+                    return false;
+                }
+                elgg_set_ignore_access($ia);
+            }
+
+            $owner_guid = $owner_guid ? (int) $owner_guid : $this->owner_guid;
+
+            if ($access_id === null) {
+                $access_id = $this->access_id;
+            } elseif ($access_id != ACCESS_PUBLIC) {
+                $access_id = (int) $access_id;
+                elgg_deprecated_notice('Setting $access_id to a value other than ACCESS_PUBLIC is deprecated. '
+                    . 'All metadata will be public in 3.0.', '2.3');
+            }
+
+            // add new md
+            $result = true;
+            foreach ($value as $value_tmp) {
+                // at this point $value is appended because it was cleared above if needed.
+                $md_id = _elgg_services()->metadataTable->create($this->guid, $name, $value_tmp, $value_type,
+                        $owner_guid, $access_id, true);
+                if (!$md_id) {
+                    return false;
+                }
+            }
+
+            return $result;
+        } else {
+            // unsaved entity. store in temp array
+
+            // returning single entries instead of an array of 1 element is decided in
+            // getMetaData(), just like pulling from the db.
+
+            if ($owner_guid != 0 || $access_id !== null) {
+                $msg = "owner guid and access id cannot be used in \ElggEntity::setMetadata() until entity is saved.";
+                throw new \InvalidArgumentException($msg);
+            }
+
+            // if overwrite, delete first
+            if (!$multiple || !isset($this->temp_metadata[$name])) {
+                $this->temp_metadata[$name] = [];
+            }
+
+            // add new md
+            $this->temp_metadata[$name] = array_merge($this->temp_metadata[$name], $value);
+            return true;
+        }
+    }
+
+    /**
+     * Deletes all metadata on this object (metadata.entity_guid = $this->guid).
+     * If you pass a name, only metadata matching that name will be deleted.
+     *
+     * @warning Calling this with no $name will clear all metadata on the entity.
+     *
+     * @param null|string $name The name of the metadata to remove.
+     * @return bool
+     * @since 1.8
+     */
+    public function deleteMetadata($name = null) {
+
+        if (!$this->guid) {
+            return false;
+        }
+
+        $options = [
+            'guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['metadata_name'] = $name;
+        }
+
+        return elgg_delete_metadata($options);
+    }
+
+    /**
+     * Deletes all metadata owned by this object (metadata.owner_guid = $this->guid).
+     * If you pass a name, only metadata matching that name will be deleted.
+     *
+     * @param null|string $name The name of metadata to delete.
+     * @return bool
+     * @since 1.8
+     */
+    public function deleteOwnedMetadata($name = null) {
+        // access is turned off for this because they might
+        // no longer have access to an entity they created metadata on.
+        $ia = elgg_set_ignore_access(true);
+        $options = [
+            'metadata_owner_guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['metadata_name'] = $name;
+        }
+
+        $r = elgg_delete_metadata($options);
+        elgg_set_ignore_access($ia);
+        return $r;
+    }
+
+    /**
+     * Disables metadata for this entity, optionally based on name.
+     *
+     * @param string $name An options name of metadata to disable.
+     * @return bool
+     * @since 1.8
+     */
+    public function disableMetadata($name = '') {
+        $options = [
+            'guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['metadata_name'] = $name;
+        }
+
+        return elgg_disable_metadata($options);
+    }
+
+    /**
+     * Enables metadata for this entity, optionally based on name.
+     *
+     * @warning Before calling this, you must use {@link access_show_hidden_entities()}
+     *
+     * @param string $name An options name of metadata to enable.
+     * @return bool
+     * @since 1.8
+     */
+    public function enableMetadata($name = '') {
+        $options = [
+            'guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['metadata_name'] = $name;
+        }
+
+        return elgg_enable_metadata($options);
+    }
+
+    /**
+     * Get a piece of volatile (non-persisted) data on this entity.
+     *
+     * @param string $name The name of the volatile data
+     *
+     * @return mixed The value or null if not found.
+     */
+    public function getVolatileData($name) {
+        return array_key_exists($name, $this->volatile) ? $this->volatile[$name] : null;
+    }
+
+    /**
+     * Set a piece of volatile (non-persisted) data on this entity
+     *
+     * @param string $name  Name
+     * @param mixed  $value Value
+     *
+     * @return void
+     */
+    public function setVolatileData($name, $value) {
+        $this->volatile[$name] = $value;
+    }
+
+    /**
+     * Cache the entity in a persisted cache
+     *
+     * @param ElggSharedMemoryCache $cache       Memcache or null cache
+     * @param int                   $last_action Last action time
+     *
+     * @return void
+     * @access private
+     * @internal
+     */
+    public function storeInPersistedCache(\ElggSharedMemoryCache $cache, $last_action = 0) {
+        $tmp = $this->volatile;
+
+        // don't store volatile data
+        $this->volatile = [];
+        if ($last_action) {
+            $this->attributes['last_action'] = (int) $last_action;
+        }
+        $cache->save($this->guid, $this);
+
+        $this->volatile = $tmp;
+    }
+
+    /**
+     * Remove all relationships to and from this entity.
+     * If you pass a relationship name, only relationships matching that name
+     * will be deleted.
+     *
+     * @warning Calling this with no $relationship will clear all relationships
+     * for this entity.
+     *
+     * @param null|string $relationship The name of the relationship to remove.
+     * @return bool
+     * @see \ElggEntity::addRelationship()
+     * @see \ElggEntity::removeRelationship()
+     */
+    public function deleteRelationships($relationship = null) {
+        $relationship = (string) $relationship;
+        $result = remove_entity_relationships($this->getGUID(), $relationship);
+        return $result && remove_entity_relationships($this->getGUID(), $relationship, true);
+    }
+
+    /**
+     * Add a relationship between this an another entity.
+     *
+     * @tip Read the relationship like "This entity is a $relationship of $guid_two."
+     *
+     * @param int    $guid_two     GUID of the target entity of the relationship.
+     * @param string $relationship The type of relationship.
+     *
+     * @return bool
+     * @see \ElggEntity::removeRelationship()
+     * @see \ElggEntity::deleteRelationships()
+     */
+    public function addRelationship($guid_two, $relationship) {
+        return add_entity_relationship($this->getGUID(), $relationship, $guid_two);
+    }
+
+    /**
+     * Remove a relationship
+     *
+     * @param int    $guid_two     GUID of the target entity of the relationship.
+     * @param string $relationship The type of relationship.
+     *
+     * @return bool
+     * @see \ElggEntity::addRelationship()
+     * @see \ElggEntity::deleteRelationships()
+     */
+    public function removeRelationship($guid_two, $relationship) {
+        return remove_entity_relationship($this->getGUID(), $relationship, $guid_two);
+    }
+
+    /**
+     * Adds a private setting to this entity.
+     *
+     * Private settings are similar to metadata but will not
+     * be searched and there are fewer helper functions for them.
+     *
+     * @param string $name  Name of private setting
+     * @param mixed  $value Value of private setting
+     *
+     * @return bool
+     */
+    public function setPrivateSetting($name, $value) {
+        if ((int) $this->guid > 0) {
+            return set_private_setting($this->getGUID(), $name, $value);
+        } else {
+            $this->temp_private_settings[$name] = $value;
+            return true;
+        }
+    }
+
+    /**
+     * Returns a private setting value
+     *
+     * @param string $name Name of the private setting
+     *
+     * @return mixed Null if the setting does not exist
+     */
+    public function getPrivateSetting($name) {
+        if ((int) ($this->guid) > 0) {
+            return get_private_setting($this->getGUID(), $name);
+        } else {
+            if (isset($this->temp_private_settings[$name])) {
+                return $this->temp_private_settings[$name];
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Removes private setting
+     *
+     * @param string $name Name of the private setting
+     *
+     * @return bool
+     */
+    public function removePrivateSetting($name) {
+        return remove_private_setting($this->getGUID(), $name);
+    }
+
+    /**
+     * Deletes all annotations on this object (annotations.entity_guid = $this->guid).
+     * If you pass a name, only annotations matching that name will be deleted.
+     *
+     * @warning Calling this with no or empty arguments will clear all annotations on the entity.
+     *
+     * @param null|string $name The annotations name to remove.
+     * @return bool
+     * @since 1.8
+     */
+    public function deleteAnnotations($name = null) {
+        $options = [
+            'guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['annotation_name'] = $name;
+        }
+
+        return elgg_delete_annotations($options);
+    }
+
+    /**
+     * Deletes all annotations owned by this object (annotations.owner_guid = $this->guid).
+     * If you pass a name, only annotations matching that name will be deleted.
+     *
+     * @param null|string $name The name of annotations to delete.
+     * @return bool
+     * @since 1.8
+     */
+    public function deleteOwnedAnnotations($name = null) {
+        // access is turned off for this because they might
+        // no longer have access to an entity they created annotations on.
+        $ia = elgg_set_ignore_access(true);
+        $options = [
+            'annotation_owner_guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['annotation_name'] = $name;
+        }
+
+        $r = elgg_delete_annotations($options);
+        elgg_set_ignore_access($ia);
+        return $r;
+    }
+
+    /**
+     * Disables annotations for this entity, optionally based on name.
+     *
+     * @param string $name An options name of annotations to disable.
+     * @return bool
+     * @since 1.8
+     */
+    public function disableAnnotations($name = '') {
+        $options = [
+            'guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['annotation_name'] = $name;
+        }
+
+        return elgg_disable_annotations($options);
+    }
+
+    /**
+     * Enables annotations for this entity, optionally based on name.
+     *
+     * @warning Before calling this, you must use {@link access_show_hidden_entities()}
+     *
+     * @param string $name An options name of annotations to enable.
+     * @return bool
+     * @since 1.8
+     */
+    public function enableAnnotations($name = '') {
+        $options = [
+            'guid' => $this->guid,
+            'limit' => 0
+        ];
+        if ($name) {
+            $options['annotation_name'] = $name;
+        }
+
+        return elgg_enable_annotations($options);
+    }
+
+    /**
+     * Helper function to return annotation calculation results
+     *
+     * @param string $name        The annotation name.
+     * @param string $calculation A valid MySQL function to run its values through
+     * @return mixed
+     */
+    private function getAnnotationCalculation($name, $calculation) {
+        $options = [
+            'guid' => $this->getGUID(),
+            'distinct' => false,
+            'annotation_name' => $name,
+            'annotation_calculation' => $calculation
+        ];
+
+        return elgg_get_annotations($options);
+    }
+
+    /**
+     * Adds an annotation to an entity.
+     *
+     * @warning By default, annotations are private.
+     *
+     * @warning Annotating an unsaved entity more than once with the same name
+     *          will only save the last annotation.
+     *
+     * @param string $name       Annotation name
+     * @param mixed  $value      Annotation value
+     * @param int    $access_id  Access ID
+     * @param int    $owner_guid GUID of the annotation owner
+     * @param string $vartype    The type of annotation value
+     *
+     * @return bool|int Returns int if an annotation is saved
+     */
+    public function annotate($name, $value, $access_id = ACCESS_PRIVATE, $owner_guid = 0, $vartype = "") {
+        if ((int) $this->guid > 0) {
+            return create_annotation($this->getGUID(), $name, $value, $vartype, $owner_guid, $access_id);
+        } else {
+            $this->temp_annotations[$name] = $value;
+        }
+        return true;
+    }
+
+    /**
+     * Gets an array of annotations.
+     *
+     * To retrieve annotations on an unsaved entity, pass array('name' => [annotation name])
+     * as the options array.
+     *
+     * @param array $options Array of options for elgg_get_annotations() except guid.
+     *
+     * @return array
+     * @see elgg_get_annotations()
+     */
+    public function getAnnotations(array $options = []) {
+        if ($this->guid) {
+            $options['guid'] = $this->guid;
+
+            return elgg_get_annotations($options);
+        } else {
+            $name = elgg_extract('annotation_name', $options, '');
+
+            if (isset($this->temp_annotations[$name])) {
+                return [$this->temp_annotations[$name]];
+            }
+        }
+
+        return [];
+    }
+
+    /**
+     * Count annotations.
+     *
+     * @param string $name The type of annotation.
+     *
+     * @return int
+     */
+    public function countAnnotations($name = "") {
+        return $this->getAnnotationCalculation($name, 'count');
+    }
+
+    /**
+     * Get the average of an integer type annotation.
+     *
+     * @param string $name Annotation name
+     *
+     * @return int
+     */
+    public function getAnnotationsAvg($name) {
+        return $this->getAnnotationCalculation($name, 'avg');
+    }
+
+    /**
+     * Get the sum of integer type annotations of a given name.
+     *
+     * @param string $name Annotation name
+     *
+     * @return int
+     */
+    public function getAnnotationsSum($name) {
+        return $this->getAnnotationCalculation($name, 'sum');
+    }
+
+    /**
+     * Get the minimum of integer type annotations of given name.
+     *
+     * @param string $name Annotation name
+     *
+     * @return int
+     */
+    public function getAnnotationsMin($name) {
+        return $this->getAnnotationCalculation($name, 'min');
+    }
+
+    /**
+     * Get the maximum of integer type annotations of a given name.
+     *
+     * @param string $name Annotation name
+     *
+     * @return int
+     */
+    public function getAnnotationsMax($name) {
+        return $this->getAnnotationCalculation($name, 'max');
+    }
+
+    /**
+     * Count the number of comments attached to this entity.
+     *
+     * @return int Number of comments
+     * @since 1.8.0
+     */
+    public function countComments() {
+        $params = ['entity' => $this];
+        $num = _elgg_services()->hooks->trigger('comments:count', $this->getType(), $params);
+
+        if (is_int($num)) {
+            return $num;
+        } else {
+            return elgg_get_entities([
+                'type' => 'object',
+                'subtype' => 'comment',
+                'container_guid' => $this->getGUID(),
+                'count' => true,
+                'distinct' => false,
+            ]);
+        }
+    }
+
+    /**
+     * Gets an array of entities with a relationship to this entity.
+     *
+     * @param array $options Options array. See elgg_get_entities_from_relationship()
+     *                       for a list of options. 'relationship_guid' is set to
+     *                       this entity.
+     *
+     * @return array|false An array of entities or false on failure
+     * @see elgg_get_entities_from_relationship()
+     */
+    public function getEntitiesFromRelationship(array $options = []) {
+        $options['relationship_guid'] = $this->guid;
+        return elgg_get_entities_from_relationship($options);
+    }
+
+    /**
+     * Gets the number of entities from a specific relationship type
+     *
+     * @param string $relationship         Relationship type (eg "friends")
+     * @param bool   $inverse_relationship Invert relationship
+     *
+     * @return int|false The number of entities or false on failure
+     */
+    public function countEntitiesFromRelationship($relationship, $inverse_relationship = false) {
+        return elgg_get_entities_from_relationship([
+            'relationship' => $relationship,
+            'relationship_guid' => $this->getGUID(),
+            'inverse_relationship' => $inverse_relationship,
+            'count' => true
+        ]);
+    }
+
+    /**
+     * Can a user edit this entity?
+     *
+     * @tip Can be overridden by registering for the permissions_check plugin hook.
+     *
+     * @param int $user_guid The user GUID, optionally (default: logged in user)
+     *
+     * @return bool Whether this entity is editable by the given user.
+     * @see elgg_set_ignore_access()
+     */
+    public function canEdit($user_guid = 0) {
+        return _elgg_services()->userCapabilities->canEdit($this, $user_guid);
+    }
+
+    /**
+     * Can a user delete this entity?
+     *
+     * @tip Can be overridden by registering for the permissions_check:delete plugin hook.
+     *
+     * @param int $user_guid The user GUID, optionally (default: logged in user)
+     *
+     * @return bool Whether this entity is deletable by the given user.
+     * @since 1.11
+     * @see elgg_set_ignore_access()
+     */
+    public function canDelete($user_guid = 0) {
+        return _elgg_services()->userCapabilities->canDelete($this, $user_guid);
+    }
+
+    /**
+     * Can a user edit metadata on this entity?
+     *
+     * If no specific metadata is passed, it returns whether the user can
+     * edit any metadata on the entity.
+     *
+     * @tip Can be overridden by by registering for the permissions_check:metadata
+     * plugin hook.
+     *
+     * @param \ElggMetadata $metadata  The piece of metadata to specifically check or null for any metadata
+     * @param int           $user_guid The user GUID, optionally (default: logged in user)
+     *
+     * @return bool
+     * @see elgg_set_ignore_access()
+     */
+    public function canEditMetadata($metadata = null, $user_guid = 0) {
+        return _elgg_services()->userCapabilities->canEditMetadata($this, $user_guid, $metadata);
+    }
+
+    /**
+     * Can a user add an entity to this container
+     *
+     * @param int    $user_guid The GUID of the user creating the entity (0 for logged in user).
+     * @param string $type      The type of entity we're looking to write
+     * @param string $subtype   The subtype of the entity we're looking to write
+     *
+     * @return bool
+     * @see elgg_set_ignore_access()
+     */
+    public function canWriteToContainer($user_guid = 0, $type = 'all', $subtype = 'all') {
+        return _elgg_services()->userCapabilities->canWriteToContainer($this, $user_guid, $type, $subtype);
+    }
+
+    /**
+     * Can a user comment on an entity?
+     *
+     * @tip Can be overridden by registering for the permissions_check:comment,
+     * <entity type> plugin hook.
+     *
+     * @param int  $user_guid User guid (default is logged in user)
+     * @param bool $default   Default permission
+     * @return bool
+     */
+    public function canComment($user_guid = 0, $default = null) {
+        return _elgg_services()->userCapabilities->canComment($this, $user_guid, $default);
+    }
+
+    /**
+     * Can a user annotate an entity?
+     *
+     * @tip Can be overridden by registering for the plugin hook [permissions_check:annotate:<name>,
+     * <entity type>] or [permissions_check:annotate, <entity type>]. The hooks are called in that order.
+     *
+     * @tip If you want logged out users to annotate an object, do not call
+     * canAnnotate(). It's easier than using the plugin hook.
+     *
+     * @param int    $user_guid       User guid (default is logged in user)
+     * @param string $annotation_name The name of the annotation (default is unspecified)
+     *
+     * @return bool
+     */
+    public function canAnnotate($user_guid = 0, $annotation_name = '') {
+        return _elgg_services()->userCapabilities->canAnnotate($this, $user_guid, $annotation_name);
+    }
+
+    /**
+     * Returns the access_id.
+     *
+     * @return int The access ID
+     */
+    public function getAccessID() {
+        return $this->access_id;
+    }
+
+    /**
+     * Returns the guid.
+     *
+     * @return int|null GUID
+     */
+    public function getGUID() {
+        return $this->guid;
+    }
+
+    /**
+     * Returns the entity type
+     *
+     * @return string The entity type
+     */
+    public function getType() {
+        return $this->type;
+    }
+
+    /**
+     * Get the entity subtype
+     *
+     * @return string The entity subtype
+     */
+    public function getSubtype() {
+        // If this object hasn't been saved, then return the subtype string.
+        if ($this->attributes['guid']) {
+            return get_subtype_from_id($this->attributes['subtype']);
+        }
+        return $this->attributes['subtype'];
+    }
+
+    /**
+     * Get the guid of the entity's owner.
+     *
+     * @return int The owner GUID
+     */
+    public function getOwnerGUID() {
+        return (int) $this->owner_guid;
+    }
+
+    /**
+     * Gets the \ElggEntity that owns this entity.
+     *
+     * @return \ElggEntity The owning entity
+     */
+    public function getOwnerEntity() {
+        return get_entity($this->owner_guid);
+    }
+
+    /**
+     * Set the container for this object.
+     *
+     * @param int $container_guid The ID of the container.
+     *
+     * @return bool
+     */
+    public function setContainerGUID($container_guid) {
+        return $this->container_guid = (int) $container_guid;
+    }
+
+    /**
+     * Gets the container GUID for this entity.
+     *
+     * @return int
+     */
+    public function getContainerGUID() {
+        return (int) $this->container_guid;
+    }
+
+    /**
+     * Get the container entity for this object.
+     *
+     * @return \ElggEntity
+     * @since 1.8.0
+     */
+    public function getContainerEntity() {
+        return get_entity($this->getContainerGUID());
+    }
+
+    /**
+     * Returns the UNIX epoch time that this entity was last updated
+     *
+     * @return int UNIX epoch time
+     */
+    public function getTimeUpdated() {
+        return $this->time_updated;
+    }
+
+    /**
+     * Gets the URL for this entity.
+     *
+     * Plugins can register for the 'entity:url', <type> plugin hook to
+     * customize the url for an entity.
+     *
+     * @return string The URL of the entity
+     */
+    public function getURL() {
+        $url = _elgg_services()->hooks->trigger('entity:url', $this->getType(), ['entity' => $this]);
 		
-		if ($url === null || $url === '' || $url === false) {
-			return '';
-		}
-
-		return elgg_normalize_url($url);
-	}
-
-	/**
-	 * Saves icons using an uploaded file as the source.
-	 *
-	 * @param string $input_name Form input name
-	 * @param string $type       The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @param array  $coords     An array of cropping coordinates x1, y1, x2, y2
-	 * @return bool
-	 */
-	public function saveIconFromUploadedFile($input_name, $type = 'icon', array $coords = []) {
-		return _elgg_services()->iconService->saveIconFromUploadedFile($this, $input_name, $type, $coords);
-	}
-
-	/**
-	 * Saves icons using a local file as the source.
-	 *
-	 * @param string $filename The full path to the local file
-	 * @param string $type     The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @param array  $coords   An array of cropping coordinates x1, y1, x2, y2
-	 * @return bool
-	 */
-	public function saveIconFromLocalFile($filename, $type = 'icon', array $coords = []) {
-		return _elgg_services()->iconService->saveIconFromLocalFile($this, $filename, $type, $coords);
-	}
-
-	/**
-	 * Saves icons using a file located in the data store as the source.
-	 *
-	 * @param string $file   An ElggFile instance
-	 * @param string $type   The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @param array  $coords An array of cropping coordinates x1, y1, x2, y2
-	 * @return bool
-	 */
-	public function saveIconFromElggFile(\ElggFile $file, $type = 'icon', array $coords = []) {
-		return _elgg_services()->iconService->saveIconFromElggFile($this, $file, $type, $coords);
-	}
+        if ($url === null || $url === '' || $url === false) {
+            return '';
+        }
+
+        return elgg_normalize_url($url);
+    }
+
+    /**
+     * Saves icons using an uploaded file as the source.
+     *
+     * @param string $input_name Form input name
+     * @param string $type       The name of the icon. e.g., 'icon', 'cover_photo'
+     * @param array  $coords     An array of cropping coordinates x1, y1, x2, y2
+     * @return bool
+     */
+    public function saveIconFromUploadedFile($input_name, $type = 'icon', array $coords = []) {
+        return _elgg_services()->iconService->saveIconFromUploadedFile($this, $input_name, $type, $coords);
+    }
+
+    /**
+     * Saves icons using a local file as the source.
+     *
+     * @param string $filename The full path to the local file
+     * @param string $type     The name of the icon. e.g., 'icon', 'cover_photo'
+     * @param array  $coords   An array of cropping coordinates x1, y1, x2, y2
+     * @return bool
+     */
+    public function saveIconFromLocalFile($filename, $type = 'icon', array $coords = []) {
+        return _elgg_services()->iconService->saveIconFromLocalFile($this, $filename, $type, $coords);
+    }
+
+    /**
+     * Saves icons using a file located in the data store as the source.
+     *
+     * @param string $file   An ElggFile instance
+     * @param string $type   The name of the icon. e.g., 'icon', 'cover_photo'
+     * @param array  $coords An array of cropping coordinates x1, y1, x2, y2
+     * @return bool
+     */
+    public function saveIconFromElggFile(\ElggFile $file, $type = 'icon', array $coords = []) {
+        return _elgg_services()->iconService->saveIconFromElggFile($this, $file, $type, $coords);
+    }
 	
-	/**
-	 * Returns entity icon as an ElggIcon object
-	 * The icon file may or may not exist on filestore
-	 *
-	 * @param string $size Size of the icon
-	 * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @return \ElggIcon
-	 */
-	public function getIcon($size, $type = 'icon') {
-		return _elgg_services()->iconService->getIcon($this, $size, $type);
-	}
-
-	/**
-	 * Removes all icon files and metadata for the passed type of icon.
-	 *
-	 * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @return bool
-	 */
-	public function deleteIcon($type = 'icon') {
-		return _elgg_services()->iconService->deleteIcon($this, $type);
-	}
+    /**
+     * Returns entity icon as an ElggIcon object
+     * The icon file may or may not exist on filestore
+     *
+     * @param string $size Size of the icon
+     * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
+     * @return \ElggIcon
+     */
+    public function getIcon($size, $type = 'icon') {
+        return _elgg_services()->iconService->getIcon($this, $size, $type);
+    }
+
+    /**
+     * Removes all icon files and metadata for the passed type of icon.
+     *
+     * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
+     * @return bool
+     */
+    public function deleteIcon($type = 'icon') {
+        return _elgg_services()->iconService->deleteIcon($this, $type);
+    }
 	
-	/**
-	 * Returns the timestamp of when the icon was changed.
-	 *
-	 * @param string $size The size of the icon
-	 * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
-	 *
-	 * @return int|null A unix timestamp of when the icon was last changed, or null if not set.
-	 */
-	public function getIconLastChange($size, $type = 'icon') {
-		return _elgg_services()->iconService->getIconLastChange($this, $size, $type);
-	}
+    /**
+     * Returns the timestamp of when the icon was changed.
+     *
+     * @param string $size The size of the icon
+     * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
+     *
+     * @return int|null A unix timestamp of when the icon was last changed, or null if not set.
+     */
+    public function getIconLastChange($size, $type = 'icon') {
+        return _elgg_services()->iconService->getIconLastChange($this, $size, $type);
+    }
 	
-	/**
-	 * Returns if the entity has an icon of the passed type.
-	 *
-	 * @param string $size The size of the icon
-	 * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
-	 * @return bool
-	 */
-	public function hasIcon($size, $type = 'icon') {
-		return _elgg_services()->iconService->hasIcon($this, $size, $type);
-	}
-
-	/**
-	 * Get the URL for this entity's icon
-	 *
-	 * Plugins can register for the 'entity:icon:url', <type> plugin hook
-	 * to customize the icon for an entity.
-	 *
-	 * @param mixed $params A string defining the size of the icon (e.g. tiny, small, medium, large)
-	 *                      or an array of parameters including 'size'
-	 * @return string The URL
-	 * @since 1.8.0
-	 */
-	public function getIconURL($params = []) {
-		return _elgg_services()->iconService->getIconURL($this, $params);
-	}
-
-	/**
-	 * Save an entity.
-	 *
-	 * @return bool|int
-	 * @throws InvalidParameterException
-	 * @throws IOException
-	 */
-	public function save() {
-		$guid = $this->guid;
-		if ($guid > 0) {
-			$guid = $this->update();
-		} else {
-			$guid = $this->create();
-			if ($guid && !_elgg_services()->events->trigger('create', $this->type, $this)) {
-				// plugins that return false to event don't need to override the access system
-				$ia = elgg_set_ignore_access(true);
-				$this->delete();
-				elgg_set_ignore_access($ia);
-				return false;
-			}
-		}
-
-		if ($guid) {
-			_elgg_services()->entityCache->set($this);
-			$this->storeInPersistedCache(_elgg_get_memcache('new_entity_cache'));
-		}
-
-		return $guid;
-	}
+    /**
+     * Returns if the entity has an icon of the passed type.
+     *
+     * @param string $size The size of the icon
+     * @param string $type The name of the icon. e.g., 'icon', 'cover_photo'
+     * @return bool
+     */
+    public function hasIcon($size, $type = 'icon') {
+        return _elgg_services()->iconService->hasIcon($this, $size, $type);
+    }
+
+    /**
+     * Get the URL for this entity's icon
+     *
+     * Plugins can register for the 'entity:icon:url', <type> plugin hook
+     * to customize the icon for an entity.
+     *
+     * @param mixed $params A string defining the size of the icon (e.g. tiny, small, medium, large)
+     *                      or an array of parameters including 'size'
+     * @return string The URL
+     * @since 1.8.0
+     */
+    public function getIconURL($params = []) {
+        return _elgg_services()->iconService->getIconURL($this, $params);
+    }
+
+    /**
+     * Save an entity.
+     *
+     * @return bool|int
+     * @throws InvalidParameterException
+     * @throws IOException
+     */
+    public function save() {
+        $guid = $this->guid;
+        if ($guid > 0) {
+            $guid = $this->update();
+        } else {
+            $guid = $this->create();
+            if ($guid && !_elgg_services()->events->trigger('create', $this->type, $this)) {
+                // plugins that return false to event don't need to override the access system
+                $ia = elgg_set_ignore_access(true);
+                $this->delete();
+                elgg_set_ignore_access($ia);
+                return false;
+            }
+        }
+
+        if ($guid) {
+            _elgg_services()->entityCache->set($this);
+            $this->storeInPersistedCache(_elgg_get_memcache('new_entity_cache'));
+        }
+
+        return $guid;
+    }
 	
-	/**
-	 * Create a new entry in the entities table.
-	 *
-	 * Saves the base information in the entities table for the entity.  Saving
-	 * the type-specific information is handled in the calling class method.
-	 *
-	 * @warning Entities must have an entry in both the entities table and their type table
-	 * or they will throw an exception when loaded.
-	 *
-	 * @return int The new entity's GUID
-	 * @throws InvalidParameterException If the entity's type has not been set.
-	 * @throws IOException If the new row fails to write to the DB.
-	 */
-	protected function create() {
-
-		$allowed_types = elgg_get_config('entity_types');
-		$type = $this->getDatabase()->sanitizeString($this->attributes['type']);
-		if (!in_array($type, $allowed_types)) {
-			throw new \InvalidParameterException('Entity type must be one of the allowed types: '
-					. implode(', ', $allowed_types));
-		}
+    /**
+     * Create a new entry in the entities table.
+     *
+     * Saves the base information in the entities table for the entity.  Saving
+     * the type-specific information is handled in the calling class method.
+     *
+     * @warning Entities must have an entry in both the entities table and their type table
+     * or they will throw an exception when loaded.
+     *
+     * @return int The new entity's GUID
+     * @throws InvalidParameterException If the entity's type has not been set.
+     * @throws IOException If the new row fails to write to the DB.
+     */
+    protected function create() {
+
+        $allowed_types = elgg_get_config('entity_types');
+        $type = $this->getDatabase()->sanitizeString($this->attributes['type']);
+        if (!in_array($type, $allowed_types)) {
+            throw new \InvalidParameterException('Entity type must be one of the allowed types: '
+                    . implode(', ', $allowed_types));
+        }
 		
-		$subtype = $this->attributes['subtype'];
-		$subtype_id = add_subtype($type, $subtype);
-		$owner_guid = (int) $this->attributes['owner_guid'];
-		$access_id = (int) $this->attributes['access_id'];
-		$now = $this->getCurrentTime()->getTimestamp();
-		$time_created = isset($this->attributes['time_created']) ? (int) $this->attributes['time_created'] : $now;
+        $subtype = $this->attributes['subtype'];
+        $subtype_id = add_subtype($type, $subtype);
+        $owner_guid = (int) $this->attributes['owner_guid'];
+        $access_id = (int) $this->attributes['access_id'];
+        $now = $this->getCurrentTime()->getTimestamp();
+        $time_created = isset($this->attributes['time_created']) ? (int) $this->attributes['time_created'] : $now;
 		
-		$container_guid = $this->attributes['container_guid'];
-		if ($container_guid == 0) {
-			$container_guid = $owner_guid;
-			$this->attributes['container_guid'] = $container_guid;
-		}
-		$container_guid = (int) $container_guid;
-
-		if ($access_id == ACCESS_DEFAULT) {
-			throw new \InvalidParameterException('ACCESS_DEFAULT is not a valid access level. See its documentation in elgglib.h');
-		}
-
-		$user_guid = elgg_get_logged_in_user_guid();
-
-		// If given an owner, verify it can be loaded
-		if ($owner_guid) {
-			$owner = $this->getOwnerEntity();
-			if (!$owner) {
-				_elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype), but the given"
-					. " owner $owner_guid could not be loaded.");
-				return false;
-			}
-
-			// If different owner than logged in, verify can write to container.
-
-			if ($user_guid != $owner_guid && !$owner->canWriteToContainer(0, $type, $subtype)) {
-				_elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype) with owner"
-					. " $owner_guid, but the user wasn't permitted to write to the owner's container.");
-				return false;
-			}
-		}
-
-		// If given a container, verify it can be loaded and that the current user can write to it
-		if ($container_guid) {
-			$container = $this->getContainerEntity();
-			if (!$container) {
-				_elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype), but the given"
-					. " container $container_guid could not be loaded.");
-				return false;
-			}
-
-			if (!$container->canWriteToContainer(0, $type, $subtype)) {
-				_elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype), but was not"
-					. " permitted to write to container $container_guid.");
-				return false;
-			}
-		}
-
-		$result = _elgg_services()->entityTable->insertRow((object) [
-			'type' => $type,
-			'subtype_id' => $subtype_id,
-			'owner_guid' => $owner_guid,
-			'container_guid' => $container_guid,
-			'access_id' => $access_id,
-			'time_created' => $time_created,
-			'time_updated' => $now,
-			'last_action' => $now,
-		], $this->attributes);
-
-		if (!$result) {
-			throw new \IOException("Unable to save new object's base entity information!");
-		}
+        $container_guid = $this->attributes['container_guid'];
+        if ($container_guid == 0) {
+            $container_guid = $owner_guid;
+            $this->attributes['container_guid'] = $container_guid;
+        }
+        $container_guid = (int) $container_guid;
+
+        if ($access_id == ACCESS_DEFAULT) {
+            throw new \InvalidParameterException('ACCESS_DEFAULT is not a valid access level. See its documentation in elgglib.h');
+        }
+
+        $user_guid = elgg_get_logged_in_user_guid();
+
+        // If given an owner, verify it can be loaded
+        if ($owner_guid) {
+            $owner = $this->getOwnerEntity();
+            if (!$owner) {
+                _elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype), but the given"
+                    . " owner $owner_guid could not be loaded.");
+                return false;
+            }
+
+            // If different owner than logged in, verify can write to container.
+
+            if ($user_guid != $owner_guid && !$owner->canWriteToContainer(0, $type, $subtype)) {
+                _elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype) with owner"
+                    . " $owner_guid, but the user wasn't permitted to write to the owner's container.");
+                return false;
+            }
+        }
+
+        // If given a container, verify it can be loaded and that the current user can write to it
+        if ($container_guid) {
+            $container = $this->getContainerEntity();
+            if (!$container) {
+                _elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype), but the given"
+                    . " container $container_guid could not be loaded.");
+                return false;
+            }
+
+            if (!$container->canWriteToContainer(0, $type, $subtype)) {
+                _elgg_services()->logger->error("User $user_guid tried to create a ($type, $subtype), but was not"
+                    . " permitted to write to container $container_guid.");
+                return false;
+            }
+        }
+
+        $result = _elgg_services()->entityTable->insertRow((object) [
+            'type' => $type,
+            'subtype_id' => $subtype_id,
+            'owner_guid' => $owner_guid,
+            'container_guid' => $container_guid,
+            'access_id' => $access_id,
+            'time_created' => $time_created,
+            'time_updated' => $now,
+            'last_action' => $now,
+        ], $this->attributes);
+
+        if (!$result) {
+            throw new \IOException("Unable to save new object's base entity information!");
+        }
 	
-		// for BC with 1.8, ->subtype always returns ID, ->getSubtype() the string
-		$this->attributes['subtype'] = (int) $subtype_id;
-		$this->attributes['guid'] = (int) $result;
-		$this->attributes['time_created'] = (int) $time_created;
-		$this->attributes['time_updated'] = (int) $now;
-		$this->attributes['last_action'] = (int) $now;
-		$this->attributes['container_guid'] = (int) $container_guid;
-
-		// We are writing this new entity to cache to make sure subsequent calls
-		// to get_entity() load entity from cache and not from the DB
-		// At this point, secondary attributes have not yet been written to the DB,
-		// but metadata and annotation event handlers may be calling get_entity()
-		_elgg_services()->entityCache->set($this);
-
-		// Save any unsaved metadata
-		if (sizeof($this->temp_metadata) > 0) {
-			foreach ($this->temp_metadata as $name => $value) {
-				$this->$name = $value;
-			}
+        // for BC with 1.8, ->subtype always returns ID, ->getSubtype() the string
+        $this->attributes['subtype'] = (int) $subtype_id;
+        $this->attributes['guid'] = (int) $result;
+        $this->attributes['time_created'] = (int) $time_created;
+        $this->attributes['time_updated'] = (int) $now;
+        $this->attributes['last_action'] = (int) $now;
+        $this->attributes['container_guid'] = (int) $container_guid;
+
+        // We are writing this new entity to cache to make sure subsequent calls
+        // to get_entity() load entity from cache and not from the DB
+        // At this point, secondary attributes have not yet been written to the DB,
+        // but metadata and annotation event handlers may be calling get_entity()
+        _elgg_services()->entityCache->set($this);
+
+        // Save any unsaved metadata
+        if (sizeof($this->temp_metadata) > 0) {
+            foreach ($this->temp_metadata as $name => $value) {
+                $this->$name = $value;
+            }
 			
-			$this->temp_metadata = [];
-		}
-
-		// Save any unsaved annotations.
-		if (sizeof($this->temp_annotations) > 0) {
-			foreach ($this->temp_annotations as $name => $value) {
-				$this->annotate($name, $value);
-			}
+            $this->temp_metadata = [];
+        }
+
+        // Save any unsaved annotations.
+        if (sizeof($this->temp_annotations) > 0) {
+            foreach ($this->temp_annotations as $name => $value) {
+                $this->annotate($name, $value);
+            }
 			
-			$this->temp_annotations = [];
-		}
-
-		// Save any unsaved private settings.
-		if (sizeof($this->temp_private_settings) > 0) {
-			foreach ($this->temp_private_settings as $name => $value) {
-				$this->setPrivateSetting($name, $value);
-			}
+            $this->temp_annotations = [];
+        }
+
+        // Save any unsaved private settings.
+        if (sizeof($this->temp_private_settings) > 0) {
+            foreach ($this->temp_private_settings as $name => $value) {
+                $this->setPrivateSetting($name, $value);
+            }
 			
-			$this->temp_private_settings = [];
-		}
+            $this->temp_private_settings = [];
+        }
 		
-		return $result;
-	}
-
-	/**
-	 * Update the entity in the database.
-	 *
-	 * @return bool Whether the update was successful.
-	 *
-	 * @throws InvalidParameterException
-	 */
-	protected function update() {
+        return $result;
+    }
+
+    /**
+     * Update the entity in the database.
+     *
+     * @return bool Whether the update was successful.
+     *
+     * @throws InvalidParameterException
+     */
+    protected function update() {
 		
-		_elgg_services()->boot->invalidateCache($this->guid);
-
-		if (!$this->canEdit()) {
-			return false;
-		}
-
-		// give old update event a chance to stop the update
-		if (!_elgg_services()->events->trigger('update', $this->type, $this)) {
-			return false;
-		}
-
-		// See #6225. We copy these after the update event in case a handler changed one of them.
-		$guid = (int) $this->guid;
-		$owner_guid = (int) $this->owner_guid;
-		$access_id = (int) $this->access_id;
-		$container_guid = (int) $this->container_guid;
-		$time_created = (int) $this->time_created;
-		$time = $this->getCurrentTime()->getTimestamp();
-
-		if ($access_id == ACCESS_DEFAULT) {
-			throw new \InvalidParameterException('ACCESS_DEFAULT is not a valid access level. See its documentation in elgglib.php');
-		}
-
-		$ret = _elgg_services()->entityTable->updateRow($guid, (object) [
-			'owner_guid' => $owner_guid,
-			'container_guid' => $container_guid,
-			'access_id' => $access_id,
-			'time_created' => $time_created,
-			'time_updated' => $time,
-			'guid' => $guid,
-		]);
-
-		elgg_trigger_after_event('update', $this->type, $this);
-
-		// TODO(evan): Move this to \ElggObject?
-		if ($this instanceof \ElggObject) {
-			update_river_access_by_object($guid, $access_id);
-		}
-
-		if ($ret !== false) {
-			$this->attributes['time_updated'] = $time;
-		}
-
-		$this->orig_attributes = [];
-
-		// Handle cases where there was no error BUT no rows were updated!
-		return $ret !== false;
-	}
-
-	/**
-	 * Loads attributes from the entities table into the object.
-	 *
-	 * @param mixed $guid GUID of entity or \stdClass object from entities table
-	 *
-	 * @return bool
-	 */
-	protected function load($guid) {
-		if ($guid instanceof \stdClass) {
-			$row = $guid;
-		} else {
-			$row = get_entity_as_row($guid);
-		}
-
-		if ($row) {
-			// Create the array if necessary - all subclasses should test before creating
-			if (!is_array($this->attributes)) {
-				$this->attributes = [];
-			}
-
-			// Now put these into the attributes array as core values
-			$objarray = (array) $row;
-			foreach ($objarray as $key => $value) {
-				$this->attributes[$key] = $value;
-			}
-
-			// guid needs to be an int  https://github.com/elgg/elgg/issues/4111
-			$this->attributes['guid'] = (int) $this->attributes['guid'];
-
-			// for BC with 1.8, ->subtype always returns ID, ->getSubtype() the string
-			$this->attributes['subtype'] = (int) $this->attributes['subtype'];
-
-			// Cache object handle
-			if ($this->attributes['guid']) {
-				_elgg_services()->entityCache->set($this);
-			}
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Stores non-attributes from the loading of the entity as volatile data
-	 *
-	 * @param array $data Key value array
-	 * @return void
-	 */
-	protected function loadAdditionalSelectValues(array $data) {
-		foreach ($data as $name => $value) {
-			$this->setVolatileData("select:$name", $value);
-		}
-	}
+        _elgg_services()->boot->invalidateCache($this->guid);
+
+        if (!$this->canEdit()) {
+            return false;
+        }
+
+        // give old update event a chance to stop the update
+        if (!_elgg_services()->events->trigger('update', $this->type, $this)) {
+            return false;
+        }
+
+        // See #6225. We copy these after the update event in case a handler changed one of them.
+        $guid = (int) $this->guid;
+        $owner_guid = (int) $this->owner_guid;
+        $access_id = (int) $this->access_id;
+        $container_guid = (int) $this->container_guid;
+        $time_created = (int) $this->time_created;
+        $time = $this->getCurrentTime()->getTimestamp();
+
+        if ($access_id == ACCESS_DEFAULT) {
+            throw new \InvalidParameterException('ACCESS_DEFAULT is not a valid access level. See its documentation in elgglib.php');
+        }
+
+        $ret = _elgg_services()->entityTable->updateRow($guid, (object) [
+            'owner_guid' => $owner_guid,
+            'container_guid' => $container_guid,
+            'access_id' => $access_id,
+            'time_created' => $time_created,
+            'time_updated' => $time,
+            'guid' => $guid,
+        ]);
+
+        elgg_trigger_after_event('update', $this->type, $this);
+
+        // TODO(evan): Move this to \ElggObject?
+        if ($this instanceof \ElggObject) {
+            update_river_access_by_object($guid, $access_id);
+        }
+
+        if ($ret !== false) {
+            $this->attributes['time_updated'] = $time;
+        }
+
+        $this->orig_attributes = [];
+
+        // Handle cases where there was no error BUT no rows were updated!
+        return $ret !== false;
+    }
+
+    /**
+     * Loads attributes from the entities table into the object.
+     *
+     * @param mixed $guid GUID of entity or \stdClass object from entities table
+     *
+     * @return bool
+     */
+    protected function load($guid) {
+        if ($guid instanceof \stdClass) {
+            $row = $guid;
+        } else {
+            $row = get_entity_as_row($guid);
+        }
+
+        if ($row) {
+            // Create the array if necessary - all subclasses should test before creating
+            if (!is_array($this->attributes)) {
+                $this->attributes = [];
+            }
+
+            // Now put these into the attributes array as core values
+            $objarray = (array) $row;
+            foreach ($objarray as $key => $value) {
+                $this->attributes[$key] = $value;
+            }
+
+            // guid needs to be an int  https://github.com/elgg/elgg/issues/4111
+            $this->attributes['guid'] = (int) $this->attributes['guid'];
+
+            // for BC with 1.8, ->subtype always returns ID, ->getSubtype() the string
+            $this->attributes['subtype'] = (int) $this->attributes['subtype'];
+
+            // Cache object handle
+            if ($this->attributes['guid']) {
+                _elgg_services()->entityCache->set($this);
+            }
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Stores non-attributes from the loading of the entity as volatile data
+     *
+     * @param array $data Key value array
+     * @return void
+     */
+    protected function loadAdditionalSelectValues(array $data) {
+        foreach ($data as $name => $value) {
+            $this->setVolatileData("select:$name", $value);
+        }
+    }
 	
-	/**
-	 * Load new data from database into existing entity. Overwrites data but
-	 * does not change values not included in the latest data.
-	 *
-	 * @internal This is used when the same entity is selected twice during a
-	 * request in case different select clauses were used to load different data
-	 * into volatile data.
-	 *
-	 * @param \stdClass $row DB row with new entity data
-	 * @return bool
-	 * @access private
-	 */
-	public function refresh(\stdClass $row) {
-		if ($row instanceof \stdClass) {
-			return $this->load($row);
-		}
-		return false;
-	}
-
-	/**
-	 * Disable this entity.
-	 *
-	 * Disabled entities are not returned by getter functions.
-	 * To enable an entity, use {@link \ElggEntity::enable()}.
-	 *
-	 * Recursively disabling an entity will disable all entities
-	 * owned or contained by the parent entity.
-	 *
-	 * You can ignore the disabled field by using {@link access_show_hidden_entities()}.
-	 *
-	 * @note Internal: Disabling an entity sets the 'enabled' column to 'no'.
-	 *
-	 * @param string $reason    Optional reason
-	 * @param bool   $recursive Recursively disable all contained entities?
-	 *
-	 * @return bool
-	 * @see \ElggEntity::enable()
-	 */
-	public function disable($reason = "", $recursive = true) {
-		if (!$this->guid) {
-			return false;
-		}
+    /**
+     * Load new data from database into existing entity. Overwrites data but
+     * does not change values not included in the latest data.
+     *
+     * @internal This is used when the same entity is selected twice during a
+     * request in case different select clauses were used to load different data
+     * into volatile data.
+     *
+     * @param \stdClass $row DB row with new entity data
+     * @return bool
+     * @access private
+     */
+    public function refresh(\stdClass $row) {
+        if ($row instanceof \stdClass) {
+            return $this->load($row);
+        }
+        return false;
+    }
+
+    /**
+     * Disable this entity.
+     *
+     * Disabled entities are not returned by getter functions.
+     * To enable an entity, use {@link \ElggEntity::enable()}.
+     *
+     * Recursively disabling an entity will disable all entities
+     * owned or contained by the parent entity.
+     *
+     * You can ignore the disabled field by using {@link access_show_hidden_entities()}.
+     *
+     * @note Internal: Disabling an entity sets the 'enabled' column to 'no'.
+     *
+     * @param string $reason    Optional reason
+     * @param bool   $recursive Recursively disable all contained entities?
+     *
+     * @return bool
+     * @see \ElggEntity::enable()
+     */
+    public function disable($reason = "", $recursive = true) {
+        if (!$this->guid) {
+            return false;
+        }
 		
-		if (!_elgg_services()->events->trigger('disable', $this->type, $this)) {
-			return false;
-		}
+        if (!_elgg_services()->events->trigger('disable', $this->type, $this)) {
+            return false;
+        }
 		
-		if (!$this->canEdit()) {
-			return false;
-		}
-
-		if ($this instanceof ElggUser && $this->banned === 'no') {
-			// temporarily ban to prevent using the site during disable
-			_elgg_services()->usersTable->markBanned($this->guid, true);
-			$unban_after = true;
-		} else {
-			$unban_after = false;
-		}
-
-		if ($reason) {
-			$this->disable_reason = $reason;
-		}
-
-		$dbprefix = elgg_get_config('dbprefix');
+        if (!$this->canEdit()) {
+            return false;
+        }
+
+        if ($this instanceof ElggUser && $this->banned === 'no') {
+            // temporarily ban to prevent using the site during disable
+            _elgg_services()->usersTable->markBanned($this->guid, true);
+            $unban_after = true;
+        } else {
+            $unban_after = false;
+        }
+
+        if ($reason) {
+            $this->disable_reason = $reason;
+        }
+
+        $dbprefix = elgg_get_config('dbprefix');
 		
-		$guid = (int) $this->guid;
+        $guid = (int) $this->guid;
 		
-		if ($recursive) {
-			// Only disable enabled subentities
-			$hidden = access_get_show_hidden_status();
-			access_show_hidden_entities(false);
-
-			$ia = elgg_set_ignore_access(true);
-
-			$base_options = [
-				'wheres' => [
-					"e.guid != $guid",
-				],
-				'limit' => false,
-			];
+        if ($recursive) {
+            // Only disable enabled subentities
+            $hidden = access_get_show_hidden_status();
+            access_show_hidden_entities(false);
+
+            $ia = elgg_set_ignore_access(true);
+
+            $base_options = [
+                'wheres' => [
+                    "e.guid != $guid",
+                ],
+                'limit' => false,
+            ];
 			
-			foreach (['owner_guid', 'container_guid'] as $db_column) {
-				$options = $base_options;
-				$options[$db_column] = $guid;
+            foreach (['owner_guid', 'container_guid'] as $db_column) {
+                $options = $base_options;
+                $options[$db_column] = $guid;
 				
-				$subentities = new \ElggBatch('elgg_get_entities', $options);
-				$subentities->setIncrementOffset(false);
+                $subentities = new \ElggBatch('elgg_get_entities', $options);
+                $subentities->setIncrementOffset(false);
 				
-				foreach ($subentities as $subentity) {
-					/* @var $subentity \ElggEntity */
-					if (!$subentity->isEnabled()) {
-						continue;
-					}
-					add_entity_relationship($subentity->guid, 'disabled_with', $guid);
-					$subentity->disable($reason);
-				}
-			}
-
-			access_show_hidden_entities($hidden);
-			elgg_set_ignore_access($ia);
-		}
-
-		$this->disableMetadata();
-		$this->disableAnnotations();
-
-		_elgg_services()->entityCache->remove($guid);
+                foreach ($subentities as $subentity) {
+                    /* @var $subentity \ElggEntity */
+                    if (!$subentity->isEnabled()) {
+                        continue;
+                    }
+                    add_entity_relationship($subentity->guid, 'disabled_with', $guid);
+                    $subentity->disable($reason);
+                }
+            }
+
+            access_show_hidden_entities($hidden);
+            elgg_set_ignore_access($ia);
+        }
+
+        $this->disableMetadata();
+        $this->disableAnnotations();
+
+        _elgg_services()->entityCache->remove($guid);
 		
-		$sql = "
+        $sql = "
 			UPDATE {$dbprefix}entities
 			SET enabled = 'no'
 			WHERE guid = :guid
 		";
-		$params = [
-			':guid' => $guid,
-		];
-		$disabled = $this->getDatabase()->updateData($sql, false, $params);
-
-		if ($unban_after) {
-			_elgg_services()->usersTable->markBanned($this->guid, false);
-		}
-
-		if ($disabled) {
-			$this->attributes['enabled'] = 'no';
-			_elgg_services()->events->trigger('disable:after', $this->type, $this);
-		}
-
-		return (bool) $disabled;
-	}
-
-	/**
-	 * Enable the entity
-	 *
-	 * @warning Disabled entities can't be loaded unless
-	 * {@link access_show_hidden_entities(true)} has been called.
-	 *
-	 * @param bool $recursive Recursively enable all entities disabled with the entity?
-	 * @see access_show_hiden_entities()
-	 * @return bool
-	 */
-	public function enable($recursive = true) {
-		$guid = (int) $this->guid;
-		if (!$guid) {
-			return false;
-		}
+        $params = [
+            ':guid' => $guid,
+        ];
+        $disabled = $this->getDatabase()->updateData($sql, false, $params);
+
+        if ($unban_after) {
+            _elgg_services()->usersTable->markBanned($this->guid, false);
+        }
+
+        if ($disabled) {
+            $this->attributes['enabled'] = 'no';
+            _elgg_services()->events->trigger('disable:after', $this->type, $this);
+        }
+
+        return (bool) $disabled;
+    }
+
+    /**
+     * Enable the entity
+     *
+     * @warning Disabled entities can't be loaded unless
+     * {@link access_show_hidden_entities(true)} has been called.
+     *
+     * @param bool $recursive Recursively enable all entities disabled with the entity?
+     * @see access_show_hiden_entities()
+     * @return bool
+     */
+    public function enable($recursive = true) {
+        $guid = (int) $this->guid;
+        if (!$guid) {
+            return false;
+        }
 		
-		if (!_elgg_services()->events->trigger('enable', $this->type, $this)) {
-			return false;
-		}
+        if (!_elgg_services()->events->trigger('enable', $this->type, $this)) {
+            return false;
+        }
 		
-		if (!$this->canEdit()) {
-			return false;
-		}
+        if (!$this->canEdit()) {
+            return false;
+        }
 		
-		global $CONFIG;
+        global $CONFIG;
 	
-		// Override access only visible entities
-		$old_access_status = access_get_show_hidden_status();
-		access_show_hidden_entities(true);
+        // Override access only visible entities
+        $old_access_status = access_get_show_hidden_status();
+        access_show_hidden_entities(true);
 	
-		$result = $this->getDatabase()->updateData("UPDATE {$CONFIG->dbprefix}entities
+        $result = $this->getDatabase()->updateData("UPDATE {$CONFIG->dbprefix}entities
 			SET enabled = 'yes'
 			WHERE guid = $guid");
 
-		$this->deleteMetadata('disable_reason');
-		$this->enableMetadata();
-		$this->enableAnnotations();
-
-		if ($recursive) {
-			$disabled_with_it = elgg_get_entities_from_relationship([
-				'relationship' => 'disabled_with',
-				'relationship_guid' => $guid,
-				'inverse_relationship' => true,
-				'limit' => 0,
-			]);
-
-			foreach ($disabled_with_it as $e) {
-				$e->enable();
-				remove_entity_relationship($e->guid, 'disabled_with', $guid);
-			}
-		}
+        $this->deleteMetadata('disable_reason');
+        $this->enableMetadata();
+        $this->enableAnnotations();
+
+        if ($recursive) {
+            $disabled_with_it = elgg_get_entities_from_relationship([
+                'relationship' => 'disabled_with',
+                'relationship_guid' => $guid,
+                'inverse_relationship' => true,
+                'limit' => 0,
+            ]);
+
+            foreach ($disabled_with_it as $e) {
+                $e->enable();
+                remove_entity_relationship($e->guid, 'disabled_with', $guid);
+            }
+        }
 	
-		access_show_hidden_entities($old_access_status);
+        access_show_hidden_entities($old_access_status);
 	
-		if ($result) {
-			$this->attributes['enabled'] = 'yes';
-			_elgg_services()->events->trigger('enable:after', $this->type, $this);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Is this entity enabled?
-	 *
-	 * @return boolean Whether this entity is enabled.
-	 */
-	public function isEnabled() {
-		return $this->enabled == 'yes';
-	}
-
-	/**
-	 * Deletes the entity.
-	 *
-	 * Removes the entity and its metadata, annotations, relationships,
-	 * river entries, and private data.
-	 *
-	 * Optionally can remove entities contained and owned by this entity.
-	 *
-	 * @warning If deleting recursively, this bypasses ownership of items contained by
-	 * the entity.  That means that if the container_guid = $this->guid, the item will
-	 * be deleted regardless of who owns it.
-	 *
-	 * @param bool $recursive If true (default) then all entities which are
-	 *                        owned or contained by $this will also be deleted.
-	 *
-	 * @return bool
-	 */
-	public function delete($recursive = true) {
-
-		$guid = $this->guid;
-		if (!$guid) {
-			return false;
-		}
+        if ($result) {
+            $this->attributes['enabled'] = 'yes';
+            _elgg_services()->events->trigger('enable:after', $this->type, $this);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Is this entity enabled?
+     *
+     * @return boolean Whether this entity is enabled.
+     */
+    public function isEnabled() {
+        return $this->enabled == 'yes';
+    }
+
+    /**
+     * Deletes the entity.
+     *
+     * Removes the entity and its metadata, annotations, relationships,
+     * river entries, and private data.
+     *
+     * Optionally can remove entities contained and owned by this entity.
+     *
+     * @warning If deleting recursively, this bypasses ownership of items contained by
+     * the entity.  That means that if the container_guid = $this->guid, the item will
+     * be deleted regardless of who owns it.
+     *
+     * @param bool $recursive If true (default) then all entities which are
+     *                        owned or contained by $this will also be deleted.
+     *
+     * @return bool
+     */
+    public function delete($recursive = true) {
+
+        $guid = $this->guid;
+        if (!$guid) {
+            return false;
+        }
 		
-		// first check if we can delete this entity
-		// NOTE: in Elgg <= 1.10.3 this was after the delete event,
-		// which could potentially remove some content if the user didn't have access
-		if (!$this->canDelete()) {
-			return false;
-		}
-
-		// now trigger an event to let others know this entity is about to be deleted
-		// so they can prevent it or take their own actions
-		if (!_elgg_services()->events->trigger('delete', $this->type, $this)) {
-			return false;
-		}
-
-		if ($this instanceof ElggUser) {
-			// ban to prevent using the site during delete
-			_elgg_services()->usersTable->markBanned($this->guid, true);
-		}
-
-		// Delete contained owned and otherwise releated objects (depth first)
-		if ($recursive) {
-			// Temporarily overriding access controls
-			$entity_disable_override = access_get_show_hidden_status();
-			access_show_hidden_entities(true);
-			$ia = elgg_set_ignore_access(true);
-
-			// @todo there was logic in the original code that ignored
-			// entities with owner or container guids of themselves.
-			// this should probably be prevented in \ElggEntity instead of checked for here
-			$base_options = [
-				'wheres' => [
-					"e.guid != $guid",
-				],
-				'limit' => false,
-			];
+        // first check if we can delete this entity
+        // NOTE: in Elgg <= 1.10.3 this was after the delete event,
+        // which could potentially remove some content if the user didn't have access
+        if (!$this->canDelete()) {
+            return false;
+        }
+
+        // now trigger an event to let others know this entity is about to be deleted
+        // so they can prevent it or take their own actions
+        if (!_elgg_services()->events->trigger('delete', $this->type, $this)) {
+            return false;
+        }
+
+        if ($this instanceof ElggUser) {
+            // ban to prevent using the site during delete
+            _elgg_services()->usersTable->markBanned($this->guid, true);
+        }
+
+        // Delete contained owned and otherwise releated objects (depth first)
+        if ($recursive) {
+            // Temporarily overriding access controls
+            $entity_disable_override = access_get_show_hidden_status();
+            access_show_hidden_entities(true);
+            $ia = elgg_set_ignore_access(true);
+
+            // @todo there was logic in the original code that ignored
+            // entities with owner or container guids of themselves.
+            // this should probably be prevented in \ElggEntity instead of checked for here
+            $base_options = [
+                'wheres' => [
+                    "e.guid != $guid",
+                ],
+                'limit' => false,
+            ];
 			
-			foreach (['owner_guid', 'container_guid'] as $db_column) {
-				$options = $base_options;
-				$options[$db_column] = $guid;
+            foreach (['owner_guid', 'container_guid'] as $db_column) {
+                $options = $base_options;
+                $options[$db_column] = $guid;
 				
-				$batch = new \ElggBatch('elgg_get_entities', $options);
-				$batch->setIncrementOffset(false);
+                $batch = new \ElggBatch('elgg_get_entities', $options);
+                $batch->setIncrementOffset(false);
 				
-				/* @var $e \ElggEntity */
-				foreach ($batch as $e) {
-					$e->delete(true);
-				}
-			}
+                /* @var $e \ElggEntity */
+                foreach ($batch as $e) {
+                    $e->delete(true);
+                }
+            }
 			
-			access_show_hidden_entities($entity_disable_override);
-			elgg_set_ignore_access($ia);
-		}
+            access_show_hidden_entities($entity_disable_override);
+            elgg_set_ignore_access($ia);
+        }
 
-		$entity_disable_override = access_get_show_hidden_status();
-		access_show_hidden_entities(true);
-		$ia = elgg_set_ignore_access(true);
+        $entity_disable_override = access_get_show_hidden_status();
+        access_show_hidden_entities(true);
+        $ia = elgg_set_ignore_access(true);
 		
-		// Now delete the entity itself
-		$this->deleteMetadata();
-		$this->deleteOwnedMetadata();
-		$this->deleteAnnotations();
-		$this->deleteOwnedAnnotations();
-		$this->deleteRelationships();
-		$this->deleteAccessCollectionMemberships();
-		$this->deleteOwnedAccessCollections();
-
-		access_show_hidden_entities($entity_disable_override);
-		elgg_set_ignore_access($ia);
-
-		_elgg_delete_river(['subject_guid' => $guid]);
-		_elgg_delete_river(['object_guid' => $guid]);
-		_elgg_delete_river(['target_guid' => $guid]);
-		remove_all_private_settings($guid);
-
-		_elgg_invalidate_cache_for_entity($guid);
-		_elgg_invalidate_memcache_for_entity($guid);
-
-		$dbprefix = elgg_get_config('dbprefix');
+        // Now delete the entity itself
+        $this->deleteMetadata();
+        $this->deleteOwnedMetadata();
+        $this->deleteAnnotations();
+        $this->deleteOwnedAnnotations();
+        $this->deleteRelationships();
+        $this->deleteAccessCollectionMemberships();
+        $this->deleteOwnedAccessCollections();
+
+        access_show_hidden_entities($entity_disable_override);
+        elgg_set_ignore_access($ia);
+
+        _elgg_delete_river(['subject_guid' => $guid]);
+        _elgg_delete_river(['object_guid' => $guid]);
+        _elgg_delete_river(['target_guid' => $guid]);
+        remove_all_private_settings($guid);
+
+        _elgg_invalidate_cache_for_entity($guid);
+        _elgg_invalidate_memcache_for_entity($guid);
+
+        $dbprefix = elgg_get_config('dbprefix');
 		
-		$sql = "
+        $sql = "
 			DELETE FROM {$dbprefix}entities
 			WHERE guid = :guid
 		";
-		$params = [
-			':guid' => $guid,
-		];
+        $params = [
+            ':guid' => $guid,
+        ];
 
-		$deleted = $this->getDatabase()->deleteData($sql, $params);
+        $deleted = $this->getDatabase()->deleteData($sql, $params);
 
-		if ($deleted && in_array($this->type, ['object', 'user', 'group', 'site'])) {
-			// delete from type-specific subtable
-			$sql = "
+        if ($deleted && in_array($this->type, ['object', 'user', 'group', 'site'])) {
+            // delete from type-specific subtable
+            $sql = "
 				DELETE FROM {$dbprefix}{$this->type}s_entity
 				WHERE guid = :guid
 			";
-			$this->getDatabase()->deleteData($sql, $params);
-		}
+            $this->getDatabase()->deleteData($sql, $params);
+        }
 		
-		_elgg_clear_entity_files($this);
-
-		return (bool) $deleted;
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function toObject() {
-		$object = $this->prepareObject(new \stdClass());
-		$params = ['entity' => $this];
-		$object = _elgg_services()->hooks->trigger('to:object', 'entity', $params, $object);
-		return $object;
-	}
-
-	/**
-	 * Prepare an object copy for toObject()
-	 *
-	 * @param \stdClass $object Object representation of the entity
-	 * @return \stdClass
-	 */
-	protected function prepareObject($object) {
-		$object->guid = $this->guid;
-		$object->type = $this->getType();
-		$object->subtype = $this->getSubtype();
-		$object->owner_guid = $this->getOwnerGUID();
-		$object->container_guid = $this->getContainerGUID();
-		$object->time_created = date('c', $this->getTimeCreated());
-		$object->time_updated = date('c', $this->getTimeUpdated());
-		$object->url = $this->getURL();
-		$object->read_access = (int) $this->access_id;
-		return $object;
-	}
-
-	/*
+        _elgg_clear_entity_files($this);
+
+        return (bool) $deleted;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toObject() {
+        $object = $this->prepareObject(new \stdClass());
+        $params = ['entity' => $this];
+        $object = _elgg_services()->hooks->trigger('to:object', 'entity', $params, $object);
+        return $object;
+    }
+
+    /**
+     * Prepare an object copy for toObject()
+     *
+     * @param \stdClass $object Object representation of the entity
+     * @return \stdClass
+     */
+    protected function prepareObject($object) {
+        $object->guid = $this->guid;
+        $object->type = $this->getType();
+        $object->subtype = $this->getSubtype();
+        $object->owner_guid = $this->getOwnerGUID();
+        $object->container_guid = $this->getContainerGUID();
+        $object->time_created = date('c', $this->getTimeCreated());
+        $object->time_updated = date('c', $this->getTimeUpdated());
+        $object->url = $this->getURL();
+        $object->read_access = (int) $this->access_id;
+        return $object;
+    }
+
+    /*
 	 * LOCATABLE INTERFACE
 	 */
 
-	/**
-	 * Gets the 'location' metadata for the entity
-	 *
-	 * @return string The location
-	 */
-	public function getLocation() {
-		return $this->location;
-	}
-
-	/**
-	 * Sets the 'location' metadata for the entity
-	 *
-	 * @param string $location String representation of the location
-	 *
-	 * @return void
-	 */
-	public function setLocation($location) {
-		$this->location = $location;
-	}
-
-	/**
-	 * Set latitude and longitude metadata tags for a given entity.
-	 *
-	 * @param float $lat  Latitude
-	 * @param float $long Longitude
-	 *
-	 * @return void
-	 * @todo Unimplemented
-	 */
-	public function setLatLong($lat, $long) {
-		$this->{"geo:lat"} = $lat;
-		$this->{"geo:long"} = $long;
-	}
-
-	/**
-	 * Return the entity's latitude.
-	 *
-	 * @return float
-	 * @todo Unimplemented
-	 */
-	public function getLatitude() {
-		return (float) $this->{"geo:lat"};
-	}
-
-	/**
-	 * Return the entity's longitude
-	 *
-	 * @return float
-	 * @todo Unimplemented
-	 */
-	public function getLongitude() {
-		return (float) $this->{"geo:long"};
-	}
-
-	/*
+    /**
+     * Gets the 'location' metadata for the entity
+     *
+     * @return string The location
+     */
+    public function getLocation() {
+        return $this->location;
+    }
+
+    /**
+     * Sets the 'location' metadata for the entity
+     *
+     * @param string $location String representation of the location
+     *
+     * @return void
+     */
+    public function setLocation($location) {
+        $this->location = $location;
+    }
+
+    /**
+     * Set latitude and longitude metadata tags for a given entity.
+     *
+     * @param float $lat  Latitude
+     * @param float $long Longitude
+     *
+     * @return void
+     * @todo Unimplemented
+     */
+    public function setLatLong($lat, $long) {
+        $this->{"geo:lat"} = $lat;
+        $this->{"geo:long"} = $long;
+    }
+
+    /**
+     * Return the entity's latitude.
+     *
+     * @return float
+     * @todo Unimplemented
+     */
+    public function getLatitude() {
+        return (float) $this->{"geo:lat"};
+    }
+
+    /**
+     * Return the entity's longitude
+     *
+     * @return float
+     * @todo Unimplemented
+     */
+    public function getLongitude() {
+        return (float) $this->{"geo:long"};
+    }
+
+    /*
 	 * SYSTEM LOG INTERFACE
 	 */
 
-	/**
-	 * Return an identification for the object for storage in the system log.
-	 * This id must be an integer.
-	 *
-	 * @return int
-	 */
-	public function getSystemLogID() {
-		return $this->getGUID();
-	}
-
-	/**
-	 * For a given ID, return the object associated with it.
-	 * This is used by the system log. It can be called on any Loggable object.
-	 *
-	 * @param int $id GUID.
-	 * @return int GUID
-	 */
-	public function getObjectFromID($id) {
-		return get_entity($id);
-	}
-
-	/**
-	 * Returns tags for this entity.
-	 *
-	 * @warning Tags must be registered by {@link elgg_register_tag_metadata_name()}.
-	 *
-	 * @param array $tag_names Optionally restrict by tag metadata names.
-	 *
-	 * @return array
-	 */
-	public function getTags($tag_names = null) {
-		if ($tag_names && !is_array($tag_names)) {
-			$tag_names = [$tag_names];
-		}
-
-		$valid_tags = elgg_get_registered_tag_metadata_names();
-		$entity_tags = [];
-
-		foreach ($valid_tags as $tag_name) {
-			if (is_array($tag_names) && !in_array($tag_name, $tag_names)) {
-				continue;
-			}
-
-			if ($tags = $this->$tag_name) {
-				// if a single tag, metadata returns a string.
-				// if multiple tags, metadata returns an array.
-				if (is_array($tags)) {
-					$entity_tags = array_merge($entity_tags, $tags);
-				} else {
-					$entity_tags[] = $tags;
-				}
-			}
-		}
-
-		return $entity_tags;
-	}
+    /**
+     * Return an identification for the object for storage in the system log.
+     * This id must be an integer.
+     *
+     * @return int
+     */
+    public function getSystemLogID() {
+        return $this->getGUID();
+    }
+
+    /**
+     * For a given ID, return the object associated with it.
+     * This is used by the system log. It can be called on any Loggable object.
+     *
+     * @param int $id GUID.
+     * @return int GUID
+     */
+    public function getObjectFromID($id) {
+        return get_entity($id);
+    }
+
+    /**
+     * Returns tags for this entity.
+     *
+     * @warning Tags must be registered by {@link elgg_register_tag_metadata_name()}.
+     *
+     * @param array $tag_names Optionally restrict by tag metadata names.
+     *
+     * @return array
+     */
+    public function getTags($tag_names = null) {
+        if ($tag_names && !is_array($tag_names)) {
+            $tag_names = [$tag_names];
+        }
+
+        $valid_tags = elgg_get_registered_tag_metadata_names();
+        $entity_tags = [];
+
+        foreach ($valid_tags as $tag_name) {
+            if (is_array($tag_names) && !in_array($tag_name, $tag_names)) {
+                continue;
+            }
+
+            if ($tags = $this->$tag_name) {
+                // if a single tag, metadata returns a string.
+                // if multiple tags, metadata returns an array.
+                if (is_array($tags)) {
+                    $entity_tags = array_merge($entity_tags, $tags);
+                } else {
+                    $entity_tags[] = $tags;
+                }
+            }
+        }
+
+        return $entity_tags;
+    }
 	
-	/**
-	 * Remove the membership of all access collections for this entity (if the entity is a user)
-	 *
-	 * @return bool
-	 * @since 1.11
-	 */
-	public function deleteAccessCollectionMemberships() {
+    /**
+     * Remove the membership of all access collections for this entity (if the entity is a user)
+     *
+     * @return bool
+     * @since 1.11
+     */
+    public function deleteAccessCollectionMemberships() {
 	
-		if (!$this->guid) {
-			return false;
-		}
+        if (!$this->guid) {
+            return false;
+        }
 		
-		if ($this->type !== 'user') {
-			return true;
-		}
+        if ($this->type !== 'user') {
+            return true;
+        }
 		
-		$ac = _elgg_services()->accessCollections;
+        $ac = _elgg_services()->accessCollections;
 		
-		$collections = $ac->getCollectionsByMember($this->guid);
-		if (empty($collections)) {
-			return true;
-		}
+        $collections = $ac->getCollectionsByMember($this->guid);
+        if (empty($collections)) {
+            return true;
+        }
 		
-		$result = true;
-		foreach ($collections as $collection) {
-			$result = $result & $ac->removeUser($this->guid, $collection->id);
-		}
+        $result = true;
+        foreach ($collections as $collection) {
+            $result = $result & $ac->removeUser($this->guid, $collection->id);
+        }
 		
-		return $result;
-	}
+        return $result;
+    }
 	
-	/**
-	 * Remove all access collections owned by this entity
-	 *
-	 * @return bool
-	 * @since 1.11
-	 */
-	public function deleteOwnedAccessCollections() {
+    /**
+     * Remove all access collections owned by this entity
+     *
+     * @return bool
+     * @since 1.11
+     */
+    public function deleteOwnedAccessCollections() {
 		
-		if (!$this->guid) {
-			return false;
-		}
+        if (!$this->guid) {
+            return false;
+        }
 		
-		$ac = _elgg_services()->accessCollections;
+        $ac = _elgg_services()->accessCollections;
 		
-		$collections = $ac->getEntityCollections($this->guid);
-		if (empty($collections)) {
-			return true;
-		}
+        $collections = $ac->getEntityCollections($this->guid);
+        if (empty($collections)) {
+            return true;
+        }
 		
-		$result = true;
-		foreach ($collections as $collection) {
-			$result = $result & $ac->delete($collection->id);
-		}
+        $result = true;
+        foreach ($collections as $collection) {
+            $result = $result & $ac->delete($collection->id);
+        }
 		
-		return $result;
-	}
-
-	/**
-	 * Update the last_action column in the entities table.
-	 *
-	 * @warning This is different to time_updated.  Time_updated is automatically set,
-	 * while last_action is only set when explicitly called.
-	 *
-	 * @param int $posted Timestamp of last action
-	 * @return int|false
-	 * @access private
-	 */
-	public function updateLastAction($posted = null) {
-		$posted = _elgg_services()->entityTable->updateLastAction($this, $posted);
-		if ($posted) {
-			$this->attributes['last_action'] = $posted;
-			_elgg_services()->entityCache->set($this);
-			$this->storeInPersistedCache(_elgg_get_memcache('new_entity_cache'));
-		}
-		return $posted;
-	}
+        return $result;
+    }
+
+    /**
+     * Update the last_action column in the entities table.
+     *
+     * @warning This is different to time_updated.  Time_updated is automatically set,
+     * while last_action is only set when explicitly called.
+     *
+     * @param int $posted Timestamp of last action
+     * @return int|false
+     * @access private
+     */
+    public function updateLastAction($posted = null) {
+        $posted = _elgg_services()->entityTable->updateLastAction($this, $posted);
+        if ($posted) {
+            $this->attributes['last_action'] = $posted;
+            _elgg_services()->entityCache->set($this);
+            $this->storeInPersistedCache(_elgg_get_memcache('new_entity_cache'));
+        }
+        return $posted;
+    }
 }

engine/classes/Elgg/Cache/EntityCache.php

Indentation +158 added lines, -158 removed lines

@@ -11,164 +11,164 @@
  */
 class EntityCache {
 
-	// @todo Pick a less arbitrary limit
-	const MAX_SIZE = 256;
-
-	/**
-	 * @var ElggEntity[] GUID keys
-	 */
-	private $entities = [];
-
-	/**
-	 * @var bool[] GUID keys
-	 */
-	private $disabled_guids = [];
-
-	/**
-	 * @var ElggSession
-	 */
-	private $session;
-
-	/**
-	 * @var MetadataCache
-	 */
-	private $metadata_cache;
-
-	/**
-	 * @var array
-	 */
-	private $username_cache = [];
+    // @todo Pick a less arbitrary limit
+    const MAX_SIZE = 256;
+
+    /**
+     * @var ElggEntity[] GUID keys
+     */
+    private $entities = [];
+
+    /**
+     * @var bool[] GUID keys
+     */
+    private $disabled_guids = [];
+
+    /**
+     * @var ElggSession
+     */
+    private $session;
+
+    /**
+     * @var MetadataCache
+     */
+    private $metadata_cache;
+
+    /**
+     * @var array
+     */
+    private $username_cache = [];
 	
-	/**
-	 * Constructor
-	 *
-	 * @param ElggSession   $session        Session
-	 * @param MetadataCache $metadata_cache MD cache
-	 */
-	public function __construct(ElggSession $session, MetadataCache $metadata_cache) {
-		$this->session = $session;
-		$this->metadata_cache = $metadata_cache;
-	}
-
-	/**
-	 * Retrieve a entity from the cache.
-	 *
-	 * @param int $guid The GUID
-	 *
-	 * @return \ElggEntity|false false if entity not cached
-	 */
-	public function get($guid) {
-		$guid = (int) $guid;
-
-		if (isset($this->entities[$guid])) {
-			return $this->entities[$guid];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Returns cached user entity by username
-	 *
-	 * @param string $username Username
-	 * @return \ElggUser|false
-	 */
-	public function getByUsername($username) {
-		if (isset($this->username_cache[$username])) {
-			return $this->get($this->username_cache[$username]);
-		}
-		return false;
-	}
-
-	/**
-	 * Cache an entity.
-	 *
-	 * @param ElggEntity $entity Entity to cache
-	 * @return void
-	 */
-	public function set(ElggEntity $entity) {
-		$guid = $entity->guid;
-
-		if (!$guid || isset($this->entities[$guid]) || isset($this->disabled_guids[$guid])) {
-			// have it or not saved
-			return;
-		}
-
-		// Don't cache non-plugin entities while access control is off, otherwise they could be
-		// exposed to users who shouldn't see them when control is re-enabled.
-		if (!($entity instanceof \ElggPlugin) && $this->session->getIgnoreAccess()) {
-			return;
-		}
-
-		// Don't store too many or we'll have memory problems
-		if (count($this->entities) > self::MAX_SIZE) {
-			$this->remove(array_rand($this->entities));
-		}
-
-		$this->entities[$guid] = $entity;
-
-		if ($entity instanceof \ElggUser) {
-			$this->username_cache[$entity->username] = $entity->guid;
-		}
-	}
-
-	/**
-	 * Invalidate this class's entry in the cache.
-	 *
-	 * @param int $guid The entity guid
-	 * @return void
-	 */
-	public function remove($guid) {
-		$guid = (int) $guid;
+    /**
+     * Constructor
+     *
+     * @param ElggSession   $session        Session
+     * @param MetadataCache $metadata_cache MD cache
+     */
+    public function __construct(ElggSession $session, MetadataCache $metadata_cache) {
+        $this->session = $session;
+        $this->metadata_cache = $metadata_cache;
+    }
+
+    /**
+     * Retrieve a entity from the cache.
+     *
+     * @param int $guid The GUID
+     *
+     * @return \ElggEntity|false false if entity not cached
+     */
+    public function get($guid) {
+        $guid = (int) $guid;
+
+        if (isset($this->entities[$guid])) {
+            return $this->entities[$guid];
+        }
+
+        return false;
+    }
+
+    /**
+     * Returns cached user entity by username
+     *
+     * @param string $username Username
+     * @return \ElggUser|false
+     */
+    public function getByUsername($username) {
+        if (isset($this->username_cache[$username])) {
+            return $this->get($this->username_cache[$username]);
+        }
+        return false;
+    }
+
+    /**
+     * Cache an entity.
+     *
+     * @param ElggEntity $entity Entity to cache
+     * @return void
+     */
+    public function set(ElggEntity $entity) {
+        $guid = $entity->guid;
+
+        if (!$guid || isset($this->entities[$guid]) || isset($this->disabled_guids[$guid])) {
+            // have it or not saved
+            return;
+        }
+
+        // Don't cache non-plugin entities while access control is off, otherwise they could be
+        // exposed to users who shouldn't see them when control is re-enabled.
+        if (!($entity instanceof \ElggPlugin) && $this->session->getIgnoreAccess()) {
+            return;
+        }
+
+        // Don't store too many or we'll have memory problems
+        if (count($this->entities) > self::MAX_SIZE) {
+            $this->remove(array_rand($this->entities));
+        }
+
+        $this->entities[$guid] = $entity;
+
+        if ($entity instanceof \ElggUser) {
+            $this->username_cache[$entity->username] = $entity->guid;
+        }
+    }
+
+    /**
+     * Invalidate this class's entry in the cache.
+     *
+     * @param int $guid The entity guid
+     * @return void
+     */
+    public function remove($guid) {
+        $guid = (int) $guid;
 		
-		if (!isset($this->entities[$guid])) {
-			return;
-		}
-
-		unset($this->entities[$guid]);
-
-		$username = array_search($guid, $this->username_cache);
-		if ($username !== false) {
-			unset($this->username_cache[$username]);
-		}
-
-		// Purge separate metadata cache. Original idea was to do in entity destructor, but that would
-		// have caused a bunch of unnecessary purges at every shutdown. Doing it this way we have no way
-		// to know that the expunged entity will be GCed (might be another reference living), but that's
-		// OK; the metadata will reload if necessary.
-		$this->metadata_cache->clear($guid);
-	}
-
-	/**
-	 * Clear the entity cache
-	 *
-	 * @return void
-	 */
-	public function clear() {
-		$this->entities = [];
-		$this->username_cache = [];
-	}
-
-	/**
-	 * Remove this entity from the entity cache and make sure it is not re-added
-	 *
-	 * @todo this is a workaround until #5604 can be implemented
-	 *
-	 * @param int $guid The entity guid
-	 * @return void
-	 */
-	public function disableCachingForEntity($guid) {
-		$this->remove($guid);
-		$this->disabled_guids[$guid] = true;
-	}
-
-	/**
-	 * Allow this entity to be stored in the entity cache
-	 *
-	 * @param int $guid The entity guid
-	 * @return void
-	 */
-	public function enableCachingForEntity($guid) {
-		unset($this->disabled_guids[$guid]);
-	}
+        if (!isset($this->entities[$guid])) {
+            return;
+        }
+
+        unset($this->entities[$guid]);
+
+        $username = array_search($guid, $this->username_cache);
+        if ($username !== false) {
+            unset($this->username_cache[$username]);
+        }
+
+        // Purge separate metadata cache. Original idea was to do in entity destructor, but that would
+        // have caused a bunch of unnecessary purges at every shutdown. Doing it this way we have no way
+        // to know that the expunged entity will be GCed (might be another reference living), but that's
+        // OK; the metadata will reload if necessary.
+        $this->metadata_cache->clear($guid);
+    }
+
+    /**
+     * Clear the entity cache
+     *
+     * @return void
+     */
+    public function clear() {
+        $this->entities = [];
+        $this->username_cache = [];
+    }
+
+    /**
+     * Remove this entity from the entity cache and make sure it is not re-added
+     *
+     * @todo this is a workaround until #5604 can be implemented
+     *
+     * @param int $guid The entity guid
+     * @return void
+     */
+    public function disableCachingForEntity($guid) {
+        $this->remove($guid);
+        $this->disabled_guids[$guid] = true;
+    }
+
+    /**
+     * Allow this entity to be stored in the entity cache
+     *
+     * @param int $guid The entity guid
+     * @return void
+     */
+    public function enableCachingForEntity($guid) {
+        unset($this->disabled_guids[$guid]);
+    }
 }