Elgg / Elgg

engine/lib/access.php

Doc Comments +2 added lines, -2 removed lines

@@ -301,7 +301,7 @@ 
  * @param string $name       The name of the collection.
  * @param int    $owner_guid The GUID of the owner (default: currently logged in user).
  *
- * @return int|false The collection ID if successful and false on failure.
+ * @return integer The collection ID if successful and false on failure.
  * @see update_access_collection()
  * @see delete_access_collection()
  */
@@ -517,7 +517,7 @@ 
  * @param string $type
  * @param array $value
  * @param array $params
- * @return array
+ * @return string[]
  *
  * @access private
  */

Indentation +85 added lines, -85 removed lines

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

engine/classes/ElggInstaller.php

Indentation +1406 added lines, -1406 removed lines

@@ -34,1414 +34,1414 @@
  */
 class ElggInstaller {
 	
-	private $steps = [
-		'welcome',
-		'requirements',
-		'database',
-		'settings',
-		'admin',
-		'complete',
-		];
-
-	private $has_completed = [
-		'config' => false,
-		'database' => false,
-		'settings' => false,
-		'admin' => false,
-	];
-
-	private $is_action = false;
-
-	private $autoLogin = true;
-
-	/**
-	 * @var ServiceProvider
-	 */
-	private $services;
-
-	/**
-	 * @var Config
-	 */
-	private $config;
-
-	/**
-	 * @var Application
-	 */
-	private $app;
-
-	/**
-	 * Dispatches a request to one of the step controllers
-	 *
-	 * @return void
-	 * @throws InstallationException
-	 */
-	public function run() {
-		$this->getApp();
-
-		$this->is_action = $this->services->request->getMethod() === 'POST';
-
-		$step = get_input('step', 'welcome');
-
-		if (!in_array($step, $this->getSteps())) {
-			$msg = elgg_echo('InstallationException:UnknownStep', [$step]);
-			throw new InstallationException($msg);
-		}
-
-		$this->determineInstallStatus();
+    private $steps = [
+        'welcome',
+        'requirements',
+        'database',
+        'settings',
+        'admin',
+        'complete',
+        ];
+
+    private $has_completed = [
+        'config' => false,
+        'database' => false,
+        'settings' => false,
+        'admin' => false,
+    ];
+
+    private $is_action = false;
+
+    private $autoLogin = true;
+
+    /**
+     * @var ServiceProvider
+     */
+    private $services;
+
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @var Application
+     */
+    private $app;
+
+    /**
+     * Dispatches a request to one of the step controllers
+     *
+     * @return void
+     * @throws InstallationException
+     */
+    public function run() {
+        $this->getApp();
+
+        $this->is_action = $this->services->request->getMethod() === 'POST';
+
+        $step = get_input('step', 'welcome');
+
+        if (!in_array($step, $this->getSteps())) {
+            $msg = elgg_echo('InstallationException:UnknownStep', [$step]);
+            throw new InstallationException($msg);
+        }
+
+        $this->determineInstallStatus();
 	
-		$this->checkInstallCompletion($step);
-
-		// check if this is an install being resumed
-		$this->resumeInstall($step);
-
-		$this->finishBootstrapping($step);
-
-		$params = $this->services->request->request->all();
-
-		$method = "run" . ucwords($step);
-		$this->$method($params);
-	}
-
-	/**
-	 * Build the application needed by the installer
-	 *
-	 * @return Application
-	 * @throws InstallationException
-	 */
-	protected function getApp() {
-		if ($this->app) {
-			return $this->app;
-		}
-
-		$config = new Config();
-		$config->elgg_config_locks = false;
-		$config->installer_running = true;
-		$config->dbencoding = 'utf8mb4';
-
-		$this->config = $config;
-		$this->services = new ServiceProvider($config);
-
-		$app = Application::factory([
-			'service_provider' => $this->services,
-			'handle_exceptions' => false,
-			'handle_shutdown' => false,
-		]);
-
-		// Don't set global $CONFIG, because loading the settings file may require it to write to
-		// it, and it can have array sets (e.g. cookie config) that fail when using a proxy for
-		// the config service.
-		//$app->setGlobalConfig();
-
-		Application::setInstance($app);
-		$app->loadCore();
-		$this->app = $app;
-
-		$this->services->setValue('session', \ElggSession::getMock());
-		$this->services->views->setViewtype('installation');
-		$this->services->views->registerPluginViews(Paths::elgg());
-		$this->services->translator->registerTranslations(Paths::elgg() . "install/languages/", true);
-
-		return $this->app;
-	}
-
-	/**
-	 * Set the auto login flag
-	 *
-	 * @param bool $flag Auto login
-	 *
-	 * @return void
-	 */
-	public function setAutoLogin($flag) {
-		$this->autoLogin = (bool) $flag;
-	}
-
-	/**
-	 * A batch install of Elgg
-	 *
-	 * All required parameters must be passed in as an associative array. See
-	 * $requiredParams for a list of them. This creates the necessary files,
-	 * loads the database, configures the site settings, and creates the admin
-	 * account. If it fails, an exception is thrown. It does not check any of
-	 * the requirements as the multiple step web installer does.
-	 *
-	 * @param array $params          Array of key value pairs
-	 * @param bool  $create_htaccess Should .htaccess be created
-	 *
-	 * @return void
-	 * @throws InstallationException
-	 */
-	public function batchInstall(array $params, $create_htaccess = false) {
-		$this->getApp();
-
-		$defaults = [
-			'dbhost' => 'localhost',
-			'dbprefix' => 'elgg_',
-			'language' => 'en',
-			'siteaccess' => ACCESS_PUBLIC,
-		];
-		$params = array_merge($defaults, $params);
-
-		$required_params = [
-			'dbuser',
-			'dbpassword',
-			'dbname',
-			'sitename',
-			'wwwroot',
-			'dataroot',
-			'displayname',
-			'email',
-			'username',
-			'password',
-		];
-		foreach ($required_params as $key) {
-			if (empty($params[$key])) {
-				$msg = elgg_echo('install:error:requiredfield', [$key]);
-				throw new InstallationException($msg);
-			}
-		}
-
-		// password is passed in once
-		$params['password1'] = $params['password2'] = $params['password'];
-
-		if ($create_htaccess) {
-			$rewrite_tester = new ElggRewriteTester();
-			if (!$rewrite_tester->createHtaccess($params['wwwroot'])) {
-				throw new InstallationException(elgg_echo('install:error:htaccess'));
-			}
-		}
-
-		$this->determineInstallStatus();
-
-		if (!$this->has_completed['config']) {
-			if (!$this->createSettingsFile($params)) {
-				throw new InstallationException(elgg_echo('install:error:settings'));
-			}
-		}
-
-		$this->loadSettingsFile();
-
-		// Make sure settings file matches parameters
-		$config = $this->config;
-		$config_keys = [
-			// param key => config key
-			'dbhost' => 'dbhost',
-			'dbuser' => 'dbuser',
-			'dbpassword' => 'dbpass',
-			'dbname' => 'dbname',
-			'dataroot' => 'dataroot',
-			'dbprefix' => 'dbprefix',
-		];
-		foreach ($config_keys as $params_key => $config_key) {
-			if ($params[$params_key] !== $config->$config_key) {
-				throw new InstallationException(elgg_echo('install:error:settings_mismatch', [$config_key]));
-			}
-		}
-
-		if (!$this->connectToDatabase()) {
-			throw new InstallationException(elgg_echo('install:error:databasesettings'));
-		}
-
-		if (!$this->has_completed['database']) {
-			if (!$this->installDatabase()) {
-				throw new InstallationException(elgg_echo('install:error:cannotloadtables'));
-			}
-		}
-
-		// load remaining core libraries
-		$this->finishBootstrapping('settings');
-
-		if (!$this->saveSiteSettings($params)) {
-			throw new InstallationException(elgg_echo('install:error:savesitesettings'));
-		}
-
-		if (!$this->createAdminAccount($params)) {
-			throw new InstallationException(elgg_echo('install:admin:cannot_create'));
-		}
-	}
-
-	/**
-	 * Renders the data passed by a controller
-	 *
-	 * @param string $step The current step
-	 * @param array  $vars Array of vars to pass to the view
-	 *
-	 * @return void
-	 */
-	protected function render($step, $vars = []) {
-		$vars['next_step'] = $this->getNextStep($step);
-
-		$title = elgg_echo("install:$step");
-		$body = elgg_view("install/pages/$step", $vars);
+        $this->checkInstallCompletion($step);
+
+        // check if this is an install being resumed
+        $this->resumeInstall($step);
+
+        $this->finishBootstrapping($step);
+
+        $params = $this->services->request->request->all();
+
+        $method = "run" . ucwords($step);
+        $this->$method($params);
+    }
+
+    /**
+     * Build the application needed by the installer
+     *
+     * @return Application
+     * @throws InstallationException
+     */
+    protected function getApp() {
+        if ($this->app) {
+            return $this->app;
+        }
+
+        $config = new Config();
+        $config->elgg_config_locks = false;
+        $config->installer_running = true;
+        $config->dbencoding = 'utf8mb4';
+
+        $this->config = $config;
+        $this->services = new ServiceProvider($config);
+
+        $app = Application::factory([
+            'service_provider' => $this->services,
+            'handle_exceptions' => false,
+            'handle_shutdown' => false,
+        ]);
+
+        // Don't set global $CONFIG, because loading the settings file may require it to write to
+        // it, and it can have array sets (e.g. cookie config) that fail when using a proxy for
+        // the config service.
+        //$app->setGlobalConfig();
+
+        Application::setInstance($app);
+        $app->loadCore();
+        $this->app = $app;
+
+        $this->services->setValue('session', \ElggSession::getMock());
+        $this->services->views->setViewtype('installation');
+        $this->services->views->registerPluginViews(Paths::elgg());
+        $this->services->translator->registerTranslations(Paths::elgg() . "install/languages/", true);
+
+        return $this->app;
+    }
+
+    /**
+     * Set the auto login flag
+     *
+     * @param bool $flag Auto login
+     *
+     * @return void
+     */
+    public function setAutoLogin($flag) {
+        $this->autoLogin = (bool) $flag;
+    }
+
+    /**
+     * A batch install of Elgg
+     *
+     * All required parameters must be passed in as an associative array. See
+     * $requiredParams for a list of them. This creates the necessary files,
+     * loads the database, configures the site settings, and creates the admin
+     * account. If it fails, an exception is thrown. It does not check any of
+     * the requirements as the multiple step web installer does.
+     *
+     * @param array $params          Array of key value pairs
+     * @param bool  $create_htaccess Should .htaccess be created
+     *
+     * @return void
+     * @throws InstallationException
+     */
+    public function batchInstall(array $params, $create_htaccess = false) {
+        $this->getApp();
+
+        $defaults = [
+            'dbhost' => 'localhost',
+            'dbprefix' => 'elgg_',
+            'language' => 'en',
+            'siteaccess' => ACCESS_PUBLIC,
+        ];
+        $params = array_merge($defaults, $params);
+
+        $required_params = [
+            'dbuser',
+            'dbpassword',
+            'dbname',
+            'sitename',
+            'wwwroot',
+            'dataroot',
+            'displayname',
+            'email',
+            'username',
+            'password',
+        ];
+        foreach ($required_params as $key) {
+            if (empty($params[$key])) {
+                $msg = elgg_echo('install:error:requiredfield', [$key]);
+                throw new InstallationException($msg);
+            }
+        }
+
+        // password is passed in once
+        $params['password1'] = $params['password2'] = $params['password'];
+
+        if ($create_htaccess) {
+            $rewrite_tester = new ElggRewriteTester();
+            if (!$rewrite_tester->createHtaccess($params['wwwroot'])) {
+                throw new InstallationException(elgg_echo('install:error:htaccess'));
+            }
+        }
+
+        $this->determineInstallStatus();
+
+        if (!$this->has_completed['config']) {
+            if (!$this->createSettingsFile($params)) {
+                throw new InstallationException(elgg_echo('install:error:settings'));
+            }
+        }
+
+        $this->loadSettingsFile();
+
+        // Make sure settings file matches parameters
+        $config = $this->config;
+        $config_keys = [
+            // param key => config key
+            'dbhost' => 'dbhost',
+            'dbuser' => 'dbuser',
+            'dbpassword' => 'dbpass',
+            'dbname' => 'dbname',
+            'dataroot' => 'dataroot',
+            'dbprefix' => 'dbprefix',
+        ];
+        foreach ($config_keys as $params_key => $config_key) {
+            if ($params[$params_key] !== $config->$config_key) {
+                throw new InstallationException(elgg_echo('install:error:settings_mismatch', [$config_key]));
+            }
+        }
+
+        if (!$this->connectToDatabase()) {
+            throw new InstallationException(elgg_echo('install:error:databasesettings'));
+        }
+
+        if (!$this->has_completed['database']) {
+            if (!$this->installDatabase()) {
+                throw new InstallationException(elgg_echo('install:error:cannotloadtables'));
+            }
+        }
+
+        // load remaining core libraries
+        $this->finishBootstrapping('settings');
+
+        if (!$this->saveSiteSettings($params)) {
+            throw new InstallationException(elgg_echo('install:error:savesitesettings'));
+        }
+
+        if (!$this->createAdminAccount($params)) {
+            throw new InstallationException(elgg_echo('install:admin:cannot_create'));
+        }
+    }
+
+    /**
+     * Renders the data passed by a controller
+     *
+     * @param string $step The current step
+     * @param array  $vars Array of vars to pass to the view
+     *
+     * @return void
+     */
+    protected function render($step, $vars = []) {
+        $vars['next_step'] = $this->getNextStep($step);
+
+        $title = elgg_echo("install:$step");
+        $body = elgg_view("install/pages/$step", $vars);
 				
-		echo elgg_view_page(
-				$title,
-				$body,
-				'default',
-				[
-					'step' => $step,
-					'steps' => $this->getSteps(),
-					]
-				);
-		exit;
-	}
-
-	/**
-	 * Step controllers
-	 */
-
-	/**
-	 * Welcome controller
-	 *
-	 * @param array $vars Not used
-	 *
-	 * @return void
-	 */
-	protected function runWelcome($vars) {
-		$this->render('welcome');
-	}
-
-	/**
-	 * Requirements controller
-	 *
-	 * Checks version of php, libraries, permissions, and rewrite rules
-	 *
-	 * @param array $vars Vars
-	 *
-	 * @return void
-	 */
-	protected function runRequirements($vars) {
-
-		$report = [];
-
-		// check PHP parameters and libraries
-		$this->checkPHP($report);
-
-		// check URL rewriting
-		$this->checkRewriteRules($report);
-
-		// check for existence of settings file
-		if ($this->checkSettingsFile($report) != true) {
-			// no file, so check permissions on engine directory
-			$this->isInstallDirWritable($report);
-		}
-
-		// check the database later
-		$report['database'] = [[
-			'severity' => 'info',
-			'message' => elgg_echo('install:check:database')
-		]];
-
-		// any failures?
-		$numFailures = $this->countNumConditions($report, 'failure');
-
-		// any warnings
-		$numWarnings = $this->countNumConditions($report, 'warning');
-
-
-		$params = [
-			'report' => $report,
-			'num_failures' => $numFailures,
-			'num_warnings' => $numWarnings,
-		];
-
-		$this->render('requirements', $params);
-	}
-
-	/**
-	 * Database set up controller
-	 *
-	 * Creates the settings.php file and creates the database tables
-	 *
-	 * @param array $submissionVars Submitted form variables
-	 *
-	 * @return void
-	 */
-	protected function runDatabase($submissionVars) {
-
-		$formVars = [
-			'dbuser' => [
-				'type' => 'text',
-				'value' => '',
-				'required' => true,
-				],
-			'dbpassword' => [
-				'type' => 'password',
-				'value' => '',
-				'required' => false,
-				],
-			'dbname' => [
-				'type' => 'text',
-				'value' => '',
-				'required' => true,
-				],
-			'dbhost' => [
-				'type' => 'text',
-				'value' => 'localhost',
-				'required' => true,
-				],
-			'dbprefix' => [
-				'type' => 'text',
-				'value' => 'elgg_',
-				'required' => true,
-				],
-			'dataroot' => [
-				'type' => 'text',
-				'value' => '',
-				'required' => true,
-			],
-			'wwwroot' => [
-				'type' => 'url',
-				'value' => _elgg_services()->config->wwwroot,
-				'required' => true,
-			],
-			'timezone' => [
-				'type' => 'dropdown',
-				'value' => 'UTC',
-				'options' => \DateTimeZone::listIdentifiers(),
-				'required' => true
-			]
-		];
-
-		if ($this->checkSettingsFile()) {
-			// user manually created settings file so we fake out action test
-			$this->is_action = true;
-		}
-
-		if ($this->is_action) {
-			call_user_func(function () use ($submissionVars, $formVars) {
-				// only create settings file if it doesn't exist
-				if (!$this->checkSettingsFile()) {
-					if (!$this->validateDatabaseVars($submissionVars, $formVars)) {
-						// error so we break out of action and serve same page
-						return;
-					}
-
-					if (!$this->createSettingsFile($submissionVars)) {
-						return;
-					}
-				}
-
-				// check db version and connect
-				if (!$this->connectToDatabase()) {
-					return;
-				}
-
-				if (!$this->installDatabase()) {
-					return;
-				}
-
-				system_message(elgg_echo('install:success:database'));
-
-				$this->continueToNextStep('database');
-			});
-		}
-
-		$formVars = $this->makeFormSticky($formVars, $submissionVars);
-
-		$params = ['variables' => $formVars,];
-
-		if ($this->checkSettingsFile()) {
-			// settings file exists and we're here so failed to create database
-			$params['failure'] = true;
-		}
-
-		$this->render('database', $params);
-	}
-
-	/**
-	 * Site settings controller
-	 *
-	 * Sets the site name, URL, data directory, etc.
-	 *
-	 * @param array $submissionVars Submitted vars
-	 *
-	 * @return void
-	 */
-	protected function runSettings($submissionVars) {
-		$formVars = [
-			'sitename' => [
-				'type' => 'text',
-				'value' => 'My New Community',
-				'required' => true,
-				],
-			'siteemail' => [
-				'type' => 'email',
-				'value' => '',
-				'required' => false,
-				],
-			'siteaccess' => [
-				'type' => 'access',
-				'value' => ACCESS_PUBLIC,
-				'required' => true,
-				],
-		];
-
-		if ($this->is_action) {
-			call_user_func(function () use ($submissionVars, $formVars) {
-				if (!$this->validateSettingsVars($submissionVars, $formVars)) {
-					return;
-				}
-
-				if (!$this->saveSiteSettings($submissionVars)) {
-					return;
-				}
-
-				system_message(elgg_echo('install:success:settings'));
-
-				$this->continueToNextStep('settings');
-			});
-		}
-
-		$formVars = $this->makeFormSticky($formVars, $submissionVars);
-
-		$this->render('settings', ['variables' => $formVars]);
-	}
-
-	/**
-	 * Admin account controller
-	 *
-	 * Creates an admin user account
-	 *
-	 * @param array $submissionVars Submitted vars
-	 *
-	 * @return void
-	 */
-	protected function runAdmin($submissionVars) {
-		$formVars = [
-			'displayname' => [
-				'type' => 'text',
-				'value' => '',
-				'required' => true,
-				],
-			'email' => [
-				'type' => 'email',
-				'value' => '',
-				'required' => true,
-				],
-			'username' => [
-				'type' => 'text',
-				'value' => '',
-				'required' => true,
-				],
-			'password1' => [
-				'type' => 'password',
-				'value' => '',
-				'required' => true,
-				'pattern' => '.{6,}',
-				],
-			'password2' => [
-				'type' => 'password',
-				'value' => '',
-				'required' => true,
-				],
-		];
-
-		if ($this->is_action) {
-			call_user_func(function () use ($submissionVars, $formVars) {
-				if (!$this->validateAdminVars($submissionVars, $formVars)) {
-					return;
-				}
-
-				if (!$this->createAdminAccount($submissionVars, $this->autoLogin)) {
-					return;
-				}
-
-				system_message(elgg_echo('install:success:admin'));
-
-				$this->continueToNextStep('admin');
-			});
-		}
-
-		// Bit of a hack to get the password help to show right number of characters
-		// We burn the value into the stored translation.
-		$lang = $this->services->translator->getCurrentLanguage();
-		$translations = $this->services->translator->getLoadedTranslations();
-		$this->services->translator->addTranslation($lang, [
-			'install:admin:help:password1' => sprintf(
-				$translations[$lang]['install:admin:help:password1'],
-				$this->config->min_password_length
-			),
-		]);
-
-		$formVars = $this->makeFormSticky($formVars, $submissionVars);
-
-		$this->render('admin', ['variables' => $formVars]);
-	}
-
-	/**
-	 * Controller for last step
-	 *
-	 * @return void
-	 */
-	protected function runComplete() {
-
-		// nudge to check out settings
-		$link = elgg_format_element([
-			'#tag_name' => 'a',
-			'#text' => elgg_echo('install:complete:admin_notice:link_text'),
-			'href' => elgg_normalize_url('admin/settings/basic'),
-		]);
-		$notice = elgg_echo('install:complete:admin_notice', [$link]);
-		elgg_add_admin_notice('fresh_install', $notice);
-
-		$this->render('complete');
-	}
-
-	/**
-	 * Step management
-	 */
-
-	/**
-	 * Get an array of steps
-	 *
-	 * @return array
-	 */
-	protected function getSteps() {
-		return $this->steps;
-	}
-
-	/**
-	 * Forwards the browser to the next step
-	 *
-	 * @param string $currentStep Current installation step
-	 *
-	 * @return void
-	 */
-	protected function continueToNextStep($currentStep) {
-		$this->is_action = false;
-		forward($this->getNextStepUrl($currentStep));
-	}
-
-	/**
-	 * Get the next step as a string
-	 *
-	 * @param string $currentStep Current installation step
-	 *
-	 * @return string
-	 */
-	protected function getNextStep($currentStep) {
-		$index = 1 + array_search($currentStep, $this->steps);
-		if (isset($this->steps[$index])) {
-			return $this->steps[$index];
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Get the URL of the next step
-	 *
-	 * @param string $currentStep Current installation step
-	 *
-	 * @return string
-	 */
-	protected function getNextStepUrl($currentStep) {
-		$nextStep = $this->getNextStep($currentStep);
-		return $this->config->wwwroot . "install.php?step=$nextStep";
-	}
-
-	/**
-	 * Updates $this->has_completed according to the current installation
-	 *
-	 * @return void
-	 * @throws InstallationException
-	 */
-	protected function determineInstallStatus() {
-		$path = Paths::settingsFile();
-		if (!is_file($path) || !is_readable($path)) {
-			return;
-		}
-
-		$this->loadSettingsFile();
-
-		$this->has_completed['config'] = true;
-
-		// must be able to connect to database to jump install steps
-		$dbSettingsPass = $this->checkDatabaseSettings(
-			$this->config->dbuser,
-			$this->config->dbpass,
-			$this->config->dbname,
-			$this->config->dbhost
-		);
-
-		if (!$dbSettingsPass) {
-			return;
-		}
-
-		$db = $this->services->db;
-
-		// check that the config table has been created
-		$result = $db->getData("SHOW TABLES");
-		if ($result) {
-			foreach ($result as $table) {
-				$table = (array) $table;
-				if (in_array("{$db->prefix}config", $table)) {
-					$this->has_completed['database'] = true;
-				}
-			}
-			if ($this->has_completed['database'] == false) {
-				return;
-			}
-		} else {
-			// no tables
-			return;
-		}
-
-		// check that the config table has entries
-		$query = "SELECT COUNT(*) AS total FROM {$db->prefix}config";
-		$result = $db->getData($query);
-		if ($result && $result[0]->total > 0) {
-			$this->has_completed['settings'] = true;
-		} else {
-			return;
-		}
-
-		// check that the users entity table has an entry
-		$query = "SELECT COUNT(*) AS total FROM {$db->prefix}users_entity";
-		$result = $db->getData($query);
-		if ($result && $result[0]->total > 0) {
-			$this->has_completed['admin'] = true;
-		} else {
-			return;
-		}
-	}
-
-	/**
-	 * Security check to ensure the installer cannot be run after installation
-	 * has finished. If this is detected, the viewer is sent to the front page.
-	 *
-	 * @param string $step Installation step to check against
-	 *
-	 * @return void
-	 */
-	protected function checkInstallCompletion($step) {
-		if ($step != 'complete') {
-			if (!in_array(false, $this->has_completed)) {
-				// install complete but someone is trying to view an install page
-				forward();
-			}
-		}
-	}
-
-	/**
-	 * Check if this is a case of a install being resumed and figure
-	 * out where to continue from. Returns the best guess on the step.
-	 *
-	 * @param string $step Installation step to resume from
-	 *
-	 * @return string
-	 */
-	protected function resumeInstall($step) {
-		// only do a resume from the first step
-		if ($step !== 'welcome') {
-			return;
-		}
-
-		if ($this->has_completed['database'] == false) {
-			return;
-		}
-
-		if ($this->has_completed['settings'] == false) {
-			forward("install.php?step=settings");
-		}
-
-		if ($this->has_completed['admin'] == false) {
-			forward("install.php?step=admin");
-		}
-
-		// everything appears to be set up
-		forward("install.php?step=complete");
-	}
-
-	/**
-	 * Bootstrapping
-	 */
-
-	/**
-	 * Load remaining engine libraries and complete bootstrapping
-	 *
-	 * @param string $step Which step to boot strap for. Required because
-	 *                     boot strapping is different until the DB is populated.
-	 *
-	 * @return void
-	 * @throws InstallationException
-	 */
-	protected function finishBootstrapping($step) {
-
-		$index_db = array_search('database', $this->getSteps());
-		$index_settings = array_search('settings', $this->getSteps());
-		$index_admin = array_search('admin', $this->getSteps());
-		$index_complete = array_search('complete', $this->getSteps());
-		$index_step = array_search($step, $this->getSteps());
-
-		// To log in the user, we need to use the Elgg core session handling.
-		// Otherwise, use default php session handling
-		$use_elgg_session = ($index_step == $index_admin && $this->is_action) || ($index_step == $index_complete);
-		if (!$use_elgg_session) {
-			$session = ElggSession::fromFiles($this->config);
-			$session->setName('Elgg_install');
-			$this->services->setValue('session', $session);
-		}
-
-		if ($index_step > $index_db) {
-			// once the database has been created, load rest of engine
-
-			// dummy site needed to boot
-			$this->config->site = new ElggSite();
-
-			$this->app->bootCore();
-		}
-	}
-
-	/**
-	 * Load settings
-	 *
-	 * @return void
-	 * @throws InstallationException
-	 */
-	protected function loadSettingsFile() {
-		try {
-			$config = Config::fromFile(Paths::settingsFile());
-			$this->config->mergeValues($config->getValues());
-
-			// in case the DB instance is already captured in services, we re-inject its settings.
-			$this->services->db->resetConnections(DbConfig::fromElggConfig($this->config));
-		} catch (\Exception $e) {
-			$msg = elgg_echo('InstallationException:CannotLoadSettings');
-			throw new InstallationException($msg, 0, $e);
-		}
-	}
-
-	/**
-	 * Action handling methods
-	 */
-
-	/**
-	 * If form is reshown, remember previously submitted variables
-	 *
-	 * @param array $formVars       Vars int he form
-	 * @param array $submissionVars Submitted vars
-	 *
-	 * @return array
-	 */
-	protected function makeFormSticky($formVars, $submissionVars) {
-		foreach ($submissionVars as $field => $value) {
-			$formVars[$field]['value'] = $value;
-		}
-		return $formVars;
-	}
-
-	/* Requirement checks support methods */
-
-	/**
-	 * Indicates whether the webserver can add settings.php on its own or not.
-	 *
-	 * @param array $report The requirements report object
-	 *
-	 * @return bool
-	 */
-	protected function isInstallDirWritable(&$report) {
-		if (!is_writable(Paths::projectConfig())) {
-			$msg = elgg_echo('install:check:installdir', [Paths::PATH_TO_CONFIG]);
-			$report['settings'] = [
-				[
-					'severity' => 'failure',
-					'message' => $msg,
-				]
-			];
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Check that the settings file exists
-	 *
-	 * @param array $report The requirements report array
-	 *
-	 * @return bool
-	 */
-	protected function checkSettingsFile(&$report = []) {
-		if (!is_file(Paths::settingsFile())) {
-			return false;
-		}
-
-		if (!is_readable(Paths::settingsFile())) {
-			$report['settings'] = [
-				[
-					'severity' => 'failure',
-					'message' => elgg_echo('install:check:readsettings'),
-				]
-			];
-		}
+        echo elgg_view_page(
+                $title,
+                $body,
+                'default',
+                [
+                    'step' => $step,
+                    'steps' => $this->getSteps(),
+                    ]
+                );
+        exit;
+    }
+
+    /**
+     * Step controllers
+     */
+
+    /**
+     * Welcome controller
+     *
+     * @param array $vars Not used
+     *
+     * @return void
+     */
+    protected function runWelcome($vars) {
+        $this->render('welcome');
+    }
+
+    /**
+     * Requirements controller
+     *
+     * Checks version of php, libraries, permissions, and rewrite rules
+     *
+     * @param array $vars Vars
+     *
+     * @return void
+     */
+    protected function runRequirements($vars) {
+
+        $report = [];
+
+        // check PHP parameters and libraries
+        $this->checkPHP($report);
+
+        // check URL rewriting
+        $this->checkRewriteRules($report);
+
+        // check for existence of settings file
+        if ($this->checkSettingsFile($report) != true) {
+            // no file, so check permissions on engine directory
+            $this->isInstallDirWritable($report);
+        }
+
+        // check the database later
+        $report['database'] = [[
+            'severity' => 'info',
+            'message' => elgg_echo('install:check:database')
+        ]];
+
+        // any failures?
+        $numFailures = $this->countNumConditions($report, 'failure');
+
+        // any warnings
+        $numWarnings = $this->countNumConditions($report, 'warning');
+
+
+        $params = [
+            'report' => $report,
+            'num_failures' => $numFailures,
+            'num_warnings' => $numWarnings,
+        ];
+
+        $this->render('requirements', $params);
+    }
+
+    /**
+     * Database set up controller
+     *
+     * Creates the settings.php file and creates the database tables
+     *
+     * @param array $submissionVars Submitted form variables
+     *
+     * @return void
+     */
+    protected function runDatabase($submissionVars) {
+
+        $formVars = [
+            'dbuser' => [
+                'type' => 'text',
+                'value' => '',
+                'required' => true,
+                ],
+            'dbpassword' => [
+                'type' => 'password',
+                'value' => '',
+                'required' => false,
+                ],
+            'dbname' => [
+                'type' => 'text',
+                'value' => '',
+                'required' => true,
+                ],
+            'dbhost' => [
+                'type' => 'text',
+                'value' => 'localhost',
+                'required' => true,
+                ],
+            'dbprefix' => [
+                'type' => 'text',
+                'value' => 'elgg_',
+                'required' => true,
+                ],
+            'dataroot' => [
+                'type' => 'text',
+                'value' => '',
+                'required' => true,
+            ],
+            'wwwroot' => [
+                'type' => 'url',
+                'value' => _elgg_services()->config->wwwroot,
+                'required' => true,
+            ],
+            'timezone' => [
+                'type' => 'dropdown',
+                'value' => 'UTC',
+                'options' => \DateTimeZone::listIdentifiers(),
+                'required' => true
+            ]
+        ];
+
+        if ($this->checkSettingsFile()) {
+            // user manually created settings file so we fake out action test
+            $this->is_action = true;
+        }
+
+        if ($this->is_action) {
+            call_user_func(function () use ($submissionVars, $formVars) {
+                // only create settings file if it doesn't exist
+                if (!$this->checkSettingsFile()) {
+                    if (!$this->validateDatabaseVars($submissionVars, $formVars)) {
+                        // error so we break out of action and serve same page
+                        return;
+                    }
+
+                    if (!$this->createSettingsFile($submissionVars)) {
+                        return;
+                    }
+                }
+
+                // check db version and connect
+                if (!$this->connectToDatabase()) {
+                    return;
+                }
+
+                if (!$this->installDatabase()) {
+                    return;
+                }
+
+                system_message(elgg_echo('install:success:database'));
+
+                $this->continueToNextStep('database');
+            });
+        }
+
+        $formVars = $this->makeFormSticky($formVars, $submissionVars);
+
+        $params = ['variables' => $formVars,];
+
+        if ($this->checkSettingsFile()) {
+            // settings file exists and we're here so failed to create database
+            $params['failure'] = true;
+        }
+
+        $this->render('database', $params);
+    }
+
+    /**
+     * Site settings controller
+     *
+     * Sets the site name, URL, data directory, etc.
+     *
+     * @param array $submissionVars Submitted vars
+     *
+     * @return void
+     */
+    protected function runSettings($submissionVars) {
+        $formVars = [
+            'sitename' => [
+                'type' => 'text',
+                'value' => 'My New Community',
+                'required' => true,
+                ],
+            'siteemail' => [
+                'type' => 'email',
+                'value' => '',
+                'required' => false,
+                ],
+            'siteaccess' => [
+                'type' => 'access',
+                'value' => ACCESS_PUBLIC,
+                'required' => true,
+                ],
+        ];
+
+        if ($this->is_action) {
+            call_user_func(function () use ($submissionVars, $formVars) {
+                if (!$this->validateSettingsVars($submissionVars, $formVars)) {
+                    return;
+                }
+
+                if (!$this->saveSiteSettings($submissionVars)) {
+                    return;
+                }
+
+                system_message(elgg_echo('install:success:settings'));
+
+                $this->continueToNextStep('settings');
+            });
+        }
+
+        $formVars = $this->makeFormSticky($formVars, $submissionVars);
+
+        $this->render('settings', ['variables' => $formVars]);
+    }
+
+    /**
+     * Admin account controller
+     *
+     * Creates an admin user account
+     *
+     * @param array $submissionVars Submitted vars
+     *
+     * @return void
+     */
+    protected function runAdmin($submissionVars) {
+        $formVars = [
+            'displayname' => [
+                'type' => 'text',
+                'value' => '',
+                'required' => true,
+                ],
+            'email' => [
+                'type' => 'email',
+                'value' => '',
+                'required' => true,
+                ],
+            'username' => [
+                'type' => 'text',
+                'value' => '',
+                'required' => true,
+                ],
+            'password1' => [
+                'type' => 'password',
+                'value' => '',
+                'required' => true,
+                'pattern' => '.{6,}',
+                ],
+            'password2' => [
+                'type' => 'password',
+                'value' => '',
+                'required' => true,
+                ],
+        ];
+
+        if ($this->is_action) {
+            call_user_func(function () use ($submissionVars, $formVars) {
+                if (!$this->validateAdminVars($submissionVars, $formVars)) {
+                    return;
+                }
+
+                if (!$this->createAdminAccount($submissionVars, $this->autoLogin)) {
+                    return;
+                }
+
+                system_message(elgg_echo('install:success:admin'));
+
+                $this->continueToNextStep('admin');
+            });
+        }
+
+        // Bit of a hack to get the password help to show right number of characters
+        // We burn the value into the stored translation.
+        $lang = $this->services->translator->getCurrentLanguage();
+        $translations = $this->services->translator->getLoadedTranslations();
+        $this->services->translator->addTranslation($lang, [
+            'install:admin:help:password1' => sprintf(
+                $translations[$lang]['install:admin:help:password1'],
+                $this->config->min_password_length
+            ),
+        ]);
+
+        $formVars = $this->makeFormSticky($formVars, $submissionVars);
+
+        $this->render('admin', ['variables' => $formVars]);
+    }
+
+    /**
+     * Controller for last step
+     *
+     * @return void
+     */
+    protected function runComplete() {
+
+        // nudge to check out settings
+        $link = elgg_format_element([
+            '#tag_name' => 'a',
+            '#text' => elgg_echo('install:complete:admin_notice:link_text'),
+            'href' => elgg_normalize_url('admin/settings/basic'),
+        ]);
+        $notice = elgg_echo('install:complete:admin_notice', [$link]);
+        elgg_add_admin_notice('fresh_install', $notice);
+
+        $this->render('complete');
+    }
+
+    /**
+     * Step management
+     */
+
+    /**
+     * Get an array of steps
+     *
+     * @return array
+     */
+    protected function getSteps() {
+        return $this->steps;
+    }
+
+    /**
+     * Forwards the browser to the next step
+     *
+     * @param string $currentStep Current installation step
+     *
+     * @return void
+     */
+    protected function continueToNextStep($currentStep) {
+        $this->is_action = false;
+        forward($this->getNextStepUrl($currentStep));
+    }
+
+    /**
+     * Get the next step as a string
+     *
+     * @param string $currentStep Current installation step
+     *
+     * @return string
+     */
+    protected function getNextStep($currentStep) {
+        $index = 1 + array_search($currentStep, $this->steps);
+        if (isset($this->steps[$index])) {
+            return $this->steps[$index];
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Get the URL of the next step
+     *
+     * @param string $currentStep Current installation step
+     *
+     * @return string
+     */
+    protected function getNextStepUrl($currentStep) {
+        $nextStep = $this->getNextStep($currentStep);
+        return $this->config->wwwroot . "install.php?step=$nextStep";
+    }
+
+    /**
+     * Updates $this->has_completed according to the current installation
+     *
+     * @return void
+     * @throws InstallationException
+     */
+    protected function determineInstallStatus() {
+        $path = Paths::settingsFile();
+        if (!is_file($path) || !is_readable($path)) {
+            return;
+        }
+
+        $this->loadSettingsFile();
+
+        $this->has_completed['config'] = true;
+
+        // must be able to connect to database to jump install steps
+        $dbSettingsPass = $this->checkDatabaseSettings(
+            $this->config->dbuser,
+            $this->config->dbpass,
+            $this->config->dbname,
+            $this->config->dbhost
+        );
+
+        if (!$dbSettingsPass) {
+            return;
+        }
+
+        $db = $this->services->db;
+
+        // check that the config table has been created
+        $result = $db->getData("SHOW TABLES");
+        if ($result) {
+            foreach ($result as $table) {
+                $table = (array) $table;
+                if (in_array("{$db->prefix}config", $table)) {
+                    $this->has_completed['database'] = true;
+                }
+            }
+            if ($this->has_completed['database'] == false) {
+                return;
+            }
+        } else {
+            // no tables
+            return;
+        }
+
+        // check that the config table has entries
+        $query = "SELECT COUNT(*) AS total FROM {$db->prefix}config";
+        $result = $db->getData($query);
+        if ($result && $result[0]->total > 0) {
+            $this->has_completed['settings'] = true;
+        } else {
+            return;
+        }
+
+        // check that the users entity table has an entry
+        $query = "SELECT COUNT(*) AS total FROM {$db->prefix}users_entity";
+        $result = $db->getData($query);
+        if ($result && $result[0]->total > 0) {
+            $this->has_completed['admin'] = true;
+        } else {
+            return;
+        }
+    }
+
+    /**
+     * Security check to ensure the installer cannot be run after installation
+     * has finished. If this is detected, the viewer is sent to the front page.
+     *
+     * @param string $step Installation step to check against
+     *
+     * @return void
+     */
+    protected function checkInstallCompletion($step) {
+        if ($step != 'complete') {
+            if (!in_array(false, $this->has_completed)) {
+                // install complete but someone is trying to view an install page
+                forward();
+            }
+        }
+    }
+
+    /**
+     * Check if this is a case of a install being resumed and figure
+     * out where to continue from. Returns the best guess on the step.
+     *
+     * @param string $step Installation step to resume from
+     *
+     * @return string
+     */
+    protected function resumeInstall($step) {
+        // only do a resume from the first step
+        if ($step !== 'welcome') {
+            return;
+        }
+
+        if ($this->has_completed['database'] == false) {
+            return;
+        }
+
+        if ($this->has_completed['settings'] == false) {
+            forward("install.php?step=settings");
+        }
+
+        if ($this->has_completed['admin'] == false) {
+            forward("install.php?step=admin");
+        }
+
+        // everything appears to be set up
+        forward("install.php?step=complete");
+    }
+
+    /**
+     * Bootstrapping
+     */
+
+    /**
+     * Load remaining engine libraries and complete bootstrapping
+     *
+     * @param string $step Which step to boot strap for. Required because
+     *                     boot strapping is different until the DB is populated.
+     *
+     * @return void
+     * @throws InstallationException
+     */
+    protected function finishBootstrapping($step) {
+
+        $index_db = array_search('database', $this->getSteps());
+        $index_settings = array_search('settings', $this->getSteps());
+        $index_admin = array_search('admin', $this->getSteps());
+        $index_complete = array_search('complete', $this->getSteps());
+        $index_step = array_search($step, $this->getSteps());
+
+        // To log in the user, we need to use the Elgg core session handling.
+        // Otherwise, use default php session handling
+        $use_elgg_session = ($index_step == $index_admin && $this->is_action) || ($index_step == $index_complete);
+        if (!$use_elgg_session) {
+            $session = ElggSession::fromFiles($this->config);
+            $session->setName('Elgg_install');
+            $this->services->setValue('session', $session);
+        }
+
+        if ($index_step > $index_db) {
+            // once the database has been created, load rest of engine
+
+            // dummy site needed to boot
+            $this->config->site = new ElggSite();
+
+            $this->app->bootCore();
+        }
+    }
+
+    /**
+     * Load settings
+     *
+     * @return void
+     * @throws InstallationException
+     */
+    protected function loadSettingsFile() {
+        try {
+            $config = Config::fromFile(Paths::settingsFile());
+            $this->config->mergeValues($config->getValues());
+
+            // in case the DB instance is already captured in services, we re-inject its settings.
+            $this->services->db->resetConnections(DbConfig::fromElggConfig($this->config));
+        } catch (\Exception $e) {
+            $msg = elgg_echo('InstallationException:CannotLoadSettings');
+            throw new InstallationException($msg, 0, $e);
+        }
+    }
+
+    /**
+     * Action handling methods
+     */
+
+    /**
+     * If form is reshown, remember previously submitted variables
+     *
+     * @param array $formVars       Vars int he form
+     * @param array $submissionVars Submitted vars
+     *
+     * @return array
+     */
+    protected function makeFormSticky($formVars, $submissionVars) {
+        foreach ($submissionVars as $field => $value) {
+            $formVars[$field]['value'] = $value;
+        }
+        return $formVars;
+    }
+
+    /* Requirement checks support methods */
+
+    /**
+     * Indicates whether the webserver can add settings.php on its own or not.
+     *
+     * @param array $report The requirements report object
+     *
+     * @return bool
+     */
+    protected function isInstallDirWritable(&$report) {
+        if (!is_writable(Paths::projectConfig())) {
+            $msg = elgg_echo('install:check:installdir', [Paths::PATH_TO_CONFIG]);
+            $report['settings'] = [
+                [
+                    'severity' => 'failure',
+                    'message' => $msg,
+                ]
+            ];
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Check that the settings file exists
+     *
+     * @param array $report The requirements report array
+     *
+     * @return bool
+     */
+    protected function checkSettingsFile(&$report = []) {
+        if (!is_file(Paths::settingsFile())) {
+            return false;
+        }
+
+        if (!is_readable(Paths::settingsFile())) {
+            $report['settings'] = [
+                [
+                    'severity' => 'failure',
+                    'message' => elgg_echo('install:check:readsettings'),
+                ]
+            ];
+        }
 		
-		return true;
-	}
+        return true;
+    }
 	
-	/**
-	 * Check version of PHP, extensions, and variables
-	 *
-	 * @param array $report The requirements report array
-	 *
-	 * @return void
-	 */
-	protected function checkPHP(&$report) {
-		$phpReport = [];
-
-		$min_php_version = '5.6.0';
-		if (version_compare(PHP_VERSION, $min_php_version, '<')) {
-			$phpReport[] = [
-				'severity' => 'failure',
-				'message' => elgg_echo('install:check:php:version', [$min_php_version, PHP_VERSION])
-			];
-		}
-
-		$this->checkPhpExtensions($phpReport);
-
-		$this->checkPhpDirectives($phpReport);
-
-		if (count($phpReport) == 0) {
-			$phpReport[] = [
-				'severity' => 'pass',
-				'message' => elgg_echo('install:check:php:success')
-			];
-		}
-
-		$report['php'] = $phpReport;
-	}
-
-	/**
-	 * Check the server's PHP extensions
-	 *
-	 * @param array $phpReport The PHP requirements report array
-	 *
-	 * @return void
-	 */
-	protected function checkPhpExtensions(&$phpReport) {
-		$extensions = get_loaded_extensions();
-		$requiredExtensions = [
-			'pdo_mysql',
-			'json',
-			'xml',
-			'gd',
-		];
-		foreach ($requiredExtensions as $extension) {
-			if (!in_array($extension, $extensions)) {
-				$phpReport[] = [
-					'severity' => 'failure',
-					'message' => elgg_echo('install:check:php:extension', [$extension])
-				];
-			}
-		}
-
-		$recommendedExtensions = [
-			'mbstring',
-		];
-		foreach ($recommendedExtensions as $extension) {
-			if (!in_array($extension, $extensions)) {
-				$phpReport[] = [
-					'severity' => 'warning',
-					'message' => elgg_echo('install:check:php:extension:recommend', [$extension])
-				];
-			}
-		}
-	}
-
-	/**
-	 * Check PHP parameters
-	 *
-	 * @param array $phpReport The PHP requirements report array
-	 *
-	 * @return void
-	 */
-	protected function checkPhpDirectives(&$phpReport) {
-		if (ini_get('open_basedir')) {
-			$phpReport[] = [
-				'severity' => 'warning',
-				'message' => elgg_echo("install:check:php:open_basedir")
-			];
-		}
-
-		if (ini_get('safe_mode')) {
-			$phpReport[] = [
-				'severity' => 'warning',
-				'message' => elgg_echo("install:check:php:safe_mode")
-			];
-		}
-
-		if (ini_get('arg_separator.output') !== '&') {
-			$separator = htmlspecialchars(ini_get('arg_separator.output'));
-			$msg = elgg_echo("install:check:php:arg_separator", [$separator]);
-			$phpReport[] = [
-				'severity' => 'failure',
-				'message' => $msg,
-			];
-		}
-
-		if (ini_get('register_globals')) {
-			$phpReport[] = [
-				'severity' => 'failure',
-				'message' => elgg_echo("install:check:php:register_globals")
-			];
-		}
-
-		if (ini_get('session.auto_start')) {
-			$phpReport[] = [
-				'severity' => 'failure',
-				'message' => elgg_echo("install:check:php:session.auto_start")
-			];
-		}
-	}
-
-	/**
-	 * Confirm that the rewrite rules are firing
-	 *
-	 * @param array $report The requirements report array
-	 *
-	 * @return void
-	 */
-	protected function checkRewriteRules(&$report) {
-		$tester = new ElggRewriteTester();
-		$url = $this->config->wwwroot;
-		$url .= Request::REWRITE_TEST_TOKEN . '?' . http_build_query([
-				Request::REWRITE_TEST_TOKEN => '1',
-		]);
-		$report['rewrite'] = [$tester->run($url, Paths::project())];
-	}
-
-	/**
-	 * Count the number of failures in the requirements report
-	 *
-	 * @param array  $report    The requirements report array
-	 * @param string $condition 'failure' or 'warning'
-	 *
-	 * @return int
-	 */
-	protected function countNumConditions($report, $condition) {
-		$count = 0;
-		foreach ($report as $category => $checks) {
-			foreach ($checks as $check) {
-				if ($check['severity'] === $condition) {
-					$count++;
-				}
-			}
-		}
-
-		return $count;
-	}
-
-
-	/**
-	 * Database support methods
-	 */
-
-	/**
-	 * Validate the variables for the database step
-	 *
-	 * @param array $submissionVars Submitted vars
-	 * @param array $formVars       Vars in the form
-	 *
-	 * @return bool
-	 */
-	protected function validateDatabaseVars($submissionVars, $formVars) {
-
-		foreach ($formVars as $field => $info) {
-			if ($info['required'] == true && !$submissionVars[$field]) {
-				$name = elgg_echo("install:database:label:$field");
-				register_error(elgg_echo('install:error:requiredfield', [$name]));
-				return false;
-			}
-		}
-
-		// check that data root is absolute path
-		if (stripos(PHP_OS, 'win') === 0) {
-			if (strpos($submissionVars['dataroot'], ':') !== 1) {
-				$msg = elgg_echo('install:error:relative_path', [$submissionVars['dataroot']]);
-				register_error($msg);
-				return false;
-			}
-		} else {
-			if (strpos($submissionVars['dataroot'], '/') !== 0) {
-				$msg = elgg_echo('install:error:relative_path', [$submissionVars['dataroot']]);
-				register_error($msg);
-				return false;
-			}
-		}
-
-		// check that data root exists
-		if (!is_dir($submissionVars['dataroot'])) {
-			$msg = elgg_echo('install:error:datadirectoryexists', [$submissionVars['dataroot']]);
-			register_error($msg);
-			return false;
-		}
-
-		// check that data root is writable
-		if (!is_writable($submissionVars['dataroot'])) {
-			$msg = elgg_echo('install:error:writedatadirectory', [$submissionVars['dataroot']]);
-			register_error($msg);
-			return false;
-		}
-
-		if (!$this->config->data_dir_override) {
-			// check that data root is not subdirectory of Elgg root
-			if (stripos($submissionVars['dataroot'], $this->config->path) === 0) {
-				$msg = elgg_echo('install:error:locationdatadirectory', [$submissionVars['dataroot']]);
-				register_error($msg);
-				return false;
-			}
-		}
-
-		// according to postgres documentation: SQL identifiers and key words must
-		// begin with a letter (a-z, but also letters with diacritical marks and
-		// non-Latin letters) or an underscore (_). Subsequent characters in an
-		// identifier or key word can be letters, underscores, digits (0-9), or dollar signs ($).
-		// Refs #4994
-		if (!preg_match("/^[a-zA-Z_][\w]*$/", $submissionVars['dbprefix'])) {
-			register_error(elgg_echo('install:error:database_prefix'));
-			return false;
-		}
-
-		return $this->checkDatabaseSettings(
-			$submissionVars['dbuser'],
-			$submissionVars['dbpassword'],
-			$submissionVars['dbname'],
-			$submissionVars['dbhost']
-		);
-	}
-
-	/**
-	 * Confirm the settings for the database
-	 *
-	 * @param string $user     Username
-	 * @param string $password Password
-	 * @param string $dbname   Database name
-	 * @param string $host     Host
-	 *
-	 * @return bool
-	 */
-	protected function checkDatabaseSettings($user, $password, $dbname, $host) {
-		$config = new DbConfig((object) [
-			'dbhost' => $host,
-			'dbuser' => $user,
-			'dbpass' => $password,
-			'dbname' => $dbname,
-			'dbencoding' => 'utf8mb4',
-		]);
-		$db = new \Elgg\Database($config);
-
-		try {
-			$db->getDataRow("SELECT 1");
-		} catch (DatabaseException $e) {
-			if (0 === strpos($e->getMessage(), "Elgg couldn't connect")) {
-				register_error(elgg_echo('install:error:databasesettings'));
-			} else {
-				register_error(elgg_echo('install:error:nodatabase', [$dbname]));
-			}
-			return false;
-		}
-
-		// check MySQL version
-		$version = $db->getServerVersion(DbConfig::READ_WRITE);
-		if (version_compare($version, '5.5.3', '<')) {
-			register_error(elgg_echo('install:error:oldmysql2', [$version]));
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Writes the settings file to the engine directory
-	 *
-	 * @param array $params Array of inputted params from the user
-	 *
-	 * @return bool
-	 */
-	protected function createSettingsFile($params) {
-		$template = Application::elggDir()->getContents("elgg-config/settings.example.php");
-		if (!$template) {
-			register_error(elgg_echo('install:error:readsettingsphp'));
-			return false;
-		}
-
-		foreach ($params as $k => $v) {
-			$template = str_replace("{{" . $k . "}}", $v, $template);
-		}
-
-		$result = file_put_contents(Paths::settingsFile(), $template);
-		if (!$result) {
-			register_error(elgg_echo('install:error:writesettingphp'));
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Bootstrap database connection before entire engine is available
-	 *
-	 * @return bool
-	 */
-	protected function connectToDatabase() {
-		try {
-			$this->services->db->setupConnections();
-		} catch (DatabaseException $e) {
-			register_error($e->getMessage());
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Create the database tables
-	 *
-	 * @return bool
-	 */
-	protected function installDatabase() {
-		$ret = \Elgg\Application::migrate();
-		if ($ret) {
-			init_site_secret();
-		}
-		return $ret;
-	}
-
-	/**
-	 * Site settings support methods
-	 */
-
-	/**
-	 * Create the data directory if requested
-	 *
-	 * @param array $submissionVars Submitted vars
-	 * @param array $formVars       Variables in the form
-	 *
-	 * @return bool
-	 */
-	protected function createDataDirectory(&$submissionVars, $formVars) {
-		// did the user have option of Elgg creating the data directory
-		if ($formVars['dataroot']['type'] != 'combo') {
-			return true;
-		}
-
-		// did the user select the option
-		if ($submissionVars['dataroot'] != 'dataroot-checkbox') {
-			return true;
-		}
-
-		$dir = sanitise_filepath($submissionVars['path']) . 'data';
-		if (file_exists($dir) || mkdir($dir, 0700)) {
-			$submissionVars['dataroot'] = $dir;
-			if (!file_exists("$dir/.htaccess")) {
-				$htaccess = "Order Deny,Allow\nDeny from All\n";
-				if (!file_put_contents("$dir/.htaccess", $htaccess)) {
-					return false;
-				}
-			}
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Validate the site settings form variables
-	 *
-	 * @param array $submissionVars Submitted vars
-	 * @param array $formVars       Vars in the form
-	 *
-	 * @return bool
-	 */
-	protected function validateSettingsVars($submissionVars, $formVars) {
-		foreach ($formVars as $field => $info) {
-			$submissionVars[$field] = trim($submissionVars[$field]);
-			if ($info['required'] == true && $submissionVars[$field] === '') {
-				$name = elgg_echo("install:settings:label:$field");
-				register_error(elgg_echo('install:error:requiredfield', [$name]));
-				return false;
-			}
-		}
-
-		// check that email address is email address
-		if ($submissionVars['siteemail'] && !is_email_address($submissionVars['siteemail'])) {
-			$msg = elgg_echo('install:error:emailaddress', [$submissionVars['siteemail']]);
-			register_error($msg);
-			return false;
-		}
-
-		// @todo check that url is a url
-		// @note filter_var cannot be used because it doesn't work on international urls
-
-		return true;
-	}
-
-	/**
-	 * Initialize the site including site entity, plugins, and configuration
-	 *
-	 * @param array $submissionVars Submitted vars
-	 *
-	 * @return bool
-	 */
-	protected function saveSiteSettings($submissionVars) {
-		$site = new ElggSite();
-		$site->name = strip_tags($submissionVars['sitename']);
-		$site->access_id = ACCESS_PUBLIC;
-		$site->email = $submissionVars['siteemail'];
-
-		$guid = $site->save();
-		if ($guid !== 1) {
-			register_error(elgg_echo('install:error:createsite'));
-			return false;
-		}
-
-		$this->config->site = $site;
-
-		// new installations have run all the upgrades
-		$upgrades = elgg_get_upgrade_files(Paths::elgg() . "engine/lib/upgrades/");
-
-		$sets = [
-			'installed' => time(),
-			'version' => elgg_get_version(),
-			'simplecache_enabled' => 1,
-			'system_cache_enabled' => 1,
-			'simplecache_lastupdate' => time(),
-			'processed_upgrades' => $upgrades,
-			'language' => 'en',
-			'default_access' => $submissionVars['siteaccess'],
-			'allow_registration' => false,
-			'walled_garden' => false,
-			'allow_user_default_access' => '',
-			'default_limit' => 10,
-			'security_protect_upgrade' => true,
-			'security_notify_admins' => true,
-			'security_notify_user_password' => true,
-			'security_email_require_password' => true,
-		];
-		foreach ($sets as $key => $value) {
-			elgg_save_config($key, $value);
-		}
-
-		// Enable a set of default plugins
-		_elgg_generate_plugin_entities();
-
-		foreach (elgg_get_plugins('any') as $plugin) {
-			if ($plugin->getManifest()) {
-				if ($plugin->getManifest()->getActivateOnInstall()) {
-					$plugin->activate();
-				}
-				if (in_array('theme', $plugin->getManifest()->getCategories())) {
-					$plugin->setPriority('last');
-				}
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Admin account support methods
-	 */
-
-	/**
-	 * Validate account form variables
-	 *
-	 * @param array $submissionVars Submitted vars
-	 * @param array $formVars       Form vars
-	 *
-	 * @return bool
-	 */
-	protected function validateAdminVars($submissionVars, $formVars) {
-
-		foreach ($formVars as $field => $info) {
-			if ($info['required'] == true && !$submissionVars[$field]) {
-				$name = elgg_echo("install:admin:label:$field");
-				register_error(elgg_echo('install:error:requiredfield', [$name]));
-				return false;
-			}
-		}
-
-		if ($submissionVars['password1'] !== $submissionVars['password2']) {
-			register_error(elgg_echo('install:admin:password:mismatch'));
-			return false;
-		}
-
-		if (trim($submissionVars['password1']) == "") {
-			register_error(elgg_echo('install:admin:password:empty'));
-			return false;
-		}
-
-		$minLength = $this->services->configTable->get('min_password_length');
-		if (strlen($submissionVars['password1']) < $minLength) {
-			register_error(elgg_echo('install:admin:password:tooshort'));
-			return false;
-		}
-
-		// check that email address is email address
-		if ($submissionVars['email'] && !is_email_address($submissionVars['email'])) {
-			$msg = elgg_echo('install:error:emailaddress', [$submissionVars['email']]);
-			register_error($msg);
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Create a user account for the admin
-	 *
-	 * @param array $submissionVars Submitted vars
-	 * @param bool  $login          Login in the admin user?
-	 *
-	 * @return bool
-	 */
-	protected function createAdminAccount($submissionVars, $login = false) {
-		try {
-			$guid = register_user(
-				$submissionVars['username'],
-				$submissionVars['password1'],
-				$submissionVars['displayname'],
-				$submissionVars['email']
-			);
-		} catch (Exception $e) {
-			register_error($e->getMessage());
-			return false;
-		}
-
-		if (!$guid) {
-			register_error(elgg_echo('install:admin:cannot_create'));
-			return false;
-		}
-
-		$user = get_entity($guid);
-		if (!$user instanceof ElggUser) {
-			register_error(elgg_echo('install:error:loadadmin'));
-			return false;
-		}
-
-		$ia = elgg_set_ignore_access(true);
-		if ($user->makeAdmin() == false) {
-			register_error(elgg_echo('install:error:adminaccess'));
-		} else {
-			$this->services->configTable->set('admin_registered', 1);
-		}
-		elgg_set_ignore_access($ia);
-
-		// add validation data to satisfy user validation plugins
-		$user->validated = 1;
-		$user->validated_method = 'admin_user';
-
-		if (!$login) {
-			return true;
-		}
-
-		$session = ElggSession::fromDatabase($this->config, $this->services->db);
-		$session->start();
-		$this->services->setValue('session', $session);
-		if (login($user) == false) {
-			register_error(elgg_echo('install:error:adminlogin'));
-		}
-
-		return true;
-	}
+    /**
+     * Check version of PHP, extensions, and variables
+     *
+     * @param array $report The requirements report array
+     *
+     * @return void
+     */
+    protected function checkPHP(&$report) {
+        $phpReport = [];
+
+        $min_php_version = '5.6.0';
+        if (version_compare(PHP_VERSION, $min_php_version, '<')) {
+            $phpReport[] = [
+                'severity' => 'failure',
+                'message' => elgg_echo('install:check:php:version', [$min_php_version, PHP_VERSION])
+            ];
+        }
+
+        $this->checkPhpExtensions($phpReport);
+
+        $this->checkPhpDirectives($phpReport);
+
+        if (count($phpReport) == 0) {
+            $phpReport[] = [
+                'severity' => 'pass',
+                'message' => elgg_echo('install:check:php:success')
+            ];
+        }
+
+        $report['php'] = $phpReport;
+    }
+
+    /**
+     * Check the server's PHP extensions
+     *
+     * @param array $phpReport The PHP requirements report array
+     *
+     * @return void
+     */
+    protected function checkPhpExtensions(&$phpReport) {
+        $extensions = get_loaded_extensions();
+        $requiredExtensions = [
+            'pdo_mysql',
+            'json',
+            'xml',
+            'gd',
+        ];
+        foreach ($requiredExtensions as $extension) {
+            if (!in_array($extension, $extensions)) {
+                $phpReport[] = [
+                    'severity' => 'failure',
+                    'message' => elgg_echo('install:check:php:extension', [$extension])
+                ];
+            }
+        }
+
+        $recommendedExtensions = [
+            'mbstring',
+        ];
+        foreach ($recommendedExtensions as $extension) {
+            if (!in_array($extension, $extensions)) {
+                $phpReport[] = [
+                    'severity' => 'warning',
+                    'message' => elgg_echo('install:check:php:extension:recommend', [$extension])
+                ];
+            }
+        }
+    }
+
+    /**
+     * Check PHP parameters
+     *
+     * @param array $phpReport The PHP requirements report array
+     *
+     * @return void
+     */
+    protected function checkPhpDirectives(&$phpReport) {
+        if (ini_get('open_basedir')) {
+            $phpReport[] = [
+                'severity' => 'warning',
+                'message' => elgg_echo("install:check:php:open_basedir")
+            ];
+        }
+
+        if (ini_get('safe_mode')) {
+            $phpReport[] = [
+                'severity' => 'warning',
+                'message' => elgg_echo("install:check:php:safe_mode")
+            ];
+        }
+
+        if (ini_get('arg_separator.output') !== '&') {
+            $separator = htmlspecialchars(ini_get('arg_separator.output'));
+            $msg = elgg_echo("install:check:php:arg_separator", [$separator]);
+            $phpReport[] = [
+                'severity' => 'failure',
+                'message' => $msg,
+            ];
+        }
+
+        if (ini_get('register_globals')) {
+            $phpReport[] = [
+                'severity' => 'failure',
+                'message' => elgg_echo("install:check:php:register_globals")
+            ];
+        }
+
+        if (ini_get('session.auto_start')) {
+            $phpReport[] = [
+                'severity' => 'failure',
+                'message' => elgg_echo("install:check:php:session.auto_start")
+            ];
+        }
+    }
+
+    /**
+     * Confirm that the rewrite rules are firing
+     *
+     * @param array $report The requirements report array
+     *
+     * @return void
+     */
+    protected function checkRewriteRules(&$report) {
+        $tester = new ElggRewriteTester();
+        $url = $this->config->wwwroot;
+        $url .= Request::REWRITE_TEST_TOKEN . '?' . http_build_query([
+                Request::REWRITE_TEST_TOKEN => '1',
+        ]);
+        $report['rewrite'] = [$tester->run($url, Paths::project())];
+    }
+
+    /**
+     * Count the number of failures in the requirements report
+     *
+     * @param array  $report    The requirements report array
+     * @param string $condition 'failure' or 'warning'
+     *
+     * @return int
+     */
+    protected function countNumConditions($report, $condition) {
+        $count = 0;
+        foreach ($report as $category => $checks) {
+            foreach ($checks as $check) {
+                if ($check['severity'] === $condition) {
+                    $count++;
+                }
+            }
+        }
+
+        return $count;
+    }
+
+
+    /**
+     * Database support methods
+     */
+
+    /**
+     * Validate the variables for the database step
+     *
+     * @param array $submissionVars Submitted vars
+     * @param array $formVars       Vars in the form
+     *
+     * @return bool
+     */
+    protected function validateDatabaseVars($submissionVars, $formVars) {
+
+        foreach ($formVars as $field => $info) {
+            if ($info['required'] == true && !$submissionVars[$field]) {
+                $name = elgg_echo("install:database:label:$field");
+                register_error(elgg_echo('install:error:requiredfield', [$name]));
+                return false;
+            }
+        }
+
+        // check that data root is absolute path
+        if (stripos(PHP_OS, 'win') === 0) {
+            if (strpos($submissionVars['dataroot'], ':') !== 1) {
+                $msg = elgg_echo('install:error:relative_path', [$submissionVars['dataroot']]);
+                register_error($msg);
+                return false;
+            }
+        } else {
+            if (strpos($submissionVars['dataroot'], '/') !== 0) {
+                $msg = elgg_echo('install:error:relative_path', [$submissionVars['dataroot']]);
+                register_error($msg);
+                return false;
+            }
+        }
+
+        // check that data root exists
+        if (!is_dir($submissionVars['dataroot'])) {
+            $msg = elgg_echo('install:error:datadirectoryexists', [$submissionVars['dataroot']]);
+            register_error($msg);
+            return false;
+        }
+
+        // check that data root is writable
+        if (!is_writable($submissionVars['dataroot'])) {
+            $msg = elgg_echo('install:error:writedatadirectory', [$submissionVars['dataroot']]);
+            register_error($msg);
+            return false;
+        }
+
+        if (!$this->config->data_dir_override) {
+            // check that data root is not subdirectory of Elgg root
+            if (stripos($submissionVars['dataroot'], $this->config->path) === 0) {
+                $msg = elgg_echo('install:error:locationdatadirectory', [$submissionVars['dataroot']]);
+                register_error($msg);
+                return false;
+            }
+        }
+
+        // according to postgres documentation: SQL identifiers and key words must
+        // begin with a letter (a-z, but also letters with diacritical marks and
+        // non-Latin letters) or an underscore (_). Subsequent characters in an
+        // identifier or key word can be letters, underscores, digits (0-9), or dollar signs ($).
+        // Refs #4994
+        if (!preg_match("/^[a-zA-Z_][\w]*$/", $submissionVars['dbprefix'])) {
+            register_error(elgg_echo('install:error:database_prefix'));
+            return false;
+        }
+
+        return $this->checkDatabaseSettings(
+            $submissionVars['dbuser'],
+            $submissionVars['dbpassword'],
+            $submissionVars['dbname'],
+            $submissionVars['dbhost']
+        );
+    }
+
+    /**
+     * Confirm the settings for the database
+     *
+     * @param string $user     Username
+     * @param string $password Password
+     * @param string $dbname   Database name
+     * @param string $host     Host
+     *
+     * @return bool
+     */
+    protected function checkDatabaseSettings($user, $password, $dbname, $host) {
+        $config = new DbConfig((object) [
+            'dbhost' => $host,
+            'dbuser' => $user,
+            'dbpass' => $password,
+            'dbname' => $dbname,
+            'dbencoding' => 'utf8mb4',
+        ]);
+        $db = new \Elgg\Database($config);
+
+        try {
+            $db->getDataRow("SELECT 1");
+        } catch (DatabaseException $e) {
+            if (0 === strpos($e->getMessage(), "Elgg couldn't connect")) {
+                register_error(elgg_echo('install:error:databasesettings'));
+            } else {
+                register_error(elgg_echo('install:error:nodatabase', [$dbname]));
+            }
+            return false;
+        }
+
+        // check MySQL version
+        $version = $db->getServerVersion(DbConfig::READ_WRITE);
+        if (version_compare($version, '5.5.3', '<')) {
+            register_error(elgg_echo('install:error:oldmysql2', [$version]));
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Writes the settings file to the engine directory
+     *
+     * @param array $params Array of inputted params from the user
+     *
+     * @return bool
+     */
+    protected function createSettingsFile($params) {
+        $template = Application::elggDir()->getContents("elgg-config/settings.example.php");
+        if (!$template) {
+            register_error(elgg_echo('install:error:readsettingsphp'));
+            return false;
+        }
+
+        foreach ($params as $k => $v) {
+            $template = str_replace("{{" . $k . "}}", $v, $template);
+        }
+
+        $result = file_put_contents(Paths::settingsFile(), $template);
+        if (!$result) {
+            register_error(elgg_echo('install:error:writesettingphp'));
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Bootstrap database connection before entire engine is available
+     *
+     * @return bool
+     */
+    protected function connectToDatabase() {
+        try {
+            $this->services->db->setupConnections();
+        } catch (DatabaseException $e) {
+            register_error($e->getMessage());
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Create the database tables
+     *
+     * @return bool
+     */
+    protected function installDatabase() {
+        $ret = \Elgg\Application::migrate();
+        if ($ret) {
+            init_site_secret();
+        }
+        return $ret;
+    }
+
+    /**
+     * Site settings support methods
+     */
+
+    /**
+     * Create the data directory if requested
+     *
+     * @param array $submissionVars Submitted vars
+     * @param array $formVars       Variables in the form
+     *
+     * @return bool
+     */
+    protected function createDataDirectory(&$submissionVars, $formVars) {
+        // did the user have option of Elgg creating the data directory
+        if ($formVars['dataroot']['type'] != 'combo') {
+            return true;
+        }
+
+        // did the user select the option
+        if ($submissionVars['dataroot'] != 'dataroot-checkbox') {
+            return true;
+        }
+
+        $dir = sanitise_filepath($submissionVars['path']) . 'data';
+        if (file_exists($dir) || mkdir($dir, 0700)) {
+            $submissionVars['dataroot'] = $dir;
+            if (!file_exists("$dir/.htaccess")) {
+                $htaccess = "Order Deny,Allow\nDeny from All\n";
+                if (!file_put_contents("$dir/.htaccess", $htaccess)) {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Validate the site settings form variables
+     *
+     * @param array $submissionVars Submitted vars
+     * @param array $formVars       Vars in the form
+     *
+     * @return bool
+     */
+    protected function validateSettingsVars($submissionVars, $formVars) {
+        foreach ($formVars as $field => $info) {
+            $submissionVars[$field] = trim($submissionVars[$field]);
+            if ($info['required'] == true && $submissionVars[$field] === '') {
+                $name = elgg_echo("install:settings:label:$field");
+                register_error(elgg_echo('install:error:requiredfield', [$name]));
+                return false;
+            }
+        }
+
+        // check that email address is email address
+        if ($submissionVars['siteemail'] && !is_email_address($submissionVars['siteemail'])) {
+            $msg = elgg_echo('install:error:emailaddress', [$submissionVars['siteemail']]);
+            register_error($msg);
+            return false;
+        }
+
+        // @todo check that url is a url
+        // @note filter_var cannot be used because it doesn't work on international urls
+
+        return true;
+    }
+
+    /**
+     * Initialize the site including site entity, plugins, and configuration
+     *
+     * @param array $submissionVars Submitted vars
+     *
+     * @return bool
+     */
+    protected function saveSiteSettings($submissionVars) {
+        $site = new ElggSite();
+        $site->name = strip_tags($submissionVars['sitename']);
+        $site->access_id = ACCESS_PUBLIC;
+        $site->email = $submissionVars['siteemail'];
+
+        $guid = $site->save();
+        if ($guid !== 1) {
+            register_error(elgg_echo('install:error:createsite'));
+            return false;
+        }
+
+        $this->config->site = $site;
+
+        // new installations have run all the upgrades
+        $upgrades = elgg_get_upgrade_files(Paths::elgg() . "engine/lib/upgrades/");
+
+        $sets = [
+            'installed' => time(),
+            'version' => elgg_get_version(),
+            'simplecache_enabled' => 1,
+            'system_cache_enabled' => 1,
+            'simplecache_lastupdate' => time(),
+            'processed_upgrades' => $upgrades,
+            'language' => 'en',
+            'default_access' => $submissionVars['siteaccess'],
+            'allow_registration' => false,
+            'walled_garden' => false,
+            'allow_user_default_access' => '',
+            'default_limit' => 10,
+            'security_protect_upgrade' => true,
+            'security_notify_admins' => true,
+            'security_notify_user_password' => true,
+            'security_email_require_password' => true,
+        ];
+        foreach ($sets as $key => $value) {
+            elgg_save_config($key, $value);
+        }
+
+        // Enable a set of default plugins
+        _elgg_generate_plugin_entities();
+
+        foreach (elgg_get_plugins('any') as $plugin) {
+            if ($plugin->getManifest()) {
+                if ($plugin->getManifest()->getActivateOnInstall()) {
+                    $plugin->activate();
+                }
+                if (in_array('theme', $plugin->getManifest()->getCategories())) {
+                    $plugin->setPriority('last');
+                }
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Admin account support methods
+     */
+
+    /**
+     * Validate account form variables
+     *
+     * @param array $submissionVars Submitted vars
+     * @param array $formVars       Form vars
+     *
+     * @return bool
+     */
+    protected function validateAdminVars($submissionVars, $formVars) {
+
+        foreach ($formVars as $field => $info) {
+            if ($info['required'] == true && !$submissionVars[$field]) {
+                $name = elgg_echo("install:admin:label:$field");
+                register_error(elgg_echo('install:error:requiredfield', [$name]));
+                return false;
+            }
+        }
+
+        if ($submissionVars['password1'] !== $submissionVars['password2']) {
+            register_error(elgg_echo('install:admin:password:mismatch'));
+            return false;
+        }
+
+        if (trim($submissionVars['password1']) == "") {
+            register_error(elgg_echo('install:admin:password:empty'));
+            return false;
+        }
+
+        $minLength = $this->services->configTable->get('min_password_length');
+        if (strlen($submissionVars['password1']) < $minLength) {
+            register_error(elgg_echo('install:admin:password:tooshort'));
+            return false;
+        }
+
+        // check that email address is email address
+        if ($submissionVars['email'] && !is_email_address($submissionVars['email'])) {
+            $msg = elgg_echo('install:error:emailaddress', [$submissionVars['email']]);
+            register_error($msg);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Create a user account for the admin
+     *
+     * @param array $submissionVars Submitted vars
+     * @param bool  $login          Login in the admin user?
+     *
+     * @return bool
+     */
+    protected function createAdminAccount($submissionVars, $login = false) {
+        try {
+            $guid = register_user(
+                $submissionVars['username'],
+                $submissionVars['password1'],
+                $submissionVars['displayname'],
+                $submissionVars['email']
+            );
+        } catch (Exception $e) {
+            register_error($e->getMessage());
+            return false;
+        }
+
+        if (!$guid) {
+            register_error(elgg_echo('install:admin:cannot_create'));
+            return false;
+        }
+
+        $user = get_entity($guid);
+        if (!$user instanceof ElggUser) {
+            register_error(elgg_echo('install:error:loadadmin'));
+            return false;
+        }
+
+        $ia = elgg_set_ignore_access(true);
+        if ($user->makeAdmin() == false) {
+            register_error(elgg_echo('install:error:adminaccess'));
+        } else {
+            $this->services->configTable->set('admin_registered', 1);
+        }
+        elgg_set_ignore_access($ia);
+
+        // add validation data to satisfy user validation plugins
+        $user->validated = 1;
+        $user->validated_method = 'admin_user';
+
+        if (!$login) {
+            return true;
+        }
+
+        $session = ElggSession::fromDatabase($this->config, $this->services->db);
+        $session->start();
+        $this->services->setValue('session', $session);
+        if (login($user) == false) {
+            register_error(elgg_echo('install:error:adminlogin'));
+        }
+
+        return true;
+    }
 }

engine/classes/Elgg/Di/ServiceProvider.php

Indentation +400 added lines, -400 removed lines

@@ -95,404 +95,404 @@
  */
 class ServiceProvider extends DiContainer {
 
-	/**
-	 * Constructor
-	 *
-	 * @param Config $config Elgg Config service
-	 */
-	public function __construct(Config $config) {
-
-		$this->setFactory('autoloadManager', function(ServiceProvider $c) {
-			$manager = new \Elgg\AutoloadManager($c->classLoader);
-			if (!$c->config->AutoloaderManager_skip_storage) {
-				$manager->setStorage($c->fileCache);
-				$manager->loadCache();
-			}
-			return $manager;
-		});
-
-		$this->setFactory('accessCache', function(ServiceProvider $c) {
-			return new \ElggStaticVariableCache('access');
-		});
-
-		$this->setFactory('accessCollections', function(ServiceProvider $c) {
-			return new \Elgg\Database\AccessCollections(
-					$c->config, $c->db, $c->entityTable, $c->userCapabilities, $c->accessCache, $c->hooks, $c->session, $c->translator);
-		});
-
-		$this->setFactory('actions', function(ServiceProvider $c) {
-			return new \Elgg\ActionsService($c->config, $c->session, $c->crypto);
-		});
-
-		$this->setClassName('adminNotices', \Elgg\Database\AdminNotices::class);
-
-		$this->setFactory('ajax', function(ServiceProvider $c) {
-			return new \Elgg\Ajax\Service($c->hooks, $c->systemMessages, $c->input, $c->amdConfig);
-		});
-
-		$this->setFactory('amdConfig', function(ServiceProvider $c) {
-			$obj = new \Elgg\Amd\Config($c->hooks);
-			$obj->setBaseUrl($c->simpleCache->getRoot());
-			return $obj;
-		});
-
-		$this->setFactory('annotations', function(ServiceProvider $c) {
-			return new \Elgg\Database\Annotations($c->db, $c->session, $c->hooks->getEvents());
-		});
-
-		$this->setClassName('autoP', \ElggAutoP::class);
-
-		$this->setFactory('boot', function(ServiceProvider $c) {
-			$boot = new \Elgg\BootService();
-			if ($c->config->enable_profiling) {
-				$boot->setTimer($c->timer);
-			}
-			return $boot;
-		});
-
-		$this->setFactory('batchUpgrader', function(ServiceProvider $c) {
-			return new \Elgg\BatchUpgrader($c->config);
-		});
-
-		$this->setFactory('cacheHandler', function(ServiceProvider $c) {
-			$simplecache_enabled = $c->config->simplecache_enabled;
-			if ($simplecache_enabled === null) {
-				$simplecache_enabled = $c->configTable->get('simplecache_enabled');
-			}
-			return new \Elgg\Application\CacheHandler($c->config, $c->request, $simplecache_enabled);
-		});
-
-		$this->setFactory('classLoader', function(ServiceProvider $c) {
-			$loader = new \Elgg\ClassLoader(new \Elgg\ClassMap());
-			$loader->register();
-			return $loader;
-		});
-
-		$this->setValue('config', $config);
-
-		$this->setFactory('configTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\ConfigTable($c->db, $c->boot, $c->logger);
-		});
-
-		$this->setFactory('context', function(ServiceProvider $c) {
-			$context = new \Elgg\Context();
-			$context->initialize($c->request);
-			return $context;
-		});
-
-		$this->setClassName('crypto', \ElggCrypto::class);
-
-		$this->setFactory('db', function(ServiceProvider $c) {
-			$db = new \Elgg\Database($c->dbConfig);
-			$db->setLogger($c->logger);
-
-			if ($c->config->profiling_sql) {
-				$db->setTimer($c->timer);
-			}
-
-			return $db;
-		});
-
-		$this->setFactory('dbConfig', function(ServiceProvider $c) {
-			$config = $c->config;
-			$db_config = \Elgg\Database\DbConfig::fromElggConfig($config);
-
-			// get this stuff out of config!
-			unset($config->db);
-			unset($config->dbname);
-			unset($config->dbhost);
-			unset($config->dbuser);
-			unset($config->dbpass);
-
-			return $db_config;
-		});
-
-		$this->setFactory('deprecation', function(ServiceProvider $c) {
-			return new \Elgg\DeprecationService($c->logger);
-		});
-
-		$this->setFactory('emails', function(ServiceProvider $c) {
-			return new \Elgg\EmailService($c->config, $c->hooks, $c->mailer, $c->logger);
-		});
-
-		$this->setFactory('entityCache', function(ServiceProvider $c) {
-			return new \Elgg\Cache\EntityCache($c->session, $c->metadataCache);
-		});
-
-		$this->setFactory('entityPreloader', function(ServiceProvider $c) {
-			return new \Elgg\EntityPreloader($c->entityCache, $c->entityTable);
-		});
-
-		$this->setFactory('entityTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\EntityTable(
-				$c->config,
-				$c->db,
-				$c->entityCache,
-				$c->metadataCache,
-				$c->subtypeTable,
-				$c->hooks->getEvents(),
-				$c->session,
-				$c->translator,
-				$c->logger
-			);
-		});
-
-		$this->setClassName('externalFiles', \Elgg\Assets\ExternalFiles::class);
-
-		$this->setFactory('fileCache', function(ServiceProvider $c) {
-			return new \ElggFileCache($c->config->cacheroot . 'system_cache/');
-		});
-
-		$this->setFactory('filestore', function(ServiceProvider $c) {
-			return new \ElggDiskFilestore($c->config->dataroot);
-		});
-
-		$this->setFactory('forms', function(ServiceProvider $c) {
-			return new \Elgg\FormsService($c->views, $c->logger);
-		});
-
-		$this->setClassName('handlers', \Elgg\HandlersService::class);
-
-		$this->setFactory('hmac', function(ServiceProvider $c) {
-			return new \Elgg\Security\HmacFactory($c->siteSecret, $c->crypto);
-		});
-
-		$this->setFactory('hooks', function(ServiceProvider $c) {
-			$events = new \Elgg\EventsService($c->handlers);
-			if ($c->config->enable_profiling) {
-				$events->setTimer($c->timer);
-			}
-			return new \Elgg\PluginHooksService($events);
-		});
-
-		$this->setFactory('iconService', function(ServiceProvider $c) {
-			return new \Elgg\EntityIconService($c->config, $c->hooks, $c->request, $c->logger, $c->entityTable);
-		});
-
-		$this->setClassName('input', \Elgg\Http\Input::class);
-
-		$this->setFactory('imageService', function(ServiceProvider $c) {
-			$imagine = new \Imagine\Gd\Imagine();
-			return new \Elgg\ImageService($imagine, $c->config);
-		});
-
-		$this->setFactory('logger', function (ServiceProvider $c) {
-			$logger = new \Elgg\Logger($c->hooks, $c->context);
-			$logger->setLevel($c->config->debug);
-			return $logger;
-		});
-
-		// TODO(evan): Support configurable transports...
-		$this->setClassName('mailer', 'Zend\Mail\Transport\Sendmail');
-
-		$this->setFactory('menus', function(ServiceProvider $c) {
-			return new \Elgg\Menu\Service($c->hooks, $c->config);
-		});
-
-		$this->setFactory('metadataCache', function (ServiceProvider $c) {
-			$cache = _elgg_get_memcache('metadata');
-			return new \Elgg\Cache\MetadataCache($cache);
-		});
-
-		$this->setFactory('memcacheStashPool', function(ServiceProvider $c) {
-			if (!$c->config->memcache) {
-				return null;
-			}
-
-			$servers = $c->config->memcache_servers;
-			if (!$servers) {
-				return null;
-			}
-			$driver = new \Stash\Driver\Memcache([
-				'servers' => $servers,
-			]);
-			return new \Stash\Pool($driver);
-		});
-
-		$this->setFactory('metadataTable', function(ServiceProvider $c) {
-			// TODO(ewinslow): Use Pool instead of MetadataCache for caching
-			return new \Elgg\Database\MetadataTable(
-				$c->metadataCache, $c->db, $c->entityTable, $c->hooks->getEvents(), $c->session);
-		});
-
-		$this->setFactory('mutex', function(ServiceProvider $c) {
-			return new \Elgg\Database\Mutex(
-				$c->db,
-				$c->logger
-			);
-		});
-
-		$this->setFactory('notifications', function(ServiceProvider $c) {
-			// @todo move queue in service provider
-			$queue_name = \Elgg\Notifications\NotificationsService::QUEUE_NAME;
-			$queue = new \Elgg\Queue\DatabaseQueue($queue_name, $c->db);
-			$sub = new \Elgg\Notifications\SubscriptionsService($c->db);
-			return new \Elgg\Notifications\NotificationsService($sub, $queue, $c->hooks, $c->session, $c->translator, $c->entityTable, $c->logger);
-		});
-
-		$this->setClassName('nullCache', \Elgg\Cache\NullCache::class);
-
-		$this->setFactory('persistentLogin', function(ServiceProvider $c) {
-			$global_cookies_config = $c->config->getCookieConfig();
-			$cookie_config = $global_cookies_config['remember_me'];
-			$cookie_name = $cookie_config['name'];
-			$cookie_token = $c->request->cookies->get($cookie_name, '');
-			return new \Elgg\PersistentLoginService(
-				$c->db, $c->session, $c->crypto, $cookie_config, $cookie_token);
-		});
-
-		$this->setClassName('passwords', \Elgg\PasswordService::class);
-
-		$this->setFactory('plugins', function(ServiceProvider $c) {
-			$pool = new Pool\InMemory();
-			$plugins = new \Elgg\Database\Plugins($pool, $c->pluginSettingsCache);
-			if ($c->config->enable_profiling) {
-				$plugins->setTimer($c->timer);
-			}
-			return $plugins;
-		});
-
-		$this->setClassName('pluginSettingsCache', \Elgg\Cache\PluginSettingsCache::class);
-
-		$this->setFactory('privateSettings', function(ServiceProvider $c) {
-			return new \Elgg\Database\PrivateSettingsTable($c->db, $c->entityTable, $c->pluginSettingsCache);
-		});
-
-		$this->setFactory('publicDb', function(ServiceProvider $c) {
-			return new \Elgg\Application\Database($c->db);
-		});
-
-		$this->setFactory('queryCounter', function(ServiceProvider $c) {
-			return new \Elgg\Database\QueryCounter($c->db);
-		}, false);
-
-		$this->setFactory('redirects', function(ServiceProvider $c) {
-			$url = current_page_url();
-			$is_xhr = $c->request->isXmlHttpRequest();
-			return new \Elgg\RedirectService($c->session, $is_xhr, $c->config->wwwroot, $url);
-		});
-
-		$this->setFactory('relationshipsTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\RelationshipsTable($c->db, $c->entityTable, $c->metadataTable, $c->hooks->getEvents());
-		});
-
-		$this->setFactory('request', [\Elgg\Http\Request::class, 'createFromGlobals']);
-
-		$this->setFactory('responseFactory', function(ServiceProvider $c) {
-			if (PHP_SAPI === 'cli') {
-				$transport = new \Elgg\Http\OutputBufferTransport();
-			} else {
-				$transport = new \Elgg\Http\HttpProtocolTransport();
-			}
-			return new \Elgg\Http\ResponseFactory($c->request, $c->hooks, $c->ajax, $transport);
-		});
-
-		$this->setFactory('router', function(ServiceProvider $c) {
-			// TODO(evan): Init routes from plugins or cache
-			$router = new \Elgg\Router($c->hooks);
-			if ($c->config->enable_profiling) {
-				$router->setTimer($c->timer);
-			}
-			return $router;
-		});
-
-		$this->setFactory('seeder', function(ServiceProvider $c) {
-			return new \Elgg\Database\Seeder($c->hooks);
-		});
-
-		$this->setFactory('serveFileHandler', function(ServiceProvider $c) {
-			return new \Elgg\Application\ServeFileHandler($c->hmac, $c->config);
-		});
-
-		$this->setFactory('session', function(ServiceProvider $c) {
-			return \ElggSession::fromDatabase($c->config, $c->db);
-		});
-
-		$this->setClassName('urlSigner', \Elgg\Security\UrlSigner::class);
-
-		$this->setFactory('simpleCache', function(ServiceProvider $c) {
-			return new \Elgg\Cache\SimpleCache($c->config);
-		});
-
-		/**
-		 * If the key is in the settings file, this is injected early.
-		 *
-		 * @see \Elgg\Application::initConfig
-		 */
-		$this->setFactory('siteSecret', function(ServiceProvider $c) {
-			return \Elgg\Database\SiteSecret::fromDatabase($c->configTable);
-		});
-
-		$this->setClassName('stickyForms', \Elgg\Forms\StickyForms::class);
-
-		$this->setFactory('subtypeTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\SubtypeTable($c->db);
-		});
-
-		$this->setFactory('systemCache', function (ServiceProvider $c) {
-			$cache = new \Elgg\Cache\SystemCache($c->fileCache, $c->config);
-			if ($c->config->enable_profiling) {
-				$cache->setTimer($c->timer);
-			}
-			return $cache;
-		});
-
-		$this->setFactory('systemMessages', function(ServiceProvider $c) {
-			return new \Elgg\SystemMessagesService($c->session);
-		});
-
-		$this->setClassName('table_columns', \Elgg\Views\TableColumn\ColumnFactory::class);
-
-		$this->setClassName('timer', \Elgg\Timer::class);
-
-		$this->setFactory('translator', function(ServiceProvider $c) {
-			return new \Elgg\I18n\Translator($c->config);
-		});
-
-		$this->setFactory('uploads', function(ServiceProvider $c) {
-			return new \Elgg\UploadService($c->request);
-		});
-
-		$this->setFactory('upgrades', function(ServiceProvider $c) {
-			return new \Elgg\UpgradeService(
-				$c->translator,
-				$c->hooks,
-				$c->config,
-				$c->logger,
-				$c->mutex
-			);
-		});
-
-		$this->setFactory('userCapabilities', function(ServiceProvider $c) {
-			return new \Elgg\UserCapabilities($c->hooks, $c->entityTable, $c->session);
-		});
-
-		$this->setFactory('usersTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\UsersTable(
-				$c->config,
-				$c->db,
-				$c->entityTable,
-				$c->entityCache,
-				$c->hooks->getEvents()
-			);
-		});
-
-		$this->setFactory('upgradeLocator', function(ServiceProvider $c) {
-			return new \Elgg\Upgrade\Locator(
-				$c->plugins,
-				$c->logger,
-				$c->privateSettings
-			);
-		});
-
-		$this->setFactory('views', function(ServiceProvider $c) {
-			return new \Elgg\ViewsService($c->hooks, $c->logger, $c->input);
-		});
-
-		$this->setFactory('viewCacher', function(ServiceProvider $c) {
-			return new \Elgg\Cache\ViewCacher($c->views, $c->config);
-		});
-
-		$this->setClassName('widgets', \Elgg\WidgetsService::class);
-	}
+    /**
+     * Constructor
+     *
+     * @param Config $config Elgg Config service
+     */
+    public function __construct(Config $config) {
+
+        $this->setFactory('autoloadManager', function(ServiceProvider $c) {
+            $manager = new \Elgg\AutoloadManager($c->classLoader);
+            if (!$c->config->AutoloaderManager_skip_storage) {
+                $manager->setStorage($c->fileCache);
+                $manager->loadCache();
+            }
+            return $manager;
+        });
+
+        $this->setFactory('accessCache', function(ServiceProvider $c) {
+            return new \ElggStaticVariableCache('access');
+        });
+
+        $this->setFactory('accessCollections', function(ServiceProvider $c) {
+            return new \Elgg\Database\AccessCollections(
+                    $c->config, $c->db, $c->entityTable, $c->userCapabilities, $c->accessCache, $c->hooks, $c->session, $c->translator);
+        });
+
+        $this->setFactory('actions', function(ServiceProvider $c) {
+            return new \Elgg\ActionsService($c->config, $c->session, $c->crypto);
+        });
+
+        $this->setClassName('adminNotices', \Elgg\Database\AdminNotices::class);
+
+        $this->setFactory('ajax', function(ServiceProvider $c) {
+            return new \Elgg\Ajax\Service($c->hooks, $c->systemMessages, $c->input, $c->amdConfig);
+        });
+
+        $this->setFactory('amdConfig', function(ServiceProvider $c) {
+            $obj = new \Elgg\Amd\Config($c->hooks);
+            $obj->setBaseUrl($c->simpleCache->getRoot());
+            return $obj;
+        });
+
+        $this->setFactory('annotations', function(ServiceProvider $c) {
+            return new \Elgg\Database\Annotations($c->db, $c->session, $c->hooks->getEvents());
+        });
+
+        $this->setClassName('autoP', \ElggAutoP::class);
+
+        $this->setFactory('boot', function(ServiceProvider $c) {
+            $boot = new \Elgg\BootService();
+            if ($c->config->enable_profiling) {
+                $boot->setTimer($c->timer);
+            }
+            return $boot;
+        });
+
+        $this->setFactory('batchUpgrader', function(ServiceProvider $c) {
+            return new \Elgg\BatchUpgrader($c->config);
+        });
+
+        $this->setFactory('cacheHandler', function(ServiceProvider $c) {
+            $simplecache_enabled = $c->config->simplecache_enabled;
+            if ($simplecache_enabled === null) {
+                $simplecache_enabled = $c->configTable->get('simplecache_enabled');
+            }
+            return new \Elgg\Application\CacheHandler($c->config, $c->request, $simplecache_enabled);
+        });
+
+        $this->setFactory('classLoader', function(ServiceProvider $c) {
+            $loader = new \Elgg\ClassLoader(new \Elgg\ClassMap());
+            $loader->register();
+            return $loader;
+        });
+
+        $this->setValue('config', $config);
+
+        $this->setFactory('configTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\ConfigTable($c->db, $c->boot, $c->logger);
+        });
+
+        $this->setFactory('context', function(ServiceProvider $c) {
+            $context = new \Elgg\Context();
+            $context->initialize($c->request);
+            return $context;
+        });
+
+        $this->setClassName('crypto', \ElggCrypto::class);
+
+        $this->setFactory('db', function(ServiceProvider $c) {
+            $db = new \Elgg\Database($c->dbConfig);
+            $db->setLogger($c->logger);
+
+            if ($c->config->profiling_sql) {
+                $db->setTimer($c->timer);
+            }
+
+            return $db;
+        });
+
+        $this->setFactory('dbConfig', function(ServiceProvider $c) {
+            $config = $c->config;
+            $db_config = \Elgg\Database\DbConfig::fromElggConfig($config);
+
+            // get this stuff out of config!
+            unset($config->db);
+            unset($config->dbname);
+            unset($config->dbhost);
+            unset($config->dbuser);
+            unset($config->dbpass);
+
+            return $db_config;
+        });
+
+        $this->setFactory('deprecation', function(ServiceProvider $c) {
+            return new \Elgg\DeprecationService($c->logger);
+        });
+
+        $this->setFactory('emails', function(ServiceProvider $c) {
+            return new \Elgg\EmailService($c->config, $c->hooks, $c->mailer, $c->logger);
+        });
+
+        $this->setFactory('entityCache', function(ServiceProvider $c) {
+            return new \Elgg\Cache\EntityCache($c->session, $c->metadataCache);
+        });
+
+        $this->setFactory('entityPreloader', function(ServiceProvider $c) {
+            return new \Elgg\EntityPreloader($c->entityCache, $c->entityTable);
+        });
+
+        $this->setFactory('entityTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\EntityTable(
+                $c->config,
+                $c->db,
+                $c->entityCache,
+                $c->metadataCache,
+                $c->subtypeTable,
+                $c->hooks->getEvents(),
+                $c->session,
+                $c->translator,
+                $c->logger
+            );
+        });
+
+        $this->setClassName('externalFiles', \Elgg\Assets\ExternalFiles::class);
+
+        $this->setFactory('fileCache', function(ServiceProvider $c) {
+            return new \ElggFileCache($c->config->cacheroot . 'system_cache/');
+        });
+
+        $this->setFactory('filestore', function(ServiceProvider $c) {
+            return new \ElggDiskFilestore($c->config->dataroot);
+        });
+
+        $this->setFactory('forms', function(ServiceProvider $c) {
+            return new \Elgg\FormsService($c->views, $c->logger);
+        });
+
+        $this->setClassName('handlers', \Elgg\HandlersService::class);
+
+        $this->setFactory('hmac', function(ServiceProvider $c) {
+            return new \Elgg\Security\HmacFactory($c->siteSecret, $c->crypto);
+        });
+
+        $this->setFactory('hooks', function(ServiceProvider $c) {
+            $events = new \Elgg\EventsService($c->handlers);
+            if ($c->config->enable_profiling) {
+                $events->setTimer($c->timer);
+            }
+            return new \Elgg\PluginHooksService($events);
+        });
+
+        $this->setFactory('iconService', function(ServiceProvider $c) {
+            return new \Elgg\EntityIconService($c->config, $c->hooks, $c->request, $c->logger, $c->entityTable);
+        });
+
+        $this->setClassName('input', \Elgg\Http\Input::class);
+
+        $this->setFactory('imageService', function(ServiceProvider $c) {
+            $imagine = new \Imagine\Gd\Imagine();
+            return new \Elgg\ImageService($imagine, $c->config);
+        });
+
+        $this->setFactory('logger', function (ServiceProvider $c) {
+            $logger = new \Elgg\Logger($c->hooks, $c->context);
+            $logger->setLevel($c->config->debug);
+            return $logger;
+        });
+
+        // TODO(evan): Support configurable transports...
+        $this->setClassName('mailer', 'Zend\Mail\Transport\Sendmail');
+
+        $this->setFactory('menus', function(ServiceProvider $c) {
+            return new \Elgg\Menu\Service($c->hooks, $c->config);
+        });
+
+        $this->setFactory('metadataCache', function (ServiceProvider $c) {
+            $cache = _elgg_get_memcache('metadata');
+            return new \Elgg\Cache\MetadataCache($cache);
+        });
+
+        $this->setFactory('memcacheStashPool', function(ServiceProvider $c) {
+            if (!$c->config->memcache) {
+                return null;
+            }
+
+            $servers = $c->config->memcache_servers;
+            if (!$servers) {
+                return null;
+            }
+            $driver = new \Stash\Driver\Memcache([
+                'servers' => $servers,
+            ]);
+            return new \Stash\Pool($driver);
+        });
+
+        $this->setFactory('metadataTable', function(ServiceProvider $c) {
+            // TODO(ewinslow): Use Pool instead of MetadataCache for caching
+            return new \Elgg\Database\MetadataTable(
+                $c->metadataCache, $c->db, $c->entityTable, $c->hooks->getEvents(), $c->session);
+        });
+
+        $this->setFactory('mutex', function(ServiceProvider $c) {
+            return new \Elgg\Database\Mutex(
+                $c->db,
+                $c->logger
+            );
+        });
+
+        $this->setFactory('notifications', function(ServiceProvider $c) {
+            // @todo move queue in service provider
+            $queue_name = \Elgg\Notifications\NotificationsService::QUEUE_NAME;
+            $queue = new \Elgg\Queue\DatabaseQueue($queue_name, $c->db);
+            $sub = new \Elgg\Notifications\SubscriptionsService($c->db);
+            return new \Elgg\Notifications\NotificationsService($sub, $queue, $c->hooks, $c->session, $c->translator, $c->entityTable, $c->logger);
+        });
+
+        $this->setClassName('nullCache', \Elgg\Cache\NullCache::class);
+
+        $this->setFactory('persistentLogin', function(ServiceProvider $c) {
+            $global_cookies_config = $c->config->getCookieConfig();
+            $cookie_config = $global_cookies_config['remember_me'];
+            $cookie_name = $cookie_config['name'];
+            $cookie_token = $c->request->cookies->get($cookie_name, '');
+            return new \Elgg\PersistentLoginService(
+                $c->db, $c->session, $c->crypto, $cookie_config, $cookie_token);
+        });
+
+        $this->setClassName('passwords', \Elgg\PasswordService::class);
+
+        $this->setFactory('plugins', function(ServiceProvider $c) {
+            $pool = new Pool\InMemory();
+            $plugins = new \Elgg\Database\Plugins($pool, $c->pluginSettingsCache);
+            if ($c->config->enable_profiling) {
+                $plugins->setTimer($c->timer);
+            }
+            return $plugins;
+        });
+
+        $this->setClassName('pluginSettingsCache', \Elgg\Cache\PluginSettingsCache::class);
+
+        $this->setFactory('privateSettings', function(ServiceProvider $c) {
+            return new \Elgg\Database\PrivateSettingsTable($c->db, $c->entityTable, $c->pluginSettingsCache);
+        });
+
+        $this->setFactory('publicDb', function(ServiceProvider $c) {
+            return new \Elgg\Application\Database($c->db);
+        });
+
+        $this->setFactory('queryCounter', function(ServiceProvider $c) {
+            return new \Elgg\Database\QueryCounter($c->db);
+        }, false);
+
+        $this->setFactory('redirects', function(ServiceProvider $c) {
+            $url = current_page_url();
+            $is_xhr = $c->request->isXmlHttpRequest();
+            return new \Elgg\RedirectService($c->session, $is_xhr, $c->config->wwwroot, $url);
+        });
+
+        $this->setFactory('relationshipsTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\RelationshipsTable($c->db, $c->entityTable, $c->metadataTable, $c->hooks->getEvents());
+        });
+
+        $this->setFactory('request', [\Elgg\Http\Request::class, 'createFromGlobals']);
+
+        $this->setFactory('responseFactory', function(ServiceProvider $c) {
+            if (PHP_SAPI === 'cli') {
+                $transport = new \Elgg\Http\OutputBufferTransport();
+            } else {
+                $transport = new \Elgg\Http\HttpProtocolTransport();
+            }
+            return new \Elgg\Http\ResponseFactory($c->request, $c->hooks, $c->ajax, $transport);
+        });
+
+        $this->setFactory('router', function(ServiceProvider $c) {
+            // TODO(evan): Init routes from plugins or cache
+            $router = new \Elgg\Router($c->hooks);
+            if ($c->config->enable_profiling) {
+                $router->setTimer($c->timer);
+            }
+            return $router;
+        });
+
+        $this->setFactory('seeder', function(ServiceProvider $c) {
+            return new \Elgg\Database\Seeder($c->hooks);
+        });
+
+        $this->setFactory('serveFileHandler', function(ServiceProvider $c) {
+            return new \Elgg\Application\ServeFileHandler($c->hmac, $c->config);
+        });
+
+        $this->setFactory('session', function(ServiceProvider $c) {
+            return \ElggSession::fromDatabase($c->config, $c->db);
+        });
+
+        $this->setClassName('urlSigner', \Elgg\Security\UrlSigner::class);
+
+        $this->setFactory('simpleCache', function(ServiceProvider $c) {
+            return new \Elgg\Cache\SimpleCache($c->config);
+        });
+
+        /**
+         * If the key is in the settings file, this is injected early.
+         *
+         * @see \Elgg\Application::initConfig
+         */
+        $this->setFactory('siteSecret', function(ServiceProvider $c) {
+            return \Elgg\Database\SiteSecret::fromDatabase($c->configTable);
+        });
+
+        $this->setClassName('stickyForms', \Elgg\Forms\StickyForms::class);
+
+        $this->setFactory('subtypeTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\SubtypeTable($c->db);
+        });
+
+        $this->setFactory('systemCache', function (ServiceProvider $c) {
+            $cache = new \Elgg\Cache\SystemCache($c->fileCache, $c->config);
+            if ($c->config->enable_profiling) {
+                $cache->setTimer($c->timer);
+            }
+            return $cache;
+        });
+
+        $this->setFactory('systemMessages', function(ServiceProvider $c) {
+            return new \Elgg\SystemMessagesService($c->session);
+        });
+
+        $this->setClassName('table_columns', \Elgg\Views\TableColumn\ColumnFactory::class);
+
+        $this->setClassName('timer', \Elgg\Timer::class);
+
+        $this->setFactory('translator', function(ServiceProvider $c) {
+            return new \Elgg\I18n\Translator($c->config);
+        });
+
+        $this->setFactory('uploads', function(ServiceProvider $c) {
+            return new \Elgg\UploadService($c->request);
+        });
+
+        $this->setFactory('upgrades', function(ServiceProvider $c) {
+            return new \Elgg\UpgradeService(
+                $c->translator,
+                $c->hooks,
+                $c->config,
+                $c->logger,
+                $c->mutex
+            );
+        });
+
+        $this->setFactory('userCapabilities', function(ServiceProvider $c) {
+            return new \Elgg\UserCapabilities($c->hooks, $c->entityTable, $c->session);
+        });
+
+        $this->setFactory('usersTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\UsersTable(
+                $c->config,
+                $c->db,
+                $c->entityTable,
+                $c->entityCache,
+                $c->hooks->getEvents()
+            );
+        });
+
+        $this->setFactory('upgradeLocator', function(ServiceProvider $c) {
+            return new \Elgg\Upgrade\Locator(
+                $c->plugins,
+                $c->logger,
+                $c->privateSettings
+            );
+        });
+
+        $this->setFactory('views', function(ServiceProvider $c) {
+            return new \Elgg\ViewsService($c->hooks, $c->logger, $c->input);
+        });
+
+        $this->setFactory('viewCacher', function(ServiceProvider $c) {
+            return new \Elgg\Cache\ViewCacher($c->views, $c->config);
+        });
+
+        $this->setClassName('widgets', \Elgg\WidgetsService::class);
+    }
 }

engine/classes/Elgg/Database/Plugins.php

Indentation +957 added lines, -957 removed lines

@@ -17,713 +17,713 @@ 
  * @since 1.10.0
  */
 class Plugins {
-	use Profilable;
+    use Profilable;
 
-	/**
-	 * @var \ElggPlugin[]
-	 */
-	private $boot_plugins = [];
+    /**
+     * @var \ElggPlugin[]
+     */
+    private $boot_plugins = [];
 
-	/**
-	 * @var array|null
-	 */
-	private $provides_cache;
+    /**
+     * @var array|null
+     */
+    private $provides_cache;
 
-	/**
-	 * @var string[] Active plugins, with plugin ID => GUID. Missing keys imply inactive plugins.
-	 */
-	private $active_guids = [];
+    /**
+     * @var string[] Active plugins, with plugin ID => GUID. Missing keys imply inactive plugins.
+     */
+    private $active_guids = [];
 
-	/**
-	 * @var bool Has $active_guids been populated?
-	 */
-	private $active_guids_known = false;
+    /**
+     * @var bool Has $active_guids been populated?
+     */
+    private $active_guids_known = false;
 
-	/**
-	 * @var Pool
-	 */
-	private $plugins_by_id;
+    /**
+     * @var Pool
+     */
+    private $plugins_by_id;
 
-	/**
-	 * @var PluginSettingsCache
-	 */
-	private $settings_cache;
+    /**
+     * @var PluginSettingsCache
+     */
+    private $settings_cache;
 
-	/**
-	 * Constructor
-	 *
-	 * @param Pool                $pool  Cache for referencing plugins by ID
-	 * @param PluginSettingsCache $cache Plugin settings cache
-	 */
-	public function __construct(Pool $pool, PluginSettingsCache $cache) {
-		$this->plugins_by_id = $pool;
-		$this->settings_cache = $cache;
-	}
+    /**
+     * Constructor
+     *
+     * @param Pool                $pool  Cache for referencing plugins by ID
+     * @param PluginSettingsCache $cache Plugin settings cache
+     */
+    public function __construct(Pool $pool, PluginSettingsCache $cache) {
+        $this->plugins_by_id = $pool;
+        $this->settings_cache = $cache;
+    }
 
-	/**
-	 * Set the list of active plugins according to the boot data cache
-	 *
-	 * @param \ElggPlugin[] $plugins Set of active plugins
-	 * @return void
-	 */
-	public function setBootPlugins(array $plugins) {
-		$this->boot_plugins = $plugins;
-		foreach ($plugins as $plugin) {
-			$this->plugins_by_id->put($plugin->getID(), $plugin);
-		}
-	}
+    /**
+     * Set the list of active plugins according to the boot data cache
+     *
+     * @param \ElggPlugin[] $plugins Set of active plugins
+     * @return void
+     */
+    public function setBootPlugins(array $plugins) {
+        $this->boot_plugins = $plugins;
+        foreach ($plugins as $plugin) {
+            $this->plugins_by_id->put($plugin->getID(), $plugin);
+        }
+    }
 
-	/**
-	 * Returns a list of plugin directory names from a base directory.
-	 *
-	 * @param string $dir A dir to scan for plugins. Defaults to config's plugins_path.
-	 *                    Must have a trailing slash.
-	 *
-	 * @return array Array of directory names (not full paths)
-	 * @access private
-	 */
-	function getDirsInDir($dir = null) {
-		if (!$dir) {
-			$dir = elgg_get_plugins_path();
-		}
-	
-		$plugin_dirs = [];
-		$handle = opendir($dir);
-	
-		if ($handle) {
-			while ($plugin_dir = readdir($handle)) {
-				// must be directory and not begin with a .
-				if (substr($plugin_dir, 0, 1) !== '.' && is_dir($dir . $plugin_dir)) {
-					$plugin_dirs[] = $plugin_dir;
-				}
-			}
-		}
-	
-		sort($plugin_dirs);
-	
-		return $plugin_dirs;
-	}
-	
-	/**
-	 * Discovers plugins in the plugins_path setting and creates \ElggPlugin
-	 * entities for them if they don't exist.  If there are plugins with entities
-	 * but not actual files, will disable the \ElggPlugin entities and mark as inactive.
-	 * The \ElggPlugin object holds config data, so don't delete.
-	 *
-	 * @return bool
-	 * @access private
-	 */
-	function generateEntities() {
-	
-		$mod_dir = elgg_get_plugins_path();
-		$db_prefix = _elgg_config()->dbprefix;
-	
-		// ignore access in case this is called with no admin logged in - needed for creating plugins perhaps?
-		$old_ia = elgg_set_ignore_access(true);
-	
-		// show hidden entities so that we can enable them if appropriate
-		$old_access = access_show_hidden_entities(true);
-	
-		$known_plugins = elgg_get_entities_from_relationship([
-			'type' => 'object',
-			'subtype' => 'plugin',
-			'selects' => ['plugin_oe.*'],
-			'joins' => ["JOIN {$db_prefix}objects_entity plugin_oe on plugin_oe.guid = e.guid"],
-			'limit' => ELGG_ENTITIES_NO_VALUE,
-		]);
-		/* @var \ElggPlugin[] $known_plugins */
-	
-		if (!$known_plugins) {
-			$known_plugins = [];
-		}
-	
-		// map paths to indexes
-		$id_map = [];
-		foreach ($known_plugins as $i => $plugin) {
-			// if the ID is wrong, delete the plugin because we can never load it.
-			$id = $plugin->getID();
-			if (!$id) {
-				$plugin->delete();
-				unset($known_plugins[$i]);
-				continue;
-			}
-			$id_map[$plugin->getID()] = $i;
-		}
-	
-		$physical_plugins = $this->getDirsInDir($mod_dir);
-		if (!$physical_plugins) {
-			elgg_set_ignore_access($old_ia);
-			return false;
-		}
-	
-		// check real plugins against known ones
-		foreach ($physical_plugins as $plugin_id) {
-			// is this already in the db?
-			if (array_key_exists($plugin_id, $id_map)) {
-				$index = $id_map[$plugin_id];
-				$plugin = $known_plugins[$index];
-				// was this plugin deleted and its entity disabled?
-				if (!$plugin->isEnabled()) {
-					$plugin->enable();
-					$plugin->deactivate();
-					$plugin->setPriority('last');
-				}
-	
-				// remove from the list of plugins to disable
-				unset($known_plugins[$index]);
-			} else {
-				// create new plugin
-				// priority is forced to last in save() if not set.
-				$plugin = new \ElggPlugin($mod_dir . $plugin_id);
-				$plugin->save();
-			}
-		}
-	
-		// everything remaining in $known_plugins needs to be disabled
-		// because they are entities, but their dirs were removed.
-		// don't delete the entities because they hold settings.
-		foreach ($known_plugins as $plugin) {
-			if ($plugin->isActive()) {
-				$plugin->deactivate();
-			}
-			// remove the priority.
-			$name = $this->namespacePrivateSetting('internal', 'priority');
-			remove_private_setting($plugin->guid, $name);
-			if ($plugin->isEnabled()) {
-				$plugin->disable();
-			}
-		}
-	
-		access_show_hidden_entities($old_access);
-		elgg_set_ignore_access($old_ia);
-	
-		return true;
-	}
-	
-	/**
-	 * Cache a reference to this plugin by its ID
-	 *
-	 * @param \ElggPlugin $plugin
-	 *
-	 * @access private
-	 */
-	function cache(\ElggPlugin $plugin) {
-		$this->plugins_by_id->put($plugin->getID(), $plugin);
-	}
-	
-	/**
-	 * Returns an \ElggPlugin object with the path $path.
-	 *
-	 * @param string $plugin_id The id (dir name) of the plugin. NOT the guid.
-	 * @return \ElggPlugin|null
-	 */
-	function get($plugin_id) {
-		return $this->plugins_by_id->get($plugin_id, function () use ($plugin_id) {
-			$plugin_id = sanitize_string($plugin_id);
-			$db_prefix = _elgg_config()->dbprefix;
+    /**
+     * Returns a list of plugin directory names from a base directory.
+     *
+     * @param string $dir A dir to scan for plugins. Defaults to config's plugins_path.
+     *                    Must have a trailing slash.
+     *
+     * @return array Array of directory names (not full paths)
+     * @access private
+     */
+    function getDirsInDir($dir = null) {
+        if (!$dir) {
+            $dir = elgg_get_plugins_path();
+        }
+	
+        $plugin_dirs = [];
+        $handle = opendir($dir);
+	
+        if ($handle) {
+            while ($plugin_dir = readdir($handle)) {
+                // must be directory and not begin with a .
+                if (substr($plugin_dir, 0, 1) !== '.' && is_dir($dir . $plugin_dir)) {
+                    $plugin_dirs[] = $plugin_dir;
+                }
+            }
+        }
+	
+        sort($plugin_dirs);
+	
+        return $plugin_dirs;
+    }
+	
+    /**
+     * Discovers plugins in the plugins_path setting and creates \ElggPlugin
+     * entities for them if they don't exist.  If there are plugins with entities
+     * but not actual files, will disable the \ElggPlugin entities and mark as inactive.
+     * The \ElggPlugin object holds config data, so don't delete.
+     *
+     * @return bool
+     * @access private
+     */
+    function generateEntities() {
+	
+        $mod_dir = elgg_get_plugins_path();
+        $db_prefix = _elgg_config()->dbprefix;
+	
+        // ignore access in case this is called with no admin logged in - needed for creating plugins perhaps?
+        $old_ia = elgg_set_ignore_access(true);
+	
+        // show hidden entities so that we can enable them if appropriate
+        $old_access = access_show_hidden_entities(true);
+	
+        $known_plugins = elgg_get_entities_from_relationship([
+            'type' => 'object',
+            'subtype' => 'plugin',
+            'selects' => ['plugin_oe.*'],
+            'joins' => ["JOIN {$db_prefix}objects_entity plugin_oe on plugin_oe.guid = e.guid"],
+            'limit' => ELGG_ENTITIES_NO_VALUE,
+        ]);
+        /* @var \ElggPlugin[] $known_plugins */
+	
+        if (!$known_plugins) {
+            $known_plugins = [];
+        }
+	
+        // map paths to indexes
+        $id_map = [];
+        foreach ($known_plugins as $i => $plugin) {
+            // if the ID is wrong, delete the plugin because we can never load it.
+            $id = $plugin->getID();
+            if (!$id) {
+                $plugin->delete();
+                unset($known_plugins[$i]);
+                continue;
+            }
+            $id_map[$plugin->getID()] = $i;
+        }
+	
+        $physical_plugins = $this->getDirsInDir($mod_dir);
+        if (!$physical_plugins) {
+            elgg_set_ignore_access($old_ia);
+            return false;
+        }
+	
+        // check real plugins against known ones
+        foreach ($physical_plugins as $plugin_id) {
+            // is this already in the db?
+            if (array_key_exists($plugin_id, $id_map)) {
+                $index = $id_map[$plugin_id];
+                $plugin = $known_plugins[$index];
+                // was this plugin deleted and its entity disabled?
+                if (!$plugin->isEnabled()) {
+                    $plugin->enable();
+                    $plugin->deactivate();
+                    $plugin->setPriority('last');
+                }
+	
+                // remove from the list of plugins to disable
+                unset($known_plugins[$index]);
+            } else {
+                // create new plugin
+                // priority is forced to last in save() if not set.
+                $plugin = new \ElggPlugin($mod_dir . $plugin_id);
+                $plugin->save();
+            }
+        }
+	
+        // everything remaining in $known_plugins needs to be disabled
+        // because they are entities, but their dirs were removed.
+        // don't delete the entities because they hold settings.
+        foreach ($known_plugins as $plugin) {
+            if ($plugin->isActive()) {
+                $plugin->deactivate();
+            }
+            // remove the priority.
+            $name = $this->namespacePrivateSetting('internal', 'priority');
+            remove_private_setting($plugin->guid, $name);
+            if ($plugin->isEnabled()) {
+                $plugin->disable();
+            }
+        }
+	
+        access_show_hidden_entities($old_access);
+        elgg_set_ignore_access($old_ia);
+	
+        return true;
+    }
+	
+    /**
+     * Cache a reference to this plugin by its ID
+     *
+     * @param \ElggPlugin $plugin
+     *
+     * @access private
+     */
+    function cache(\ElggPlugin $plugin) {
+        $this->plugins_by_id->put($plugin->getID(), $plugin);
+    }
+	
+    /**
+     * Returns an \ElggPlugin object with the path $path.
+     *
+     * @param string $plugin_id The id (dir name) of the plugin. NOT the guid.
+     * @return \ElggPlugin|null
+     */
+    function get($plugin_id) {
+        return $this->plugins_by_id->get($plugin_id, function () use ($plugin_id) {
+            $plugin_id = sanitize_string($plugin_id);
+            $db_prefix = _elgg_config()->dbprefix;
 
-			$options = [
-				'type' => 'object',
-				'subtype' => 'plugin',
-				'joins' => ["JOIN {$db_prefix}objects_entity oe on oe.guid = e.guid"],
-				'selects' => ["oe.title", "oe.description"],
-				'wheres' => ["oe.title = '$plugin_id'"],
-				'limit' => 1,
-				'distinct' => false,
-			];
+            $options = [
+                'type' => 'object',
+                'subtype' => 'plugin',
+                'joins' => ["JOIN {$db_prefix}objects_entity oe on oe.guid = e.guid"],
+                'selects' => ["oe.title", "oe.description"],
+                'wheres' => ["oe.title = '$plugin_id'"],
+                'limit' => 1,
+                'distinct' => false,
+            ];
 
-			$plugins = elgg_get_entities($options);
+            $plugins = elgg_get_entities($options);
 
-			if ($plugins) {
-				return $plugins[0];
-			}
+            if ($plugins) {
+                return $plugins[0];
+            }
 
-			return null;
-		});
-	}
-	
-	/**
-	 * Returns if a plugin exists in the system.
-	 *
-	 * @warning This checks only plugins that are registered in the system!
-	 * If the plugin cache is outdated, be sure to regenerate it with
-	 * {@link _elgg_generate_plugin_objects()} first.
-	 *
-	 * @param string $id The plugin ID.
-	 * @return bool
-	 */
-	function exists($id) {
-		return (bool) $this->get($id);
-	}
-	
-	/**
-	 * Returns the highest priority of the plugins
-	 *
-	 * @return int
-	 * @access private
-	 */
-	function getMaxPriority() {
-		$db_prefix = _elgg_config()->dbprefix;
-		$priority = $this->namespacePrivateSetting('internal', 'priority');
-		$plugin_subtype = get_subtype_id('object', 'plugin');
-	
-		$q = "SELECT MAX(CAST(ps.value AS unsigned)) as max
+            return null;
+        });
+    }
+	
+    /**
+     * Returns if a plugin exists in the system.
+     *
+     * @warning This checks only plugins that are registered in the system!
+     * If the plugin cache is outdated, be sure to regenerate it with
+     * {@link _elgg_generate_plugin_objects()} first.
+     *
+     * @param string $id The plugin ID.
+     * @return bool
+     */
+    function exists($id) {
+        return (bool) $this->get($id);
+    }
+	
+    /**
+     * Returns the highest priority of the plugins
+     *
+     * @return int
+     * @access private
+     */
+    function getMaxPriority() {
+        $db_prefix = _elgg_config()->dbprefix;
+        $priority = $this->namespacePrivateSetting('internal', 'priority');
+        $plugin_subtype = get_subtype_id('object', 'plugin');
+	
+        $q = "SELECT MAX(CAST(ps.value AS unsigned)) as max
 			FROM {$db_prefix}entities e, {$db_prefix}private_settings ps
 			WHERE ps.name = '$priority'
 			AND ps.entity_guid = e.guid
 			AND e.type = 'object' and e.subtype = $plugin_subtype";
 	
-		$data = get_data($q);
-		if ($data) {
-			$max = $data[0]->max;
-		} else {
-			$max = 1;
-		}
-	
-		// can't have a priority of 0.
-		return ($max) ? $max : 1;
-	}
-	
-	/**
-	 * Returns if a plugin is active for a current site.
-	 *
-	 * @param string $plugin_id The plugin ID
-	 * @return bool
-	 */
-	function isActive($plugin_id) {
-		if ($this->active_guids_known) {
-			return isset($this->active_guids[$plugin_id]);
-		}
+        $data = get_data($q);
+        if ($data) {
+            $max = $data[0]->max;
+        } else {
+            $max = 1;
+        }
+	
+        // can't have a priority of 0.
+        return ($max) ? $max : 1;
+    }
+	
+    /**
+     * Returns if a plugin is active for a current site.
+     *
+     * @param string $plugin_id The plugin ID
+     * @return bool
+     */
+    function isActive($plugin_id) {
+        if ($this->active_guids_known) {
+            return isset($this->active_guids[$plugin_id]);
+        }
 
-		$site = elgg_get_site_entity();
-	
-		if (!($site instanceof \ElggSite)) {
-			return false;
-		}
-	
-		$plugin = $this->get($plugin_id);
-	
-		if (!$plugin) {
-			return false;
-		}
-	
-		return $plugin->isActive($site->guid);
-	}
-	
-	/**
-	 * Loads all active plugins in the order specified in the tool admin panel.
-	 *
-	 * @note This is called on every page load. If a plugin is active and problematic, it
-	 * will be disabled and a visible error emitted. This does not check the deps system because
-	 * that was too slow.
-	 *
-	 * @return bool
-	 * @access private
-	 */
-	function load() {
-		if ($this->timer) {
-			$this->timer->begin([__METHOD__]);
-		}
+        $site = elgg_get_site_entity();
+	
+        if (!($site instanceof \ElggSite)) {
+            return false;
+        }
+	
+        $plugin = $this->get($plugin_id);
+	
+        if (!$plugin) {
+            return false;
+        }
+	
+        return $plugin->isActive($site->guid);
+    }
+	
+    /**
+     * Loads all active plugins in the order specified in the tool admin panel.
+     *
+     * @note This is called on every page load. If a plugin is active and problematic, it
+     * will be disabled and a visible error emitted. This does not check the deps system because
+     * that was too slow.
+     *
+     * @return bool
+     * @access private
+     */
+    function load() {
+        if ($this->timer) {
+            $this->timer->begin([__METHOD__]);
+        }
 
-		$plugins_path = elgg_get_plugins_path();
-		$start_flags = ELGG_PLUGIN_INCLUDE_START |
-						ELGG_PLUGIN_REGISTER_VIEWS |
-						ELGG_PLUGIN_REGISTER_ACTIONS |
-						ELGG_PLUGIN_REGISTER_LANGUAGES |
-						ELGG_PLUGIN_REGISTER_WIDGETS |
-						ELGG_PLUGIN_REGISTER_CLASSES;
-	
-		if (!$plugins_path) {
-			return false;
-		}
-	
-		// temporary disable all plugins if there is a file called 'disabled' in the plugin dir
-		if (file_exists("$plugins_path/disabled")) {
-			if (elgg_is_admin_logged_in() && elgg_in_context('admin')) {
-				system_message(_elgg_services()->translator->translate('plugins:disabled'));
-			}
-			return false;
-		}
+        $plugins_path = elgg_get_plugins_path();
+        $start_flags = ELGG_PLUGIN_INCLUDE_START |
+                        ELGG_PLUGIN_REGISTER_VIEWS |
+                        ELGG_PLUGIN_REGISTER_ACTIONS |
+                        ELGG_PLUGIN_REGISTER_LANGUAGES |
+                        ELGG_PLUGIN_REGISTER_WIDGETS |
+                        ELGG_PLUGIN_REGISTER_CLASSES;
+	
+        if (!$plugins_path) {
+            return false;
+        }
+	
+        // temporary disable all plugins if there is a file called 'disabled' in the plugin dir
+        if (file_exists("$plugins_path/disabled")) {
+            if (elgg_is_admin_logged_in() && elgg_in_context('admin')) {
+                system_message(_elgg_services()->translator->translate('plugins:disabled'));
+            }
+            return false;
+        }
 
-		$config = _elgg_config();
+        $config = _elgg_config();
 	
-		if ($config->system_cache_loaded) {
-			$start_flags = $start_flags & ~ELGG_PLUGIN_REGISTER_VIEWS;
-		}
+        if ($config->system_cache_loaded) {
+            $start_flags = $start_flags & ~ELGG_PLUGIN_REGISTER_VIEWS;
+        }
 	
-		if (_elgg_services()->translator->wasLoadedFromCache()) {
-			$start_flags = $start_flags & ~ELGG_PLUGIN_REGISTER_LANGUAGES;
-		}
+        if (_elgg_services()->translator->wasLoadedFromCache()) {
+            $start_flags = $start_flags & ~ELGG_PLUGIN_REGISTER_LANGUAGES;
+        }
 	
-		$plugins = $this->boot_plugins;
-		if (!$plugins) {
-			$this->active_guids_known = true;
-			return true;
-		}
+        $plugins = $this->boot_plugins;
+        if (!$plugins) {
+            $this->active_guids_known = true;
+            return true;
+        }
 
-		$return = true;
-		foreach ($plugins as $plugin) {
-			$id = $plugin->getID();
-			try {
-				$plugin->start($start_flags);
-				$this->active_guids[$id] = $plugin->guid;
-			} catch (Exception $e) {
-				$disable_plugins = _elgg_config()->auto_disable_plugins;
-				if ($disable_plugins === null) {
-					$disable_plugins = true;
-				}
-				if ($disable_plugins) {
-					$plugin->deactivate();
+        $return = true;
+        foreach ($plugins as $plugin) {
+            $id = $plugin->getID();
+            try {
+                $plugin->start($start_flags);
+                $this->active_guids[$id] = $plugin->guid;
+            } catch (Exception $e) {
+                $disable_plugins = _elgg_config()->auto_disable_plugins;
+                if ($disable_plugins === null) {
+                    $disable_plugins = true;
+                }
+                if ($disable_plugins) {
+                    $plugin->deactivate();
 				
-					$msg = _elgg_services()->translator->translate('PluginException:CannotStart',
-									[$id, $plugin->guid, $e->getMessage()]);
-					elgg_add_admin_notice("cannot_start $id", $msg);
-					$return = false;
-				}
-			}
-		}
+                    $msg = _elgg_services()->translator->translate('PluginException:CannotStart',
+                                    [$id, $plugin->guid, $e->getMessage()]);
+                    elgg_add_admin_notice("cannot_start $id", $msg);
+                    $return = false;
+                }
+            }
+        }
 
-		$this->active_guids_known = true;
+        $this->active_guids_known = true;
 
-		if ($this->timer) {
-			$this->timer->end([__METHOD__]);
-		}
-		return $return;
-	}
-	
-	/**
-	 * Returns an ordered list of plugins
-	 *
-	 * @param string $status The status of the plugins. active, inactive, or all.
-	 * @return \ElggPlugin[]
-	 */
-	function find($status = 'active') {
-		if (!_elgg_services()->db) {
-			return [];
-		}
+        if ($this->timer) {
+            $this->timer->end([__METHOD__]);
+        }
+        return $return;
+    }
+	
+    /**
+     * Returns an ordered list of plugins
+     *
+     * @param string $status The status of the plugins. active, inactive, or all.
+     * @return \ElggPlugin[]
+     */
+    function find($status = 'active') {
+        if (!_elgg_services()->db) {
+            return [];
+        }
 
-		$db_prefix = _elgg_config()->dbprefix;
-		$priority = $this->namespacePrivateSetting('internal', 'priority');
-		$site_guid = 1;
+        $db_prefix = _elgg_config()->dbprefix;
+        $priority = $this->namespacePrivateSetting('internal', 'priority');
+        $site_guid = 1;
 		
-		// grab plugins
-		$options = [
-			'type' => 'object',
-			'subtype' => 'plugin',
-			'limit' => ELGG_ENTITIES_NO_VALUE,
-			'selects' => ['plugin_oe.*', 'ps.value'],
-			'joins' => [
-				"JOIN {$db_prefix}private_settings ps on ps.entity_guid = e.guid",
-				"JOIN {$db_prefix}objects_entity plugin_oe on plugin_oe.guid = e.guid"
-				],
-			'wheres' => ["ps.name = '$priority'"],
-			// ORDER BY CAST(ps.value) is super slow. We usort() below.
-			'order_by' => false,
-			'distinct' => false,
-		];
-	
-		switch ($status) {
-			case 'active':
-				$options['relationship'] = 'active_plugin';
-				$options['relationship_guid'] = $site_guid;
-				$options['inverse_relationship'] = true;
-				break;
-	
-			case 'inactive':
-				$options['wheres'][] = "NOT EXISTS (
+        // grab plugins
+        $options = [
+            'type' => 'object',
+            'subtype' => 'plugin',
+            'limit' => ELGG_ENTITIES_NO_VALUE,
+            'selects' => ['plugin_oe.*', 'ps.value'],
+            'joins' => [
+                "JOIN {$db_prefix}private_settings ps on ps.entity_guid = e.guid",
+                "JOIN {$db_prefix}objects_entity plugin_oe on plugin_oe.guid = e.guid"
+                ],
+            'wheres' => ["ps.name = '$priority'"],
+            // ORDER BY CAST(ps.value) is super slow. We usort() below.
+            'order_by' => false,
+            'distinct' => false,
+        ];
+	
+        switch ($status) {
+            case 'active':
+                $options['relationship'] = 'active_plugin';
+                $options['relationship_guid'] = $site_guid;
+                $options['inverse_relationship'] = true;
+                break;
+	
+            case 'inactive':
+                $options['wheres'][] = "NOT EXISTS (
 						SELECT 1 FROM {$db_prefix}entity_relationships active_er
 						WHERE active_er.guid_one = e.guid
 							AND active_er.relationship = 'active_plugin'
 							AND active_er.guid_two = $site_guid)";
-				break;
+                break;
 	
-			case 'all':
-			default:
-				break;
-		}
+            case 'all':
+            default:
+                break;
+        }
 	
-		$old_ia = elgg_set_ignore_access(true);
-		$plugins = elgg_get_entities_from_relationship($options);
-		elgg_set_ignore_access($old_ia);
+        $old_ia = elgg_set_ignore_access(true);
+        $plugins = elgg_get_entities_from_relationship($options);
+        elgg_set_ignore_access($old_ia);
 
-		usort($plugins, function (\ElggPlugin $a, \ElggPlugin $b) {
-			$a_value = $a->getVolatileData('select:value');
-			$b_value = $b->getVolatileData('select:value');
+        usort($plugins, function (\ElggPlugin $a, \ElggPlugin $b) {
+            $a_value = $a->getVolatileData('select:value');
+            $b_value = $b->getVolatileData('select:value');
 
-			if ($b_value !== $a_value) {
-				return $a_value - $b_value;
-			} else {
-				return $a->guid - $b->guid;
-			}
-		});
-	
-		return $plugins;
-	}
-	
-	/**
-	 * Reorder plugins to an order specified by the array.
-	 * Plugins not included in this array will be appended to the end.
-	 *
-	 * @note This doesn't use the \ElggPlugin->setPriority() method because
-	 *       all plugins are being changed and we don't want it to automatically
-	 *       reorder plugins.
-	 * @todo Can this be done in a single sql command?
-	 *
-	 * @param array $order An array of plugin ids in the order to set them
-	 * @return bool
-	 * @access private
-	 */
-	function setPriorities(array $order) {
-		$name = $this->namespacePrivateSetting('internal', 'priority');
-	
-		$plugins = $this->find('any');
-		if (!$plugins) {
-			return false;
-		}
-	
-		// reindex to get standard counting. no need to increment by 10.
-		// though we do start with 1
-		$order = array_values($order);
-	
-		$missing_plugins = [];
-		/* @var \ElggPlugin[] $missing_plugins */
-	
-		$priority = 0;
-		foreach ($plugins as $plugin) {
-			$plugin_id = $plugin->getID();
-	
-			if (!in_array($plugin_id, $order)) {
-				$missing_plugins[] = $plugin;
-				continue;
-			}
-	
-			$priority = array_search($plugin_id, $order) + 1;
-	
-			if (!$plugin->setPrivateSetting($name, $priority)) {
-				return false;
-			}
-		}
-	
-		// set the missing plugins' priorities
-		if (empty($missing_plugins)) {
-			return true;
-		}
+            if ($b_value !== $a_value) {
+                return $a_value - $b_value;
+            } else {
+                return $a->guid - $b->guid;
+            }
+        });
+	
+        return $plugins;
+    }
+	
+    /**
+     * Reorder plugins to an order specified by the array.
+     * Plugins not included in this array will be appended to the end.
+     *
+     * @note This doesn't use the \ElggPlugin->setPriority() method because
+     *       all plugins are being changed and we don't want it to automatically
+     *       reorder plugins.
+     * @todo Can this be done in a single sql command?
+     *
+     * @param array $order An array of plugin ids in the order to set them
+     * @return bool
+     * @access private
+     */
+    function setPriorities(array $order) {
+        $name = $this->namespacePrivateSetting('internal', 'priority');
+	
+        $plugins = $this->find('any');
+        if (!$plugins) {
+            return false;
+        }
+	
+        // reindex to get standard counting. no need to increment by 10.
+        // though we do start with 1
+        $order = array_values($order);
+	
+        $missing_plugins = [];
+        /* @var \ElggPlugin[] $missing_plugins */
+	
+        $priority = 0;
+        foreach ($plugins as $plugin) {
+            $plugin_id = $plugin->getID();
+	
+            if (!in_array($plugin_id, $order)) {
+                $missing_plugins[] = $plugin;
+                continue;
+            }
+	
+            $priority = array_search($plugin_id, $order) + 1;
+	
+            if (!$plugin->setPrivateSetting($name, $priority)) {
+                return false;
+            }
+        }
+	
+        // set the missing plugins' priorities
+        if (empty($missing_plugins)) {
+            return true;
+        }
 		
-		foreach ($missing_plugins as $plugin) {
-			$priority++;
-			if (!$plugin->setPrivateSetting($name, $priority)) {
-				return false;
-			}
-		}
-	
-		return true;
-	}
-	
-	/**
-	 * Reindexes all plugin priorities starting at 1.
-	 *
-	 * @return bool
-	 * @access private
-	 */
-	function reindexPriorities() {
-		return $this->setPriorities([]);
-	}
-	
-	/**
-	 * Namespaces a string to be used as a private setting name for a plugin.
-	 *
-	 * For user_settings, two namespaces are added: a user setting namespace and the
-	 * plugin id.
-	 *
-	 * For internal (plugin priority), there is a single internal namespace added.
-	 *
-	 * @param string $type The type of setting: user_setting or internal.
-	 * @param string $name The name to namespace.
-	 * @param string $id   The plugin's ID to namespace with.  Required for user_setting.
-	 * @return string
-	 * @access private
-	 */
-	function namespacePrivateSetting($type, $name, $id = null) {
-		switch ($type) {
-			case 'user_setting':
-				if (!$id) {
-					throw new \InvalidArgumentException("You must pass the plugin id for user settings");
-				}
-				$name = ELGG_PLUGIN_USER_SETTING_PREFIX . "$id:$name";
-				break;
-	
-			case 'internal':
-				$name = ELGG_PLUGIN_INTERNAL_PREFIX . $name;
-				break;
-		}
-	
-		return $name;
-	}
-	
-	
-	/**
-	 * Returns an array of all provides from all active plugins.
-	 *
-	 * Array in the form array(
-	 * 	'provide_type' => array(
-	 * 		'provided_name' => array(
-	 * 			'version' => '1.8',
-	 * 			'provided_by' => 'provider_plugin_id'
-	 *  	)
-	 *  )
-	 * )
-	 *
-	 * @param string $type The type of provides to return
-	 * @param string $name A specific provided name to return. Requires $provide_type.
-	 *
-	 * @return array
-	 * @access private
-	 */
-	function getProvides($type = null, $name = null) {
-		if ($this->provides_cache === null) {
-			$active_plugins = $this->find('active');
+        foreach ($missing_plugins as $plugin) {
+            $priority++;
+            if (!$plugin->setPrivateSetting($name, $priority)) {
+                return false;
+            }
+        }
+	
+        return true;
+    }
+	
+    /**
+     * Reindexes all plugin priorities starting at 1.
+     *
+     * @return bool
+     * @access private
+     */
+    function reindexPriorities() {
+        return $this->setPriorities([]);
+    }
+	
+    /**
+     * Namespaces a string to be used as a private setting name for a plugin.
+     *
+     * For user_settings, two namespaces are added: a user setting namespace and the
+     * plugin id.
+     *
+     * For internal (plugin priority), there is a single internal namespace added.
+     *
+     * @param string $type The type of setting: user_setting or internal.
+     * @param string $name The name to namespace.
+     * @param string $id   The plugin's ID to namespace with.  Required for user_setting.
+     * @return string
+     * @access private
+     */
+    function namespacePrivateSetting($type, $name, $id = null) {
+        switch ($type) {
+            case 'user_setting':
+                if (!$id) {
+                    throw new \InvalidArgumentException("You must pass the plugin id for user settings");
+                }
+                $name = ELGG_PLUGIN_USER_SETTING_PREFIX . "$id:$name";
+                break;
+	
+            case 'internal':
+                $name = ELGG_PLUGIN_INTERNAL_PREFIX . $name;
+                break;
+        }
+	
+        return $name;
+    }
+	
+	
+    /**
+     * Returns an array of all provides from all active plugins.
+     *
+     * Array in the form array(
+     * 	'provide_type' => array(
+     * 		'provided_name' => array(
+     * 			'version' => '1.8',
+     * 			'provided_by' => 'provider_plugin_id'
+     *  	)
+     *  )
+     * )
+     *
+     * @param string $type The type of provides to return
+     * @param string $name A specific provided name to return. Requires $provide_type.
+     *
+     * @return array
+     * @access private
+     */
+    function getProvides($type = null, $name = null) {
+        if ($this->provides_cache === null) {
+            $active_plugins = $this->find('active');
 		
-			$provides = [];
-	
-			foreach ($active_plugins as $plugin) {
-				$plugin_provides = [];
-				$manifest = $plugin->getManifest();
-				if ($manifest instanceof \ElggPluginManifest) {
-					$plugin_provides = $plugin->getManifest()->getProvides();
-				}
-				if ($plugin_provides) {
-					foreach ($plugin_provides as $provided) {
-						$provides[$provided['type']][$provided['name']] = [
-							'version' => $provided['version'],
-							'provided_by' => $plugin->getID()
-						];
-					}
-				}
-			}
+            $provides = [];
+	
+            foreach ($active_plugins as $plugin) {
+                $plugin_provides = [];
+                $manifest = $plugin->getManifest();
+                if ($manifest instanceof \ElggPluginManifest) {
+                    $plugin_provides = $plugin->getManifest()->getProvides();
+                }
+                if ($plugin_provides) {
+                    foreach ($plugin_provides as $provided) {
+                        $provides[$provided['type']][$provided['name']] = [
+                            'version' => $provided['version'],
+                            'provided_by' => $plugin->getID()
+                        ];
+                    }
+                }
+            }
 			
-			$this->provides_cache = $provides;
-		}
+            $this->provides_cache = $provides;
+        }
 		
-		if ($type && $name) {
-			if (isset($this->provides_cache[$type][$name])) {
-				return $this->provides_cache[$type][$name];
-			} else {
-				return false;
-			}
-		} elseif ($type) {
-			if (isset($this->provides_cache[$type])) {
-				return $this->provides_cache[$type];
-			} else {
-				return false;
-			}
-		}
-	
-		return $this->provides_cache;
-	}
-	
-	/**
-	 * Deletes all cached data on plugins being provided.
-	 *
-	 * @return boolean
-	 * @access private
-	 */
-	function invalidateProvidesCache() {
-		$this->provides_cache = null;
-		return true;
-	}
+        if ($type && $name) {
+            if (isset($this->provides_cache[$type][$name])) {
+                return $this->provides_cache[$type][$name];
+            } else {
+                return false;
+            }
+        } elseif ($type) {
+            if (isset($this->provides_cache[$type])) {
+                return $this->provides_cache[$type];
+            } else {
+                return false;
+            }
+        }
+	
+        return $this->provides_cache;
+    }
+	
+    /**
+     * Deletes all cached data on plugins being provided.
+     *
+     * @return boolean
+     * @access private
+     */
+    function invalidateProvidesCache() {
+        $this->provides_cache = null;
+        return true;
+    }
 
-	/**
-	 * Delete the cache holding whether plugins are active or not
-	 *
-	 * @return void
-	 * @access private
-	 */
-	public function invalidateIsActiveCache() {
-		$this->active_guids = [];
-		$this->active_guids_known = false;
-	}
-	
-	/**
-	 * Checks if a plugin is currently providing $type and $name, and optionally
-	 * checking a version.
-	 *
-	 * @param string $type       The type of the provide
-	 * @param string $name       The name of the provide
-	 * @param string $version    A version to check against
-	 * @param string $comparison The comparison operator to use in version_compare()
-	 *
-	 * @return array An array in the form array(
-	 * 	'status' => bool Does the provide exist?,
-	 * 	'value' => string The version provided
-	 * )
-	 * @access private
-	 */
-	function checkProvides($type, $name, $version = null, $comparison = 'ge') {
-		$provided = $this->getProvides($type, $name);
-		if (!$provided) {
-			return [
-				'status' => false,
-				'value' => ''
-			];
-		}
-	
-		if ($version) {
-			$status = version_compare($provided['version'], $version, $comparison);
-		} else {
-			$status = true;
-		}
-	
-		return [
-			'status' => $status,
-			'value' => $provided['version']
-		];
-	}
-	
-	/**
-	 * Returns an array of parsed strings for a dependency in the
-	 * format: array(
-	 * 	'type'			=>	requires, conflicts, or provides.
-	 * 	'name'			=>	The name of the requirement / conflict
-	 * 	'value'			=>	A string representing the expected value: <1, >=3, !=enabled
-	 * 	'local_value'	=>	The current value, ("Not installed")
-	 * 	'comment'		=>	Free form text to help resovle the problem ("Enable / Search for plugin <link>")
-	 * )
-	 *
-	 * @param array $dep An \ElggPluginPackage dependency array
-	 * @return array
-	 * @access private
-	 */
-	function getDependencyStrings($dep) {
-		$translator = _elgg_services()->translator;
-		$dep_system = elgg_extract('type', $dep);
-		$info = elgg_extract('dep', $dep);
-		$type = elgg_extract('type', $info);
-	
-		if (!$dep_system || !$info || !$type) {
-			return false;
-		}
-	
-		// rewrite some of these to be more readable
-		$comparison = elgg_extract('comparison', $info);
-		switch ($comparison) {
-			case 'lt':
-				$comparison = '<';
-				break;
-			case 'gt':
-				$comparison = '>';
-				break;
-			case 'ge':
-				$comparison = '>=';
-				break;
-			case 'le':
-				$comparison = '<=';
-				break;
-			default:
-				//keep $comparison value intact
-				break;
-		}
-	
-		/*
+    /**
+     * Delete the cache holding whether plugins are active or not
+     *
+     * @return void
+     * @access private
+     */
+    public function invalidateIsActiveCache() {
+        $this->active_guids = [];
+        $this->active_guids_known = false;
+    }
+	
+    /**
+     * Checks if a plugin is currently providing $type and $name, and optionally
+     * checking a version.
+     *
+     * @param string $type       The type of the provide
+     * @param string $name       The name of the provide
+     * @param string $version    A version to check against
+     * @param string $comparison The comparison operator to use in version_compare()
+     *
+     * @return array An array in the form array(
+     * 	'status' => bool Does the provide exist?,
+     * 	'value' => string The version provided
+     * )
+     * @access private
+     */
+    function checkProvides($type, $name, $version = null, $comparison = 'ge') {
+        $provided = $this->getProvides($type, $name);
+        if (!$provided) {
+            return [
+                'status' => false,
+                'value' => ''
+            ];
+        }
+	
+        if ($version) {
+            $status = version_compare($provided['version'], $version, $comparison);
+        } else {
+            $status = true;
+        }
+	
+        return [
+            'status' => $status,
+            'value' => $provided['version']
+        ];
+    }
+	
+    /**
+     * Returns an array of parsed strings for a dependency in the
+     * format: array(
+     * 	'type'			=>	requires, conflicts, or provides.
+     * 	'name'			=>	The name of the requirement / conflict
+     * 	'value'			=>	A string representing the expected value: <1, >=3, !=enabled
+     * 	'local_value'	=>	The current value, ("Not installed")
+     * 	'comment'		=>	Free form text to help resovle the problem ("Enable / Search for plugin <link>")
+     * )
+     *
+     * @param array $dep An \ElggPluginPackage dependency array
+     * @return array
+     * @access private
+     */
+    function getDependencyStrings($dep) {
+        $translator = _elgg_services()->translator;
+        $dep_system = elgg_extract('type', $dep);
+        $info = elgg_extract('dep', $dep);
+        $type = elgg_extract('type', $info);
+	
+        if (!$dep_system || !$info || !$type) {
+            return false;
+        }
+	
+        // rewrite some of these to be more readable
+        $comparison = elgg_extract('comparison', $info);
+        switch ($comparison) {
+            case 'lt':
+                $comparison = '<';
+                break;
+            case 'gt':
+                $comparison = '>';
+                break;
+            case 'ge':
+                $comparison = '>=';
+                break;
+            case 'le':
+                $comparison = '<=';
+                break;
+            default:
+                //keep $comparison value intact
+                break;
+        }
+	
+        /*
 		'requires'	'plugin oauth_lib'	<1.3	1.3		'downgrade'
 		'requires'	'php setting bob'	>3		3		'change it'
 		'conflicts'	'php setting'		>3		4		'change it'
@@ -731,304 +731,304 @@ 
 		'provides'	'plugin oauth_lib'	1.3		--		--
 		'priority'	'before blog'		--		after	'move it'
 		*/
-		$strings = [];
-		$strings['type'] = $translator->translate('ElggPlugin:Dependencies:' . ucwords($dep_system));
-	
-		switch ($type) {
-			case 'elgg_release':
-				// 'Elgg Version'
-				$strings['name'] = $translator->translate('ElggPlugin:Dependencies:Elgg');
-				$strings['expected_value'] = "$comparison {$info['version']}";
-				$strings['local_value'] = $dep['value'];
-				$strings['comment'] = '';
-				break;
-	
-			case 'php_version':
-				// 'PHP version'
-				$strings['name'] = $translator->translate('ElggPlugin:Dependencies:PhpVersion');
-				$strings['expected_value'] = "$comparison {$info['version']}";
-				$strings['local_value'] = $dep['value'];
-				$strings['comment'] = '';
-				break;
+        $strings = [];
+        $strings['type'] = $translator->translate('ElggPlugin:Dependencies:' . ucwords($dep_system));
+	
+        switch ($type) {
+            case 'elgg_release':
+                // 'Elgg Version'
+                $strings['name'] = $translator->translate('ElggPlugin:Dependencies:Elgg');
+                $strings['expected_value'] = "$comparison {$info['version']}";
+                $strings['local_value'] = $dep['value'];
+                $strings['comment'] = '';
+                break;
+	
+            case 'php_version':
+                // 'PHP version'
+                $strings['name'] = $translator->translate('ElggPlugin:Dependencies:PhpVersion');
+                $strings['expected_value'] = "$comparison {$info['version']}";
+                $strings['local_value'] = $dep['value'];
+                $strings['comment'] = '';
+                break;
 			
-			case 'php_extension':
-				// PHP Extension %s [version]
-				$strings['name'] = $translator->translate('ElggPlugin:Dependencies:PhpExtension', [$info['name']]);
-				if ($info['version']) {
-					$strings['expected_value'] = "$comparison {$info['version']}";
-					$strings['local_value'] = $dep['value'];
-				} else {
-					$strings['expected_value'] = '';
-					$strings['local_value'] = '';
-				}
-				$strings['comment'] = '';
-				break;
-	
-			case 'php_ini':
-				$strings['name'] = $translator->translate('ElggPlugin:Dependencies:PhpIni', [$info['name']]);
-				$strings['expected_value'] = "$comparison {$info['value']}";
-				$strings['local_value'] = $dep['value'];
-				$strings['comment'] = '';
-				break;
-	
-			case 'plugin':
-				$strings['name'] = $translator->translate('ElggPlugin:Dependencies:Plugin', [$info['name']]);
-				$expected = $info['version'] ? "$comparison {$info['version']}" : $translator->translate('any');
-				$strings['expected_value'] = $expected;
-				$strings['local_value'] = $dep['value'] ? $dep['value'] : '--';
-				$strings['comment'] = '';
-				break;
-	
-			case 'priority':
-				$expected_priority = ucwords($info['priority']);
-				$real_priority = ucwords($dep['value']);
-				$strings['name'] = $translator->translate('ElggPlugin:Dependencies:Priority');
-				$strings['expected_value'] = $translator->translate("ElggPlugin:Dependencies:Priority:$expected_priority", [$info['plugin']]);
-				$strings['local_value'] = $translator->translate("ElggPlugin:Dependencies:Priority:$real_priority", [$info['plugin']]);
-				$strings['comment'] = '';
-				break;
-		}
-	
-		if ($dep['type'] == 'suggests') {
-			if ($dep['status']) {
-				$strings['comment'] = $translator->translate('ok');
-			} else {
-				$strings['comment'] = $translator->translate('ElggPlugin:Dependencies:Suggests:Unsatisfied');
-			}
-		} else {
-			if ($dep['status']) {
-				$strings['comment'] = $translator->translate('ok');
-			} else {
-				$strings['comment'] = $translator->translate('error');
-			}
-		}
-	
-		return $strings;
-	}
-	
-	/**
-	 * Returns an array of all plugin user settings for a user.
-	 *
-	 * @param int    $user_guid  The user GUID or 0 for the currently logged in user.
-	 * @param string $plugin_id  The plugin ID (Required)
-	 * @param bool   $return_obj Return settings as an object? This can be used to in reusable
-	 *                           views where the settings are passed as $vars['entity'].
-	 * @return array
-	 * @see \ElggPlugin::getAllUserSettings()
-	 */
-	function getAllUserSettings($user_guid = 0, $plugin_id = null, $return_obj = false) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
-	
-		$settings = $plugin->getAllUserSettings((int) $user_guid);
-	
-		if ($settings && $return_obj) {
-			$return = new \stdClass;
-	
-			foreach ($settings as $k => $v) {
-				$return->$k = $v;
-			}
-	
-			return $return;
-		} else {
-			return $settings;
-		}
-	}
-	
-	/**
-	 * Set a user specific setting for a plugin.
-	 *
-	 * @param string $name      The name. Note: cannot be "title".
-	 * @param mixed  $value     The value.
-	 * @param int    $user_guid The user GUID or 0 for the currently logged in user.
-	 * @param string $plugin_id The plugin ID (Required)
-	 *
-	 * @return bool
-	 * @see \ElggPlugin::setUserSetting()
-	 */
-	function setUserSetting($name, $value, $user_guid = 0, $plugin_id = null) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
+            case 'php_extension':
+                // PHP Extension %s [version]
+                $strings['name'] = $translator->translate('ElggPlugin:Dependencies:PhpExtension', [$info['name']]);
+                if ($info['version']) {
+                    $strings['expected_value'] = "$comparison {$info['version']}";
+                    $strings['local_value'] = $dep['value'];
+                } else {
+                    $strings['expected_value'] = '';
+                    $strings['local_value'] = '';
+                }
+                $strings['comment'] = '';
+                break;
+	
+            case 'php_ini':
+                $strings['name'] = $translator->translate('ElggPlugin:Dependencies:PhpIni', [$info['name']]);
+                $strings['expected_value'] = "$comparison {$info['value']}";
+                $strings['local_value'] = $dep['value'];
+                $strings['comment'] = '';
+                break;
+	
+            case 'plugin':
+                $strings['name'] = $translator->translate('ElggPlugin:Dependencies:Plugin', [$info['name']]);
+                $expected = $info['version'] ? "$comparison {$info['version']}" : $translator->translate('any');
+                $strings['expected_value'] = $expected;
+                $strings['local_value'] = $dep['value'] ? $dep['value'] : '--';
+                $strings['comment'] = '';
+                break;
+	
+            case 'priority':
+                $expected_priority = ucwords($info['priority']);
+                $real_priority = ucwords($dep['value']);
+                $strings['name'] = $translator->translate('ElggPlugin:Dependencies:Priority');
+                $strings['expected_value'] = $translator->translate("ElggPlugin:Dependencies:Priority:$expected_priority", [$info['plugin']]);
+                $strings['local_value'] = $translator->translate("ElggPlugin:Dependencies:Priority:$real_priority", [$info['plugin']]);
+                $strings['comment'] = '';
+                break;
+        }
+	
+        if ($dep['type'] == 'suggests') {
+            if ($dep['status']) {
+                $strings['comment'] = $translator->translate('ok');
+            } else {
+                $strings['comment'] = $translator->translate('ElggPlugin:Dependencies:Suggests:Unsatisfied');
+            }
+        } else {
+            if ($dep['status']) {
+                $strings['comment'] = $translator->translate('ok');
+            } else {
+                $strings['comment'] = $translator->translate('error');
+            }
+        }
+	
+        return $strings;
+    }
+	
+    /**
+     * Returns an array of all plugin user settings for a user.
+     *
+     * @param int    $user_guid  The user GUID or 0 for the currently logged in user.
+     * @param string $plugin_id  The plugin ID (Required)
+     * @param bool   $return_obj Return settings as an object? This can be used to in reusable
+     *                           views where the settings are passed as $vars['entity'].
+     * @return array
+     * @see \ElggPlugin::getAllUserSettings()
+     */
+    function getAllUserSettings($user_guid = 0, $plugin_id = null, $return_obj = false) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
+	
+        $settings = $plugin->getAllUserSettings((int) $user_guid);
+	
+        if ($settings && $return_obj) {
+            $return = new \stdClass;
+	
+            foreach ($settings as $k => $v) {
+                $return->$k = $v;
+            }
+	
+            return $return;
+        } else {
+            return $settings;
+        }
+    }
+	
+    /**
+     * Set a user specific setting for a plugin.
+     *
+     * @param string $name      The name. Note: cannot be "title".
+     * @param mixed  $value     The value.
+     * @param int    $user_guid The user GUID or 0 for the currently logged in user.
+     * @param string $plugin_id The plugin ID (Required)
+     *
+     * @return bool
+     * @see \ElggPlugin::setUserSetting()
+     */
+    function setUserSetting($name, $value, $user_guid = 0, $plugin_id = null) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
 
-		return $plugin->setUserSetting($name, $value, (int) $user_guid);
-	}
-	
-	/**
-	 * Unsets a user-specific plugin setting
-	 *
-	 * @param string $name      Name of the setting
-	 * @param int    $user_guid The user GUID or 0 for the currently logged in user.
-	 * @param string $plugin_id The plugin ID (Required)
-	 *
-	 * @return bool
-	 * @see \ElggPlugin::unsetUserSetting()
-	 */
-	function unsetUserSetting($name, $user_guid = 0, $plugin_id = null) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
+        return $plugin->setUserSetting($name, $value, (int) $user_guid);
+    }
+	
+    /**
+     * Unsets a user-specific plugin setting
+     *
+     * @param string $name      Name of the setting
+     * @param int    $user_guid The user GUID or 0 for the currently logged in user.
+     * @param string $plugin_id The plugin ID (Required)
+     *
+     * @return bool
+     * @see \ElggPlugin::unsetUserSetting()
+     */
+    function unsetUserSetting($name, $user_guid = 0, $plugin_id = null) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
 
-		return $plugin->unsetUserSetting($name, (int) $user_guid);
-	}
-	
-	/**
-	 * Get a user specific setting for a plugin.
-	 *
-	 * @param string $name      The name of the setting.
-	 * @param int    $user_guid The user GUID or 0 for the currently logged in user.
-	 * @param string $plugin_id The plugin ID (Required)
-	 * @param mixed  $default   The default value to return if none is set
-	 *
-	 * @return mixed
-	 * @see \ElggPlugin::getUserSetting()
-	 */
-	function getUserSetting($name, $user_guid = 0, $plugin_id = null, $default = null) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
+        return $plugin->unsetUserSetting($name, (int) $user_guid);
+    }
+	
+    /**
+     * Get a user specific setting for a plugin.
+     *
+     * @param string $name      The name of the setting.
+     * @param int    $user_guid The user GUID or 0 for the currently logged in user.
+     * @param string $plugin_id The plugin ID (Required)
+     * @param mixed  $default   The default value to return if none is set
+     *
+     * @return mixed
+     * @see \ElggPlugin::getUserSetting()
+     */
+    function getUserSetting($name, $user_guid = 0, $plugin_id = null, $default = null) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
 
-		return $plugin->getUserSetting($name, (int) $user_guid, $default);
-	}
-	
-	/**
-	 * Set a setting for a plugin.
-	 *
-	 * @param string $name      The name of the setting - note, can't be "title".
-	 * @param mixed  $value     The value.
-	 * @param string $plugin_id The plugin ID (Required)
-	 *
-	 * @return bool
-	 * @see \ElggPlugin::setSetting()
-	 */
-	function setSetting($name, $value, $plugin_id) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
+        return $plugin->getUserSetting($name, (int) $user_guid, $default);
+    }
+	
+    /**
+     * Set a setting for a plugin.
+     *
+     * @param string $name      The name of the setting - note, can't be "title".
+     * @param mixed  $value     The value.
+     * @param string $plugin_id The plugin ID (Required)
+     *
+     * @return bool
+     * @see \ElggPlugin::setSetting()
+     */
+    function setSetting($name, $value, $plugin_id) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
 
-		return $plugin->setSetting($name, $value);
-	}
-	
-	/**
-	 * Get setting for a plugin.
-	 *
-	 * @param string $name      The name of the setting.
-	 * @param string $plugin_id The plugin ID (Required)
-	 * @param mixed  $default   The default value to return if none is set
-	 *
-	 * @return mixed
-	 * @see \ElggPlugin::getSetting()
-	 */
-	function getSetting($name, $plugin_id, $default = null) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
+        return $plugin->setSetting($name, $value);
+    }
+	
+    /**
+     * Get setting for a plugin.
+     *
+     * @param string $name      The name of the setting.
+     * @param string $plugin_id The plugin ID (Required)
+     * @param mixed  $default   The default value to return if none is set
+     *
+     * @return mixed
+     * @see \ElggPlugin::getSetting()
+     */
+    function getSetting($name, $plugin_id, $default = null) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
 
-		return $plugin->getSetting($name, $default);
-	}
-	
-	/**
-	 * Unsets a plugin setting.
-	 *
-	 * @param string $name      The name of the setting.
-	 * @param string $plugin_id The plugin ID (Required)
-	 *
-	 * @return bool
-	 * @see \ElggPlugin::unsetSetting()
-	 */
-	function unsetSetting($name, $plugin_id) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
+        return $plugin->getSetting($name, $default);
+    }
+	
+    /**
+     * Unsets a plugin setting.
+     *
+     * @param string $name      The name of the setting.
+     * @param string $plugin_id The plugin ID (Required)
+     *
+     * @return bool
+     * @see \ElggPlugin::unsetSetting()
+     */
+    function unsetSetting($name, $plugin_id) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
 
-		return $plugin->unsetSetting($name);
-	}
-	
-	/**
-	 * Unsets all plugin settings for a plugin.
-	 *
-	 * @param string $plugin_id The plugin ID (Required)
-	 *
-	 * @return bool
-	 * @see \ElggPlugin::unsetAllSettings()
-	 */
-	function unsetAllSettings($plugin_id) {
-		$plugin = $this->get($plugin_id);
-		if (!$plugin) {
-			return false;
-		}
-	
-		return $plugin->unsetAllSettings();
-	}
-	
-	/**
-	 * Returns entities based upon plugin user settings.
-	 * Takes all the options for {@link elgg_get_entities_from_private_settings()}
-	 * in addition to the ones below.
-	 *
-	 * @param array $options Array in the format:
-	 *
-	 * 	plugin_id => STR The plugin id. Required.
-	 *
-	 * 	plugin_user_setting_names => null|ARR private setting names
-	 *
-	 * 	plugin_user_setting_values => null|ARR metadata values
-	 *
-	 * 	plugin_user_setting_name_value_pairs => null|ARR (
-	 *                                         name => 'name',
-	 *                                         value => 'value',
-	 *                                         'operand' => '=',
-	 *                                        )
-	 * 	                             Currently if multiple values are sent via
-	 *                               an array (value => array('value1', 'value2')
-	 *                               the pair's operand will be forced to "IN".
-	 *
-	 * 	plugin_user_setting_name_value_pairs_operator => null|STR The operator to use for combining
-	 *                                        (name = value) OPERATOR (name = value); default AND
-	 *
-	 * @return mixed int If count, int. If not count, array. false on errors.
-	 */
-	function getEntitiesFromUserSettings(array $options = []) {
-		$singulars = ['plugin_user_setting_name', 'plugin_user_setting_value',
-			'plugin_user_setting_name_value_pair'];
-	
-		$options = _elgg_normalize_plural_options_array($options, $singulars);
-	
-		// rewrite plugin_user_setting_name_* to the right PS ones.
-		$map = [
-			'plugin_user_setting_names' => 'private_setting_names',
-			'plugin_user_setting_values' => 'private_setting_values',
-			'plugin_user_setting_name_value_pairs' => 'private_setting_name_value_pairs',
-			'plugin_user_setting_name_value_pairs_operator' => 'private_setting_name_value_pairs_operator',
-		];
-	
-		foreach ($map as $plugin => $private) {
-			if (!isset($options[$plugin])) {
-				continue;
-			}
-	
-			if (isset($options[$private])) {
-				if (!is_array($options[$private])) {
-					$options[$private] = [$options[$private]];
-				}
-	
-				$options[$private] = array_merge($options[$private], $options[$plugin]);
-			} else {
-				$options[$private] = $options[$plugin];
-			}
-		}
-	
-		$prefix = $this->namespacePrivateSetting('user_setting', '', $options['plugin_id']);
-		$options['private_setting_name_prefix'] = $prefix;
-	
-		return elgg_get_entities_from_private_settings($options);
-	}
+        return $plugin->unsetSetting($name);
+    }
+	
+    /**
+     * Unsets all plugin settings for a plugin.
+     *
+     * @param string $plugin_id The plugin ID (Required)
+     *
+     * @return bool
+     * @see \ElggPlugin::unsetAllSettings()
+     */
+    function unsetAllSettings($plugin_id) {
+        $plugin = $this->get($plugin_id);
+        if (!$plugin) {
+            return false;
+        }
+	
+        return $plugin->unsetAllSettings();
+    }
+	
+    /**
+     * Returns entities based upon plugin user settings.
+     * Takes all the options for {@link elgg_get_entities_from_private_settings()}
+     * in addition to the ones below.
+     *
+     * @param array $options Array in the format:
+     *
+     * 	plugin_id => STR The plugin id. Required.
+     *
+     * 	plugin_user_setting_names => null|ARR private setting names
+     *
+     * 	plugin_user_setting_values => null|ARR metadata values
+     *
+     * 	plugin_user_setting_name_value_pairs => null|ARR (
+     *                                         name => 'name',
+     *                                         value => 'value',
+     *                                         'operand' => '=',
+     *                                        )
+     * 	                             Currently if multiple values are sent via
+     *                               an array (value => array('value1', 'value2')
+     *                               the pair's operand will be forced to "IN".
+     *
+     * 	plugin_user_setting_name_value_pairs_operator => null|STR The operator to use for combining
+     *                                        (name = value) OPERATOR (name = value); default AND
+     *
+     * @return mixed int If count, int. If not count, array. false on errors.
+     */
+    function getEntitiesFromUserSettings(array $options = []) {
+        $singulars = ['plugin_user_setting_name', 'plugin_user_setting_value',
+            'plugin_user_setting_name_value_pair'];
+	
+        $options = _elgg_normalize_plural_options_array($options, $singulars);
+	
+        // rewrite plugin_user_setting_name_* to the right PS ones.
+        $map = [
+            'plugin_user_setting_names' => 'private_setting_names',
+            'plugin_user_setting_values' => 'private_setting_values',
+            'plugin_user_setting_name_value_pairs' => 'private_setting_name_value_pairs',
+            'plugin_user_setting_name_value_pairs_operator' => 'private_setting_name_value_pairs_operator',
+        ];
+	
+        foreach ($map as $plugin => $private) {
+            if (!isset($options[$plugin])) {
+                continue;
+            }
+	
+            if (isset($options[$private])) {
+                if (!is_array($options[$private])) {
+                    $options[$private] = [$options[$private]];
+                }
+	
+                $options[$private] = array_merge($options[$private], $options[$plugin]);
+            } else {
+                $options[$private] = $options[$plugin];
+            }
+        }
+	
+        $prefix = $this->namespacePrivateSetting('user_setting', '', $options['plugin_id']);
+        $options['private_setting_name_prefix'] = $prefix;
+	
+        return elgg_get_entities_from_private_settings($options);
+    }
 }

engine/classes/Elgg/Database/EntityTable.php

Indentation +1417 added lines, -1417 removed lines

@@ -38,177 +38,177 @@ 
  */
 class EntityTable {
 
-	use \Elgg\TimeUsing;
+    use \Elgg\TimeUsing;
 	
-	/**
-	 * @var Conf
-	 */
-	protected $config;
-
-	/**
-	 * @var Database
-	 */
-	protected $db;
-
-	/**
-	 * @var string
-	 */
-	protected $table;
-
-	/**
-	 * @var SubtypeTable
-	 */
-	protected $subtype_table;
-
-	/**
-	 * @var EntityCache
-	 */
-	protected $entity_cache;
-
-	/**
-	 * @var EntityPreloader
-	 */
-	protected $entity_preloader;
-
-	/**
-	 * @var MetadataCache
-	 */
-	protected $metadata_cache;
-
-	/**
-	 * @var EventsService
-	 */
-	protected $events;
-
-	/**
-	 * @var ElggSession
-	 */
-	protected $session;
-
-	/**
-	 * @var Translator
-	 */
-	protected $translator;
-
-	/**
-	 * @var Logger
-	 */
-	protected $logger;
-
-	/**
-	 * Constructor
-	 *
-	 * @param Conf          $config         Config
-	 * @param Database      $db             Database
-	 * @param EntityCache   $entity_cache   Entity cache
-	 * @param MetadataCache $metadata_cache Metadata cache
-	 * @param SubtypeTable  $subtype_table  Subtype table
-	 * @param EventsService $events         Events service
-	 * @param ElggSession   $session        Session
-	 * @param Translator    $translator     Translator
-	 * @param Logger        $logger         Logger
-	 */
-	public function __construct(
-		Conf $config,
-		Database $db,
-		EntityCache $entity_cache,
-		MetadataCache $metadata_cache,
-		SubtypeTable $subtype_table,
-		EventsService $events,
-		ElggSession $session,
-		Translator $translator,
-		Logger $logger
-	) {
-		$this->config = $config;
-		$this->db = $db;
-		$this->table = $this->db->prefix . 'entities';
-		$this->entity_cache = $entity_cache;
-		$this->metadata_cache = $metadata_cache;
-		$this->subtype_table = $subtype_table;
-		$this->events = $events;
-		$this->session = $session;
-		$this->translator = $translator;
-		$this->logger = $logger;
-	}
-
-	/**
-	 * Returns a database row from the entities table.
-	 *
-	 * @see entity_row_to_elggstar()
-	 *
-	 * @tip Use get_entity() to return the fully loaded entity.
-	 *
-	 * @warning This will only return results if a) it exists, b) you have access to it.
-	 * see {@link _elgg_get_access_where_sql()}.
-	 *
-	 * @param int $guid      The GUID of the object to extract
-	 * @param int $user_guid GUID of the user accessing the row
-	 *                       Defaults to logged in user if null
-	 *                       Builds an access query for a logged out user if 0
-	 * @return stdClass|false
-	 * @access private
-	 */
-	public function getRow($guid, $user_guid = null) {
-
-		if (!$guid) {
-			return false;
-		}
-
-		$access = _elgg_get_access_where_sql([
-			'table_alias' => '',
-			'user_guid' => $user_guid,
-		]);
-
-		$sql = "SELECT * FROM {$this->db->prefix}entities
+    /**
+     * @var Conf
+     */
+    protected $config;
+
+    /**
+     * @var Database
+     */
+    protected $db;
+
+    /**
+     * @var string
+     */
+    protected $table;
+
+    /**
+     * @var SubtypeTable
+     */
+    protected $subtype_table;
+
+    /**
+     * @var EntityCache
+     */
+    protected $entity_cache;
+
+    /**
+     * @var EntityPreloader
+     */
+    protected $entity_preloader;
+
+    /**
+     * @var MetadataCache
+     */
+    protected $metadata_cache;
+
+    /**
+     * @var EventsService
+     */
+    protected $events;
+
+    /**
+     * @var ElggSession
+     */
+    protected $session;
+
+    /**
+     * @var Translator
+     */
+    protected $translator;
+
+    /**
+     * @var Logger
+     */
+    protected $logger;
+
+    /**
+     * Constructor
+     *
+     * @param Conf          $config         Config
+     * @param Database      $db             Database
+     * @param EntityCache   $entity_cache   Entity cache
+     * @param MetadataCache $metadata_cache Metadata cache
+     * @param SubtypeTable  $subtype_table  Subtype table
+     * @param EventsService $events         Events service
+     * @param ElggSession   $session        Session
+     * @param Translator    $translator     Translator
+     * @param Logger        $logger         Logger
+     */
+    public function __construct(
+        Conf $config,
+        Database $db,
+        EntityCache $entity_cache,
+        MetadataCache $metadata_cache,
+        SubtypeTable $subtype_table,
+        EventsService $events,
+        ElggSession $session,
+        Translator $translator,
+        Logger $logger
+    ) {
+        $this->config = $config;
+        $this->db = $db;
+        $this->table = $this->db->prefix . 'entities';
+        $this->entity_cache = $entity_cache;
+        $this->metadata_cache = $metadata_cache;
+        $this->subtype_table = $subtype_table;
+        $this->events = $events;
+        $this->session = $session;
+        $this->translator = $translator;
+        $this->logger = $logger;
+    }
+
+    /**
+     * Returns a database row from the entities table.
+     *
+     * @see entity_row_to_elggstar()
+     *
+     * @tip Use get_entity() to return the fully loaded entity.
+     *
+     * @warning This will only return results if a) it exists, b) you have access to it.
+     * see {@link _elgg_get_access_where_sql()}.
+     *
+     * @param int $guid      The GUID of the object to extract
+     * @param int $user_guid GUID of the user accessing the row
+     *                       Defaults to logged in user if null
+     *                       Builds an access query for a logged out user if 0
+     * @return stdClass|false
+     * @access private
+     */
+    public function getRow($guid, $user_guid = null) {
+
+        if (!$guid) {
+            return false;
+        }
+
+        $access = _elgg_get_access_where_sql([
+            'table_alias' => '',
+            'user_guid' => $user_guid,
+        ]);
+
+        $sql = "SELECT * FROM {$this->db->prefix}entities
 			WHERE guid = :guid AND $access";
 
-		$params = [
-			':guid' => (int) $guid,
-		];
-
-		return $this->db->getDataRow($sql, null, $params);
-	}
-
-	/**
-	 * Adds a new row to the entity table
-	 *
-	 * @param stdClass $row        Entity base information
-	 * @param array    $attributes All primary and secondary table attributes
-	 *                             Used by database mock services to allow mocking
-	 *                             entities that were instantiated using new keyword
-	 *                             and calling ElggEntity::save()
-	 * @return int|false
-	 */
-	public function insertRow(stdClass $row, array $attributes = []) {
-
-		$sql = "INSERT INTO {$this->db->prefix}entities
+        $params = [
+            ':guid' => (int) $guid,
+        ];
+
+        return $this->db->getDataRow($sql, null, $params);
+    }
+
+    /**
+     * Adds a new row to the entity table
+     *
+     * @param stdClass $row        Entity base information
+     * @param array    $attributes All primary and secondary table attributes
+     *                             Used by database mock services to allow mocking
+     *                             entities that were instantiated using new keyword
+     *                             and calling ElggEntity::save()
+     * @return int|false
+     */
+    public function insertRow(stdClass $row, array $attributes = []) {
+
+        $sql = "INSERT INTO {$this->db->prefix}entities
 			(type, subtype, owner_guid, container_guid,
 				access_id, time_created, time_updated, last_action)
 			VALUES
 			(:type, :subtype_id, :owner_guid, :container_guid,
 				:access_id, :time_created, :time_updated, :last_action)";
 
-		return $this->db->insertData($sql, [
-			':type' => $row->type,
-			':subtype_id' => $row->subtype_id,
-			':owner_guid' => $row->owner_guid,
-			':container_guid' => $row->container_guid,
-			':access_id' => $row->access_id,
-			':time_created' => $row->time_created,
-			':time_updated' => $row->time_updated,
-			':last_action' => $row->last_action,
-		]);
-	}
-
-	/**
-	 * Update entity table row
-	 *
-	 * @param int      $guid Entity guid
-	 * @param stdClass $row  Updated data
-	 * @return int|false
-	 */
-	public function updateRow($guid, stdClass $row) {
-		$sql = "
+        return $this->db->insertData($sql, [
+            ':type' => $row->type,
+            ':subtype_id' => $row->subtype_id,
+            ':owner_guid' => $row->owner_guid,
+            ':container_guid' => $row->container_guid,
+            ':access_id' => $row->access_id,
+            ':time_created' => $row->time_created,
+            ':time_updated' => $row->time_updated,
+            ':last_action' => $row->last_action,
+        ]);
+    }
+
+    /**
+     * Update entity table row
+     *
+     * @param int      $guid Entity guid
+     * @param stdClass $row  Updated data
+     * @return int|false
+     */
+    public function updateRow($guid, stdClass $row) {
+        $sql = "
 			UPDATE {$this->db->prefix}entities
 			SET owner_guid = :owner_guid,
 			    access_id = :access_id,
@@ -218,1280 +218,1280 @@ 
 			WHERE guid = :guid
 		";
 
-		$params = [
-			':owner_guid' => $row->owner_guid,
-			':access_id' => $row->access_id,
-			':container_guid' => $row->container_guid,
-			':time_created' => $row->time_created,
-			':time_updated' => $row->time_updated,
-			':guid' => $guid,
-		];
-
-		return $this->db->updateData($sql, false, $params);
-	}
-
-	/**
-	 * Create an Elgg* object from a given entity row.
-	 *
-	 * Handles loading all tables into the correct class.
-	 *
-	 * @see get_entity_as_row()
-	 * @see add_subtype()
-	 * @see get_entity()
-	 *
-	 * @access private
-	 *
-	 * @param stdClass $row The row of the entry in the entities table.
-	 * @return ElggEntity|false
-	 * @throws ClassException
-	 * @throws InstallationException
-	 */
-	public function rowToElggStar($row) {
-		if (!$row instanceof stdClass) {
-			return $row;
-		}
-
-		if (!isset($row->guid) || !isset($row->subtype)) {
-			return $row;
-		}
+        $params = [
+            ':owner_guid' => $row->owner_guid,
+            ':access_id' => $row->access_id,
+            ':container_guid' => $row->container_guid,
+            ':time_created' => $row->time_created,
+            ':time_updated' => $row->time_updated,
+            ':guid' => $guid,
+        ];
+
+        return $this->db->updateData($sql, false, $params);
+    }
+
+    /**
+     * Create an Elgg* object from a given entity row.
+     *
+     * Handles loading all tables into the correct class.
+     *
+     * @see get_entity_as_row()
+     * @see add_subtype()
+     * @see get_entity()
+     *
+     * @access private
+     *
+     * @param stdClass $row The row of the entry in the entities table.
+     * @return ElggEntity|false
+     * @throws ClassException
+     * @throws InstallationException
+     */
+    public function rowToElggStar($row) {
+        if (!$row instanceof stdClass) {
+            return $row;
+        }
+
+        if (!isset($row->guid) || !isset($row->subtype)) {
+            return $row;
+        }
 	
-		$class_name = $this->subtype_table->getClassFromId($row->subtype);
-		if ($class_name && !class_exists($class_name)) {
-			$this->logger->error("Class '$class_name' was not found, missing plugin?");
-			$class_name = '';
-		}
-
-		if (!$class_name) {
-			$map = [
-				'object' => ElggObject::class,
-				'user' => ElggUser::class,
-				'group' => ElggGroup::class,
-				'site' => ElggSite::class,
-			];
-
-			if (isset($map[$row->type])) {
-				$class_name = $map[$row->type];
-			} else {
-				throw new InstallationException("Entity type {$row->type} is not supported.");
-			}
-		}
-
-		$entity = new $class_name($row);
-		if (!$entity instanceof ElggEntity) {
-			throw new ClassException("$class_name must extend " . ElggEntity::class);
-		}
-
-		return $entity;
-	}
-
-	/**
-	 * Get an entity from the in-memory or memcache caches
-	 *
-	 * @param int $guid GUID
-	 *
-	 * @return \ElggEntity
-	 */
-	protected function getFromCache($guid) {
-		$entity = $this->entity_cache->get($guid);
-		if ($entity) {
-			return $entity;
-		}
-
-		$memcache = _elgg_get_memcache('new_entity_cache');
-		$entity = $memcache->load($guid);
-		if (!$entity instanceof ElggEntity) {
-			return false;
-		}
-
-		// Validate accessibility if from memcache
-		if (!elgg_get_ignore_access() && !has_access_to_entity($entity)) {
-			return false;
-		}
-
-		$this->entity_cache->set($entity);
-		return $entity;
-	}
-
-	/**
-	 * Loads and returns an entity object from a guid.
-	 *
-	 * @param int    $guid The GUID of the entity
-	 * @param string $type The type of the entity. If given, even an existing entity with the given GUID
-	 *                     will not be returned unless its type matches.
-	 *
-	 * @return ElggEntity|stdClass|false The correct Elgg or custom object based upon entity type and subtype
-	 * @throws ClassException
-	 * @throws InstallationException
-	 */
-	public function get($guid, $type = '') {
-		// We could also use: if (!(int) $guid) { return false },
-		// but that evaluates to a false positive for $guid = true.
-		// This is a bit slower, but more thorough.
-		if (!is_numeric($guid) || $guid === 0 || $guid === '0') {
-			return false;
-		}
-
-		$guid = (int) $guid;
-
-		$entity = $this->getFromCache($guid);
-		if ($entity && (!$type || elgg_instanceof($entity, $type))) {
-			return $entity;
-		}
-
-		$row = $this->getRow($guid);
-		if (!$row) {
-			return false;
-		}
-
-		if ($type && $row->type != $type) {
-			return false;
-		}
-
-		$entity = $this->rowToElggStar($row);
-
-		if ($entity instanceof ElggEntity) {
-			$entity->storeInPersistedCache(_elgg_get_memcache('new_entity_cache'));
-		}
-
-		return $entity;
-	}
-
-	/**
-	 * Does an entity exist?
-	 *
-	 * This function checks for the existence of an entity independent of access
-	 * permissions. It is useful for situations when a user cannot access an entity
-	 * and it must be determined whether entity has been deleted or the access level
-	 * has changed.
-	 *
-	 * @param int $guid The GUID of the entity
-	 * @return bool
-	 */
-	public function exists($guid) {
-
-		// need to ignore access and show hidden entities to check existence
-		$ia = $this->session->setIgnoreAccess(true);
-		$show_hidden = access_show_hidden_entities(true);
-
-		$result = $this->getRow($guid);
-
-		$this->session->setIgnoreAccess($ia);
-		access_show_hidden_entities($show_hidden);
-
-		return !empty($result);
-	}
-
-	/**
-	 * Enable an entity.
-	 *
-	 * @param int  $guid      GUID of entity to enable
-	 * @param bool $recursive Recursively enable all entities disabled with the entity?
-	 * @return bool
-	 */
-	public function enable($guid, $recursive = true) {
-
-		// Override access only visible entities
-		$old_access_status = access_get_show_hidden_status();
-		access_show_hidden_entities(true);
-
-		$result = false;
-		$entity = get_entity($guid);
-		if ($entity) {
-			$result = $entity->enable($recursive);
-		}
-
-		access_show_hidden_entities($old_access_status);
-		return $result;
-	}
-
-	/**
-	 * Returns an array of entities with optional filtering.
-	 *
-	 * Entities are the basic unit of storage in Elgg.  This function
-	 * provides the simplest way to get an array of entities.  There
-	 * are many options available that can be passed to filter
-	 * what sorts of entities are returned.
-	 *
-	 * @tip To output formatted strings of entities, use {@link elgg_list_entities()} and
-	 * its cousins.
-	 *
-	 * @tip Plural arguments can be written as singular if only specifying a
-	 * single element.  ('type' => 'object' vs 'types' => array('object')).
-	 *
-	 * @see elgg_get_entities_from_metadata()
-	 * @see elgg_get_entities_from_relationship()
-	 * @see elgg_get_entities_from_access_id()
-	 * @see elgg_get_entities_from_annotations()
-	 * @see elgg_list_entities()
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * 	types => null|STR entity type (type IN ('type1', 'type2')
-	 *           Joined with subtypes by AND. See below)
-	 *
-	 * 	subtypes => null|STR entity subtype (SQL: subtype IN ('subtype1', 'subtype2))
-	 *              Use ELGG_ENTITIES_NO_VALUE to match the default subtype.
-	 *              Use ELGG_ENTITIES_ANY_VALUE to match any subtype.
-	 *
-	 * 	type_subtype_pairs => null|ARR (array('type' => 'subtype'))
-	 *                        array(
-	 *                            'object' => array('blog', 'file'), // All objects with subtype of 'blog' or 'file'
-	 *                            'user' => ELGG_ENTITY_ANY_VALUE, // All users irrespective of subtype
-	 *                        );
-	 *
-	 * 	guids => null|ARR Array of entity guids
-	 *
-	 * 	owner_guids => null|ARR Array of owner guids
-	 *
-	 * 	container_guids => null|ARR Array of container_guids
-	 *
-	 * 	order_by => null (time_created desc)|STR SQL order by clause
-	 *
-	 *  reverse_order_by => BOOL Reverse the default order by clause
-	 *
-	 * 	limit => null (10)|INT SQL limit clause (0 means no limit)
-	 *
-	 * 	offset => null (0)|INT SQL offset clause
-	 *
-	 * 	created_time_lower => null|INT Created time lower boundary in epoch time
-	 *
-	 * 	created_time_upper => null|INT Created time upper boundary in epoch time
-	 *
-	 * 	modified_time_lower => null|INT Modified time lower boundary in epoch time
-	 *
-	 * 	modified_time_upper => null|INT Modified time upper boundary in epoch time
-	 *
-	 * 	count => true|false return a count instead of entities
-	 *
-	 * 	wheres => array() Additional where clauses to AND together
-	 *
-	 * 	joins => array() Additional joins
-	 *
-	 * 	preload_owners => bool (false) If set to true, this function will preload
-	 * 					  all the owners of the returned entities resulting in better
-	 * 					  performance if those owners need to be displayed
-	 *
-	 *  preload_containers => bool (false) If set to true, this function will preload
-	 * 					      all the containers of the returned entities resulting in better
-	 * 					      performance if those containers need to be displayed
-	 *
-	 *
-	 * 	callback => string A callback function to pass each row through
-	 *
-	 * 	distinct => bool (true) If set to false, Elgg will drop the DISTINCT clause from
-	 * 				the MySQL query, which will improve performance in some situations.
-	 * 				Avoid setting this option without a full understanding of the underlying
-	 * 				SQL query Elgg creates.
-	 *
-	 *  batch => bool (false) If set to true, an Elgg\BatchResult object will be returned instead of an array.
-	 *           Since 2.3
-	 *
-	 *  batch_inc_offset => bool (true) If "batch" is used, this tells the batch to increment the offset
-	 *                      on each fetch. This must be set to false if you delete the batched results.
-	 *
-	 *  batch_size => int (25) If "batch" is used, this is the number of entities/rows to pull in before
-	 *                requesting more.
-	 *
-	 * @return \ElggEntity[]|int|mixed If count, int. Otherwise an array or an Elgg\BatchResult. false on errors.
-	 *
-	 * @see elgg_get_entities_from_metadata()
-	 * @see elgg_get_entities_from_relationship()
-	 * @see elgg_get_entities_from_access_id()
-	 * @see elgg_get_entities_from_annotations()
-	 * @see elgg_list_entities()
-	 */
-	public function getEntities(array $options = []) {
-		_elgg_check_unsupported_site_guid($options);
-
-		$defaults = [
-			'types'                 => ELGG_ENTITIES_ANY_VALUE,
-			'subtypes'              => ELGG_ENTITIES_ANY_VALUE,
-			'type_subtype_pairs'    => ELGG_ENTITIES_ANY_VALUE,
-
-			'guids'                 => ELGG_ENTITIES_ANY_VALUE,
-			'owner_guids'           => ELGG_ENTITIES_ANY_VALUE,
-			'container_guids'       => ELGG_ENTITIES_ANY_VALUE,
-
-			'modified_time_lower'   => ELGG_ENTITIES_ANY_VALUE,
-			'modified_time_upper'   => ELGG_ENTITIES_ANY_VALUE,
-			'created_time_lower'    => ELGG_ENTITIES_ANY_VALUE,
-			'created_time_upper'    => ELGG_ENTITIES_ANY_VALUE,
-
-			'reverse_order_by'      => false,
-			'order_by'              => 'e.time_created desc',
-			'group_by'              => ELGG_ENTITIES_ANY_VALUE,
-			'limit'                 => $this->config->default_limit,
-			'offset'                => 0,
-			'count'                 => false,
-			'selects'               => [],
-			'wheres'                => [],
-			'joins'                 => [],
-
-			'preload_owners'        => false,
-			'preload_containers'    => false,
-			'callback'              => 'entity_row_to_elggstar',
-			'distinct'              => true,
-
-			'batch'                 => false,
-			'batch_inc_offset'      => true,
-			'batch_size'            => 25,
-
-			// private API
-			'__ElggBatch'           => null,
-		];
-
-		$options = array_merge($defaults, $options);
-
-		if ($options['batch'] && !$options['count']) {
-			$batch_size = $options['batch_size'];
-			$batch_inc_offset = $options['batch_inc_offset'];
-
-			// clean batch keys from $options.
-			unset($options['batch'], $options['batch_size'], $options['batch_inc_offset']);
-
-			return new \ElggBatch([$this, 'getEntities'], $options, null, $batch_size, $batch_inc_offset);
-		}
+        $class_name = $this->subtype_table->getClassFromId($row->subtype);
+        if ($class_name && !class_exists($class_name)) {
+            $this->logger->error("Class '$class_name' was not found, missing plugin?");
+            $class_name = '';
+        }
+
+        if (!$class_name) {
+            $map = [
+                'object' => ElggObject::class,
+                'user' => ElggUser::class,
+                'group' => ElggGroup::class,
+                'site' => ElggSite::class,
+            ];
+
+            if (isset($map[$row->type])) {
+                $class_name = $map[$row->type];
+            } else {
+                throw new InstallationException("Entity type {$row->type} is not supported.");
+            }
+        }
+
+        $entity = new $class_name($row);
+        if (!$entity instanceof ElggEntity) {
+            throw new ClassException("$class_name must extend " . ElggEntity::class);
+        }
+
+        return $entity;
+    }
+
+    /**
+     * Get an entity from the in-memory or memcache caches
+     *
+     * @param int $guid GUID
+     *
+     * @return \ElggEntity
+     */
+    protected function getFromCache($guid) {
+        $entity = $this->entity_cache->get($guid);
+        if ($entity) {
+            return $entity;
+        }
+
+        $memcache = _elgg_get_memcache('new_entity_cache');
+        $entity = $memcache->load($guid);
+        if (!$entity instanceof ElggEntity) {
+            return false;
+        }
+
+        // Validate accessibility if from memcache
+        if (!elgg_get_ignore_access() && !has_access_to_entity($entity)) {
+            return false;
+        }
+
+        $this->entity_cache->set($entity);
+        return $entity;
+    }
+
+    /**
+     * Loads and returns an entity object from a guid.
+     *
+     * @param int    $guid The GUID of the entity
+     * @param string $type The type of the entity. If given, even an existing entity with the given GUID
+     *                     will not be returned unless its type matches.
+     *
+     * @return ElggEntity|stdClass|false The correct Elgg or custom object based upon entity type and subtype
+     * @throws ClassException
+     * @throws InstallationException
+     */
+    public function get($guid, $type = '') {
+        // We could also use: if (!(int) $guid) { return false },
+        // but that evaluates to a false positive for $guid = true.
+        // This is a bit slower, but more thorough.
+        if (!is_numeric($guid) || $guid === 0 || $guid === '0') {
+            return false;
+        }
+
+        $guid = (int) $guid;
+
+        $entity = $this->getFromCache($guid);
+        if ($entity && (!$type || elgg_instanceof($entity, $type))) {
+            return $entity;
+        }
+
+        $row = $this->getRow($guid);
+        if (!$row) {
+            return false;
+        }
+
+        if ($type && $row->type != $type) {
+            return false;
+        }
+
+        $entity = $this->rowToElggStar($row);
+
+        if ($entity instanceof ElggEntity) {
+            $entity->storeInPersistedCache(_elgg_get_memcache('new_entity_cache'));
+        }
+
+        return $entity;
+    }
+
+    /**
+     * Does an entity exist?
+     *
+     * This function checks for the existence of an entity independent of access
+     * permissions. It is useful for situations when a user cannot access an entity
+     * and it must be determined whether entity has been deleted or the access level
+     * has changed.
+     *
+     * @param int $guid The GUID of the entity
+     * @return bool
+     */
+    public function exists($guid) {
+
+        // need to ignore access and show hidden entities to check existence
+        $ia = $this->session->setIgnoreAccess(true);
+        $show_hidden = access_show_hidden_entities(true);
+
+        $result = $this->getRow($guid);
+
+        $this->session->setIgnoreAccess($ia);
+        access_show_hidden_entities($show_hidden);
+
+        return !empty($result);
+    }
+
+    /**
+     * Enable an entity.
+     *
+     * @param int  $guid      GUID of entity to enable
+     * @param bool $recursive Recursively enable all entities disabled with the entity?
+     * @return bool
+     */
+    public function enable($guid, $recursive = true) {
+
+        // Override access only visible entities
+        $old_access_status = access_get_show_hidden_status();
+        access_show_hidden_entities(true);
+
+        $result = false;
+        $entity = get_entity($guid);
+        if ($entity) {
+            $result = $entity->enable($recursive);
+        }
+
+        access_show_hidden_entities($old_access_status);
+        return $result;
+    }
+
+    /**
+     * Returns an array of entities with optional filtering.
+     *
+     * Entities are the basic unit of storage in Elgg.  This function
+     * provides the simplest way to get an array of entities.  There
+     * are many options available that can be passed to filter
+     * what sorts of entities are returned.
+     *
+     * @tip To output formatted strings of entities, use {@link elgg_list_entities()} and
+     * its cousins.
+     *
+     * @tip Plural arguments can be written as singular if only specifying a
+     * single element.  ('type' => 'object' vs 'types' => array('object')).
+     *
+     * @see elgg_get_entities_from_metadata()
+     * @see elgg_get_entities_from_relationship()
+     * @see elgg_get_entities_from_access_id()
+     * @see elgg_get_entities_from_annotations()
+     * @see elgg_list_entities()
+     *
+     * @param array $options Array in format:
+     *
+     * 	types => null|STR entity type (type IN ('type1', 'type2')
+     *           Joined with subtypes by AND. See below)
+     *
+     * 	subtypes => null|STR entity subtype (SQL: subtype IN ('subtype1', 'subtype2))
+     *              Use ELGG_ENTITIES_NO_VALUE to match the default subtype.
+     *              Use ELGG_ENTITIES_ANY_VALUE to match any subtype.
+     *
+     * 	type_subtype_pairs => null|ARR (array('type' => 'subtype'))
+     *                        array(
+     *                            'object' => array('blog', 'file'), // All objects with subtype of 'blog' or 'file'
+     *                            'user' => ELGG_ENTITY_ANY_VALUE, // All users irrespective of subtype
+     *                        );
+     *
+     * 	guids => null|ARR Array of entity guids
+     *
+     * 	owner_guids => null|ARR Array of owner guids
+     *
+     * 	container_guids => null|ARR Array of container_guids
+     *
+     * 	order_by => null (time_created desc)|STR SQL order by clause
+     *
+     *  reverse_order_by => BOOL Reverse the default order by clause
+     *
+     * 	limit => null (10)|INT SQL limit clause (0 means no limit)
+     *
+     * 	offset => null (0)|INT SQL offset clause
+     *
+     * 	created_time_lower => null|INT Created time lower boundary in epoch time
+     *
+     * 	created_time_upper => null|INT Created time upper boundary in epoch time
+     *
+     * 	modified_time_lower => null|INT Modified time lower boundary in epoch time
+     *
+     * 	modified_time_upper => null|INT Modified time upper boundary in epoch time
+     *
+     * 	count => true|false return a count instead of entities
+     *
+     * 	wheres => array() Additional where clauses to AND together
+     *
+     * 	joins => array() Additional joins
+     *
+     * 	preload_owners => bool (false) If set to true, this function will preload
+     * 					  all the owners of the returned entities resulting in better
+     * 					  performance if those owners need to be displayed
+     *
+     *  preload_containers => bool (false) If set to true, this function will preload
+     * 					      all the containers of the returned entities resulting in better
+     * 					      performance if those containers need to be displayed
+     *
+     *
+     * 	callback => string A callback function to pass each row through
+     *
+     * 	distinct => bool (true) If set to false, Elgg will drop the DISTINCT clause from
+     * 				the MySQL query, which will improve performance in some situations.
+     * 				Avoid setting this option without a full understanding of the underlying
+     * 				SQL query Elgg creates.
+     *
+     *  batch => bool (false) If set to true, an Elgg\BatchResult object will be returned instead of an array.
+     *           Since 2.3
+     *
+     *  batch_inc_offset => bool (true) If "batch" is used, this tells the batch to increment the offset
+     *                      on each fetch. This must be set to false if you delete the batched results.
+     *
+     *  batch_size => int (25) If "batch" is used, this is the number of entities/rows to pull in before
+     *                requesting more.
+     *
+     * @return \ElggEntity[]|int|mixed If count, int. Otherwise an array or an Elgg\BatchResult. false on errors.
+     *
+     * @see elgg_get_entities_from_metadata()
+     * @see elgg_get_entities_from_relationship()
+     * @see elgg_get_entities_from_access_id()
+     * @see elgg_get_entities_from_annotations()
+     * @see elgg_list_entities()
+     */
+    public function getEntities(array $options = []) {
+        _elgg_check_unsupported_site_guid($options);
+
+        $defaults = [
+            'types'                 => ELGG_ENTITIES_ANY_VALUE,
+            'subtypes'              => ELGG_ENTITIES_ANY_VALUE,
+            'type_subtype_pairs'    => ELGG_ENTITIES_ANY_VALUE,
+
+            'guids'                 => ELGG_ENTITIES_ANY_VALUE,
+            'owner_guids'           => ELGG_ENTITIES_ANY_VALUE,
+            'container_guids'       => ELGG_ENTITIES_ANY_VALUE,
+
+            'modified_time_lower'   => ELGG_ENTITIES_ANY_VALUE,
+            'modified_time_upper'   => ELGG_ENTITIES_ANY_VALUE,
+            'created_time_lower'    => ELGG_ENTITIES_ANY_VALUE,
+            'created_time_upper'    => ELGG_ENTITIES_ANY_VALUE,
+
+            'reverse_order_by'      => false,
+            'order_by'              => 'e.time_created desc',
+            'group_by'              => ELGG_ENTITIES_ANY_VALUE,
+            'limit'                 => $this->config->default_limit,
+            'offset'                => 0,
+            'count'                 => false,
+            'selects'               => [],
+            'wheres'                => [],
+            'joins'                 => [],
+
+            'preload_owners'        => false,
+            'preload_containers'    => false,
+            'callback'              => 'entity_row_to_elggstar',
+            'distinct'              => true,
+
+            'batch'                 => false,
+            'batch_inc_offset'      => true,
+            'batch_size'            => 25,
+
+            // private API
+            '__ElggBatch'           => null,
+        ];
+
+        $options = array_merge($defaults, $options);
+
+        if ($options['batch'] && !$options['count']) {
+            $batch_size = $options['batch_size'];
+            $batch_inc_offset = $options['batch_inc_offset'];
+
+            // clean batch keys from $options.
+            unset($options['batch'], $options['batch_size'], $options['batch_inc_offset']);
+
+            return new \ElggBatch([$this, 'getEntities'], $options, null, $batch_size, $batch_inc_offset);
+        }
 	
-		// can't use helper function with type_subtype_pair because
-		// it's already an array...just need to merge it
-		if (isset($options['type_subtype_pair'])) {
-			if (isset($options['type_subtype_pairs'])) {
-				$options['type_subtype_pairs'] = array_merge($options['type_subtype_pairs'],
-					$options['type_subtype_pair']);
-			} else {
-				$options['type_subtype_pairs'] = $options['type_subtype_pair'];
-			}
-		}
-
-		$singulars = ['type', 'subtype', 'guid', 'owner_guid', 'container_guid'];
-		$options = _elgg_normalize_plural_options_array($options, $singulars);
-
-		$options = $this->autoJoinTables($options);
-
-		// evaluate where clauses
-		if (!is_array($options['wheres'])) {
-			$options['wheres'] = [$options['wheres']];
-		}
-
-		$wheres = $options['wheres'];
-
-		$wheres[] = $this->getEntityTypeSubtypeWhereSql('e', $options['types'],
-			$options['subtypes'], $options['type_subtype_pairs']);
-
-		$wheres[] = $this->getGuidBasedWhereSql('e.guid', $options['guids']);
-		$wheres[] = $this->getGuidBasedWhereSql('e.owner_guid', $options['owner_guids']);
-		$wheres[] = $this->getGuidBasedWhereSql('e.container_guid', $options['container_guids']);
-
-		$wheres[] = $this->getEntityTimeWhereSql('e', $options['created_time_upper'],
-			$options['created_time_lower'], $options['modified_time_upper'], $options['modified_time_lower']);
-
-		// see if any functions failed
-		// remove empty strings on successful functions
-		foreach ($wheres as $i => $where) {
-			if ($where === false) {
-				return false;
-			} elseif (empty($where)) {
-				unset($wheres[$i]);
-			}
-		}
-
-		// remove identical where clauses
-		$wheres = array_unique($wheres);
-
-		// evaluate join clauses
-		if (!is_array($options['joins'])) {
-			$options['joins'] = [$options['joins']];
-		}
-
-		// remove identical join clauses
-		$joins = array_unique($options['joins']);
-
-		foreach ($joins as $i => $join) {
-			if ($join === false) {
-				return false;
-			} elseif (empty($join)) {
-				unset($joins[$i]);
-			}
-		}
-
-		// evalutate selects
-		if ($options['selects']) {
-			$selects = '';
-			foreach ($options['selects'] as $select) {
-				$selects .= ", $select";
-			}
-		} else {
-			$selects = '';
-		}
-
-		if (!$options['count']) {
-			$distinct = $options['distinct'] ? "DISTINCT" : "";
-			$query = "SELECT $distinct e.*{$selects} FROM {$this->db->prefix}entities e ";
-		} else {
-			// note: when DISTINCT unneeded, it's slightly faster to compute COUNT(*) than GUIDs
-			$count_expr = $options['distinct'] ? "DISTINCT e.guid" : "*";
-			$query = "SELECT COUNT($count_expr) as total FROM {$this->db->prefix}entities e ";
-		}
-
-		// add joins
-		foreach ($joins as $j) {
-			$query .= " $j ";
-		}
-
-		// add wheres
-		$query .= ' WHERE ';
-
-		foreach ($wheres as $w) {
-			$query .= " $w AND ";
-		}
-
-		// Add access controls
-		$query .= _elgg_get_access_where_sql();
-
-		// reverse order by
-		if ($options['reverse_order_by']) {
-			$options['order_by'] = _elgg_sql_reverse_order_by_clause($options['order_by']);
-		}
-
-		if ($options['count']) {
-			$total = $this->db->getDataRow($query);
-			return (int) $total->total;
-		}
-
-		if ($options['group_by']) {
-			$query .= " GROUP BY {$options['group_by']}";
-		}
-
-		if ($options['order_by']) {
-			$query .= " ORDER BY {$options['order_by']}";
-		}
-
-		if ($options['limit']) {
-			$limit = sanitise_int($options['limit'], false);
-			$offset = sanitise_int($options['offset'], false);
-			$query .= " LIMIT $offset, $limit";
-		}
-
-		if ($options['callback'] === 'entity_row_to_elggstar') {
-			$results = $this->fetchFromSql($query, $options['__ElggBatch']);
-		} else {
-			$results = $this->db->getData($query, $options['callback']);
-		}
-
-		if (!$results) {
-			// no results, no preloading
-			return $results;
-		}
-
-		// populate entity and metadata caches, and prepare $entities for preloader
-		$guids = [];
-		foreach ($results as $item) {
-			// A custom callback could result in items that aren't \ElggEntity's, so check for them
-			if ($item instanceof ElggEntity) {
-				$this->entity_cache->set($item);
-				// plugins usually have only settings
-				if (!$item instanceof ElggPlugin) {
-					$guids[] = $item->guid;
-				}
-			}
-		}
-		// @todo Without this, recursive delete fails. See #4568
-		reset($results);
-
-		if ($guids) {
-			// there were entities in the result set, preload metadata for them
-			$this->metadata_cache->populateFromEntities($guids);
-		}
-
-		if (count($results) > 1) {
-			$props_to_preload = [];
-			if ($options['preload_owners']) {
-				$props_to_preload[] = 'owner_guid';
-			}
-			if ($options['preload_containers']) {
-				$props_to_preload[] = 'container_guid';
-			}
-			if ($props_to_preload) {
-				// note, ElggEntityPreloaderIntegrationTest assumes it can swap out
-				// the preloader after boot. If you inject this component at construction
-				// time that unit test will break. :/
-				_elgg_services()->entityPreloader->preload($results, $props_to_preload);
-			}
-		}
-
-		return $results;
-	}
-
-	/**
-	 * Decorate getEntities() options in order to auto-join secondary tables where it's
-	 * safe to do so.
-	 *
-	 * @param array $options Options array in getEntities() after normalization
-	 * @return array
-	 */
-	protected function autoJoinTables(array $options) {
-		// we must be careful that the query doesn't specify any options that may join
-		// tables or change the selected columns
-		if (!is_array($options['types'])
-				|| count($options['types']) !== 1
-				|| !empty($options['selects'])
-				|| !empty($options['wheres'])
-				|| !empty($options['joins'])
-				|| $options['callback'] !== 'entity_row_to_elggstar'
-				|| $options['count']) {
-			// Too dangerous to auto-join
-			return $options;
-		}
-
-		$join_types = [
-			// Each class must have a static getExternalAttributes() : array
-			'object' => 'ElggObject',
-			'user' => 'ElggUser',
-			'group' => 'ElggGroup',
-			'site' => 'ElggSite',
-		];
-
-		// We use reset() because $options['types'] may not have a numeric key
-		$type = reset($options['types']);
-
-		// Get the columns we'll need to select. We can't use st.* because the order_by
-		// clause may reference "guid", which MySQL will complain about being ambiguous
-		try {
-			$attributes = \ElggEntity::getExtraAttributeDefaults($type);
-		} catch (\Exception $e) {
-			$this->logger->error("Unrecognized type: $type");
-			return $options;
-		}
-
-		foreach (array_keys($attributes) as $col) {
-			$options['selects'][] = "st.$col";
-		}
-
-		// join the secondary table
-		$options['joins'][] = "JOIN {$this->db->prefix}{$type}s_entity st ON (e.guid = st.guid)";
-
-		return $options;
-	}
-
-	/**
-	 * Return entities from an SQL query generated by elgg_get_entities.
-	 *
-	 * @access private
-	 *
-	 * @param string    $sql
-	 * @param ElggBatch $batch
-	 * @return ElggEntity[]
-	 * @throws LogicException
-	 */
-	public function fetchFromSql($sql, \ElggBatch $batch = null) {
-		$plugin_subtype = $this->subtype_table->getId('object', 'plugin');
-
-		// Keys are types, values are columns that, if present, suggest that the secondary
-		// table is already JOINed. Note it's OK if guess incorrectly because entity load()
-		// will fetch any missing attributes.
-		$types_to_optimize = [
-			'object' => 'title',
-			'user' => 'password_hash',
-			'group' => 'name',
-			'site' => 'url',
-		];
-
-		$rows = $this->db->getData($sql);
-
-		// guids to look up in each type
-		$lookup_types = [];
-		// maps GUIDs to the $rows key
-		$guid_to_key = [];
-
-		if (isset($rows[0]->type, $rows[0]->subtype)
-				&& $rows[0]->type === 'object'
-				&& $rows[0]->subtype == $plugin_subtype) {
-			// Likely the entire resultset is plugins, which have already been optimized
-			// to JOIN the secondary table. In this case we allow retrieving from cache,
-			// but abandon the extra queries.
-			$types_to_optimize = [];
-		}
-
-		// First pass: use cache where possible, gather GUIDs that we're optimizing
-		foreach ($rows as $i => $row) {
-			if (empty($row->guid) || empty($row->type)) {
-				throw new LogicException('Entity row missing guid or type');
-			}
-
-			// We try ephemeral cache because it's blazingly fast and we ideally want to access
-			// the same PHP instance. We don't try memcache because it isn't worth the overhead.
-			$entity = $this->entity_cache->get($row->guid);
-			if ($entity) {
-				// from static var, must be refreshed in case row has extra columns
-				$entity->refresh($row);
-				$rows[$i] = $entity;
-				continue;
-			}
-
-			if (isset($types_to_optimize[$row->type])) {
-				// check if row already looks JOINed.
-				if (isset($row->{$types_to_optimize[$row->type]})) {
-					// Row probably already contains JOINed secondary table. Don't make another query just
-					// to pull data that's already there
-					continue;
-				}
-				$lookup_types[$row->type][] = $row->guid;
-				$guid_to_key[$row->guid] = $i;
-			}
-		}
-		// Do secondary queries and merge rows
-		if ($lookup_types) {
-			foreach ($lookup_types as $type => $guids) {
-				$set = "(" . implode(',', $guids) . ")";
-				$sql = "SELECT * FROM {$this->db->prefix}{$type}s_entity WHERE guid IN $set";
-				$secondary_rows = $this->db->getData($sql);
-				if ($secondary_rows) {
-					foreach ($secondary_rows as $secondary_row) {
-						$key = $guid_to_key[$secondary_row->guid];
-						// cast to arrays to merge then cast back
-						$rows[$key] = (object) array_merge((array) $rows[$key], (array) $secondary_row);
-					}
-				}
-			}
-		}
-		// Second pass to finish conversion
-		foreach ($rows as $i => $row) {
-			if ($row instanceof ElggEntity) {
-				continue;
-			} else {
-				try {
-					$rows[$i] = $this->rowToElggStar($row);
-				} catch (IncompleteEntityException $e) {
-					// don't let incomplete entities throw fatal errors
-					unset($rows[$i]);
-
-					// report incompletes to the batch process that spawned this query
-					if ($batch) {
-						$batch->reportIncompleteEntity($row);
-					}
-				}
-			}
-		}
-		return $rows;
-	}
-
-	/**
-	 * Returns SQL where clause for type and subtype on main entity table
-	 *
-	 * @param string     $table    Entity table prefix as defined in SELECT...FROM entities $table
-	 * @param null|array $types    Array of types or null if none.
-	 * @param null|array $subtypes Array of subtypes or null if none
-	 * @param null|array $pairs    Array of pairs of types and subtypes
-	 *
-	 * @return false|string
-	 * @access private
-	 */
-	public function getEntityTypeSubtypeWhereSql($table, $types, $subtypes, $pairs) {
-		// subtype depends upon type.
-		if ($subtypes && !$types) {
-			$this->logger->warn("Cannot set subtypes without type.");
-			return false;
-		}
-
-		// short circuit if nothing is requested
-		if (!$types && !$subtypes && !$pairs) {
-			return '';
-		}
-
-		// pairs override
-		$wheres = [];
-		if (!is_array($pairs)) {
-			if (!is_array($types)) {
-				$types = [$types];
-			}
-
-			if ($subtypes && !is_array($subtypes)) {
-				$subtypes = [$subtypes];
-			}
-
-			// decrementer for valid types.  Return false if no valid types
-			$valid_types_count = count($types);
-			$valid_subtypes_count = 0;
-			// remove invalid types to get an accurate count of
-			// valid types for the invalid subtype detection to use
-			// below.
-			// also grab the count of ALL subtypes on valid types to decrement later on
-			// and check against.
-			//
-			// yes this is duplicating a foreach on $types.
-			foreach ($types as $type) {
-				if (!in_array($type, \Elgg\Config::getEntityTypes())) {
-					$valid_types_count--;
-					unset($types[array_search($type, $types)]);
-				} else {
-					// do the checking (and decrementing) in the subtype section.
-					$valid_subtypes_count += count($subtypes);
-				}
-			}
-
-			// return false if nothing is valid.
-			if (!$valid_types_count) {
-				return false;
-			}
-
-			// subtypes are based upon types, so we need to look at each
-			// type individually to get the right subtype id.
-			foreach ($types as $type) {
-				$subtype_ids = [];
-				if ($subtypes) {
-					foreach ($subtypes as $subtype) {
-						// check that the subtype is valid
-						if (!$subtype && ELGG_ENTITIES_NO_VALUE === $subtype) {
-							// subtype value is 0
-							$subtype_ids[] = ELGG_ENTITIES_NO_VALUE;
-						} elseif (!$subtype) {
-							// subtype is ignored.
-							// this handles ELGG_ENTITIES_ANY_VALUE, '', and anything falsy that isn't 0
-							continue;
-						} else {
-							$subtype_id = get_subtype_id($type, $subtype);
-
-							if ($subtype_id) {
-								$subtype_ids[] = $subtype_id;
-							} else {
-								$valid_subtypes_count--;
-								$this->logger->notice("Type-subtype '$type:$subtype' does not exist!");
-								continue;
-							}
-						}
-					}
-
-					// return false if we're all invalid subtypes in the only valid type
-					if ($valid_subtypes_count <= 0) {
-						return false;
-					}
-				}
-
-				if (is_array($subtype_ids) && count($subtype_ids)) {
-					$subtype_ids_str = implode(',', $subtype_ids);
-					$wheres[] = "({$table}.type = '$type' AND {$table}.subtype IN ($subtype_ids_str))";
-				} else {
-					$wheres[] = "({$table}.type = '$type')";
-				}
-			}
-		} else {
-			// using type/subtype pairs
-			$valid_pairs_count = count($pairs);
-			$valid_pairs_subtypes_count = 0;
-
-			// same deal as above--we need to know how many valid types
-			// and subtypes we have before hitting the subtype section.
-			// also normalize the subtypes into arrays here.
-			foreach ($pairs as $paired_type => $paired_subtypes) {
-				if (!in_array($paired_type, \Elgg\Config::getEntityTypes())) {
-					$valid_pairs_count--;
-					unset($pairs[array_search($paired_type, $pairs)]);
-				} else {
-					if ($paired_subtypes && !is_array($paired_subtypes)) {
-						$pairs[$paired_type] = [$paired_subtypes];
-					}
-					$valid_pairs_subtypes_count += count($paired_subtypes);
-				}
-			}
-
-			if ($valid_pairs_count <= 0) {
-				return false;
-			}
-			foreach ($pairs as $paired_type => $paired_subtypes) {
-				// this will always be an array because of line 2027, right?
-				// no...some overly clever person can say pair => array('object' => null)
-				if (is_array($paired_subtypes)) {
-					$paired_subtype_ids = [];
-					foreach ($paired_subtypes as $paired_subtype) {
-						if (ELGG_ENTITIES_NO_VALUE === $paired_subtype || ($paired_subtype_id = get_subtype_id($paired_type, $paired_subtype))) {
-							$paired_subtype_ids[] = (ELGG_ENTITIES_NO_VALUE === $paired_subtype) ?
-									ELGG_ENTITIES_NO_VALUE : $paired_subtype_id;
-						} else {
-							$valid_pairs_subtypes_count--;
-							$this->logger->notice("Type-subtype '$paired_type:$paired_subtype' does not exist!");
-							// return false if we're all invalid subtypes in the only valid type
-							continue;
-						}
-					}
-
-					// return false if there are no valid subtypes.
-					if ($valid_pairs_subtypes_count <= 0) {
-						return false;
-					}
-
-
-					if ($paired_subtype_ids_str = implode(',', $paired_subtype_ids)) {
-						$wheres[] = "({$table}.type = '$paired_type'"
-								. " AND {$table}.subtype IN ($paired_subtype_ids_str))";
-					}
-				} else {
-					$wheres[] = "({$table}.type = '$paired_type')";
-				}
-			}
-		}
-
-		// pairs override the above.  return false if they don't exist.
-		if (is_array($wheres) && count($wheres)) {
-			$where = implode(' OR ', $wheres);
-			return "($where)";
-		}
-
-		return '';
-	}
-
-	/**
-	 * Returns SQL where clause for owner and containers.
-	 *
-	 * @param string     $column Column name the guids should be checked against. Usually
-	 *                           best to provide in table.column format.
-	 * @param null|array $guids  Array of GUIDs.
-	 *
-	 * @return false|string
-	 * @access private
-	 */
-	public function getGuidBasedWhereSql($column, $guids) {
-		// short circuit if nothing requested
-		// 0 is a valid guid
-		if (!$guids && $guids !== 0) {
-			return '';
-		}
-
-		// normalize and sanitise owners
-		if (!is_array($guids)) {
-			$guids = [$guids];
-		}
-
-		$guids_sanitized = [];
-		foreach ($guids as $guid) {
-			if ($guid !== ELGG_ENTITIES_NO_VALUE) {
-				$guid = sanitise_int($guid);
-
-				if (!$guid) {
-					return false;
-				}
-			}
-			$guids_sanitized[] = $guid;
-		}
-
-		$where = '';
-		$guid_str = implode(',', $guids_sanitized);
-
-		// implode(',', 0) returns 0.
-		if ($guid_str !== false && $guid_str !== '') {
-			$where = "($column IN ($guid_str))";
-		}
-
-		return $where;
-	}
-
-	/**
-	 * Returns SQL where clause for entity time limits.
-	 *
-	 * @param string   $table              Entity table prefix as defined in
-	 *                                     SELECT...FROM entities $table
-	 * @param null|int $time_created_upper Time created upper limit
-	 * @param null|int $time_created_lower Time created lower limit
-	 * @param null|int $time_updated_upper Time updated upper limit
-	 * @param null|int $time_updated_lower Time updated lower limit
-	 *
-	 * @return false|string false on fail, string on success.
-	 * @access private
-	 */
-	public function getEntityTimeWhereSql($table, $time_created_upper = null,
-	$time_created_lower = null, $time_updated_upper = null, $time_updated_lower = null) {
-
-		$wheres = [];
-
-		// exploit PHP's loose typing (quack) to check that they are INTs and not str cast to 0
-		if ($time_created_upper && $time_created_upper == sanitise_int($time_created_upper)) {
-			$wheres[] = "{$table}.time_created <= $time_created_upper";
-		}
-
-		if ($time_created_lower && $time_created_lower == sanitise_int($time_created_lower)) {
-			$wheres[] = "{$table}.time_created >= $time_created_lower";
-		}
-
-		if ($time_updated_upper && $time_updated_upper == sanitise_int($time_updated_upper)) {
-			$wheres[] = "{$table}.time_updated <= $time_updated_upper";
-		}
-
-		if ($time_updated_lower && $time_updated_lower == sanitise_int($time_updated_lower)) {
-			$wheres[] = "{$table}.time_updated >= $time_updated_lower";
-		}
-
-		if (is_array($wheres) && count($wheres) > 0) {
-			$where_str = implode(' AND ', $wheres);
-			return "($where_str)";
-		}
-
-		return '';
-	}
-
-	/**
-	 * Gets entities based upon attributes in secondary tables.
-	 * Also accepts all options available to elgg_get_entities(),
-	 * elgg_get_entities_from_metadata(), and elgg_get_entities_from_relationship().
-	 *
-	 * @warning requires that the entity type be specified and there can only be one
-	 * type.
-	 *
-	 * @see elgg_get_entities
-	 * @see elgg_get_entities_from_metadata
-	 * @see elgg_get_entities_from_relationship
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * 	attribute_name_value_pairs => ARR (
-	 *                                   'name' => 'name',
-	 *                                   'value' => 'value',
-	 *                                   'operand' => '=', (optional)
-	 *                                   'case_sensitive' => false (optional)
-	 *                                  )
-	 * 	                             If multiple values are sent via
-	 *                               an array ('value' => array('value1', 'value2')
-	 *                               the pair's operand will be forced to "IN".
-	 *
-	 * 	attribute_name_value_pairs_operator => null|STR The operator to use for combining
-	 *                                        (name = value) OPERATOR (name = value); default is AND
-	 *
-	 * @return ElggEntity[]|mixed If count, int. If not count, array. false on errors.
-	 * @throws InvalidArgumentException
-	 * @todo Does not support ordering by attributes or using an attribute pair shortcut like this ('title' => 'foo')
-	 */
-	public function getEntitiesFromAttributes(array $options = []) {
-		$defaults = [
-			'attribute_name_value_pairs' => ELGG_ENTITIES_ANY_VALUE,
-			'attribute_name_value_pairs_operator' => 'AND',
-		];
-
-		$options = array_merge($defaults, $options);
-
-		$singulars = ['type', 'attribute_name_value_pair'];
-		$options = _elgg_normalize_plural_options_array($options, $singulars);
-
-		$clauses = _elgg_get_entity_attribute_where_sql($options);
-
-		if ($clauses) {
-			// merge wheres to pass to elgg_get_entities()
-			if (isset($options['wheres']) && !is_array($options['wheres'])) {
-				$options['wheres'] = [$options['wheres']];
-			} elseif (!isset($options['wheres'])) {
-				$options['wheres'] = [];
-			}
-
-			$options['wheres'] = array_merge($options['wheres'], $clauses['wheres']);
-
-			// merge joins to pass to elgg_get_entities()
-			if (isset($options['joins']) && !is_array($options['joins'])) {
-				$options['joins'] = [$options['joins']];
-			} elseif (!isset($options['joins'])) {
-				$options['joins'] = [];
-			}
-
-			$options['joins'] = array_merge($options['joins'], $clauses['joins']);
-		}
-
-		return elgg_get_entities_from_relationship($options);
-	}
-
-	/**
-	 * Get the join and where clauses for working with entity attributes
-	 *
-	 * @return false|array False on fail, array('joins', 'wheres')
-	 * @access private
-	 * @throws InvalidArgumentException
-	 */
-	public function getEntityAttributeWhereSql(array $options = []) {
-
-		if (!isset($options['types'])) {
-			throw new InvalidArgumentException("The entity type must be defined for elgg_get_entities_from_attributes()");
-		}
-
-		if (is_array($options['types']) && count($options['types']) !== 1) {
-			throw new InvalidArgumentException("Only one type can be passed to elgg_get_entities_from_attributes()");
-		}
-
-		// type can be passed as string or array
-		$type = $options['types'];
-		if (is_array($type)) {
-			$type = $type[0];
-		}
-
-		// @todo the types should be defined somewhere (as constant on \ElggEntity?)
-		if (!in_array($type, ['group', 'object', 'site', 'user'])) {
-			throw new InvalidArgumentException("Invalid type '$type' passed to elgg_get_entities_from_attributes()");
-		}
-
-
-		$type_table = "{$this->db->prefix}{$type}s_entity";
-
-		$return = [
-			'joins' => [],
-			'wheres' => [],
-		];
-
-		// short circuit if nothing requested
-		if ($options['attribute_name_value_pairs'] == ELGG_ENTITIES_ANY_VALUE) {
-			return $return;
-		}
-
-		if (!is_array($options['attribute_name_value_pairs'])) {
-			throw new InvalidArgumentException("attribute_name_value_pairs must be an array for elgg_get_entities_from_attributes()");
-		}
-
-		$wheres = [];
-
-		// check if this is an array of pairs or just a single pair.
-		$pairs = $options['attribute_name_value_pairs'];
-		if (isset($pairs['name']) || isset($pairs['value'])) {
-			$pairs = [$pairs];
-		}
-
-		$pair_wheres = [];
-		foreach ($pairs as $index => $pair) {
-			// must have at least a name and value
-			if (!isset($pair['name']) || !isset($pair['value'])) {
-				continue;
-			}
-
-			if (isset($pair['operand'])) {
-				$operand = sanitize_string($pair['operand']);
-			} else {
-				$operand = '=';
-			}
-
-			if (is_numeric($pair['value'])) {
-				$value = sanitize_string($pair['value']);
-			} else if (is_array($pair['value'])) {
-				$values_array = [];
-				foreach ($pair['value'] as $pair_value) {
-					if (is_numeric($pair_value)) {
-						$values_array[] = sanitize_string($pair_value);
-					} else {
-						$values_array[] = "'" . sanitize_string($pair_value) . "'";
-					}
-				}
-
-				$operand = 'IN';
-				if ($values_array) {
-					$value = '(' . implode(', ', $values_array) . ')';
-				}
-			} else {
-				$value = "'" . sanitize_string($pair['value']) . "'";
-			}
-
-			$name = sanitize_string($pair['name']);
-
-			// case sensitivity can be specified per pair
-			$pair_binary = '';
-			if (isset($pair['case_sensitive'])) {
-				$pair_binary = ($pair['case_sensitive']) ? 'BINARY ' : '';
-			}
-
-			$pair_wheres[] = "({$pair_binary}type_table.$name $operand $value)";
-		}
-
-		if ($where = implode(" {$options['attribute_name_value_pairs_operator']} ", $pair_wheres)) {
-			$return['wheres'][] = "($where)";
-
-			$return['joins'][] = "JOIN $type_table type_table ON e.guid = type_table.guid";
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Returns a list of months in which entities were updated or created.
-	 *
-	 * @tip Use this to generate a list of archives by month for when entities were added or updated.
-	 *
-	 * @todo document how to pass in array for $subtype
-	 *
-	 * @warning Months are returned in the form YYYYMM.
-	 *
-	 * @param string $type           The type of entity
-	 * @param string $subtype        The subtype of entity
-	 * @param int    $container_guid The container GUID that the entities belong to
-	 * @param string $order_by       Order_by SQL order by clause
-	 *
-	 * @return array|false Either an array months as YYYYMM, or false on failure
-	 */
-	public function getDates($type = '', $subtype = '', $container_guid = 0, $order_by = 'time_created') {
-
-		$where = [];
-
-		if ($type != "") {
-			$type = sanitise_string($type);
-			$where[] = "type='$type'";
-		}
-
-		if (is_array($subtype)) {
-			$tempwhere = "";
-			if (sizeof($subtype)) {
-				foreach ($subtype as $typekey => $subtypearray) {
-					foreach ($subtypearray as $subtypeval) {
-						$typekey = sanitise_string($typekey);
-						if (!empty($subtypeval)) {
-							if (!$subtypeval = (int) get_subtype_id($typekey, $subtypeval)) {
-								return false;
-							}
-						} else {
-							$subtypeval = 0;
-						}
-						if (!empty($tempwhere)) {
-							$tempwhere .= " or ";
-						}
-						$tempwhere .= "(type = '{$typekey}' and subtype = {$subtypeval})";
-					}
-				}
-			}
-			if (!empty($tempwhere)) {
-				$where[] = "({$tempwhere})";
-			}
-		} else {
-			if ($subtype) {
-				if (!$subtype_id = get_subtype_id($type, $subtype)) {
-					return false;
-				} else {
-					$where[] = "subtype=$subtype_id";
-				}
-			}
-		}
-
-		if ($container_guid !== 0) {
-			if (is_array($container_guid)) {
-				foreach ($container_guid as $key => $val) {
-					$container_guid[$key] = (int) $val;
-				}
-				$where[] = "container_guid in (" . implode(",", $container_guid) . ")";
-			} else {
-				$container_guid = (int) $container_guid;
-				$where[] = "container_guid = {$container_guid}";
-			}
-		}
-
-		$where[] = _elgg_get_access_where_sql(['table_alias' => '']);
-
-		$sql = "SELECT DISTINCT EXTRACT(YEAR_MONTH FROM FROM_UNIXTIME(time_created)) AS yearmonth
+        // can't use helper function with type_subtype_pair because
+        // it's already an array...just need to merge it
+        if (isset($options['type_subtype_pair'])) {
+            if (isset($options['type_subtype_pairs'])) {
+                $options['type_subtype_pairs'] = array_merge($options['type_subtype_pairs'],
+                    $options['type_subtype_pair']);
+            } else {
+                $options['type_subtype_pairs'] = $options['type_subtype_pair'];
+            }
+        }
+
+        $singulars = ['type', 'subtype', 'guid', 'owner_guid', 'container_guid'];
+        $options = _elgg_normalize_plural_options_array($options, $singulars);
+
+        $options = $this->autoJoinTables($options);
+
+        // evaluate where clauses
+        if (!is_array($options['wheres'])) {
+            $options['wheres'] = [$options['wheres']];
+        }
+
+        $wheres = $options['wheres'];
+
+        $wheres[] = $this->getEntityTypeSubtypeWhereSql('e', $options['types'],
+            $options['subtypes'], $options['type_subtype_pairs']);
+
+        $wheres[] = $this->getGuidBasedWhereSql('e.guid', $options['guids']);
+        $wheres[] = $this->getGuidBasedWhereSql('e.owner_guid', $options['owner_guids']);
+        $wheres[] = $this->getGuidBasedWhereSql('e.container_guid', $options['container_guids']);
+
+        $wheres[] = $this->getEntityTimeWhereSql('e', $options['created_time_upper'],
+            $options['created_time_lower'], $options['modified_time_upper'], $options['modified_time_lower']);
+
+        // see if any functions failed
+        // remove empty strings on successful functions
+        foreach ($wheres as $i => $where) {
+            if ($where === false) {
+                return false;
+            } elseif (empty($where)) {
+                unset($wheres[$i]);
+            }
+        }
+
+        // remove identical where clauses
+        $wheres = array_unique($wheres);
+
+        // evaluate join clauses
+        if (!is_array($options['joins'])) {
+            $options['joins'] = [$options['joins']];
+        }
+
+        // remove identical join clauses
+        $joins = array_unique($options['joins']);
+
+        foreach ($joins as $i => $join) {
+            if ($join === false) {
+                return false;
+            } elseif (empty($join)) {
+                unset($joins[$i]);
+            }
+        }
+
+        // evalutate selects
+        if ($options['selects']) {
+            $selects = '';
+            foreach ($options['selects'] as $select) {
+                $selects .= ", $select";
+            }
+        } else {
+            $selects = '';
+        }
+
+        if (!$options['count']) {
+            $distinct = $options['distinct'] ? "DISTINCT" : "";
+            $query = "SELECT $distinct e.*{$selects} FROM {$this->db->prefix}entities e ";
+        } else {
+            // note: when DISTINCT unneeded, it's slightly faster to compute COUNT(*) than GUIDs
+            $count_expr = $options['distinct'] ? "DISTINCT e.guid" : "*";
+            $query = "SELECT COUNT($count_expr) as total FROM {$this->db->prefix}entities e ";
+        }
+
+        // add joins
+        foreach ($joins as $j) {
+            $query .= " $j ";
+        }
+
+        // add wheres
+        $query .= ' WHERE ';
+
+        foreach ($wheres as $w) {
+            $query .= " $w AND ";
+        }
+
+        // Add access controls
+        $query .= _elgg_get_access_where_sql();
+
+        // reverse order by
+        if ($options['reverse_order_by']) {
+            $options['order_by'] = _elgg_sql_reverse_order_by_clause($options['order_by']);
+        }
+
+        if ($options['count']) {
+            $total = $this->db->getDataRow($query);
+            return (int) $total->total;
+        }
+
+        if ($options['group_by']) {
+            $query .= " GROUP BY {$options['group_by']}";
+        }
+
+        if ($options['order_by']) {
+            $query .= " ORDER BY {$options['order_by']}";
+        }
+
+        if ($options['limit']) {
+            $limit = sanitise_int($options['limit'], false);
+            $offset = sanitise_int($options['offset'], false);
+            $query .= " LIMIT $offset, $limit";
+        }
+
+        if ($options['callback'] === 'entity_row_to_elggstar') {
+            $results = $this->fetchFromSql($query, $options['__ElggBatch']);
+        } else {
+            $results = $this->db->getData($query, $options['callback']);
+        }
+
+        if (!$results) {
+            // no results, no preloading
+            return $results;
+        }
+
+        // populate entity and metadata caches, and prepare $entities for preloader
+        $guids = [];
+        foreach ($results as $item) {
+            // A custom callback could result in items that aren't \ElggEntity's, so check for them
+            if ($item instanceof ElggEntity) {
+                $this->entity_cache->set($item);
+                // plugins usually have only settings
+                if (!$item instanceof ElggPlugin) {
+                    $guids[] = $item->guid;
+                }
+            }
+        }
+        // @todo Without this, recursive delete fails. See #4568
+        reset($results);
+
+        if ($guids) {
+            // there were entities in the result set, preload metadata for them
+            $this->metadata_cache->populateFromEntities($guids);
+        }
+
+        if (count($results) > 1) {
+            $props_to_preload = [];
+            if ($options['preload_owners']) {
+                $props_to_preload[] = 'owner_guid';
+            }
+            if ($options['preload_containers']) {
+                $props_to_preload[] = 'container_guid';
+            }
+            if ($props_to_preload) {
+                // note, ElggEntityPreloaderIntegrationTest assumes it can swap out
+                // the preloader after boot. If you inject this component at construction
+                // time that unit test will break. :/
+                _elgg_services()->entityPreloader->preload($results, $props_to_preload);
+            }
+        }
+
+        return $results;
+    }
+
+    /**
+     * Decorate getEntities() options in order to auto-join secondary tables where it's
+     * safe to do so.
+     *
+     * @param array $options Options array in getEntities() after normalization
+     * @return array
+     */
+    protected function autoJoinTables(array $options) {
+        // we must be careful that the query doesn't specify any options that may join
+        // tables or change the selected columns
+        if (!is_array($options['types'])
+                || count($options['types']) !== 1
+                || !empty($options['selects'])
+                || !empty($options['wheres'])
+                || !empty($options['joins'])
+                || $options['callback'] !== 'entity_row_to_elggstar'
+                || $options['count']) {
+            // Too dangerous to auto-join
+            return $options;
+        }
+
+        $join_types = [
+            // Each class must have a static getExternalAttributes() : array
+            'object' => 'ElggObject',
+            'user' => 'ElggUser',
+            'group' => 'ElggGroup',
+            'site' => 'ElggSite',
+        ];
+
+        // We use reset() because $options['types'] may not have a numeric key
+        $type = reset($options['types']);
+
+        // Get the columns we'll need to select. We can't use st.* because the order_by
+        // clause may reference "guid", which MySQL will complain about being ambiguous
+        try {
+            $attributes = \ElggEntity::getExtraAttributeDefaults($type);
+        } catch (\Exception $e) {
+            $this->logger->error("Unrecognized type: $type");
+            return $options;
+        }
+
+        foreach (array_keys($attributes) as $col) {
+            $options['selects'][] = "st.$col";
+        }
+
+        // join the secondary table
+        $options['joins'][] = "JOIN {$this->db->prefix}{$type}s_entity st ON (e.guid = st.guid)";
+
+        return $options;
+    }
+
+    /**
+     * Return entities from an SQL query generated by elgg_get_entities.
+     *
+     * @access private
+     *
+     * @param string    $sql
+     * @param ElggBatch $batch
+     * @return ElggEntity[]
+     * @throws LogicException
+     */
+    public function fetchFromSql($sql, \ElggBatch $batch = null) {
+        $plugin_subtype = $this->subtype_table->getId('object', 'plugin');
+
+        // Keys are types, values are columns that, if present, suggest that the secondary
+        // table is already JOINed. Note it's OK if guess incorrectly because entity load()
+        // will fetch any missing attributes.
+        $types_to_optimize = [
+            'object' => 'title',
+            'user' => 'password_hash',
+            'group' => 'name',
+            'site' => 'url',
+        ];
+
+        $rows = $this->db->getData($sql);
+
+        // guids to look up in each type
+        $lookup_types = [];
+        // maps GUIDs to the $rows key
+        $guid_to_key = [];
+
+        if (isset($rows[0]->type, $rows[0]->subtype)
+                && $rows[0]->type === 'object'
+                && $rows[0]->subtype == $plugin_subtype) {
+            // Likely the entire resultset is plugins, which have already been optimized
+            // to JOIN the secondary table. In this case we allow retrieving from cache,
+            // but abandon the extra queries.
+            $types_to_optimize = [];
+        }
+
+        // First pass: use cache where possible, gather GUIDs that we're optimizing
+        foreach ($rows as $i => $row) {
+            if (empty($row->guid) || empty($row->type)) {
+                throw new LogicException('Entity row missing guid or type');
+            }
+
+            // We try ephemeral cache because it's blazingly fast and we ideally want to access
+            // the same PHP instance. We don't try memcache because it isn't worth the overhead.
+            $entity = $this->entity_cache->get($row->guid);
+            if ($entity) {
+                // from static var, must be refreshed in case row has extra columns
+                $entity->refresh($row);
+                $rows[$i] = $entity;
+                continue;
+            }
+
+            if (isset($types_to_optimize[$row->type])) {
+                // check if row already looks JOINed.
+                if (isset($row->{$types_to_optimize[$row->type]})) {
+                    // Row probably already contains JOINed secondary table. Don't make another query just
+                    // to pull data that's already there
+                    continue;
+                }
+                $lookup_types[$row->type][] = $row->guid;
+                $guid_to_key[$row->guid] = $i;
+            }
+        }
+        // Do secondary queries and merge rows
+        if ($lookup_types) {
+            foreach ($lookup_types as $type => $guids) {
+                $set = "(" . implode(',', $guids) . ")";
+                $sql = "SELECT * FROM {$this->db->prefix}{$type}s_entity WHERE guid IN $set";
+                $secondary_rows = $this->db->getData($sql);
+                if ($secondary_rows) {
+                    foreach ($secondary_rows as $secondary_row) {
+                        $key = $guid_to_key[$secondary_row->guid];
+                        // cast to arrays to merge then cast back
+                        $rows[$key] = (object) array_merge((array) $rows[$key], (array) $secondary_row);
+                    }
+                }
+            }
+        }
+        // Second pass to finish conversion
+        foreach ($rows as $i => $row) {
+            if ($row instanceof ElggEntity) {
+                continue;
+            } else {
+                try {
+                    $rows[$i] = $this->rowToElggStar($row);
+                } catch (IncompleteEntityException $e) {
+                    // don't let incomplete entities throw fatal errors
+                    unset($rows[$i]);
+
+                    // report incompletes to the batch process that spawned this query
+                    if ($batch) {
+                        $batch->reportIncompleteEntity($row);
+                    }
+                }
+            }
+        }
+        return $rows;
+    }
+
+    /**
+     * Returns SQL where clause for type and subtype on main entity table
+     *
+     * @param string     $table    Entity table prefix as defined in SELECT...FROM entities $table
+     * @param null|array $types    Array of types or null if none.
+     * @param null|array $subtypes Array of subtypes or null if none
+     * @param null|array $pairs    Array of pairs of types and subtypes
+     *
+     * @return false|string
+     * @access private
+     */
+    public function getEntityTypeSubtypeWhereSql($table, $types, $subtypes, $pairs) {
+        // subtype depends upon type.
+        if ($subtypes && !$types) {
+            $this->logger->warn("Cannot set subtypes without type.");
+            return false;
+        }
+
+        // short circuit if nothing is requested
+        if (!$types && !$subtypes && !$pairs) {
+            return '';
+        }
+
+        // pairs override
+        $wheres = [];
+        if (!is_array($pairs)) {
+            if (!is_array($types)) {
+                $types = [$types];
+            }
+
+            if ($subtypes && !is_array($subtypes)) {
+                $subtypes = [$subtypes];
+            }
+
+            // decrementer for valid types.  Return false if no valid types
+            $valid_types_count = count($types);
+            $valid_subtypes_count = 0;
+            // remove invalid types to get an accurate count of
+            // valid types for the invalid subtype detection to use
+            // below.
+            // also grab the count of ALL subtypes on valid types to decrement later on
+            // and check against.
+            //
+            // yes this is duplicating a foreach on $types.
+            foreach ($types as $type) {
+                if (!in_array($type, \Elgg\Config::getEntityTypes())) {
+                    $valid_types_count--;
+                    unset($types[array_search($type, $types)]);
+                } else {
+                    // do the checking (and decrementing) in the subtype section.
+                    $valid_subtypes_count += count($subtypes);
+                }
+            }
+
+            // return false if nothing is valid.
+            if (!$valid_types_count) {
+                return false;
+            }
+
+            // subtypes are based upon types, so we need to look at each
+            // type individually to get the right subtype id.
+            foreach ($types as $type) {
+                $subtype_ids = [];
+                if ($subtypes) {
+                    foreach ($subtypes as $subtype) {
+                        // check that the subtype is valid
+                        if (!$subtype && ELGG_ENTITIES_NO_VALUE === $subtype) {
+                            // subtype value is 0
+                            $subtype_ids[] = ELGG_ENTITIES_NO_VALUE;
+                        } elseif (!$subtype) {
+                            // subtype is ignored.
+                            // this handles ELGG_ENTITIES_ANY_VALUE, '', and anything falsy that isn't 0
+                            continue;
+                        } else {
+                            $subtype_id = get_subtype_id($type, $subtype);
+
+                            if ($subtype_id) {
+                                $subtype_ids[] = $subtype_id;
+                            } else {
+                                $valid_subtypes_count--;
+                                $this->logger->notice("Type-subtype '$type:$subtype' does not exist!");
+                                continue;
+                            }
+                        }
+                    }
+
+                    // return false if we're all invalid subtypes in the only valid type
+                    if ($valid_subtypes_count <= 0) {
+                        return false;
+                    }
+                }
+
+                if (is_array($subtype_ids) && count($subtype_ids)) {
+                    $subtype_ids_str = implode(',', $subtype_ids);
+                    $wheres[] = "({$table}.type = '$type' AND {$table}.subtype IN ($subtype_ids_str))";
+                } else {
+                    $wheres[] = "({$table}.type = '$type')";
+                }
+            }
+        } else {
+            // using type/subtype pairs
+            $valid_pairs_count = count($pairs);
+            $valid_pairs_subtypes_count = 0;
+
+            // same deal as above--we need to know how many valid types
+            // and subtypes we have before hitting the subtype section.
+            // also normalize the subtypes into arrays here.
+            foreach ($pairs as $paired_type => $paired_subtypes) {
+                if (!in_array($paired_type, \Elgg\Config::getEntityTypes())) {
+                    $valid_pairs_count--;
+                    unset($pairs[array_search($paired_type, $pairs)]);
+                } else {
+                    if ($paired_subtypes && !is_array($paired_subtypes)) {
+                        $pairs[$paired_type] = [$paired_subtypes];
+                    }
+                    $valid_pairs_subtypes_count += count($paired_subtypes);
+                }
+            }
+
+            if ($valid_pairs_count <= 0) {
+                return false;
+            }
+            foreach ($pairs as $paired_type => $paired_subtypes) {
+                // this will always be an array because of line 2027, right?
+                // no...some overly clever person can say pair => array('object' => null)
+                if (is_array($paired_subtypes)) {
+                    $paired_subtype_ids = [];
+                    foreach ($paired_subtypes as $paired_subtype) {
+                        if (ELGG_ENTITIES_NO_VALUE === $paired_subtype || ($paired_subtype_id = get_subtype_id($paired_type, $paired_subtype))) {
+                            $paired_subtype_ids[] = (ELGG_ENTITIES_NO_VALUE === $paired_subtype) ?
+                                    ELGG_ENTITIES_NO_VALUE : $paired_subtype_id;
+                        } else {
+                            $valid_pairs_subtypes_count--;
+                            $this->logger->notice("Type-subtype '$paired_type:$paired_subtype' does not exist!");
+                            // return false if we're all invalid subtypes in the only valid type
+                            continue;
+                        }
+                    }
+
+                    // return false if there are no valid subtypes.
+                    if ($valid_pairs_subtypes_count <= 0) {
+                        return false;
+                    }
+
+
+                    if ($paired_subtype_ids_str = implode(',', $paired_subtype_ids)) {
+                        $wheres[] = "({$table}.type = '$paired_type'"
+                                . " AND {$table}.subtype IN ($paired_subtype_ids_str))";
+                    }
+                } else {
+                    $wheres[] = "({$table}.type = '$paired_type')";
+                }
+            }
+        }
+
+        // pairs override the above.  return false if they don't exist.
+        if (is_array($wheres) && count($wheres)) {
+            $where = implode(' OR ', $wheres);
+            return "($where)";
+        }
+
+        return '';
+    }
+
+    /**
+     * Returns SQL where clause for owner and containers.
+     *
+     * @param string     $column Column name the guids should be checked against. Usually
+     *                           best to provide in table.column format.
+     * @param null|array $guids  Array of GUIDs.
+     *
+     * @return false|string
+     * @access private
+     */
+    public function getGuidBasedWhereSql($column, $guids) {
+        // short circuit if nothing requested
+        // 0 is a valid guid
+        if (!$guids && $guids !== 0) {
+            return '';
+        }
+
+        // normalize and sanitise owners
+        if (!is_array($guids)) {
+            $guids = [$guids];
+        }
+
+        $guids_sanitized = [];
+        foreach ($guids as $guid) {
+            if ($guid !== ELGG_ENTITIES_NO_VALUE) {
+                $guid = sanitise_int($guid);
+
+                if (!$guid) {
+                    return false;
+                }
+            }
+            $guids_sanitized[] = $guid;
+        }
+
+        $where = '';
+        $guid_str = implode(',', $guids_sanitized);
+
+        // implode(',', 0) returns 0.
+        if ($guid_str !== false && $guid_str !== '') {
+            $where = "($column IN ($guid_str))";
+        }
+
+        return $where;
+    }
+
+    /**
+     * Returns SQL where clause for entity time limits.
+     *
+     * @param string   $table              Entity table prefix as defined in
+     *                                     SELECT...FROM entities $table
+     * @param null|int $time_created_upper Time created upper limit
+     * @param null|int $time_created_lower Time created lower limit
+     * @param null|int $time_updated_upper Time updated upper limit
+     * @param null|int $time_updated_lower Time updated lower limit
+     *
+     * @return false|string false on fail, string on success.
+     * @access private
+     */
+    public function getEntityTimeWhereSql($table, $time_created_upper = null,
+    $time_created_lower = null, $time_updated_upper = null, $time_updated_lower = null) {
+
+        $wheres = [];
+
+        // exploit PHP's loose typing (quack) to check that they are INTs and not str cast to 0
+        if ($time_created_upper && $time_created_upper == sanitise_int($time_created_upper)) {
+            $wheres[] = "{$table}.time_created <= $time_created_upper";
+        }
+
+        if ($time_created_lower && $time_created_lower == sanitise_int($time_created_lower)) {
+            $wheres[] = "{$table}.time_created >= $time_created_lower";
+        }
+
+        if ($time_updated_upper && $time_updated_upper == sanitise_int($time_updated_upper)) {
+            $wheres[] = "{$table}.time_updated <= $time_updated_upper";
+        }
+
+        if ($time_updated_lower && $time_updated_lower == sanitise_int($time_updated_lower)) {
+            $wheres[] = "{$table}.time_updated >= $time_updated_lower";
+        }
+
+        if (is_array($wheres) && count($wheres) > 0) {
+            $where_str = implode(' AND ', $wheres);
+            return "($where_str)";
+        }
+
+        return '';
+    }
+
+    /**
+     * Gets entities based upon attributes in secondary tables.
+     * Also accepts all options available to elgg_get_entities(),
+     * elgg_get_entities_from_metadata(), and elgg_get_entities_from_relationship().
+     *
+     * @warning requires that the entity type be specified and there can only be one
+     * type.
+     *
+     * @see elgg_get_entities
+     * @see elgg_get_entities_from_metadata
+     * @see elgg_get_entities_from_relationship
+     *
+     * @param array $options Array in format:
+     *
+     * 	attribute_name_value_pairs => ARR (
+     *                                   'name' => 'name',
+     *                                   'value' => 'value',
+     *                                   'operand' => '=', (optional)
+     *                                   'case_sensitive' => false (optional)
+     *                                  )
+     * 	                             If multiple values are sent via
+     *                               an array ('value' => array('value1', 'value2')
+     *                               the pair's operand will be forced to "IN".
+     *
+     * 	attribute_name_value_pairs_operator => null|STR The operator to use for combining
+     *                                        (name = value) OPERATOR (name = value); default is AND
+     *
+     * @return ElggEntity[]|mixed If count, int. If not count, array. false on errors.
+     * @throws InvalidArgumentException
+     * @todo Does not support ordering by attributes or using an attribute pair shortcut like this ('title' => 'foo')
+     */
+    public function getEntitiesFromAttributes(array $options = []) {
+        $defaults = [
+            'attribute_name_value_pairs' => ELGG_ENTITIES_ANY_VALUE,
+            'attribute_name_value_pairs_operator' => 'AND',
+        ];
+
+        $options = array_merge($defaults, $options);
+
+        $singulars = ['type', 'attribute_name_value_pair'];
+        $options = _elgg_normalize_plural_options_array($options, $singulars);
+
+        $clauses = _elgg_get_entity_attribute_where_sql($options);
+
+        if ($clauses) {
+            // merge wheres to pass to elgg_get_entities()
+            if (isset($options['wheres']) && !is_array($options['wheres'])) {
+                $options['wheres'] = [$options['wheres']];
+            } elseif (!isset($options['wheres'])) {
+                $options['wheres'] = [];
+            }
+
+            $options['wheres'] = array_merge($options['wheres'], $clauses['wheres']);
+
+            // merge joins to pass to elgg_get_entities()
+            if (isset($options['joins']) && !is_array($options['joins'])) {
+                $options['joins'] = [$options['joins']];
+            } elseif (!isset($options['joins'])) {
+                $options['joins'] = [];
+            }
+
+            $options['joins'] = array_merge($options['joins'], $clauses['joins']);
+        }
+
+        return elgg_get_entities_from_relationship($options);
+    }
+
+    /**
+     * Get the join and where clauses for working with entity attributes
+     *
+     * @return false|array False on fail, array('joins', 'wheres')
+     * @access private
+     * @throws InvalidArgumentException
+     */
+    public function getEntityAttributeWhereSql(array $options = []) {
+
+        if (!isset($options['types'])) {
+            throw new InvalidArgumentException("The entity type must be defined for elgg_get_entities_from_attributes()");
+        }
+
+        if (is_array($options['types']) && count($options['types']) !== 1) {
+            throw new InvalidArgumentException("Only one type can be passed to elgg_get_entities_from_attributes()");
+        }
+
+        // type can be passed as string or array
+        $type = $options['types'];
+        if (is_array($type)) {
+            $type = $type[0];
+        }
+
+        // @todo the types should be defined somewhere (as constant on \ElggEntity?)
+        if (!in_array($type, ['group', 'object', 'site', 'user'])) {
+            throw new InvalidArgumentException("Invalid type '$type' passed to elgg_get_entities_from_attributes()");
+        }
+
+
+        $type_table = "{$this->db->prefix}{$type}s_entity";
+
+        $return = [
+            'joins' => [],
+            'wheres' => [],
+        ];
+
+        // short circuit if nothing requested
+        if ($options['attribute_name_value_pairs'] == ELGG_ENTITIES_ANY_VALUE) {
+            return $return;
+        }
+
+        if (!is_array($options['attribute_name_value_pairs'])) {
+            throw new InvalidArgumentException("attribute_name_value_pairs must be an array for elgg_get_entities_from_attributes()");
+        }
+
+        $wheres = [];
+
+        // check if this is an array of pairs or just a single pair.
+        $pairs = $options['attribute_name_value_pairs'];
+        if (isset($pairs['name']) || isset($pairs['value'])) {
+            $pairs = [$pairs];
+        }
+
+        $pair_wheres = [];
+        foreach ($pairs as $index => $pair) {
+            // must have at least a name and value
+            if (!isset($pair['name']) || !isset($pair['value'])) {
+                continue;
+            }
+
+            if (isset($pair['operand'])) {
+                $operand = sanitize_string($pair['operand']);
+            } else {
+                $operand = '=';
+            }
+
+            if (is_numeric($pair['value'])) {
+                $value = sanitize_string($pair['value']);
+            } else if (is_array($pair['value'])) {
+                $values_array = [];
+                foreach ($pair['value'] as $pair_value) {
+                    if (is_numeric($pair_value)) {
+                        $values_array[] = sanitize_string($pair_value);
+                    } else {
+                        $values_array[] = "'" . sanitize_string($pair_value) . "'";
+                    }
+                }
+
+                $operand = 'IN';
+                if ($values_array) {
+                    $value = '(' . implode(', ', $values_array) . ')';
+                }
+            } else {
+                $value = "'" . sanitize_string($pair['value']) . "'";
+            }
+
+            $name = sanitize_string($pair['name']);
+
+            // case sensitivity can be specified per pair
+            $pair_binary = '';
+            if (isset($pair['case_sensitive'])) {
+                $pair_binary = ($pair['case_sensitive']) ? 'BINARY ' : '';
+            }
+
+            $pair_wheres[] = "({$pair_binary}type_table.$name $operand $value)";
+        }
+
+        if ($where = implode(" {$options['attribute_name_value_pairs_operator']} ", $pair_wheres)) {
+            $return['wheres'][] = "($where)";
+
+            $return['joins'][] = "JOIN $type_table type_table ON e.guid = type_table.guid";
+        }
+
+        return $return;
+    }
+
+    /**
+     * Returns a list of months in which entities were updated or created.
+     *
+     * @tip Use this to generate a list of archives by month for when entities were added or updated.
+     *
+     * @todo document how to pass in array for $subtype
+     *
+     * @warning Months are returned in the form YYYYMM.
+     *
+     * @param string $type           The type of entity
+     * @param string $subtype        The subtype of entity
+     * @param int    $container_guid The container GUID that the entities belong to
+     * @param string $order_by       Order_by SQL order by clause
+     *
+     * @return array|false Either an array months as YYYYMM, or false on failure
+     */
+    public function getDates($type = '', $subtype = '', $container_guid = 0, $order_by = 'time_created') {
+
+        $where = [];
+
+        if ($type != "") {
+            $type = sanitise_string($type);
+            $where[] = "type='$type'";
+        }
+
+        if (is_array($subtype)) {
+            $tempwhere = "";
+            if (sizeof($subtype)) {
+                foreach ($subtype as $typekey => $subtypearray) {
+                    foreach ($subtypearray as $subtypeval) {
+                        $typekey = sanitise_string($typekey);
+                        if (!empty($subtypeval)) {
+                            if (!$subtypeval = (int) get_subtype_id($typekey, $subtypeval)) {
+                                return false;
+                            }
+                        } else {
+                            $subtypeval = 0;
+                        }
+                        if (!empty($tempwhere)) {
+                            $tempwhere .= " or ";
+                        }
+                        $tempwhere .= "(type = '{$typekey}' and subtype = {$subtypeval})";
+                    }
+                }
+            }
+            if (!empty($tempwhere)) {
+                $where[] = "({$tempwhere})";
+            }
+        } else {
+            if ($subtype) {
+                if (!$subtype_id = get_subtype_id($type, $subtype)) {
+                    return false;
+                } else {
+                    $where[] = "subtype=$subtype_id";
+                }
+            }
+        }
+
+        if ($container_guid !== 0) {
+            if (is_array($container_guid)) {
+                foreach ($container_guid as $key => $val) {
+                    $container_guid[$key] = (int) $val;
+                }
+                $where[] = "container_guid in (" . implode(",", $container_guid) . ")";
+            } else {
+                $container_guid = (int) $container_guid;
+                $where[] = "container_guid = {$container_guid}";
+            }
+        }
+
+        $where[] = _elgg_get_access_where_sql(['table_alias' => '']);
+
+        $sql = "SELECT DISTINCT EXTRACT(YEAR_MONTH FROM FROM_UNIXTIME(time_created)) AS yearmonth
 			FROM {$this->db->prefix}entities where ";
 
-		foreach ($where as $w) {
-			$sql .= " $w and ";
-		}
-
-		$sql .= "1=1 ORDER BY $order_by";
-		if ($result = $this->db->getData($sql)) {
-			$endresult = [];
-			foreach ($result as $res) {
-				$endresult[] = $res->yearmonth;
-			}
-			return $endresult;
-		}
-		return false;
-	}
-
-	/**
-	 * Update the last_action column in the entities table for $guid.
-	 *
-	 * @warning This is different to time_updated.  Time_updated is automatically set,
-	 * while last_action is only set when explicitly called.
-	 *
-	 * @param ElggEntity $entity Entity annotation|relationship action carried out on
-	 * @param int        $posted Timestamp of last action
-	 * @return int
-	 * @access private
-	 */
-	public function updateLastAction(ElggEntity $entity, $posted = null) {
-
-		if (!$posted) {
-			$posted = $this->getCurrentTime()->getTimestamp();
-		}
+        foreach ($where as $w) {
+            $sql .= " $w and ";
+        }
+
+        $sql .= "1=1 ORDER BY $order_by";
+        if ($result = $this->db->getData($sql)) {
+            $endresult = [];
+            foreach ($result as $res) {
+                $endresult[] = $res->yearmonth;
+            }
+            return $endresult;
+        }
+        return false;
+    }
+
+    /**
+     * Update the last_action column in the entities table for $guid.
+     *
+     * @warning This is different to time_updated.  Time_updated is automatically set,
+     * while last_action is only set when explicitly called.
+     *
+     * @param ElggEntity $entity Entity annotation|relationship action carried out on
+     * @param int        $posted Timestamp of last action
+     * @return int
+     * @access private
+     */
+    public function updateLastAction(ElggEntity $entity, $posted = null) {
+
+        if (!$posted) {
+            $posted = $this->getCurrentTime()->getTimestamp();
+        }
 		
-		$query = "
+        $query = "
 			UPDATE {$this->db->prefix}entities
 			SET last_action = :last_action
 			WHERE guid = :guid
 		";
 
-		$params = [
-			':last_action' => (int) $posted,
-			':guid' => (int) $entity->guid,
-		];
+        $params = [
+            ':last_action' => (int) $posted,
+            ':guid' => (int) $entity->guid,
+        ];
 		
-		$this->db->updateData($query, true, $params);
-
-		return (int) $posted;
-	}
-
-	/**
-	 * Get a user by GUID even if the entity is hidden or disabled
-	 *
-	 * @param int $guid User GUID. Default is logged in user
-	 *
-	 * @return ElggUser|false
-	 * @throws UserFetchFailureException
-	 * @access private
-	 */
-	public function getUserForPermissionsCheck($guid = 0) {
-		if (!$guid) {
-			return $this->session->getLoggedInUser();
-		}
-
-		// need to ignore access and show hidden entities for potential hidden/disabled users
-		$ia = $this->session->setIgnoreAccess(true);
-		$show_hidden = access_show_hidden_entities(true);
+        $this->db->updateData($query, true, $params);
+
+        return (int) $posted;
+    }
+
+    /**
+     * Get a user by GUID even if the entity is hidden or disabled
+     *
+     * @param int $guid User GUID. Default is logged in user
+     *
+     * @return ElggUser|false
+     * @throws UserFetchFailureException
+     * @access private
+     */
+    public function getUserForPermissionsCheck($guid = 0) {
+        if (!$guid) {
+            return $this->session->getLoggedInUser();
+        }
+
+        // need to ignore access and show hidden entities for potential hidden/disabled users
+        $ia = $this->session->setIgnoreAccess(true);
+        $show_hidden = access_show_hidden_entities(true);
 	
-		$user = $this->get($guid, 'user');
-
-		$this->session->setIgnoreAccess($ia);
-		access_show_hidden_entities($show_hidden);
-
-		if (!$user) {
-			// requested to check access for a specific user_guid, but there is no user entity, so the caller
-			// should cancel the check and return false
-			$message = $this->translator->translate('UserFetchFailureException', [$guid]);
-			// $this->logger->warn($message);
-
-			throw new UserFetchFailureException($message);
-		}
-
-		return $user;
-	}
-
-	/**
-	 * Disables all entities owned and contained by a user (or another entity)
-	 *
-	 * @param int $owner_guid The owner GUID
-	 * @return bool
-	 */
-	public function disableEntities($owner_guid) {
-		$entity = get_entity($owner_guid);
-		if (!$entity || !$entity->canEdit()) {
-			return false;
-		}
-
-		if (!$this->events->trigger('disable', $entity->type, $entity)) {
-			return false;
-		}
-
-		$query = "
+        $user = $this->get($guid, 'user');
+
+        $this->session->setIgnoreAccess($ia);
+        access_show_hidden_entities($show_hidden);
+
+        if (!$user) {
+            // requested to check access for a specific user_guid, but there is no user entity, so the caller
+            // should cancel the check and return false
+            $message = $this->translator->translate('UserFetchFailureException', [$guid]);
+            // $this->logger->warn($message);
+
+            throw new UserFetchFailureException($message);
+        }
+
+        return $user;
+    }
+
+    /**
+     * Disables all entities owned and contained by a user (or another entity)
+     *
+     * @param int $owner_guid The owner GUID
+     * @return bool
+     */
+    public function disableEntities($owner_guid) {
+        $entity = get_entity($owner_guid);
+        if (!$entity || !$entity->canEdit()) {
+            return false;
+        }
+
+        if (!$this->events->trigger('disable', $entity->type, $entity)) {
+            return false;
+        }
+
+        $query = "
 			UPDATE {$this->table}entities
 			SET enabled='no'
 			WHERE owner_guid = :owner_guid
 			OR container_guid = :owner_guid";
 
-		$params = [
-			':owner_guid' => (int) $owner_guid,
-		];
+        $params = [
+            ':owner_guid' => (int) $owner_guid,
+        ];
 
-		_elgg_invalidate_cache_for_entity($entity->guid);
-		_elgg_invalidate_memcache_for_entity($entity->guid);
+        _elgg_invalidate_cache_for_entity($entity->guid);
+        _elgg_invalidate_memcache_for_entity($entity->guid);
 		
-		if ($this->db->updateData($query, true, $params)) {
-			return true;
-		}
+        if ($this->db->updateData($query, true, $params)) {
+            return true;
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }

engine/classes/Elgg/UserCapabilities.php

Spacing +2 added lines, -2 removed lines

@@ -102,7 +102,7 @@ 
 		}
 
 		// Test user if possible - should default to false unless a plugin hook says otherwise
-		$default = call_user_func(function () use ($entity, $user) {
+		$default = call_user_func(function() use ($entity, $user) {
 			if (!$user) {
 				return false;
 			}
@@ -411,7 +411,7 @@ 
 			// accepting these for BC
 			$annotation_name = '';
 		} elseif (!is_string($annotation_name)) {
-			throw new InvalidArgumentException(__METHOD__ . ' expects \$annotation_name to be a string');
+			throw new InvalidArgumentException(__METHOD__.' expects \$annotation_name to be a string');
 		}
 
 		if ($this->canBypassPermissionsCheck($user_guid)) {

Indentation +443 added lines, -443 removed lines

@@ -22,449 +22,449 @@
  */
 class UserCapabilities {
 
-	/**
-	 * @var PluginHooksService $hooks
-	 */
-	private $hooks;
-
-	/**
-	 * @var EntityTable
-	 */
-	private $entities;
-
-	/**
-	 * @var ElggSession
-	 */
-	private $session;
-
-	/**
-	 * Constructor
-	 *
-	 * @param PluginHooksService $hooks    Plugin hooks service
-	 * @param EntityTable        $entities Entity table
-	 * @param ElggSession        $session  Session
-	 */
-	public function __construct(PluginHooksService $hooks, EntityTable $entities, ElggSession $session) {
-		$this->hooks = $hooks;
-		$this->entities = $entities;
-		$this->session = $session;
-	}
-
-	/**
-	 * Decides if the access system should be ignored for a user.
-	 *
-	 * Returns true (meaning ignore access) if either of these 2 conditions are true:
-	 *   1) an admin user guid is passed to this function.
-	 *   2) {@link elgg_get_ignore_access()} returns true.
-	 *
-	 * @see elgg_set_ignore_access()
-	 *
-	 * @param int $user_guid The user to check against.
-	 *
-	 * @return bool
-	 */
-	public function canBypassPermissionsCheck($user_guid = 0) {
-		if ($this->session->getIgnoreAccess()) {
-			// Checking ignored access first to avoid infinite loops,
-			// when trying to fetch a user by guid
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		return $user && $user->isAdmin();
-	}
-
-	/**
-	 * Can a user edit this entity?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check plugin hook.
-	 *
-	 * @param ElggEntity $entity    Object entity
-	 * @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(ElggEntity $entity, $user_guid = 0) {
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		// Test user if possible - should default to false unless a plugin hook says otherwise
-		$default = call_user_func(function () use ($entity, $user) {
-			if (!$user) {
-				return false;
-			}
-
-			// favor the persisted attributes if not saved
-			$attrs = array_merge(
-					[
-				'owner_guid' => $entity->owner_guid,
-				'container_guid' => $entity->container_guid,
-					], $entity->getOriginalAttributes()
-			);
-
-			if ($attrs['owner_guid'] == $user->guid) {
-				return true;
-			}
-
-			if ($attrs['container_guid'] == $user->guid) {
-				return true;
-			}
-
-			if ($entity->guid == $user->guid) {
-				return true;
-			}
-
-			$container = $this->entities->get($attrs['container_guid']);
-
-			return ($container && $container->canEdit($user->guid));
-		});
-
-		$params = ['entity' => $entity, 'user' => $user];
-		return $this->hooks->trigger('permissions_check', $entity->getType(), $params, $default);
-	}
-
-	/**
-	 * Can a user delete this entity?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check:delete plugin hook.
-	 *
-	 * @param ElggEntity $entity    Object entity
-	 * @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(ElggEntity $entity, $user_guid = 0) {
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$return = $entity->canEdit($user_guid);
-
-		$params = [
-			'entity' => $entity,
-			'user' => $user
-		];
-		return $this->hooks->trigger('permissions_check:delete', $entity->getType(), $params, $return);
-	}
-
-	/**
-	 * Can a user delete this river item?
-	 *
-	 * @tip Can be overridden by registering for the "permissions_check:delete", "river" plugin hook.
-	 *
-	 * @param ElggRiverItem $item      River item
-	 * @param int           $user_guid The user GUID, optionally (default: logged in user)
-	 *
-	 * @return bool Whether this river item should be considered deletable by the given user.
-	 * @since 2.3
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canDeleteRiverItem(ElggRiverItem $item, $user_guid = 0) {
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$params = [
-			'item' => $item,
-			'user' => $user,
-		];
-		return $this->hooks->trigger('permissions_check:delete', 'river', $params, false);
-	}
-
-	/**
-	 * 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 ElggEntity   $entity    Object entity
-	 * @param int          $user_guid The user GUID, optionally (default: logged in user)
-	 * @param ElggMetadata $metadata  The piece of metadata to specifically check or null for any metadata
-	 *
-	 * @return bool
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canEditMetadata(ElggEntity $entity, $user_guid = 0, ElggMetadata $metadata = null) {
-		if (!$entity->guid) {
-			// @todo cannot edit metadata on unsaved entity?
-			return false;
-		}
-
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		if ($user) {
-			$user_guid = $user->guid;
-		}
-
-		// if metadata is not owned or owned by the user, then can edit
-		if ($metadata && ($metadata->owner_guid == 0 || $metadata->owner_guid == $user_guid)) {
-			$return = true;
-		} else {
-			$return = $entity->canEdit($user_guid);
-		}
-
-		// metadata and user may be null
-		$params = [
-			'entity' => $entity,
-			'user' => $user,
-			'metadata' => $metadata
-		];
-		return $this->hooks->trigger('permissions_check:metadata', $entity->getType(), $params, $return);
-	}
-
-	/**
-	 * Determines whether or not the user can edit this annotation
-	 *
-	 * @param Elggentity     $entity     Object entity
-	 * @param int            $user_guid  The GUID of the user (defaults to currently logged in user)
-	 * @param ElggAnnotation $annotation Annotation
-	 *
-	 * @return bool
-	 * @see elgg_set_ignore_access()
-	 */
-	public function canEditAnnotation(ElggEntity $entity, $user_guid = 0, ElggAnnotation $annotation = null) {
-		if (!$annotation) {
-			return false;
-		}
-
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$result = false;
-
-		if ($user) {
-			// If the owner of annotation is the specified user, they can edit.
-			if ($annotation->owner_guid == $user->guid) {
-				$result = true;
-			}
-
-			// If the user can edit the entity this is attached to, they can edit.
-			if ($result == false && $entity->canEdit($user->guid)) {
-				$result = true;
-			}
-		}
-
-		// Trigger plugin hook - note that $user may be null
-		$params = [
-			'entity' => $entity,
-			'user' => $user,
-			'annotation' => $annotation
-		];
-
-		return $this->hooks->trigger('permissions_check', 'annotation', $params, $result);
-	}
+    /**
+     * @var PluginHooksService $hooks
+     */
+    private $hooks;
+
+    /**
+     * @var EntityTable
+     */
+    private $entities;
+
+    /**
+     * @var ElggSession
+     */
+    private $session;
+
+    /**
+     * Constructor
+     *
+     * @param PluginHooksService $hooks    Plugin hooks service
+     * @param EntityTable        $entities Entity table
+     * @param ElggSession        $session  Session
+     */
+    public function __construct(PluginHooksService $hooks, EntityTable $entities, ElggSession $session) {
+        $this->hooks = $hooks;
+        $this->entities = $entities;
+        $this->session = $session;
+    }
+
+    /**
+     * Decides if the access system should be ignored for a user.
+     *
+     * Returns true (meaning ignore access) if either of these 2 conditions are true:
+     *   1) an admin user guid is passed to this function.
+     *   2) {@link elgg_get_ignore_access()} returns true.
+     *
+     * @see elgg_set_ignore_access()
+     *
+     * @param int $user_guid The user to check against.
+     *
+     * @return bool
+     */
+    public function canBypassPermissionsCheck($user_guid = 0) {
+        if ($this->session->getIgnoreAccess()) {
+            // Checking ignored access first to avoid infinite loops,
+            // when trying to fetch a user by guid
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        return $user && $user->isAdmin();
+    }
+
+    /**
+     * Can a user edit this entity?
+     *
+     * @tip Can be overridden by registering for the permissions_check plugin hook.
+     *
+     * @param ElggEntity $entity    Object entity
+     * @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(ElggEntity $entity, $user_guid = 0) {
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        // Test user if possible - should default to false unless a plugin hook says otherwise
+        $default = call_user_func(function () use ($entity, $user) {
+            if (!$user) {
+                return false;
+            }
+
+            // favor the persisted attributes if not saved
+            $attrs = array_merge(
+                    [
+                'owner_guid' => $entity->owner_guid,
+                'container_guid' => $entity->container_guid,
+                    ], $entity->getOriginalAttributes()
+            );
+
+            if ($attrs['owner_guid'] == $user->guid) {
+                return true;
+            }
+
+            if ($attrs['container_guid'] == $user->guid) {
+                return true;
+            }
+
+            if ($entity->guid == $user->guid) {
+                return true;
+            }
+
+            $container = $this->entities->get($attrs['container_guid']);
+
+            return ($container && $container->canEdit($user->guid));
+        });
+
+        $params = ['entity' => $entity, 'user' => $user];
+        return $this->hooks->trigger('permissions_check', $entity->getType(), $params, $default);
+    }
+
+    /**
+     * Can a user delete this entity?
+     *
+     * @tip Can be overridden by registering for the permissions_check:delete plugin hook.
+     *
+     * @param ElggEntity $entity    Object entity
+     * @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(ElggEntity $entity, $user_guid = 0) {
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $return = $entity->canEdit($user_guid);
+
+        $params = [
+            'entity' => $entity,
+            'user' => $user
+        ];
+        return $this->hooks->trigger('permissions_check:delete', $entity->getType(), $params, $return);
+    }
+
+    /**
+     * Can a user delete this river item?
+     *
+     * @tip Can be overridden by registering for the "permissions_check:delete", "river" plugin hook.
+     *
+     * @param ElggRiverItem $item      River item
+     * @param int           $user_guid The user GUID, optionally (default: logged in user)
+     *
+     * @return bool Whether this river item should be considered deletable by the given user.
+     * @since 2.3
+     * @see elgg_set_ignore_access()
+     */
+    public function canDeleteRiverItem(ElggRiverItem $item, $user_guid = 0) {
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $params = [
+            'item' => $item,
+            'user' => $user,
+        ];
+        return $this->hooks->trigger('permissions_check:delete', 'river', $params, false);
+    }
+
+    /**
+     * 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 ElggEntity   $entity    Object entity
+     * @param int          $user_guid The user GUID, optionally (default: logged in user)
+     * @param ElggMetadata $metadata  The piece of metadata to specifically check or null for any metadata
+     *
+     * @return bool
+     * @see elgg_set_ignore_access()
+     */
+    public function canEditMetadata(ElggEntity $entity, $user_guid = 0, ElggMetadata $metadata = null) {
+        if (!$entity->guid) {
+            // @todo cannot edit metadata on unsaved entity?
+            return false;
+        }
+
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        if ($user) {
+            $user_guid = $user->guid;
+        }
+
+        // if metadata is not owned or owned by the user, then can edit
+        if ($metadata && ($metadata->owner_guid == 0 || $metadata->owner_guid == $user_guid)) {
+            $return = true;
+        } else {
+            $return = $entity->canEdit($user_guid);
+        }
+
+        // metadata and user may be null
+        $params = [
+            'entity' => $entity,
+            'user' => $user,
+            'metadata' => $metadata
+        ];
+        return $this->hooks->trigger('permissions_check:metadata', $entity->getType(), $params, $return);
+    }
+
+    /**
+     * Determines whether or not the user can edit this annotation
+     *
+     * @param Elggentity     $entity     Object entity
+     * @param int            $user_guid  The GUID of the user (defaults to currently logged in user)
+     * @param ElggAnnotation $annotation Annotation
+     *
+     * @return bool
+     * @see elgg_set_ignore_access()
+     */
+    public function canEditAnnotation(ElggEntity $entity, $user_guid = 0, ElggAnnotation $annotation = null) {
+        if (!$annotation) {
+            return false;
+        }
+
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $result = false;
+
+        if ($user) {
+            // If the owner of annotation is the specified user, they can edit.
+            if ($annotation->owner_guid == $user->guid) {
+                $result = true;
+            }
+
+            // If the user can edit the entity this is attached to, they can edit.
+            if ($result == false && $entity->canEdit($user->guid)) {
+                $result = true;
+            }
+        }
+
+        // Trigger plugin hook - note that $user may be null
+        $params = [
+            'entity' => $entity,
+            'user' => $user,
+            'annotation' => $annotation
+        ];
+
+        return $this->hooks->trigger('permissions_check', 'annotation', $params, $result);
+    }
 	
-	/**
-	 * Can a user add an entity to this container
-	 *
-	 * @param ElggEntity $entity    Container entity
-	 * @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(ElggEntity $entity, $user_guid = 0, $type = 'all', $subtype = 'all') {
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		if ($user) {
-			$user_guid = $user->guid;
-		}
-
-		$params = [
-			'container' => $entity,
-			'user' => $user,
-			'subtype' => $subtype
-		];
-
-		// Unlike permissions, logic check can be used to prevent certain entity
-		// types from being contained by other entity types,
-		// e.g. discussion reply objects can only be contained by discussion objects.
-		// This hook can also be used to apply status logic, e.g. to disallow
-		// new replies in closed discussions.
-		// We do not take a stand hence the return is null. This can be used by
-		// handlers to check if another hook has modified the value.
-		$logic_check = $this->hooks->trigger('container_logic_check', $type, $params);
-
-		if ($logic_check === false) {
-			return false;
-		}
-
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		$return = false;
-		if ($entity) {
-			// If the user can edit the container, they can also write to it
-			if ($entity->canEdit($user_guid)) {
-				$return = true;
-			}
-		}
-
-		// Container permissions can prevent users from writing to an entity.
-		// For instance, these permissions can prevent non-group members from writing
-		// content to the group.
-		return $this->hooks->trigger('container_permissions_check', $type, $params, $return);
-	}
-
-	/**
-	 * Can a user comment on an entity?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check:comment,
-	 * <entity type> plugin hook.
-	 *
-	 * @param ElggEntity $entity    Object entity
-	 * @param int        $user_guid User guid (default is logged in user)
-	 * @param bool       $default   Default permission
-	 * @return bool
-	 */
-	public function canComment(ElggEntity $entity, $user_guid = 0, $default = null) {
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		// By default, we don't take a position of whether commenting is allowed
-		// because it is handled by the subclasses of \ElggEntity
-		$params = [
-			'entity' => $entity,
-			'user' => $user
-		];
-		return $this->hooks->trigger('permissions_check:comment', $entity->getType(), $params, $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 ElggEntity $entity          Objet entity
-	 * @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(ElggEntity $entity, $user_guid = 0, $annotation_name = '') {
-		if ($annotation_name === null || $annotation_name === false) {
-			// accepting these for BC
-			$annotation_name = '';
-		} elseif (!is_string($annotation_name)) {
-			throw new InvalidArgumentException(__METHOD__ . ' expects \$annotation_name to be a string');
-		}
-
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$return = (bool) $user;
-
-		$params = [
-			'entity' => $entity,
-			'user' => $user,
-			'annotation_name' => $annotation_name,
-		];
-
-		if (!empty($annotation_name)) {
-			$return = $this->hooks->trigger("permissions_check:annotate:$annotation_name", $entity->getType(), $params, $return);
-		}
-
-		return $this->hooks->trigger('permissions_check:annotate', $entity->getType(), $params, $return);
-	}
-
-	/**
-	 * Can a user download a file?
-	 *
-	 * @tip Can be overridden by registering for the permissions_check:download,file plugin hook.
-	 *
-	 * @param ElggFile $entity    File entity
-	 * @param int      $user_guid User guid (default is logged in user)
-	 * @param bool     $default   Default permission
-	 *
-	 * @return bool
-	 */
-	public function canDownload(ElggFile $entity, $user_guid = 0, $default = true) {
-		if ($this->canBypassPermissionsCheck($user_guid)) {
-			return true;
-		}
-
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$params = [
-			'entity' => $entity,
-			'user' => $user
-		];
-
-		return $this->hooks->trigger('permissions_check:download', 'file', $params, $default);
-	}
+    /**
+     * Can a user add an entity to this container
+     *
+     * @param ElggEntity $entity    Container entity
+     * @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(ElggEntity $entity, $user_guid = 0, $type = 'all', $subtype = 'all') {
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        if ($user) {
+            $user_guid = $user->guid;
+        }
+
+        $params = [
+            'container' => $entity,
+            'user' => $user,
+            'subtype' => $subtype
+        ];
+
+        // Unlike permissions, logic check can be used to prevent certain entity
+        // types from being contained by other entity types,
+        // e.g. discussion reply objects can only be contained by discussion objects.
+        // This hook can also be used to apply status logic, e.g. to disallow
+        // new replies in closed discussions.
+        // We do not take a stand hence the return is null. This can be used by
+        // handlers to check if another hook has modified the value.
+        $logic_check = $this->hooks->trigger('container_logic_check', $type, $params);
+
+        if ($logic_check === false) {
+            return false;
+        }
+
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        $return = false;
+        if ($entity) {
+            // If the user can edit the container, they can also write to it
+            if ($entity->canEdit($user_guid)) {
+                $return = true;
+            }
+        }
+
+        // Container permissions can prevent users from writing to an entity.
+        // For instance, these permissions can prevent non-group members from writing
+        // content to the group.
+        return $this->hooks->trigger('container_permissions_check', $type, $params, $return);
+    }
+
+    /**
+     * Can a user comment on an entity?
+     *
+     * @tip Can be overridden by registering for the permissions_check:comment,
+     * <entity type> plugin hook.
+     *
+     * @param ElggEntity $entity    Object entity
+     * @param int        $user_guid User guid (default is logged in user)
+     * @param bool       $default   Default permission
+     * @return bool
+     */
+    public function canComment(ElggEntity $entity, $user_guid = 0, $default = null) {
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        // By default, we don't take a position of whether commenting is allowed
+        // because it is handled by the subclasses of \ElggEntity
+        $params = [
+            'entity' => $entity,
+            'user' => $user
+        ];
+        return $this->hooks->trigger('permissions_check:comment', $entity->getType(), $params, $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 ElggEntity $entity          Objet entity
+     * @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(ElggEntity $entity, $user_guid = 0, $annotation_name = '') {
+        if ($annotation_name === null || $annotation_name === false) {
+            // accepting these for BC
+            $annotation_name = '';
+        } elseif (!is_string($annotation_name)) {
+            throw new InvalidArgumentException(__METHOD__ . ' expects \$annotation_name to be a string');
+        }
+
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $return = (bool) $user;
+
+        $params = [
+            'entity' => $entity,
+            'user' => $user,
+            'annotation_name' => $annotation_name,
+        ];
+
+        if (!empty($annotation_name)) {
+            $return = $this->hooks->trigger("permissions_check:annotate:$annotation_name", $entity->getType(), $params, $return);
+        }
+
+        return $this->hooks->trigger('permissions_check:annotate', $entity->getType(), $params, $return);
+    }
+
+    /**
+     * Can a user download a file?
+     *
+     * @tip Can be overridden by registering for the permissions_check:download,file plugin hook.
+     *
+     * @param ElggFile $entity    File entity
+     * @param int      $user_guid User guid (default is logged in user)
+     * @param bool     $default   Default permission
+     *
+     * @return bool
+     */
+    public function canDownload(ElggFile $entity, $user_guid = 0, $default = true) {
+        if ($this->canBypassPermissionsCheck($user_guid)) {
+            return true;
+        }
+
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $params = [
+            'entity' => $entity,
+            'user' => $user
+        ];
+
+        return $this->hooks->trigger('permissions_check:download', 'file', $params, $default);
+    }
 
 }

engine/classes/ElggEntity.php

Indentation +2072 added lines, -2072 removed lines

@@ -40,2162 +40,2162 @@
  * @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
 {
 	
-	/**
-	 * 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 = [];
-
-	/**
-	 * Create a new entity.
-	 *
-	 * Plugin developers should only use the constructor to create a new entity.
-	 * To retrieve entities, use get_entity() and the elgg_get_entities* functions.
-	 *
-	 * If no arguments are passed, it creates a new entity.
-	 * If a database result is passed as a \stdClass instance, it instantiates
-	 * that entity.
-	 *
-	 * @param \stdClass $row Database row result. Default is null to create a new object.
-	 *
-	 * @throws IOException If cannot load remaining data from db
-	 */
-	public function __construct(\stdClass $row = null) {
-		$this->initializeAttributes();
-
-		if ($row && !$this->load($row)) {
-			$msg = "Failed to load new " . get_class() . " for GUID:" . $row->guid;
-			throw new \IOException($msg);
-		}
-	}
-
-	/**
-	 * 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";
-
-		$this->attributes['type'] = $this->getType();
-		$this->attributes += self::getExtraAttributeDefaults($this->getType());
-	}
-
-	/**
-	 * 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'] = null;
-		$this->attributes['time_created'] = null;
-		$this->attributes['time_updated'] = null;
-		$this->attributes['last_action'] = null;
-
-		$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.
-	 */
-	public function getDisplayName() {
-		$attr = $this->getSecondaryTableColumns()[0];
-		return $this->$attr;
-	}
-
-	/**
-	 * Sets the title or name of this entity.
-	 *
-	 * @param string $display_name The title or name of this entity.
-	 * @return void
-	 */
-	public function setDisplayName($display_name) {
-		$attr = $this->getSecondaryTableColumns()[0];
-		$this->$attr = $display_name;
-	}
-
-	/**
-	 * 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->guid;
-
-		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.
-	 *
-	 * @return bool
-	 * @throws InvalidArgumentException
-	 */
-	public function setMetadata($name, $value, $value_type = '', $multiple = false, $owner_guid = 0) {
-
-		// 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);
-				$delete_result = elgg_delete_metadata($options);
-				elgg_set_ignore_access($ia);
-
-				if (false === $delete_result) {
-					return false;
-				}
-			}
-
-			$owner_guid = $owner_guid ? (int) $owner_guid : $this->owner_guid;
-
-			// add new md
-			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, null, true);
-				if (!$md_id) {
-					return false;
-				}
-			}
-
-			return true;
-		} 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) {
-				$msg = "owner guid 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() {
-		// this is just for the PHPUnit mocking framework
-		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]);
+    /**
+     * 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 = [];
+
+    /**
+     * Create a new entity.
+     *
+     * Plugin developers should only use the constructor to create a new entity.
+     * To retrieve entities, use get_entity() and the elgg_get_entities* functions.
+     *
+     * If no arguments are passed, it creates a new entity.
+     * If a database result is passed as a \stdClass instance, it instantiates
+     * that entity.
+     *
+     * @param \stdClass $row Database row result. Default is null to create a new object.
+     *
+     * @throws IOException If cannot load remaining data from db
+     */
+    public function __construct(\stdClass $row = null) {
+        $this->initializeAttributes();
+
+        if ($row && !$this->load($row)) {
+            $msg = "Failed to load new " . get_class() . " for GUID:" . $row->guid;
+            throw new \IOException($msg);
+        }
+    }
+
+    /**
+     * 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";
+
+        $this->attributes['type'] = $this->getType();
+        $this->attributes += self::getExtraAttributeDefaults($this->getType());
+    }
+
+    /**
+     * 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'] = null;
+        $this->attributes['time_created'] = null;
+        $this->attributes['time_updated'] = null;
+        $this->attributes['last_action'] = null;
+
+        $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.
+     */
+    public function getDisplayName() {
+        $attr = $this->getSecondaryTableColumns()[0];
+        return $this->$attr;
+    }
+
+    /**
+     * Sets the title or name of this entity.
+     *
+     * @param string $display_name The title or name of this entity.
+     * @return void
+     */
+    public function setDisplayName($display_name) {
+        $attr = $this->getSecondaryTableColumns()[0];
+        $this->$attr = $display_name;
+    }
+
+    /**
+     * 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->guid;
+
+        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.
+     *
+     * @return bool
+     * @throws InvalidArgumentException
+     */
+    public function setMetadata($name, $value, $value_type = '', $multiple = false, $owner_guid = 0) {
+
+        // 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);
+                $delete_result = elgg_delete_metadata($options);
+                elgg_set_ignore_access($ia);
+
+                if (false === $delete_result) {
+                    return false;
+                }
+            }
+
+            $owner_guid = $owner_guid ? (int) $owner_guid : $this->owner_guid;
+
+            // add new md
+            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, null, true);
+                if (!$md_id) {
+                    return false;
+                }
+            }
+
+            return true;
+        } 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) {
+                $msg = "owner guid 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() {
+        // this is just for the PHPUnit mocking framework
+        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()->hooks->getEvents()->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() {
-
-		$type = $this->attributes['type'];
-		if (!in_array($type, \Elgg\Config::getEntityTypes())) {
-			throw new \InvalidParameterException('Entity type must be one of the allowed types: '
-					. implode(', ', \Elgg\Config::getEntityTypes()));
-		}
+    /**
+     * 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()->hooks->getEvents()->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() {
+
+        $type = $this->attributes['type'];
+        if (!in_array($type, \Elgg\Config::getEntityTypes())) {
+            throw new \InvalidParameterException('Entity type must be one of the allowed types: '
+                    . implode(', ', \Elgg\Config::getEntityTypes()));
+        }
 		
-		$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($user_guid, $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($user_guid, $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;
-			}
-		}
-
-		// Create primary table row
-		$guid = _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 (!$guid) {
-			throw new \IOException("Unable to save new object's base entity information!");
-		}
-
-		// We are writing this new entity to cache to make sure subsequent calls
-		// to get_entity() load the entity from cache and not from the DB. This
-		// MUST come before the metadata and annotation writes below!
-		_elgg_services()->entityCache->set($this);
+        $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($user_guid, $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($user_guid, $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;
+            }
+        }
+
+        // Create primary table row
+        $guid = _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 (!$guid) {
+            throw new \IOException("Unable to save new object's base entity information!");
+        }
+
+        // We are writing this new entity to cache to make sure subsequent calls
+        // to get_entity() load the entity from cache and not from the DB. This
+        // MUST come before the metadata and annotation writes below!
+        _elgg_services()->entityCache->set($this);
 	
-		// for BC with 1.8, ->subtype always returns ID, ->getSubtype() the string
-		$this->attributes['subtype'] = (int) $subtype_id;
-		$this->attributes['guid'] = (int) $guid;
-		$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;
-
-		// Create secondary table row
-		$attrs = $this->getSecondaryTableColumns();
-
-		$column_names = implode(', ', $attrs);
-		$values = implode(', ', array_map(function ($attr) {
-			return ":$attr";
-		}, $attrs));
-
-		$params = [
-			':guid' => $guid,
-		];
-		foreach ($attrs as $attr) {
-			$params[":$attr"] = ($attr === 'url') ? '' : (string) $this->attributes[$attr];
-		}
-
-		$db = $this->getDatabase();
-		$query = "
+        // for BC with 1.8, ->subtype always returns ID, ->getSubtype() the string
+        $this->attributes['subtype'] = (int) $subtype_id;
+        $this->attributes['guid'] = (int) $guid;
+        $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;
+
+        // Create secondary table row
+        $attrs = $this->getSecondaryTableColumns();
+
+        $column_names = implode(', ', $attrs);
+        $values = implode(', ', array_map(function ($attr) {
+            return ":$attr";
+        }, $attrs));
+
+        $params = [
+            ':guid' => $guid,
+        ];
+        foreach ($attrs as $attr) {
+            $params[":$attr"] = ($attr === 'url') ? '' : (string) $this->attributes[$attr];
+        }
+
+        $db = $this->getDatabase();
+        $query = "
 			INSERT INTO {$db->prefix}{$this->type}s_entity
 			(guid, $column_names) VALUES (:guid, $values)
 		";
 
-		if ($db->insertData($query, $params) === false) {
-			// Uh oh, couldn't save secondary
-			$query = "
+        if ($db->insertData($query, $params) === false) {
+            // Uh oh, couldn't save secondary
+            $query = "
 				DELETE FROM {$db->prefix}entities
 				WHERE guid = :guid
 			";
-			$params = [
-				':guid' => $guid,
-			];
-			$db->deleteData($query, $params);
-
-			_elgg_services()->entityCache->remove($guid);
-
-			throw new \IOException("Unable to save new object's secondary entity information!");
-		}
-
-		// 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_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 = [];
-		}
+            $params = [
+                ':guid' => $guid,
+            ];
+            $db->deleteData($query, $params);
+
+            _elgg_services()->entityCache->remove($guid);
+
+            throw new \IOException("Unable to save new object's secondary entity information!");
+        }
+
+        // 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_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 = [];
+        }
 		
-		return $guid;
-	}
-
-	/**
-	 * Update the entity in the database.
-	 *
-	 * @return bool Whether the update was successful.
-	 *
-	 * @throws InvalidParameterException
-	 */
-	protected function update() {
+        return $guid;
+    }
+
+    /**
+     * Update the entity in the database.
+     *
+     * @return bool Whether the update was successful.
+     *
+     * @throws InvalidParameterException
+     */
+    protected function update() {
 		
-		_elgg_services()->boot->invalidateCache();
-
-		if (!$this->canEdit()) {
-			return false;
-		}
-
-		// give old update event a chance to stop the update
-		if (!_elgg_services()->hooks->getEvents()->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');
-		}
-
-		// Update primary table
-		$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,
-		]);
-		if ($ret === false) {
-			return false;
-		}
-
-		$this->attributes['time_updated'] = $time;
-
-		// Update secondary table
-		$attrs = $this->getSecondaryTableColumns();
-
-		$sets = array_map(function ($attr) {
-			return "$attr = :$attr";
-		}, $attrs);
-		$sets = implode(', ', $sets);
-
-		foreach ($attrs as $attr) {
-			$params[":$attr"] = ($attr === 'url') ? '' : (string) $this->attributes[$attr];
-		}
-		$params[':guid'] = $this->guid;
-
-		$db = $this->getDatabase();
-		$query = "
+        _elgg_services()->boot->invalidateCache();
+
+        if (!$this->canEdit()) {
+            return false;
+        }
+
+        // give old update event a chance to stop the update
+        if (!_elgg_services()->hooks->getEvents()->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');
+        }
+
+        // Update primary table
+        $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,
+        ]);
+        if ($ret === false) {
+            return false;
+        }
+
+        $this->attributes['time_updated'] = $time;
+
+        // Update secondary table
+        $attrs = $this->getSecondaryTableColumns();
+
+        $sets = array_map(function ($attr) {
+            return "$attr = :$attr";
+        }, $attrs);
+        $sets = implode(', ', $sets);
+
+        foreach ($attrs as $attr) {
+            $params[":$attr"] = ($attr === 'url') ? '' : (string) $this->attributes[$attr];
+        }
+        $params[':guid'] = $this->guid;
+
+        $db = $this->getDatabase();
+        $query = "
 			UPDATE {$db->prefix}{$this->type}s_entity
 			SET $sets
 			WHERE guid = :guid
 		";
 
-		if ($db->updateData($query, false, $params) === false) {
-			return false;
-		}
-
-		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);
-		}
-
-		$this->orig_attributes = [];
-
-		// Handle cases where there was no error BUT no rows were updated!
-		return true;
-	}
-
-	/**
-	 * Loads attributes from the entities table into the object.
-	 *
-	 * @param \stdClass $row Object of properties from database row(s)
-	 *
-	 * @return bool
-	 */
-	protected function load(\stdClass $row) {
-		$type = $this->type;
-
-		$attr_loader = new \Elgg\AttributeLoader(get_class($this), $type, $this->attributes);
-		if ($type === 'user' || $this instanceof ElggPlugin) {
-			$attr_loader->requires_access_control = false;
-		}
-		$attr_loader->secondary_loader = "get_{$type}_entity_as_row";
-
-		$attrs = $attr_loader->getRequiredAttributes($row);
-		if (!$attrs) {
-			return false;
-		}
-
-		$this->attributes = $attrs;
-
-		foreach ($attr_loader->getAdditionalSelectValues() as $name => $value) {
-			$this->setVolatileData("select:$name", $value);
-		}
-
-		_elgg_services()->entityCache->set($this);
-
-		return true;
-	}
-
-	/**
-	 * Get the added columns (besides GUID) stored in the secondary table
-	 *
-	 * @return string[]
-	 * @throws \InvalidArgumentException
-	 */
-	private function getSecondaryTableColumns() {
-		// Note: the title or name column must come first. See getDisplayName().
-		if ($this instanceof ElggObject) {
-			return ['title', 'description'];
-		}
-		if ($this instanceof ElggUser) {
-			return ['name', 'username', 'password_hash', 'email', 'language'];
-		}
-		if ($this instanceof ElggGroup) {
-			return ['name', 'description'];
-		}
-		if ($this instanceof ElggSite) {
-			return ['name', 'description', 'url'];
-		}
-		throw new \InvalidArgumentException("Not a recognized type: " . get_class($this));
-	}
-
-	/**
-	 * Get default values for the attributes not defined in \ElggEntity::initializeAttributes
-	 *
-	 * @param string $type Entity type
-	 *
-	 * @return array
-	 * @access private
-	 */
-	public static function getExtraAttributeDefaults($type) {
-		switch ($type) {
-			case 'object':
-				return [
-					'title' => null,
-					'description' => null,
-				];
-			case 'user':
-				return [
-					'name' => null,
-					'username' => null,
-					'password_hash' => null,
-					'email' => null,
-					'language' => null,
-					'banned' => "no",
-					'admin' => 'no',
-					'prev_last_action' => null,
-					'last_login' => null,
-					'prev_last_login' => null,
-				];
-			case 'group':
-				return [
-					'name' => null,
-					'description' => null,
-				];
-			case 'site':
-				return [
-					'name' => null,
-					'description' => null,
-					'url' => null,
-				];
-		}
-		throw new \InvalidArgumentException("Not a recognized type: $type");
-	}
+        if ($db->updateData($query, false, $params) === false) {
+            return false;
+        }
+
+        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);
+        }
+
+        $this->orig_attributes = [];
+
+        // Handle cases where there was no error BUT no rows were updated!
+        return true;
+    }
+
+    /**
+     * Loads attributes from the entities table into the object.
+     *
+     * @param \stdClass $row Object of properties from database row(s)
+     *
+     * @return bool
+     */
+    protected function load(\stdClass $row) {
+        $type = $this->type;
+
+        $attr_loader = new \Elgg\AttributeLoader(get_class($this), $type, $this->attributes);
+        if ($type === 'user' || $this instanceof ElggPlugin) {
+            $attr_loader->requires_access_control = false;
+        }
+        $attr_loader->secondary_loader = "get_{$type}_entity_as_row";
+
+        $attrs = $attr_loader->getRequiredAttributes($row);
+        if (!$attrs) {
+            return false;
+        }
+
+        $this->attributes = $attrs;
+
+        foreach ($attr_loader->getAdditionalSelectValues() as $name => $value) {
+            $this->setVolatileData("select:$name", $value);
+        }
+
+        _elgg_services()->entityCache->set($this);
+
+        return true;
+    }
+
+    /**
+     * Get the added columns (besides GUID) stored in the secondary table
+     *
+     * @return string[]
+     * @throws \InvalidArgumentException
+     */
+    private function getSecondaryTableColumns() {
+        // Note: the title or name column must come first. See getDisplayName().
+        if ($this instanceof ElggObject) {
+            return ['title', 'description'];
+        }
+        if ($this instanceof ElggUser) {
+            return ['name', 'username', 'password_hash', 'email', 'language'];
+        }
+        if ($this instanceof ElggGroup) {
+            return ['name', 'description'];
+        }
+        if ($this instanceof ElggSite) {
+            return ['name', 'description', 'url'];
+        }
+        throw new \InvalidArgumentException("Not a recognized type: " . get_class($this));
+    }
+
+    /**
+     * Get default values for the attributes not defined in \ElggEntity::initializeAttributes
+     *
+     * @param string $type Entity type
+     *
+     * @return array
+     * @access private
+     */
+    public static function getExtraAttributeDefaults($type) {
+        switch ($type) {
+            case 'object':
+                return [
+                    'title' => null,
+                    'description' => null,
+                ];
+            case 'user':
+                return [
+                    'name' => null,
+                    'username' => null,
+                    'password_hash' => null,
+                    'email' => null,
+                    'language' => null,
+                    'banned' => "no",
+                    'admin' => 'no',
+                    'prev_last_action' => null,
+                    'last_login' => null,
+                    'prev_last_login' => null,
+                ];
+            case 'group':
+                return [
+                    'name' => null,
+                    'description' => null,
+                ];
+            case 'site':
+                return [
+                    'name' => null,
+                    'description' => null,
+                    'url' => null,
+                ];
+        }
+        throw new \InvalidArgumentException("Not a recognized type: $type");
+    }
 	
-	/**
-	 * 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()->hooks->getEvents()->trigger('disable', $this->type, $this)) {
-			return false;
-		}
+        if (!_elgg_services()->hooks->getEvents()->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_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_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);
-		_elgg_get_memcache('new_entity_cache')->delete($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);
+        _elgg_get_memcache('new_entity_cache')->delete($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()->hooks->getEvents()->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()->hooks->getEvents()->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()->hooks->getEvents()->trigger('enable', $this->type, $this)) {
-			return false;
-		}
+        if (!_elgg_services()->hooks->getEvents()->trigger('enable', $this->type, $this)) {
+            return false;
+        }
 		
-		if (!$this->canEdit()) {
-			return false;
-		}
+        if (!$this->canEdit()) {
+            return false;
+        }
 		
-		// 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);
 
-		$db = $this->getDatabase();
-		$result = $db->updateData("
+        $db = $this->getDatabase();
+        $result = $db->updateData("
 			UPDATE {$db->prefix}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()->hooks->getEvents()->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()->hooks->getEvents()->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()->hooks->getEvents()->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()->hooks->getEvents()->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, 'limit' => false]);
-		elgg_delete_river(['object_guid' => $guid, 'limit' => false]);
-		elgg_delete_river(['target_guid' => $guid, 'limit' => false]);
+        // 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, 'limit' => false]);
+        elgg_delete_river(['object_guid' => $guid, 'limit' => false]);
+        elgg_delete_river(['target_guid' => $guid, 'limit' => false]);
 		
-		remove_all_private_settings($guid);
+        remove_all_private_settings($guid);
 
-		_elgg_invalidate_cache_for_entity($guid);
-		_elgg_invalidate_memcache_for_entity($guid);
+        _elgg_invalidate_cache_for_entity($guid);
+        _elgg_invalidate_memcache_for_entity($guid);
 
-		$dbprefix = _elgg_config()->dbprefix;
+        $dbprefix = _elgg_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/Database/AccessCollections.php

Indentation +835 added lines, -835 removed lines

@@ -24,179 +24,179 @@ 
  */
 class AccessCollections {
 
-	/**
-	 * @var Conf
-	 */
-	protected $config;
-
-	/**
-	 * @var Database
-	 */
-	protected $db;
-
-	/**
-	 * @vars \ElggStateVariableCache
-	 */
-	protected $access_cache;
-
-	/**
-	 * @var PluginHooksService
-	 */
-	protected $hooks;
-
-	/**
-	 * @var ElggSession
-	 */
-	protected $session;
-
-	/**
-	 * @var EntityTable
-	 */
-	protected $entities;
-
-	/**
-	 * @var UserCapabilities
-	 */
-	protected $capabilities;
-
-	/**
-	 * @var Translator
-	 */
-	protected $translator;
-
-	/**
-	 * @var string
-	 */
-	protected $table;
-
-	/**
-	 * @var string
-	 */
-	protected $membership_table;
-
-	/**
-	 * @var bool
-	 */
-	protected $init_complete = false;
-
-	/**
-	 * Constructor
-	 *
-	 * @param Conf                    $config       Config
-	 * @param Database                $db           Database
-	 * @param EntityTable             $entities     Entity table
-	 * @param UserCapabilities        $capabilities User capabilities
-	 * @param ElggStaticVariableCache $cache        Access cache
-	 * @param PluginHooksService      $hooks        Hooks
-	 * @param ElggSession             $session      Session
-	 * @param Translator              $translator   Translator
-	 */
-	public function __construct(
-			Conf $config,
-			Database $db,
-			EntityTable $entities,
-			UserCapabilities $capabilities,
-			ElggStaticVariableCache $cache,
-			PluginHooksService $hooks,
-			ElggSession $session,
-			Translator $translator) {
-		$this->config = $config;
-		$this->db = $db;
-		$this->entities = $entities;
-		$this->capabilities = $capabilities;
-		$this->access_cache = $cache;
-		$this->hooks = $hooks;
-		$this->session = $session;
-		$this->translator = $translator;
-
-		$this->table = "{$this->db->prefix}access_collections";
-		$this->membership_table = "{$this->db->prefix}access_collection_membership";
-	}
-
-	/**
-	 * Mark the access system as initialized
-	 *
-	 * @return void
-	 */
-	public function markInitComplete() {
-		$this->init_complete = true;
-	}
-
-	/**
-	 * Returns a string of access_ids for $user_guid appropriate for inserting into an SQL IN clause.
-	 *
-	 * @see get_access_array()
-	 *
-	 * @param int  $user_guid User ID; defaults to currently logged in user
-	 * @param bool $flush     If set to true, will refresh the access list from the
-	 *                        database rather than using this function's cache.
-	 *
-	 * @return string A concatenated string of access collections suitable for using in an SQL IN clause
-	 * @access private
-	 */
-	public function getAccessList($user_guid = 0, $flush = false) {
-		$access_array = $this->getAccessArray($user_guid, $flush);
-		$access_ids = implode(',', $access_array);
-		$list = "($access_ids)";
-
-		// for BC, populate the cache
-		$hash = $user_guid . 'get_access_list';
-		$this->access_cache->add($hash, $list);
-
-		return $list;
-	}
-
-	/**
-	 * Returns an array of access IDs a user is permitted to see.
-	 *
-	 * Can be overridden with the 'access:collections:read', 'user' plugin hook.
-	 * @warning A callback for that plugin hook needs to either not retrieve data
-	 * from the database that would use the access system (triggering the plugin again)
-	 * or ignore the second call. Otherwise, an infinite loop will be created.
-	 *
-	 * This returns a list of all the collection ids a user owns or belongs
-	 * to plus public and logged in access levels. If the user is an admin, it includes
-	 * the private access level.
-	 *
-	 * @internal this is only used in core for creating the SQL where clause when
-	 * retrieving content from the database. The friends access level is handled by
-	 * _elgg_get_access_where_sql().
-	 *
-	 * @see get_write_access_array() for the access levels that a user can write to.
-	 *
-	 * @param int  $user_guid User ID; defaults to currently logged in user
-	 * @param bool $flush     If set to true, will refresh the access ids from the
-	 *                        database rather than using this function's cache.
-	 *
-	 * @return array An array of access collections ids
-	 */
-	public function getAccessArray($user_guid = 0, $flush = false) {
-		$cache = $this->access_cache;
-
-		if ($flush) {
-			$cache->clear();
-		}
-
-		if ($user_guid == 0) {
-			$user_guid = $this->session->getLoggedInUserGuid();
-		}
-
-		$user_guid = (int) $user_guid;
-
-		$hash = $user_guid . 'get_access_array';
-
-		if ($cache[$hash]) {
-			$access_array = $cache[$hash];
-		} else {
-			// Public access is always visible
-			$access_array = [ACCESS_PUBLIC];
-
-			// The following can only return sensible data for a known user.
-			if ($user_guid) {
-				$access_array[] = ACCESS_LOGGED_IN;
-
-				// Get ACLs that user owns or is a member of
-				$query = "
+    /**
+     * @var Conf
+     */
+    protected $config;
+
+    /**
+     * @var Database
+     */
+    protected $db;
+
+    /**
+     * @vars \ElggStateVariableCache
+     */
+    protected $access_cache;
+
+    /**
+     * @var PluginHooksService
+     */
+    protected $hooks;
+
+    /**
+     * @var ElggSession
+     */
+    protected $session;
+
+    /**
+     * @var EntityTable
+     */
+    protected $entities;
+
+    /**
+     * @var UserCapabilities
+     */
+    protected $capabilities;
+
+    /**
+     * @var Translator
+     */
+    protected $translator;
+
+    /**
+     * @var string
+     */
+    protected $table;
+
+    /**
+     * @var string
+     */
+    protected $membership_table;
+
+    /**
+     * @var bool
+     */
+    protected $init_complete = false;
+
+    /**
+     * Constructor
+     *
+     * @param Conf                    $config       Config
+     * @param Database                $db           Database
+     * @param EntityTable             $entities     Entity table
+     * @param UserCapabilities        $capabilities User capabilities
+     * @param ElggStaticVariableCache $cache        Access cache
+     * @param PluginHooksService      $hooks        Hooks
+     * @param ElggSession             $session      Session
+     * @param Translator              $translator   Translator
+     */
+    public function __construct(
+            Conf $config,
+            Database $db,
+            EntityTable $entities,
+            UserCapabilities $capabilities,
+            ElggStaticVariableCache $cache,
+            PluginHooksService $hooks,
+            ElggSession $session,
+            Translator $translator) {
+        $this->config = $config;
+        $this->db = $db;
+        $this->entities = $entities;
+        $this->capabilities = $capabilities;
+        $this->access_cache = $cache;
+        $this->hooks = $hooks;
+        $this->session = $session;
+        $this->translator = $translator;
+
+        $this->table = "{$this->db->prefix}access_collections";
+        $this->membership_table = "{$this->db->prefix}access_collection_membership";
+    }
+
+    /**
+     * Mark the access system as initialized
+     *
+     * @return void
+     */
+    public function markInitComplete() {
+        $this->init_complete = true;
+    }
+
+    /**
+     * Returns a string of access_ids for $user_guid appropriate for inserting into an SQL IN clause.
+     *
+     * @see get_access_array()
+     *
+     * @param int  $user_guid User ID; defaults to currently logged in user
+     * @param bool $flush     If set to true, will refresh the access list from the
+     *                        database rather than using this function's cache.
+     *
+     * @return string A concatenated string of access collections suitable for using in an SQL IN clause
+     * @access private
+     */
+    public function getAccessList($user_guid = 0, $flush = false) {
+        $access_array = $this->getAccessArray($user_guid, $flush);
+        $access_ids = implode(',', $access_array);
+        $list = "($access_ids)";
+
+        // for BC, populate the cache
+        $hash = $user_guid . 'get_access_list';
+        $this->access_cache->add($hash, $list);
+
+        return $list;
+    }
+
+    /**
+     * Returns an array of access IDs a user is permitted to see.
+     *
+     * Can be overridden with the 'access:collections:read', 'user' plugin hook.
+     * @warning A callback for that plugin hook needs to either not retrieve data
+     * from the database that would use the access system (triggering the plugin again)
+     * or ignore the second call. Otherwise, an infinite loop will be created.
+     *
+     * This returns a list of all the collection ids a user owns or belongs
+     * to plus public and logged in access levels. If the user is an admin, it includes
+     * the private access level.
+     *
+     * @internal this is only used in core for creating the SQL where clause when
+     * retrieving content from the database. The friends access level is handled by
+     * _elgg_get_access_where_sql().
+     *
+     * @see get_write_access_array() for the access levels that a user can write to.
+     *
+     * @param int  $user_guid User ID; defaults to currently logged in user
+     * @param bool $flush     If set to true, will refresh the access ids from the
+     *                        database rather than using this function's cache.
+     *
+     * @return array An array of access collections ids
+     */
+    public function getAccessArray($user_guid = 0, $flush = false) {
+        $cache = $this->access_cache;
+
+        if ($flush) {
+            $cache->clear();
+        }
+
+        if ($user_guid == 0) {
+            $user_guid = $this->session->getLoggedInUserGuid();
+        }
+
+        $user_guid = (int) $user_guid;
+
+        $hash = $user_guid . 'get_access_array';
+
+        if ($cache[$hash]) {
+            $access_array = $cache[$hash];
+        } else {
+            // Public access is always visible
+            $access_array = [ACCESS_PUBLIC];
+
+            // The following can only return sensible data for a known user.
+            if ($user_guid) {
+                $access_array[] = ACCESS_LOGGED_IN;
+
+                // Get ACLs that user owns or is a member of
+                $query = "
 					SELECT ac.id
 					FROM {$this->table} ac
 					WHERE ac.owner_guid = :user_guid
@@ -206,690 +206,690 @@ 
 							   AND user_guid = :user_guid)
 				";
 
-				$collections = $this->db->getData($query, null, [
-					':user_guid' => $user_guid,
-				]);
-
-				if ($collections) {
-					foreach ($collections as $collection) {
-						$access_array[] = (int) $collection->id;
-					}
-				}
-
-				$ignore_access = $this->capabilities->canBypassPermissionsCheck($user_guid);
-
-				if ($ignore_access == true) {
-					$access_array[] = ACCESS_PRIVATE;
-				}
-			}
-
-			if ($this->init_complete) {
-				$cache[$hash] = $access_array;
-			}
-		}
-
-		$options = [
-			'user_id' => $user_guid,
-		];
-
-		// see the warning in the docs for this function about infinite loop potential
-		return $this->hooks->trigger('access:collections:read', 'user', $options, $access_array);
-	}
-
-	/**
-	 * Returns the SQL where clause for enforcing read access to data.
-	 *
-	 * Note that if this code is executed in privileged mode it will return (1=1).
-	 *
-	 * Otherwise it returns a where clause to retrieve the data that a user has
-	 * permission to read.
-	 *
-	 * Plugin authors can hook into the 'get_sql', 'access' plugin hook to modify,
-	 * remove, or add to the where clauses. The plugin hook will pass an array with the current
-	 * ors and ands to the function in the form:
-	 *  array(
-	 *      'ors' => array(),
-	 *      'ands' => array()
-	 *  )
-	 *
-	 * The results will be combined into an SQL where clause in the form:
-	 *  ((or1 OR or2 OR orN) AND (and1 AND and2 AND andN))
-	 *
-	 * @param array $options Array in format:
-	 *
-	 * 	table_alias => STR Optional table alias. This is based on the select and join clauses.
-	 *                     Default is 'e'.
-	 *
-	 *  user_guid => INT Optional GUID for the user that we are retrieving data for.
-	 *                   Defaults to the logged in user if null.
-	 *                   Passing 0 will build a query for a logged out user (even if there is a logged in user)
-	 *
-	 *  use_enabled_clause => BOOL Optional. Should we append the enabled clause? The default
-	 *                             is set by access_show_hidden_entities().
-	 *
-	 *  access_column => STR Optional access column name. Default is 'access_id'.
-	 *
-	 *  owner_guid_column => STR Optional owner_guid column. Default is 'owner_guid'.
-	 *
-	 *  guid_column => STR Optional guid_column. Default is 'guid'.
-	 *
-	 * @return string
-	 * @access private
-	 */
-	public function getWhereSql(array $options = []) {
-
-		$defaults = [
-			'table_alias' => 'e',
-			'user_guid' => $this->session->getLoggedInUserGuid(),
-			'use_enabled_clause' => !access_get_show_hidden_status(),
-			'access_column' => 'access_id',
-			'owner_guid_column' => 'owner_guid',
-			'guid_column' => 'guid',
-		];
-
-		foreach ($options as $key => $value) {
-			if (is_null($value)) {
-				// remove null values so we don't loose defaults in array_merge
-				unset($options[$key]);
-			}
-		}
-
-		$options = array_merge($defaults, $options);
-
-		// just in case someone passes a . at the end
-		$options['table_alias'] = rtrim($options['table_alias'], '.');
-
-		foreach (['table_alias', 'access_column', 'owner_guid_column', 'guid_column'] as $key) {
-			$options[$key] = sanitize_string($options[$key]);
-		}
-		$options['user_guid'] = sanitize_int($options['user_guid'], false);
-
-		// only add dot if we have an alias or table name
-		$table_alias = $options['table_alias'] ? $options['table_alias'] . '.' : '';
-
-		if (!isset($options['ignore_access'])) {
-			$options['ignore_access'] = $this->capabilities->canBypassPermissionsCheck($options['user_guid']);
-		}
-
-		$clauses = [
-			'ors' => [],
-			'ands' => []
-		];
-
-		$prefix = $this->db->prefix;
-
-		if ($options['ignore_access']) {
-			$clauses['ors']['ignore_access'] = '1 = 1';
-		} else if ($options['user_guid']) {
-			// include content of user's friends
-			$clauses['ors']['friends_access'] = "$table_alias{$options['access_column']} = " . ACCESS_FRIENDS . "
+                $collections = $this->db->getData($query, null, [
+                    ':user_guid' => $user_guid,
+                ]);
+
+                if ($collections) {
+                    foreach ($collections as $collection) {
+                        $access_array[] = (int) $collection->id;
+                    }
+                }
+
+                $ignore_access = $this->capabilities->canBypassPermissionsCheck($user_guid);
+
+                if ($ignore_access == true) {
+                    $access_array[] = ACCESS_PRIVATE;
+                }
+            }
+
+            if ($this->init_complete) {
+                $cache[$hash] = $access_array;
+            }
+        }
+
+        $options = [
+            'user_id' => $user_guid,
+        ];
+
+        // see the warning in the docs for this function about infinite loop potential
+        return $this->hooks->trigger('access:collections:read', 'user', $options, $access_array);
+    }
+
+    /**
+     * Returns the SQL where clause for enforcing read access to data.
+     *
+     * Note that if this code is executed in privileged mode it will return (1=1).
+     *
+     * Otherwise it returns a where clause to retrieve the data that a user has
+     * permission to read.
+     *
+     * Plugin authors can hook into the 'get_sql', 'access' plugin hook to modify,
+     * remove, or add to the where clauses. The plugin hook will pass an array with the current
+     * ors and ands to the function in the form:
+     *  array(
+     *      'ors' => array(),
+     *      'ands' => array()
+     *  )
+     *
+     * The results will be combined into an SQL where clause in the form:
+     *  ((or1 OR or2 OR orN) AND (and1 AND and2 AND andN))
+     *
+     * @param array $options Array in format:
+     *
+     * 	table_alias => STR Optional table alias. This is based on the select and join clauses.
+     *                     Default is 'e'.
+     *
+     *  user_guid => INT Optional GUID for the user that we are retrieving data for.
+     *                   Defaults to the logged in user if null.
+     *                   Passing 0 will build a query for a logged out user (even if there is a logged in user)
+     *
+     *  use_enabled_clause => BOOL Optional. Should we append the enabled clause? The default
+     *                             is set by access_show_hidden_entities().
+     *
+     *  access_column => STR Optional access column name. Default is 'access_id'.
+     *
+     *  owner_guid_column => STR Optional owner_guid column. Default is 'owner_guid'.
+     *
+     *  guid_column => STR Optional guid_column. Default is 'guid'.
+     *
+     * @return string
+     * @access private
+     */
+    public function getWhereSql(array $options = []) {
+
+        $defaults = [
+            'table_alias' => 'e',
+            'user_guid' => $this->session->getLoggedInUserGuid(),
+            'use_enabled_clause' => !access_get_show_hidden_status(),
+            'access_column' => 'access_id',
+            'owner_guid_column' => 'owner_guid',
+            'guid_column' => 'guid',
+        ];
+
+        foreach ($options as $key => $value) {
+            if (is_null($value)) {
+                // remove null values so we don't loose defaults in array_merge
+                unset($options[$key]);
+            }
+        }
+
+        $options = array_merge($defaults, $options);
+
+        // just in case someone passes a . at the end
+        $options['table_alias'] = rtrim($options['table_alias'], '.');
+
+        foreach (['table_alias', 'access_column', 'owner_guid_column', 'guid_column'] as $key) {
+            $options[$key] = sanitize_string($options[$key]);
+        }
+        $options['user_guid'] = sanitize_int($options['user_guid'], false);
+
+        // only add dot if we have an alias or table name
+        $table_alias = $options['table_alias'] ? $options['table_alias'] . '.' : '';
+
+        if (!isset($options['ignore_access'])) {
+            $options['ignore_access'] = $this->capabilities->canBypassPermissionsCheck($options['user_guid']);
+        }
+
+        $clauses = [
+            'ors' => [],
+            'ands' => []
+        ];
+
+        $prefix = $this->db->prefix;
+
+        if ($options['ignore_access']) {
+            $clauses['ors']['ignore_access'] = '1 = 1';
+        } else if ($options['user_guid']) {
+            // include content of user's friends
+            $clauses['ors']['friends_access'] = "$table_alias{$options['access_column']} = " . ACCESS_FRIENDS . "
 				AND $table_alias{$options['owner_guid_column']} IN (
 					SELECT guid_one FROM {$prefix}entity_relationships
 					WHERE relationship = 'friend' AND guid_two = {$options['user_guid']}
 				)";
 
-			// include user's content
-			$clauses['ors']['owner_access'] = "$table_alias{$options['owner_guid_column']} = {$options['user_guid']}";
-		}
-
-		// include standard accesses (public, logged in, access collections)
-		if (!$options['ignore_access']) {
-			$access_list = $this->getAccessList($options['user_guid']);
-			$clauses['ors']['acl_access'] = "$table_alias{$options['access_column']} IN {$access_list}";
-		}
-
-		if ($options['use_enabled_clause']) {
-			$clauses['ands']['use_enabled'] = "{$table_alias}enabled = 'yes'";
-		}
-
-		$clauses = $this->hooks->trigger('get_sql', 'access', $options, $clauses);
-
-		$clauses_str = '';
-		if (is_array($clauses['ors']) && $clauses['ors']) {
-			$clauses_str = '(' . implode(' OR ', $clauses['ors']) . ')';
-		}
-
-		if (is_array($clauses['ands']) && $clauses['ands']) {
-			if ($clauses_str) {
-				$clauses_str .= ' AND ';
-			}
-			$clauses_str .= '(' . implode(' AND ', $clauses['ands']) . ')';
-		}
-
-		if (empty($clauses_str)) {
-			$clauses_str = '1 = 1';
-		}
+            // include user's content
+            $clauses['ors']['owner_access'] = "$table_alias{$options['owner_guid_column']} = {$options['user_guid']}";
+        }
+
+        // include standard accesses (public, logged in, access collections)
+        if (!$options['ignore_access']) {
+            $access_list = $this->getAccessList($options['user_guid']);
+            $clauses['ors']['acl_access'] = "$table_alias{$options['access_column']} IN {$access_list}";
+        }
+
+        if ($options['use_enabled_clause']) {
+            $clauses['ands']['use_enabled'] = "{$table_alias}enabled = 'yes'";
+        }
+
+        $clauses = $this->hooks->trigger('get_sql', 'access', $options, $clauses);
+
+        $clauses_str = '';
+        if (is_array($clauses['ors']) && $clauses['ors']) {
+            $clauses_str = '(' . implode(' OR ', $clauses['ors']) . ')';
+        }
+
+        if (is_array($clauses['ands']) && $clauses['ands']) {
+            if ($clauses_str) {
+                $clauses_str .= ' AND ';
+            }
+            $clauses_str .= '(' . implode(' AND ', $clauses['ands']) . ')';
+        }
+
+        if (empty($clauses_str)) {
+            $clauses_str = '1 = 1';
+        }
 		
-		return "($clauses_str)";
-	}
-
-	/**
-	 * Can a user access an entity.
-	 *
-	 * @warning If a logged in user doesn't have access to an entity, the
-	 * core engine will not load that entity.
-	 *
-	 * @tip This is mostly useful for checking if a user other than the logged in
-	 * user has access to an entity that is currently loaded.
-	 *
-	 * @todo This function would be much more useful if we could pass the guid of the
-	 * entity to test access for. We need to be able to tell whether the entity exists
-	 * and whether the user has access to the entity.
-	 *
-	 * @param ElggEntity $entity The entity to check access for.
-	 * @param ElggUser   $user   Optionally user to check access for. Defaults to
-	 *                           logged in user (which is a useless default).
-	 *
-	 * @return bool
-	 */
-	public function hasAccessToEntity($entity, $user = null) {
-		if (!$entity instanceof \ElggEntity) {
-			return false;
-		}
-
-		if ($entity->access_id == ACCESS_PUBLIC) {
-			// Public entities are always accessible
-			return true;
-		}
-
-		$user_guid = isset($user) ? (int) $user->guid : elgg_get_logged_in_user_guid();
-
-		if ($user_guid && $user_guid == $entity->owner_guid) {
-			// Owners have access to their own content
-			return true;
-		}
-
-		if ($user_guid && $entity->access_id == ACCESS_LOGGED_IN) {
-			// Existing users have access to entities with logged in access
-			return true;
-		}
-
-		// See #7159. Must not allow ignore access to affect query
-		$ia = elgg_set_ignore_access(false);
-
-		$row = $this->entities->getRow($entity->guid, $user_guid);
-
-		elgg_set_ignore_access($ia);
-
-		return !empty($row);
-	}
-
-	/**
-	 * Returns an array of access permissions that the user is allowed to save content with.
-	 * Permissions returned are of the form (id => 'name').
-	 *
-	 * Example return value in English:
-	 * array(
-	 *     0 => 'Private',
-	 *    -2 => 'Friends',
-	 *     1 => 'Logged in users',
-	 *     2 => 'Public',
-	 *    34 => 'My favorite friends',
-	 * );
-	 *
-	 * Plugin hook of 'access:collections:write', 'user'
-	 *
-	 * @warning this only returns access collections that the user owns plus the
-	 * standard access levels. It does not return access collections that the user
-	 * belongs to such as the access collection for a group.
-	 *
-	 * @param int   $user_guid    The user's GUID.
-	 * @param bool  $flush        If this is set to true, this will ignore a cached access array
-	 * @param array $input_params Some parameters passed into an input/access view
-	 *
-	 * @return array List of access permissions
-	 */
-	public function getWriteAccessArray($user_guid = 0, $flush = false, array $input_params = []) {
-		$cache = $this->access_cache;
-
-		if ($flush) {
-			$cache->clear();
-		}
-
-		if ($user_guid == 0) {
-			$user_guid = $this->session->getLoggedInUserGuid();
-		}
-
-		$user_guid = (int) $user_guid;
-
-		$hash = $user_guid . 'get_write_access_array';
-
-		if ($cache[$hash]) {
-			$access_array = $cache[$hash];
-		} else {
-			// @todo is there such a thing as public write access?
-			$access_array = [
-				ACCESS_PRIVATE => $this->getReadableAccessLevel(ACCESS_PRIVATE),
-				ACCESS_LOGGED_IN => $this->getReadableAccessLevel(ACCESS_LOGGED_IN),
-				ACCESS_PUBLIC => $this->getReadableAccessLevel(ACCESS_PUBLIC)
-			];
-
-			$collections = $this->getEntityCollections($user_guid);
-			if ($collections) {
-				foreach ($collections as $collection) {
-					$access_array[$collection->id] = $collection->name;
-				}
-			}
-
-			if ($this->init_complete) {
-				$cache[$hash] = $access_array;
-			}
-		}
-
-		$options = [
-			'user_id' => $user_guid,
-			'input_params' => $input_params,
-		];
-		return $this->hooks->trigger('access:collections:write', 'user', $options, $access_array);
-	}
-
-	/**
-	 * Can the user change this access collection?
-	 *
-	 * Use the plugin hook of 'access:collections:write', 'user' to change this.
-	 * @see get_write_access_array() for details on the hook.
-	 *
-	 * Respects access control disabling for admin users and {@link elgg_set_ignore_access()}
-	 *
-	 * @see get_write_access_array()
-	 *
-	 * @param int   $collection_id The collection id
-	 * @param mixed $user_guid     The user GUID to check for. Defaults to logged in user.
-	 * @return bool
-	 */
-	public function canEdit($collection_id, $user_guid = null) {
-		try {
-			$user = $this->entities->getUserForPermissionsCheck($user_guid);
-		} catch (UserFetchFailureException $e) {
-			return false;
-		}
-
-		$collection = $this->get($collection_id);
-
-		if (!$user || !$collection) {
-			return false;
-		}
-
-		if ($this->capabilities->canBypassPermissionsCheck($user->guid)) {
-			return true;
-		}
-
-		$write_access = $this->getWriteAccessArray($user->guid, true);
-		return array_key_exists($collection_id, $write_access);
-	}
-
-	/**
-	 * Creates a new access collection.
-	 *
-	 * Access colletions allow plugins and users to create granular access
-	 * for entities.
-	 *
-	 * Triggers plugin hook 'access:collections:addcollection', 'collection'
-	 *
-	 * @internal Access collections are stored in the access_collections table.
-	 * Memberships to collections are in access_collections_membership.
-	 *
-	 * @param string $name       The name of the collection.
-	 * @param int    $owner_guid The GUID of the owner (default: currently logged in user).
-	 *
-	 * @return int|false The collection ID if successful and false on failure.
-	 */
-	public function create($name, $owner_guid = 0) {
-		$name = trim($name);
-		if (empty($name)) {
-			return false;
-		}
-
-		if ($owner_guid == 0) {
-			$owner_guid = $this->session->getLoggedInUserGuid();
-		}
-
-		$query = "
+        return "($clauses_str)";
+    }
+
+    /**
+     * Can a user access an entity.
+     *
+     * @warning If a logged in user doesn't have access to an entity, the
+     * core engine will not load that entity.
+     *
+     * @tip This is mostly useful for checking if a user other than the logged in
+     * user has access to an entity that is currently loaded.
+     *
+     * @todo This function would be much more useful if we could pass the guid of the
+     * entity to test access for. We need to be able to tell whether the entity exists
+     * and whether the user has access to the entity.
+     *
+     * @param ElggEntity $entity The entity to check access for.
+     * @param ElggUser   $user   Optionally user to check access for. Defaults to
+     *                           logged in user (which is a useless default).
+     *
+     * @return bool
+     */
+    public function hasAccessToEntity($entity, $user = null) {
+        if (!$entity instanceof \ElggEntity) {
+            return false;
+        }
+
+        if ($entity->access_id == ACCESS_PUBLIC) {
+            // Public entities are always accessible
+            return true;
+        }
+
+        $user_guid = isset($user) ? (int) $user->guid : elgg_get_logged_in_user_guid();
+
+        if ($user_guid && $user_guid == $entity->owner_guid) {
+            // Owners have access to their own content
+            return true;
+        }
+
+        if ($user_guid && $entity->access_id == ACCESS_LOGGED_IN) {
+            // Existing users have access to entities with logged in access
+            return true;
+        }
+
+        // See #7159. Must not allow ignore access to affect query
+        $ia = elgg_set_ignore_access(false);
+
+        $row = $this->entities->getRow($entity->guid, $user_guid);
+
+        elgg_set_ignore_access($ia);
+
+        return !empty($row);
+    }
+
+    /**
+     * Returns an array of access permissions that the user is allowed to save content with.
+     * Permissions returned are of the form (id => 'name').
+     *
+     * Example return value in English:
+     * array(
+     *     0 => 'Private',
+     *    -2 => 'Friends',
+     *     1 => 'Logged in users',
+     *     2 => 'Public',
+     *    34 => 'My favorite friends',
+     * );
+     *
+     * Plugin hook of 'access:collections:write', 'user'
+     *
+     * @warning this only returns access collections that the user owns plus the
+     * standard access levels. It does not return access collections that the user
+     * belongs to such as the access collection for a group.
+     *
+     * @param int   $user_guid    The user's GUID.
+     * @param bool  $flush        If this is set to true, this will ignore a cached access array
+     * @param array $input_params Some parameters passed into an input/access view
+     *
+     * @return array List of access permissions
+     */
+    public function getWriteAccessArray($user_guid = 0, $flush = false, array $input_params = []) {
+        $cache = $this->access_cache;
+
+        if ($flush) {
+            $cache->clear();
+        }
+
+        if ($user_guid == 0) {
+            $user_guid = $this->session->getLoggedInUserGuid();
+        }
+
+        $user_guid = (int) $user_guid;
+
+        $hash = $user_guid . 'get_write_access_array';
+
+        if ($cache[$hash]) {
+            $access_array = $cache[$hash];
+        } else {
+            // @todo is there such a thing as public write access?
+            $access_array = [
+                ACCESS_PRIVATE => $this->getReadableAccessLevel(ACCESS_PRIVATE),
+                ACCESS_LOGGED_IN => $this->getReadableAccessLevel(ACCESS_LOGGED_IN),
+                ACCESS_PUBLIC => $this->getReadableAccessLevel(ACCESS_PUBLIC)
+            ];
+
+            $collections = $this->getEntityCollections($user_guid);
+            if ($collections) {
+                foreach ($collections as $collection) {
+                    $access_array[$collection->id] = $collection->name;
+                }
+            }
+
+            if ($this->init_complete) {
+                $cache[$hash] = $access_array;
+            }
+        }
+
+        $options = [
+            'user_id' => $user_guid,
+            'input_params' => $input_params,
+        ];
+        return $this->hooks->trigger('access:collections:write', 'user', $options, $access_array);
+    }
+
+    /**
+     * Can the user change this access collection?
+     *
+     * Use the plugin hook of 'access:collections:write', 'user' to change this.
+     * @see get_write_access_array() for details on the hook.
+     *
+     * Respects access control disabling for admin users and {@link elgg_set_ignore_access()}
+     *
+     * @see get_write_access_array()
+     *
+     * @param int   $collection_id The collection id
+     * @param mixed $user_guid     The user GUID to check for. Defaults to logged in user.
+     * @return bool
+     */
+    public function canEdit($collection_id, $user_guid = null) {
+        try {
+            $user = $this->entities->getUserForPermissionsCheck($user_guid);
+        } catch (UserFetchFailureException $e) {
+            return false;
+        }
+
+        $collection = $this->get($collection_id);
+
+        if (!$user || !$collection) {
+            return false;
+        }
+
+        if ($this->capabilities->canBypassPermissionsCheck($user->guid)) {
+            return true;
+        }
+
+        $write_access = $this->getWriteAccessArray($user->guid, true);
+        return array_key_exists($collection_id, $write_access);
+    }
+
+    /**
+     * Creates a new access collection.
+     *
+     * Access colletions allow plugins and users to create granular access
+     * for entities.
+     *
+     * Triggers plugin hook 'access:collections:addcollection', 'collection'
+     *
+     * @internal Access collections are stored in the access_collections table.
+     * Memberships to collections are in access_collections_membership.
+     *
+     * @param string $name       The name of the collection.
+     * @param int    $owner_guid The GUID of the owner (default: currently logged in user).
+     *
+     * @return int|false The collection ID if successful and false on failure.
+     */
+    public function create($name, $owner_guid = 0) {
+        $name = trim($name);
+        if (empty($name)) {
+            return false;
+        }
+
+        if ($owner_guid == 0) {
+            $owner_guid = $this->session->getLoggedInUserGuid();
+        }
+
+        $query = "
 			INSERT INTO {$this->table}
 			SET name = :name,
 				owner_guid = :owner_guid
 		";
 
-		$params = [
-			':name' => $name,
-			':owner_guid' => (int) $owner_guid,
-		];
-
-		$id = $this->db->insertData($query, $params);
-		if (!$id) {
-			return false;
-		}
-
-		$this->access_cache->clear();
-
-		$hook_params = [
-			'collection_id' => $id,
-			'name' => $name,
-			'owner_guid' => $owner_guid,
-		];
-
-		if (!$this->hooks->trigger('access:collections:addcollection', 'collection', $hook_params, true)) {
-			$this->delete($id);
-			return false;
-		}
-
-		return $id;
-	}
-
-	/**
-	 * Renames an access collection
-	 *
-	 * @param int    $collection_id ID of the collection
-	 * @param string $name          The name of the collection
-	 * @return bool
-	 */
-	public function rename($collection_id, $name) {
-
-		$query = "
+        $params = [
+            ':name' => $name,
+            ':owner_guid' => (int) $owner_guid,
+        ];
+
+        $id = $this->db->insertData($query, $params);
+        if (!$id) {
+            return false;
+        }
+
+        $this->access_cache->clear();
+
+        $hook_params = [
+            'collection_id' => $id,
+            'name' => $name,
+            'owner_guid' => $owner_guid,
+        ];
+
+        if (!$this->hooks->trigger('access:collections:addcollection', 'collection', $hook_params, true)) {
+            $this->delete($id);
+            return false;
+        }
+
+        return $id;
+    }
+
+    /**
+     * Renames an access collection
+     *
+     * @param int    $collection_id ID of the collection
+     * @param string $name          The name of the collection
+     * @return bool
+     */
+    public function rename($collection_id, $name) {
+
+        $query = "
 			UPDATE {$this->table}
 			SET name = :name
 			WHERE id = :id
 		";
 
-		$params = [
-			':name' => $name,
-			':id' => (int) $collection_id,
-		];
-
-		if ($this->db->insertData($query, $params)) {
-			$this->access_cache->clear();
-			return (int) $collection_id;
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * Updates the membership in an access collection.
-	 *
-	 * @warning Expects a full list of all members that should
-	 * be part of the access collection
-	 *
-	 * @note This will run all hooks associated with adding or removing
-	 * members to access collections.
-	 *
-	 * @param int   $collection_id ID of the collection.
-	 * @param array $new_members   Array of member entities or GUIDs
-	 * @return bool
-	 */
-	public function update($collection_id, array $new_members = []) {
-		$acl = $this->get($collection_id);
-
-		if (!$acl) {
-			return false;
-		}
+        $params = [
+            ':name' => $name,
+            ':id' => (int) $collection_id,
+        ];
+
+        if ($this->db->insertData($query, $params)) {
+            $this->access_cache->clear();
+            return (int) $collection_id;
+        }
+
+        return false;
+    }
+
+
+    /**
+     * Updates the membership in an access collection.
+     *
+     * @warning Expects a full list of all members that should
+     * be part of the access collection
+     *
+     * @note This will run all hooks associated with adding or removing
+     * members to access collections.
+     *
+     * @param int   $collection_id ID of the collection.
+     * @param array $new_members   Array of member entities or GUIDs
+     * @return bool
+     */
+    public function update($collection_id, array $new_members = []) {
+        $acl = $this->get($collection_id);
+
+        if (!$acl) {
+            return false;
+        }
 		
-		$to_guid = function($elem) {
-			if (empty($elem)) {
-				return 0;
-			}
-			if (is_object($elem)) {
-				return (int) $elem->guid;
-			}
-			return (int) $elem;
-		};
+        $to_guid = function($elem) {
+            if (empty($elem)) {
+                return 0;
+            }
+            if (is_object($elem)) {
+                return (int) $elem->guid;
+            }
+            return (int) $elem;
+        };
 		
-		$current_members = [];
-		$new_members = array_map($to_guid, $new_members);
+        $current_members = [];
+        $new_members = array_map($to_guid, $new_members);
 
-		$current_members_batch = $this->getMembers($collection_id, [
-			'batch' => true,
-			'limit' => 0,
-			'callback' => false,
-		]);
+        $current_members_batch = $this->getMembers($collection_id, [
+            'batch' => true,
+            'limit' => 0,
+            'callback' => false,
+        ]);
 
-		foreach ($current_members_batch as $row) {
-			$current_members[] = $to_guid($row);
-		}
+        foreach ($current_members_batch as $row) {
+            $current_members[] = $to_guid($row);
+        }
 
-		$remove_members = array_diff($current_members, $new_members);
-		$add_members = array_diff($new_members, $current_members);
+        $remove_members = array_diff($current_members, $new_members);
+        $add_members = array_diff($new_members, $current_members);
 
-		$result = true;
+        $result = true;
 
-		foreach ($add_members as $guid) {
-			$result = $result && $this->addUser($guid, $collection_id);
-		}
+        foreach ($add_members as $guid) {
+            $result = $result && $this->addUser($guid, $collection_id);
+        }
 
-		foreach ($remove_members as $guid) {
-			$result = $result && $this->removeUser($guid, $collection_id);
-		}
+        foreach ($remove_members as $guid) {
+            $result = $result && $this->removeUser($guid, $collection_id);
+        }
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 
-		return $result;
-	}
+        return $result;
+    }
 
-	/**
-	 * Deletes a collection and its membership information
-	 *
-	 * @param int $collection_id ID of the collection
-	 * @return bool
-	 */
-	public function delete($collection_id) {
-		$collection_id = (int) $collection_id;
+    /**
+     * Deletes a collection and its membership information
+     *
+     * @param int $collection_id ID of the collection
+     * @return bool
+     */
+    public function delete($collection_id) {
+        $collection_id = (int) $collection_id;
 
-		$params = [
-			'collection_id' => $collection_id,
-		];
+        $params = [
+            'collection_id' => $collection_id,
+        ];
 
-		if (!$this->hooks->trigger('access:collections:deletecollection', 'collection', $params, true)) {
-			return false;
-		}
+        if (!$this->hooks->trigger('access:collections:deletecollection', 'collection', $params, true)) {
+            return false;
+        }
 
-		// Deleting membership doesn't affect result of deleting ACL.
-		$query = "
+        // Deleting membership doesn't affect result of deleting ACL.
+        $query = "
 			DELETE FROM {$this->membership_table}
 			WHERE access_collection_id = :access_collection_id
 		";
-		$this->db->deleteData($query, [
-			':access_collection_id' => $collection_id,
-		]);
+        $this->db->deleteData($query, [
+            ':access_collection_id' => $collection_id,
+        ]);
 
-		$query = "
+        $query = "
 			DELETE FROM {$this->table}
 			WHERE id = :id
 		";
-		$result = $this->db->deleteData($query, [
-			':id' => $collection_id,
-		]);
+        $result = $this->db->deleteData($query, [
+            ':id' => $collection_id,
+        ]);
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 		
-		return (bool) $result;
-	}
-
-	/**
-	 * Transforms a database row to an instance of ElggAccessCollection
-	 *
-	 * @param \stdClass $row Database row
-	 * @return \ElggAccessCollection
-	 */
-	public function rowToElggAccessCollection(\stdClass $row) {
-		return new \ElggAccessCollection($row);
-	}
-
-	/**
-	 * Get a specified access collection
-	 *
-	 * @note This doesn't return the members of an access collection,
-	 * just the database row of the actual collection.
-	 *
-	 * @see get_members_of_access_collection()
-	 *
-	 * @param int $collection_id The collection ID
-	 * @return \ElggAccessCollection|false
-	 */
-	public function get($collection_id) {
-
-		$callback = [$this, 'rowToElggAccessCollection'];
-
-		$query = "
+        return (bool) $result;
+    }
+
+    /**
+     * Transforms a database row to an instance of ElggAccessCollection
+     *
+     * @param \stdClass $row Database row
+     * @return \ElggAccessCollection
+     */
+    public function rowToElggAccessCollection(\stdClass $row) {
+        return new \ElggAccessCollection($row);
+    }
+
+    /**
+     * Get a specified access collection
+     *
+     * @note This doesn't return the members of an access collection,
+     * just the database row of the actual collection.
+     *
+     * @see get_members_of_access_collection()
+     *
+     * @param int $collection_id The collection ID
+     * @return \ElggAccessCollection|false
+     */
+    public function get($collection_id) {
+
+        $callback = [$this, 'rowToElggAccessCollection'];
+
+        $query = "
 			SELECT * FROM {$this->table}
 			WHERE id = :id
 		";
 
-		return $this->db->getDataRow($query, $callback, [
-			':id' => (int) $collection_id,
-		]);
-	}
-
-	/**
-	 * Check if user is already in the collection
-	 *
-	 * @param int $user_guid     GUID of the user
-	 * @param int $collection_id ID of the collection
-	 * @return bool
-	 */
-	public function hasUser($user_guid, $collection_id) {
-		$options = [
-			'guids' => (int) $user_guid,
-			'count' => true,
-		];
-		return (bool) $this->getMembers($collection_id, $options);
-	}
-
-	/**
-	 * Adds a user to an access collection.
-	 *
-	 * Triggers the 'access:collections:add_user', 'collection' plugin hook.
-	 *
-	 * @param int $user_guid     GUID of the user to add
-	 * @param int $collection_id ID of the collection to add them to
-	 * @return bool
-	 */
-	public function addUser($user_guid, $collection_id) {
-
-		$collection = $this->get($collection_id);
-
-		if (!$collection) {
-			return false;
-		}
-
-		if (!$this->entities->exists($user_guid)) {
-			return false;
-		}
-
-		$hook_params = [
-			'collection_id' => $collection->id,
-			'user_guid' => (int) $user_guid
-		];
-
-		$result = $this->hooks->trigger('access:collections:add_user', 'collection', $hook_params, true);
-		if ($result == false) {
-			return false;
-		}
-
-		// if someone tries to insert the same data twice, we do a no-op on duplicate key
-		$query = "
+        return $this->db->getDataRow($query, $callback, [
+            ':id' => (int) $collection_id,
+        ]);
+    }
+
+    /**
+     * Check if user is already in the collection
+     *
+     * @param int $user_guid     GUID of the user
+     * @param int $collection_id ID of the collection
+     * @return bool
+     */
+    public function hasUser($user_guid, $collection_id) {
+        $options = [
+            'guids' => (int) $user_guid,
+            'count' => true,
+        ];
+        return (bool) $this->getMembers($collection_id, $options);
+    }
+
+    /**
+     * Adds a user to an access collection.
+     *
+     * Triggers the 'access:collections:add_user', 'collection' plugin hook.
+     *
+     * @param int $user_guid     GUID of the user to add
+     * @param int $collection_id ID of the collection to add them to
+     * @return bool
+     */
+    public function addUser($user_guid, $collection_id) {
+
+        $collection = $this->get($collection_id);
+
+        if (!$collection) {
+            return false;
+        }
+
+        if (!$this->entities->exists($user_guid)) {
+            return false;
+        }
+
+        $hook_params = [
+            'collection_id' => $collection->id,
+            'user_guid' => (int) $user_guid
+        ];
+
+        $result = $this->hooks->trigger('access:collections:add_user', 'collection', $hook_params, true);
+        if ($result == false) {
+            return false;
+        }
+
+        // if someone tries to insert the same data twice, we do a no-op on duplicate key
+        $query = "
 			INSERT INTO {$this->membership_table}
 				SET access_collection_id = :access_collection_id,
 				    user_guid = :user_guid
 				ON DUPLICATE KEY UPDATE user_guid = user_guid
 		";
 
-		$result = $this->db->insertData($query, [
-			':access_collection_id' => (int) $collection->id,
-			':user_guid' => (int) $user_guid,
-		]);
+        $result = $this->db->insertData($query, [
+            ':access_collection_id' => (int) $collection->id,
+            ':user_guid' => (int) $user_guid,
+        ]);
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 		
-		return $result !== false;
-	}
-
-	/**
-	 * Removes a user from an access collection.
-	 *
-	 * Triggers the 'access:collections:remove_user', 'collection' plugin hook.
-	 *
-	 * @param int $user_guid     GUID of the user
-	 * @param int $collection_id ID of the collection
-	 * @return bool
-	 */
-	public function removeUser($user_guid, $collection_id) {
-
-		$params = [
-			'collection_id' => (int) $collection_id,
-			'user_guid' => (int) $user_guid,
-		];
-
-		if (!$this->hooks->trigger('access:collections:remove_user', 'collection', $params, true)) {
-			return false;
-		}
-
-		$query = "
+        return $result !== false;
+    }
+
+    /**
+     * Removes a user from an access collection.
+     *
+     * Triggers the 'access:collections:remove_user', 'collection' plugin hook.
+     *
+     * @param int $user_guid     GUID of the user
+     * @param int $collection_id ID of the collection
+     * @return bool
+     */
+    public function removeUser($user_guid, $collection_id) {
+
+        $params = [
+            'collection_id' => (int) $collection_id,
+            'user_guid' => (int) $user_guid,
+        ];
+
+        if (!$this->hooks->trigger('access:collections:remove_user', 'collection', $params, true)) {
+            return false;
+        }
+
+        $query = "
 			DELETE FROM {$this->membership_table}
 			WHERE access_collection_id = :access_collection_id
 				AND user_guid = :user_guid
 		";
 
-		$this->access_cache->clear();
+        $this->access_cache->clear();
 
-		return (bool) $this->db->deleteData($query, [
-			':access_collection_id' => (int) $collection_id,
-			':user_guid' => (int) $user_guid,
-		]);
-	}
+        return (bool) $this->db->deleteData($query, [
+            ':access_collection_id' => (int) $collection_id,
+            ':user_guid' => (int) $user_guid,
+        ]);
+    }
 
-	/**
-	 * Returns access collections owned by the user
-	 *
-	 * @param int $owner_guid GUID of the owner
-	 * @return ElggAccessCollection[]|false
-	 */
-	public function getEntityCollections($owner_guid) {
+    /**
+     * Returns access collections owned by the user
+     *
+     * @param int $owner_guid GUID of the owner
+     * @return ElggAccessCollection[]|false
+     */
+    public function getEntityCollections($owner_guid) {
 
-		$callback = [$this, 'rowToElggAccessCollection'];
+        $callback = [$this, 'rowToElggAccessCollection'];
 
-		$query = "
+        $query = "
 			SELECT * FROM {$this->table}
 				WHERE owner_guid = :owner_guid
 				ORDER BY name ASC
 		";
 
-		$params = [
-			':owner_guid' => (int) $owner_guid,
-		];
+        $params = [
+            ':owner_guid' => (int) $owner_guid,
+        ];
 
-		return $this->db->getData($query, $callback, $params);
-	}
+        return $this->db->getData($query, $callback, $params);
+    }
 
-	/**
-	 * Get members of an access collection
-	 *
-	 * @param int   $collection_id The collection's ID
-	 * @param array $options       Ege* options
-	 * @return ElggEntity[]|false
-	 */
-	public function getMembers($collection_id, array $options = []) {
+    /**
+     * Get members of an access collection
+     *
+     * @param int   $collection_id The collection's ID
+     * @param array $options       Ege* options
+     * @return ElggEntity[]|false
+     */
+    public function getMembers($collection_id, array $options = []) {
 
-		$options['joins'][] = "JOIN {$this->membership_table} acm";
+        $options['joins'][] = "JOIN {$this->membership_table} acm";
 
-		$collection_id = (int) $collection_id;
-		$options['wheres'][] = "e.guid = acm.user_guid AND acm.access_collection_id = {$collection_id}";
+        $collection_id = (int) $collection_id;
+        $options['wheres'][] = "e.guid = acm.user_guid AND acm.access_collection_id = {$collection_id}";
 
-		return $this->entities->getEntities($options);
-	}
+        return $this->entities->getEntities($options);
+    }
 
-	/**
-	 * Return an array of collections that the entity is member of
-	 *
-	 * @param int $member_guid GUID of th member
-	 *
-	 * @return ElggAccessCollection[]|false
-	 */
-	public function getCollectionsByMember($member_guid) {
+    /**
+     * Return an array of collections that the entity is member of
+     *
+     * @param int $member_guid GUID of th member
+     *
+     * @return ElggAccessCollection[]|false
+     */
+    public function getCollectionsByMember($member_guid) {
 
-		$callback = [$this, 'rowToElggAccessCollection'];
+        $callback = [$this, 'rowToElggAccessCollection'];
 
-		$query = "
+        $query = "
 			SELECT ac.* FROM {$this->table} ac
 				JOIN {$this->membership_table} acm
 					ON ac.id = acm.access_collection_id
@@ -897,58 +897,58 @@ 
 				ORDER BY name ASC
 		";
 
-		return $this->db->getData($query, $callback, [
-			':member_guid' => (int) $member_guid,
-		]);
-	}
-
-	/**
-	 * Return the name of an ACCESS_* constant or an access collection,
-	 * but only if the logged in user owns the access collection or is an admin.
-	 * Ownership requirement prevents us from exposing names of access collections
-	 * that current user has been added to by other members and may contain
-	 * sensitive classification of the current user (e.g. close friends vs acquaintances).
-	 *
-	 * Returns a string in the language of the user for global access levels, e.g.'Public, 'Friends', 'Logged in', 'Private';
-	 * or a name of the owned access collection, e.g. 'My work colleagues';
-	 * or a name of the group or other access collection, e.g. 'Group: Elgg technical support';
-	 * or 'Limited' if the user access is restricted to read-only, e.g. a friends collection the user was added to
-	 *
-	 * @param int $entity_access_id The entity's access id
-	 *
-	 * @return string
-	 * @since 1.11
-	 */
-	public function getReadableAccessLevel($entity_access_id) {
-		$access = (int) $entity_access_id;
-
-		$translator = $this->translator;
-
-		// Check if entity access id is a defined global constant
-		$access_array = [
-			ACCESS_PRIVATE => $translator->translate("PRIVATE"),
-			ACCESS_FRIENDS => $translator->translate("access:friends:label"),
-			ACCESS_LOGGED_IN => $translator->translate("LOGGED_IN"),
-			ACCESS_PUBLIC => $translator->translate("PUBLIC"),
-		];
-
-		if (array_key_exists($access, $access_array)) {
-			return $access_array[$access];
-		}
-
-		// Entity access id is probably a custom access collection
-		// Check if the user has write access to it and can see it's label
-		// Admins should always be able to see the readable version
-		$collection = $this->get($access);
-
-		$user_guid = $this->session->getLoggedInUserGuid();
+        return $this->db->getData($query, $callback, [
+            ':member_guid' => (int) $member_guid,
+        ]);
+    }
+
+    /**
+     * Return the name of an ACCESS_* constant or an access collection,
+     * but only if the logged in user owns the access collection or is an admin.
+     * Ownership requirement prevents us from exposing names of access collections
+     * that current user has been added to by other members and may contain
+     * sensitive classification of the current user (e.g. close friends vs acquaintances).
+     *
+     * Returns a string in the language of the user for global access levels, e.g.'Public, 'Friends', 'Logged in', 'Private';
+     * or a name of the owned access collection, e.g. 'My work colleagues';
+     * or a name of the group or other access collection, e.g. 'Group: Elgg technical support';
+     * or 'Limited' if the user access is restricted to read-only, e.g. a friends collection the user was added to
+     *
+     * @param int $entity_access_id The entity's access id
+     *
+     * @return string
+     * @since 1.11
+     */
+    public function getReadableAccessLevel($entity_access_id) {
+        $access = (int) $entity_access_id;
+
+        $translator = $this->translator;
+
+        // Check if entity access id is a defined global constant
+        $access_array = [
+            ACCESS_PRIVATE => $translator->translate("PRIVATE"),
+            ACCESS_FRIENDS => $translator->translate("access:friends:label"),
+            ACCESS_LOGGED_IN => $translator->translate("LOGGED_IN"),
+            ACCESS_PUBLIC => $translator->translate("PUBLIC"),
+        ];
+
+        if (array_key_exists($access, $access_array)) {
+            return $access_array[$access];
+        }
+
+        // Entity access id is probably a custom access collection
+        // Check if the user has write access to it and can see it's label
+        // Admins should always be able to see the readable version
+        $collection = $this->get($access);
+
+        $user_guid = $this->session->getLoggedInUserGuid();
 		
-		if (!$collection || !$user_guid) {
-			// return 'Limited' if there is no logged in user or collection can not be loaded
-			return $translator->translate('access:limited:label');
-		}
+        if (!$collection || !$user_guid) {
+            // return 'Limited' if there is no logged in user or collection can not be loaded
+            return $translator->translate('access:limited:label');
+        }
 
-		return $collection->getDisplayName();
-	}
+        return $collection->getDisplayName();
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -140,7 +140,7 @@ 
 		$list = "($access_ids)";
 
 		// for BC, populate the cache
-		$hash = $user_guid . 'get_access_list';
+		$hash = $user_guid.'get_access_list';
 		$this->access_cache->add($hash, $list);
 
 		return $list;
@@ -183,7 +183,7 @@ 
 
 		$user_guid = (int) $user_guid;
 
-		$hash = $user_guid . 'get_access_array';
+		$hash = $user_guid.'get_access_array';
 
 		if ($cache[$hash]) {
 			$access_array = $cache[$hash];
@@ -305,7 +305,7 @@ 
 		$options['user_guid'] = sanitize_int($options['user_guid'], false);
 
 		// only add dot if we have an alias or table name
-		$table_alias = $options['table_alias'] ? $options['table_alias'] . '.' : '';
+		$table_alias = $options['table_alias'] ? $options['table_alias'].'.' : '';
 
 		if (!isset($options['ignore_access'])) {
 			$options['ignore_access'] = $this->capabilities->canBypassPermissionsCheck($options['user_guid']);
@@ -322,7 +322,7 @@ 
 			$clauses['ors']['ignore_access'] = '1 = 1';
 		} else if ($options['user_guid']) {
 			// include content of user's friends
-			$clauses['ors']['friends_access'] = "$table_alias{$options['access_column']} = " . ACCESS_FRIENDS . "
+			$clauses['ors']['friends_access'] = "$table_alias{$options['access_column']} = ".ACCESS_FRIENDS."
 				AND $table_alias{$options['owner_guid_column']} IN (
 					SELECT guid_one FROM {$prefix}entity_relationships
 					WHERE relationship = 'friend' AND guid_two = {$options['user_guid']}
@@ -346,14 +346,14 @@ 
 
 		$clauses_str = '';
 		if (is_array($clauses['ors']) && $clauses['ors']) {
-			$clauses_str = '(' . implode(' OR ', $clauses['ors']) . ')';
+			$clauses_str = '('.implode(' OR ', $clauses['ors']).')';
 		}
 
 		if (is_array($clauses['ands']) && $clauses['ands']) {
 			if ($clauses_str) {
 				$clauses_str .= ' AND ';
 			}
-			$clauses_str .= '(' . implode(' AND ', $clauses['ands']) . ')';
+			$clauses_str .= '('.implode(' AND ', $clauses['ands']).')';
 		}
 
 		if (empty($clauses_str)) {
@@ -452,7 +452,7 @@ 
 
 		$user_guid = (int) $user_guid;
 
-		$hash = $user_guid . 'get_write_access_array';
+		$hash = $user_guid.'get_write_access_array';
 
 		if ($cache[$hash]) {
 			$access_array = $cache[$hash];

mod/friends/start.php

Indentation +170 added lines, -170 removed lines

@@ -1,19 +1,19 @@ 
 <?php
 
 function elgg_friends_plugin_init() {
-	elgg_register_plugin_hook_handler('access:collections:write', 'user', '_elgg_friends_write_access', 1);
-	elgg_register_plugin_hook_handler('filter_tabs', 'all', '_elgg_friends_filter_tabs', 1);
+    elgg_register_plugin_hook_handler('access:collections:write', 'user', '_elgg_friends_write_access', 1);
+    elgg_register_plugin_hook_handler('filter_tabs', 'all', '_elgg_friends_filter_tabs', 1);
 
-	elgg_register_event_handler('create', 'relationship', '_elgg_send_friend_notification');
+    elgg_register_event_handler('create', 'relationship', '_elgg_send_friend_notification');
 
-	elgg_register_page_handler('friends', '_elgg_friends_page_handler');
-	elgg_register_page_handler('friendsof', '_elgg_friends_page_handler');
+    elgg_register_page_handler('friends', '_elgg_friends_page_handler');
+    elgg_register_page_handler('friendsof', '_elgg_friends_page_handler');
 
-	elgg_register_plugin_hook_handler('entity:url', 'object', '_elgg_friends_widget_urls');
+    elgg_register_plugin_hook_handler('entity:url', 'object', '_elgg_friends_widget_urls');
 	
-	elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_friends_page_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:topbar', '_elgg_friends_topbar_menu');
-	elgg_register_plugin_hook_handler('register', 'menu:user_hover', '_elgg_friends_setup_user_hover_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:page', '_elgg_friends_page_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:topbar', '_elgg_friends_topbar_menu');
+    elgg_register_plugin_hook_handler('register', 'menu:user_hover', '_elgg_friends_setup_user_hover_menu');
 }
 
 elgg_register_event_handler('init', 'system', 'elgg_friends_plugin_init');
@@ -24,37 +24,37 @@ 
  * @access private
  */
 function _elgg_friends_setup_user_hover_menu($hook, $type, $return, $params) {
-	$user = $params['entity'];
-	/* @var \ElggUser $user */
-
-	if (elgg_is_logged_in()) {
-		if (elgg_get_logged_in_user_guid() != $user->guid) {
-			$isFriend = $user->isFriend();
-
-			// Always emit both to make it super easy to toggle with ajax
-			$return[] = \ElggMenuItem::factory([
-				'name' => 'remove_friend',
-				'href' => "action/friends/remove?friend={$user->guid}",
-				'is_action' => true,
-				'text' => elgg_echo('friend:remove'),
-				'icon' => 'user-times',
-				'section' => 'action',
-				'item_class' => $isFriend ? '' : 'hidden',
-			]);
-
-			$return[] = \ElggMenuItem::factory([
-				'name' => 'add_friend',
-				'href' => "action/friends/add?friend={$user->guid}",
-				'is_action' => true,
-				'text' => elgg_echo('friend:add'),
-				'icon' => 'user-plus',
-				'section' => 'action',
-				'item_class' => $isFriend ? 'hidden' : '',
-			]);
-		}
-	}
-
-	return $return;
+    $user = $params['entity'];
+    /* @var \ElggUser $user */
+
+    if (elgg_is_logged_in()) {
+        if (elgg_get_logged_in_user_guid() != $user->guid) {
+            $isFriend = $user->isFriend();
+
+            // Always emit both to make it super easy to toggle with ajax
+            $return[] = \ElggMenuItem::factory([
+                'name' => 'remove_friend',
+                'href' => "action/friends/remove?friend={$user->guid}",
+                'is_action' => true,
+                'text' => elgg_echo('friend:remove'),
+                'icon' => 'user-times',
+                'section' => 'action',
+                'item_class' => $isFriend ? '' : 'hidden',
+            ]);
+
+            $return[] = \ElggMenuItem::factory([
+                'name' => 'add_friend',
+                'href' => "action/friends/add?friend={$user->guid}",
+                'is_action' => true,
+                'text' => elgg_echo('friend:add'),
+                'icon' => 'user-plus',
+                'section' => 'action',
+                'item_class' => $isFriend ? 'hidden' : '',
+            ]);
+        }
+    }
+
+    return $return;
 }
 
 /**
@@ -67,27 +67,27 @@ 
  * @access private
  */
 function _elgg_friends_page_handler($segments, $handler) {
-	elgg_set_context('friends'); // needed because pagehandler friendsof is also using this handler
-
-	if (isset($segments[0]) && $user = get_user_by_username($segments[0])) {
-		elgg_set_page_owner_guid($user->getGUID());
-	}
-
-	if (!elgg_get_page_owner_guid()) {
-		return false;
-	}
-
-	switch ($handler) {
-		case 'friends':
-			echo elgg_view_resource("friends/index");
-			break;
-		case 'friendsof':
-			echo elgg_view_resource("friends/of");
-			break;
-		default:
-			return false;
-	}
-	return true;
+    elgg_set_context('friends'); // needed because pagehandler friendsof is also using this handler
+
+    if (isset($segments[0]) && $user = get_user_by_username($segments[0])) {
+        elgg_set_page_owner_guid($user->getGUID());
+    }
+
+    if (!elgg_get_page_owner_guid()) {
+        return false;
+    }
+
+    switch ($handler) {
+        case 'friends':
+            echo elgg_view_resource("friends/index");
+            break;
+        case 'friendsof':
+            echo elgg_view_resource("friends/of");
+            break;
+        default:
+            return false;
+    }
+    return true;
 }
 
 /**
@@ -105,21 +105,21 @@ 
  */
 function _elgg_friends_topbar_menu($hook, $type, $return, $params) {
 
-	$viewer = elgg_get_logged_in_user_entity();
-	if (!$viewer) {
-		return;
-	}
+    $viewer = elgg_get_logged_in_user_entity();
+    if (!$viewer) {
+        return;
+    }
 		
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'friends',
-		'href' => "friends/{$viewer->username}",
-		'text' => elgg_echo('friends'),
-		'icon' => 'users',
-		'title' => elgg_echo('friends'),
-		'priority' => 300,
-	]);
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'friends',
+        'href' => "friends/{$viewer->username}",
+        'text' => elgg_echo('friends'),
+        'icon' => 'users',
+        'title' => elgg_echo('friends'),
+        'priority' => 300,
+    ]);
 	
-	return $return;
+    return $return;
 }
 
 /**
@@ -137,26 +137,26 @@ 
  */
 function _elgg_friends_page_menu($hook, $type, $return, $params) {
 
-	$owner = elgg_get_page_owner_entity();
-	if (!$owner instanceof ElggUser) {
-		return;
-	}
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'friends',
-		'text' => elgg_echo('friends'),
-		'href' => 'friends/' . $owner->username,
-		'contexts' => ['friends'],
-	]);
-
-	$return[] = \ElggMenuItem::factory([
-		'name' => 'friends:of',
-		'text' => elgg_echo('friends:of'),
-		'href' => 'friendsof/' . $owner->username,
-		'contexts' => ['friends'],
-	]);
-
-	return $return;
+    $owner = elgg_get_page_owner_entity();
+    if (!$owner instanceof ElggUser) {
+        return;
+    }
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'friends',
+        'text' => elgg_echo('friends'),
+        'href' => 'friends/' . $owner->username,
+        'contexts' => ['friends'],
+    ]);
+
+    $return[] = \ElggMenuItem::factory([
+        'name' => 'friends:of',
+        'text' => elgg_echo('friends:of'),
+        'href' => 'friendsof/' . $owner->username,
+        'contexts' => ['friends'],
+    ]);
+
+    return $return;
 }
 
 /**
@@ -170,40 +170,40 @@ 
  * @access private
  */
 function _elgg_send_friend_notification($event, $type, $object) {
-	if ($object->relationship != 'friend') {
-		return true;
-	}
-
-	$user_one = get_entity($object->guid_one);
-	/* @var \ElggUser $user_one */
-
-	$user_two = get_entity($object->guid_two);
-	/* @var ElggUser $user_two */
-
-	if (!$user_one instanceof ElggUser || !$user_two instanceof ElggUser) {
-		return;
-	}
-
-	// Notification subject
-	$subject = elgg_echo('friend:newfriend:subject', [
-		$user_one->name
-	], $user_two->language);
-
-	// Notification body
-	$body = elgg_echo("friend:newfriend:body", [
-		$user_one->name,
-		$user_one->getURL()
-	], $user_two->language);
-
-	// Notification params
-	$params = [
-		'action' => 'add_friend',
-		'object' => $user_one,
-		'friend' => $user_two,
-		'url' => $user_two->getURL(),
-	];
-
-	return notify_user($user_two->guid, $object->guid_one, $subject, $body, $params);
+    if ($object->relationship != 'friend') {
+        return true;
+    }
+
+    $user_one = get_entity($object->guid_one);
+    /* @var \ElggUser $user_one */
+
+    $user_two = get_entity($object->guid_two);
+    /* @var ElggUser $user_two */
+
+    if (!$user_one instanceof ElggUser || !$user_two instanceof ElggUser) {
+        return;
+    }
+
+    // Notification subject
+    $subject = elgg_echo('friend:newfriend:subject', [
+        $user_one->name
+    ], $user_two->language);
+
+    // Notification body
+    $body = elgg_echo("friend:newfriend:body", [
+        $user_one->name,
+        $user_one->getURL()
+    ], $user_two->language);
+
+    // Notification params
+    $params = [
+        'action' => 'add_friend',
+        'object' => $user_one,
+        'friend' => $user_two,
+        'url' => $user_two->getURL(),
+    ];
+
+    return notify_user($user_two->guid, $object->guid_one, $subject, $body, $params);
 }
 
 /**
@@ -218,24 +218,24 @@ 
  */
 function _elgg_friends_write_access($hook, $type, $access_array, $params) {
 
-	// rebuild array, putting friends 1st or 2nd
-	$ret = [];
+    // rebuild array, putting friends 1st or 2nd
+    $ret = [];
 
-	// private exists, it goes first
-	if (isset($access_array[ACCESS_PRIVATE])) {
-		$ret[ACCESS_PRIVATE] = $access_array[ACCESS_PRIVATE];
-		unset($access_array[ACCESS_PRIVATE]);
-	}
+    // private exists, it goes first
+    if (isset($access_array[ACCESS_PRIVATE])) {
+        $ret[ACCESS_PRIVATE] = $access_array[ACCESS_PRIVATE];
+        unset($access_array[ACCESS_PRIVATE]);
+    }
 
-	// friends
-	$ret[ACCESS_FRIENDS] = get_readable_access_level(ACCESS_FRIENDS);
+    // friends
+    $ret[ACCESS_FRIENDS] = get_readable_access_level(ACCESS_FRIENDS);
 
-	// rest
-	foreach ($access_array as $key => $value) {
-		$ret[$key] = $value;
-	}
+    // rest
+    foreach ($access_array as $key => $value) {
+        $ret[$key] = $value;
+    }
 
-	return $ret;
+    return $ret;
 }
 
 /**
@@ -250,22 +250,22 @@ 
  */
 function _elgg_friends_filter_tabs($hook, $type, $items, $params) {
 
-	$user = elgg_extract('user', $params);
-	if (!$user instanceof ElggUser) {
-		return;
-	}
-
-	$vars = elgg_extract('vars', $params);
-	$selected = elgg_extract('selected', $params);
-
-	$items[] = ElggMenuItem::factory([
-		'name' => 'friend',
-		'text' => elgg_echo('friends'),
-		'href' => (isset($vars['friend_link'])) ? $vars['friend_link'] : "$type/friends/{$user->username}",
-		'selected' => ($selected == 'friends'),
-		'priority' => 400,
-	]);
-	return $items;
+    $user = elgg_extract('user', $params);
+    if (!$user instanceof ElggUser) {
+        return;
+    }
+
+    $vars = elgg_extract('vars', $params);
+    $selected = elgg_extract('selected', $params);
+
+    $items[] = ElggMenuItem::factory([
+        'name' => 'friend',
+        'text' => elgg_echo('friends'),
+        'href' => (isset($vars['friend_link'])) ? $vars['friend_link'] : "$type/friends/{$user->username}",
+        'selected' => ($selected == 'friends'),
+        'priority' => 400,
+    ]);
+    return $items;
 }
 
 
@@ -280,19 +280,19 @@ 
  * @access private
  */
 function _elgg_friends_widget_urls($hook, $type, $result, $params) {
-	$widget = elgg_extract('entity', $params);
-	if (!($widget instanceof \ElggWidget)) {
-		return;
-	}
+    $widget = elgg_extract('entity', $params);
+    if (!($widget instanceof \ElggWidget)) {
+        return;
+    }
 	
-	if ($widget->handler !== 'friends') {
-		return;
-	}
+    if ($widget->handler !== 'friends') {
+        return;
+    }
 	
-	$owner = $widget->getOwnerEntity();
-	if (!($owner instanceof \ElggUser)) {
-		return;
-	}
+    $owner = $widget->getOwnerEntity();
+    if (!($owner instanceof \ElggUser)) {
+        return;
+    }
 			
-	return "friends/{$owner->username}";
+    return "friends/{$owner->username}";
 }