Elgg / Elgg

engine/lib/pam.php

Indentation +13 added lines, -13 removed lines

@@ -37,22 +37,22 @@ 
  * @return bool
  */
 function register_pam_handler($handler, $importance = "sufficient", $policy = "user") {
-	// setup array for this type of pam if not already set
-	if (!isset(\ElggPAM::$_handlers[$policy])) {
-		\ElggPAM::$_handlers[$policy] = [];
-	}
+    // setup array for this type of pam if not already set
+    if (!isset(\ElggPAM::$_handlers[$policy])) {
+        \ElggPAM::$_handlers[$policy] = [];
+    }
 
-	// @todo remove requirement that $handle be a global function
-	if (is_string($handler) && is_callable($handler, true)) {
-		\ElggPAM::$_handlers[$policy][$handler] = new \stdClass;
+    // @todo remove requirement that $handle be a global function
+    if (is_string($handler) && is_callable($handler, true)) {
+        \ElggPAM::$_handlers[$policy][$handler] = new \stdClass;
 
-		\ElggPAM::$_handlers[$policy][$handler]->handler = $handler;
-		\ElggPAM::$_handlers[$policy][$handler]->importance = strtolower($importance);
+        \ElggPAM::$_handlers[$policy][$handler]->handler = $handler;
+        \ElggPAM::$_handlers[$policy][$handler]->importance = strtolower($importance);
 
-		return true;
-	}
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 /**
@@ -65,5 +65,5 @@ 
  * @since 1.7.0
  */
 function unregister_pam_handler($handler, $policy = "user") {
-	unset(\ElggPAM::$_handlers[$policy][$handler]);
+    unset(\ElggPAM::$_handlers[$policy][$handler]);
 }

engine/classes/ElggPAM.php

Indentation +90 added lines, -90 removed lines

@@ -5,105 +5,105 @@
  */
 class ElggPAM {
 
-	/**
-	 * @var array
-	 * @access private
-	 * @todo move state into a PAM service
-	 */
-	public static $_handlers = [];
+    /**
+     * @var array
+     * @access private
+     * @todo move state into a PAM service
+     */
+    public static $_handlers = [];
 
-	/**
-	 * @var string PAM policy type: user, api or plugin-defined policies
-	 */
-	protected $policy;
+    /**
+     * @var string PAM policy type: user, api or plugin-defined policies
+     */
+    protected $policy;
 
-	/**
-	 * @var array Failure mesages
-	 */
-	protected $messages;
+    /**
+     * @var array Failure mesages
+     */
+    protected $messages;
 
-	/**
-	 * \ElggPAM constructor
-	 *
-	 * @param string $policy PAM policy type: user, api, or plugin-defined policies
-	 */
-	public function __construct($policy) {
-		$this->policy = $policy;
-		$this->messages = ['sufficient' => [], 'required' => []];
-	}
+    /**
+     * \ElggPAM constructor
+     *
+     * @param string $policy PAM policy type: user, api, or plugin-defined policies
+     */
+    public function __construct($policy) {
+        $this->policy = $policy;
+        $this->messages = ['sufficient' => [], 'required' => []];
+    }
 
-	/**
-	 * Authenticate a set of credentials against a policy
-	 * This function will process all registered PAM handlers or stop when the first
-	 * handler fails. A handler fails by either returning false or throwing an
-	 * exception. The advantage of throwing an exception is that it returns a message
-	 * that can be passed to the user. The processing order of the handlers is
-	 * determined by the order that they were registered.
-	 *
-	 * If $credentials are provided, the PAM handler should authenticate using the
-	 * provided credentials. If not, then credentials should be prompted for or
-	 * otherwise retrieved (eg from the HTTP header or $_SESSION).
-	 *
-	 * @param array $credentials Credentials array dependant on policy type
-	 * @return bool
-	 */
-	public function authenticate($credentials = []) {
-		if (!isset(self::$_handlers[$this->policy]) ||
-			!is_array(self::$_handlers[$this->policy])) {
-			return false;
-		}
+    /**
+     * Authenticate a set of credentials against a policy
+     * This function will process all registered PAM handlers or stop when the first
+     * handler fails. A handler fails by either returning false or throwing an
+     * exception. The advantage of throwing an exception is that it returns a message
+     * that can be passed to the user. The processing order of the handlers is
+     * determined by the order that they were registered.
+     *
+     * If $credentials are provided, the PAM handler should authenticate using the
+     * provided credentials. If not, then credentials should be prompted for or
+     * otherwise retrieved (eg from the HTTP header or $_SESSION).
+     *
+     * @param array $credentials Credentials array dependant on policy type
+     * @return bool
+     */
+    public function authenticate($credentials = []) {
+        if (!isset(self::$_handlers[$this->policy]) ||
+            !is_array(self::$_handlers[$this->policy])) {
+            return false;
+        }
 
-		$authenticated = false;
+        $authenticated = false;
 
-		foreach (self::$_handlers[$this->policy] as $v) {
-			$handler = $v->handler;
-			if (!is_callable($handler)) {
-				continue;
-			}
-			/* @var callable $handler */
+        foreach (self::$_handlers[$this->policy] as $v) {
+            $handler = $v->handler;
+            if (!is_callable($handler)) {
+                continue;
+            }
+            /* @var callable $handler */
 
-			$importance = $v->importance;
+            $importance = $v->importance;
 
-			try {
-				// Execute the handler
-				// @todo don't assume $handler is a global function
-				$result = call_user_func($handler, $credentials);
-				if ($result) {
-					$authenticated = true;
-				} elseif ($result === false) {
-					if ($importance == 'required') {
-						$this->messages['required'][] = "$handler:failed";
-						return false;
-					} else {
-						$this->messages['sufficient'][] = "$handler:failed";
-					}
-				}
-			} catch (Exception $e) {
-				if ($importance == 'required') {
-					$this->messages['required'][] = $e->getMessage();
-					return false;
-				} else {
-					$this->messages['sufficient'][] = $e->getMessage();
-				}
-			}
-		}
+            try {
+                // Execute the handler
+                // @todo don't assume $handler is a global function
+                $result = call_user_func($handler, $credentials);
+                if ($result) {
+                    $authenticated = true;
+                } elseif ($result === false) {
+                    if ($importance == 'required') {
+                        $this->messages['required'][] = "$handler:failed";
+                        return false;
+                    } else {
+                        $this->messages['sufficient'][] = "$handler:failed";
+                    }
+                }
+            } catch (Exception $e) {
+                if ($importance == 'required') {
+                    $this->messages['required'][] = $e->getMessage();
+                    return false;
+                } else {
+                    $this->messages['sufficient'][] = $e->getMessage();
+                }
+            }
+        }
 
-		return $authenticated;
-	}
+        return $authenticated;
+    }
 
-	/**
-	 * Get a failure message to display to user
-	 *
-	 * @return string
-	 */
-	public function getFailureMessage() {
-		$message = _elgg_services()->translator->translate('auth:nopams');
-		if (!empty($this->messages['required'])) {
-			$message = $this->messages['required'][0];
-		} elseif (!empty($this->messages['sufficient'])) {
-			$message = $this->messages['sufficient'][0];
-		}
+    /**
+     * Get a failure message to display to user
+     *
+     * @return string
+     */
+    public function getFailureMessage() {
+        $message = _elgg_services()->translator->translate('auth:nopams');
+        if (!empty($this->messages['required'])) {
+            $message = $this->messages['required'][0];
+        } elseif (!empty($this->messages['sufficient'])) {
+            $message = $this->messages['sufficient'][0];
+        }
 
-		return _elgg_services()->hooks->trigger('fail', 'auth', $this->messages, $message);
-	}
+        return _elgg_services()->hooks->trigger('fail', 'auth', $this->messages, $message);
+    }
 }

engine/classes/Elgg/Assets/ExternalFiles.php

Indentation +227 added lines, -227 removed lines

@@ -11,231 +11,231 @@
  */
 class ExternalFiles {
 
-	/**
-	 * @var ElggPriorityList[]
-	 */
-	protected $externals = [];
-
-	/**
-	 * @var array
-	 */
-	protected $externals_map = [];
-
-	/**
-	 * Core registration function for external files
-	 *
-	 * @param string $type     Type of external resource (js or css)
-	 * @param string $name     Identifier used as key
-	 * @param string $url      URL
-	 * @param string $location Location in the page to include the file
-	 * @param int    $priority Loading priority of the file
-	 *
-	 * @return bool
-	 */
-	public function register($type, $name, $url, $location, $priority = 500) {
-		if (empty($name) || empty($url)) {
-			return false;
-		}
-	
-		$url = elgg_normalize_url($url);
-
-		$this->setupType($type);
-	
-		$name = trim(strtolower($name));
-	
-		// normalize bogus priorities, but allow empty, null, and false to be defaults.
-		if (!is_numeric($priority)) {
-			$priority = 500;
-		}
-	
-		// no negative priorities right now.
-		$priority = max((int) $priority, 0);
-	
-		$item = elgg_extract($name, $this->externals_map[$type]);
-	
-		if ($item) {
-			// updating a registered item
-			// don't update loaded because it could already be set
-			$item->url = $url;
-			$item->location = $location;
-	
-			// if loaded before registered, that means it hasn't been added to the list yet
-			if ($this->externals[$type]->contains($item)) {
-				$priority = $this->externals[$type]->move($item, $priority);
-			} else {
-				$priority = $this->externals[$type]->add($item, $priority);
-			}
-		} else {
-			$item = (object) [
-				'loaded' => false,
-				'url' => $url,
-				'location' => $location,
-			];
-			$priority = $this->externals[$type]->add($item, $priority);
-		}
-
-		$this->externals_map[$type][$name] = $item;
-	
-		return $priority !== false;
-	}
-	
-	/**
-	 * Unregister an external file
-	 *
-	 * @param string $type Type of file: js or css
-	 * @param string $name The identifier of the file
-	 *
-	 * @return bool
-	 */
-	public function unregister($type, $name) {
-		$this->setupType($type);
-	
-		$name = trim(strtolower($name));
-		$item = elgg_extract($name, $this->externals_map[$type]);
-	
-		if ($item) {
-			unset($this->externals_map[$type][$name]);
-			return $this->externals[$type]->remove($item);
-		}
-	
-		return false;
-	}
-
-	/**
-	 * Get metadata for a registered file
-	 *
-	 * @param string $type
-	 * @param string $name
-	 *
-	 * @return \stdClass|null
-	 */
-	public function getFile($type, $name) {
-		$this->setupType($type);
-
-		$name = trim(strtolower($name));
-		if (!isset($this->externals_map[$type][$name])) {
-			return null;
-		}
-
-		$item = $this->externals_map[$type][$name];
-		$priority = $this->externals[$type]->getPriority($item);
-
-		// don't allow internal properties to be altered
-		$clone = clone $item;
-		$clone->priority = $priority;
-
-		return $clone;
-	}
-	
-	/**
-	 * Load an external resource for use on this page
-	 *
-	 * @param string $type Type of file: js or css
-	 * @param string $name The identifier for the file
-	 *
-	 * @return void
-	 */
-	public function load($type, $name) {
-		$this->setupType($type);
-	
-		$name = trim(strtolower($name));
-	
-		$item = elgg_extract($name, $this->externals_map[$type]);
-	
-		if ($item) {
-			// update a registered item
-			$item->loaded = true;
-		} else {
-			$item = (object) [
-				'loaded' => true,
-				'url' => '',
-				'location' => '',
-			];
-			if (elgg_view_exists($name)) {
-				$item->url = elgg_get_simplecache_url($name);
-				$item->location = ($type == 'js') ? 'foot' : 'head';
-			}
-
-			$this->externals[$type]->add($item);
-			$this->externals_map[$type][$name] = $item;
-		}
-	}
-	
-	/**
-	 * Get external resource descriptors
-	 *
-	 * @param string $type     Type of file: js or css
-	 * @param string $location Page location
-	 *
-	 * @return string[] URLs of files to load
-	 */
-	public function getLoadedFiles($type, $location) {
-		if (!isset($this->externals[$type])) {
-			return [];
-		}
-
-		$items = $this->externals[$type]->getElements();
-
-		$items = array_filter($items, function($v) use ($location) {
-			return $v->loaded == true && $v->location == $location;
-		});
-		if ($items) {
-			array_walk($items, function(&$v, $k){
-				$v = $v->url;
-			});
-		}
-		return $items;
-	}
-
-	/**
-	 * Get registered file objects
-	 *
-	 * @param string $type     Type of file: js or css
-	 * @param string $location Page location
-	 *
-	 * @return \stdClass[]
-	 */
-	public function getRegisteredFiles($type, $location) {
-		if (!isset($this->externals[$type])) {
-			return [];
-		}
-
-		$ret = [];
-		$items = $this->externals[$type]->getElements();
-		$items = array_filter($items, function($v) use ($location) {
-			return ($v->location == $location);
-		});
-
-		foreach ($items as $item) {
-			$ret[] = clone $item;
-		}
-
-		return $ret;
-	}
-
-	/**
-	 * Unregister all files
-	 *
-	 * @return void
-	 */
-	public function reset() {
-		$this->externals = [];
-		$this->externals_map = [];
-	}
-	
-	/**
-	 * Bootstraps the externals data structure
-	 *
-	 * @param string $type The type of external, js or css.
-	 * @return void
-	 */
-	protected function setupType($type) {
-		if (!isset($this->externals[$type])) {
-			$this->externals[$type] = new \ElggPriorityList();
-		}
-	
-		if (!isset($this->externals_map[$type])) {
-			$this->externals_map[$type] = [];
-		}
-	}
+    /**
+     * @var ElggPriorityList[]
+     */
+    protected $externals = [];
+
+    /**
+     * @var array
+     */
+    protected $externals_map = [];
+
+    /**
+     * Core registration function for external files
+     *
+     * @param string $type     Type of external resource (js or css)
+     * @param string $name     Identifier used as key
+     * @param string $url      URL
+     * @param string $location Location in the page to include the file
+     * @param int    $priority Loading priority of the file
+     *
+     * @return bool
+     */
+    public function register($type, $name, $url, $location, $priority = 500) {
+        if (empty($name) || empty($url)) {
+            return false;
+        }
+	
+        $url = elgg_normalize_url($url);
+
+        $this->setupType($type);
+	
+        $name = trim(strtolower($name));
+	
+        // normalize bogus priorities, but allow empty, null, and false to be defaults.
+        if (!is_numeric($priority)) {
+            $priority = 500;
+        }
+	
+        // no negative priorities right now.
+        $priority = max((int) $priority, 0);
+	
+        $item = elgg_extract($name, $this->externals_map[$type]);
+	
+        if ($item) {
+            // updating a registered item
+            // don't update loaded because it could already be set
+            $item->url = $url;
+            $item->location = $location;
+	
+            // if loaded before registered, that means it hasn't been added to the list yet
+            if ($this->externals[$type]->contains($item)) {
+                $priority = $this->externals[$type]->move($item, $priority);
+            } else {
+                $priority = $this->externals[$type]->add($item, $priority);
+            }
+        } else {
+            $item = (object) [
+                'loaded' => false,
+                'url' => $url,
+                'location' => $location,
+            ];
+            $priority = $this->externals[$type]->add($item, $priority);
+        }
+
+        $this->externals_map[$type][$name] = $item;
+	
+        return $priority !== false;
+    }
+	
+    /**
+     * Unregister an external file
+     *
+     * @param string $type Type of file: js or css
+     * @param string $name The identifier of the file
+     *
+     * @return bool
+     */
+    public function unregister($type, $name) {
+        $this->setupType($type);
+	
+        $name = trim(strtolower($name));
+        $item = elgg_extract($name, $this->externals_map[$type]);
+	
+        if ($item) {
+            unset($this->externals_map[$type][$name]);
+            return $this->externals[$type]->remove($item);
+        }
+	
+        return false;
+    }
+
+    /**
+     * Get metadata for a registered file
+     *
+     * @param string $type
+     * @param string $name
+     *
+     * @return \stdClass|null
+     */
+    public function getFile($type, $name) {
+        $this->setupType($type);
+
+        $name = trim(strtolower($name));
+        if (!isset($this->externals_map[$type][$name])) {
+            return null;
+        }
+
+        $item = $this->externals_map[$type][$name];
+        $priority = $this->externals[$type]->getPriority($item);
+
+        // don't allow internal properties to be altered
+        $clone = clone $item;
+        $clone->priority = $priority;
+
+        return $clone;
+    }
+	
+    /**
+     * Load an external resource for use on this page
+     *
+     * @param string $type Type of file: js or css
+     * @param string $name The identifier for the file
+     *
+     * @return void
+     */
+    public function load($type, $name) {
+        $this->setupType($type);
+	
+        $name = trim(strtolower($name));
+	
+        $item = elgg_extract($name, $this->externals_map[$type]);
+	
+        if ($item) {
+            // update a registered item
+            $item->loaded = true;
+        } else {
+            $item = (object) [
+                'loaded' => true,
+                'url' => '',
+                'location' => '',
+            ];
+            if (elgg_view_exists($name)) {
+                $item->url = elgg_get_simplecache_url($name);
+                $item->location = ($type == 'js') ? 'foot' : 'head';
+            }
+
+            $this->externals[$type]->add($item);
+            $this->externals_map[$type][$name] = $item;
+        }
+    }
+	
+    /**
+     * Get external resource descriptors
+     *
+     * @param string $type     Type of file: js or css
+     * @param string $location Page location
+     *
+     * @return string[] URLs of files to load
+     */
+    public function getLoadedFiles($type, $location) {
+        if (!isset($this->externals[$type])) {
+            return [];
+        }
+
+        $items = $this->externals[$type]->getElements();
+
+        $items = array_filter($items, function($v) use ($location) {
+            return $v->loaded == true && $v->location == $location;
+        });
+        if ($items) {
+            array_walk($items, function(&$v, $k){
+                $v = $v->url;
+            });
+        }
+        return $items;
+    }
+
+    /**
+     * Get registered file objects
+     *
+     * @param string $type     Type of file: js or css
+     * @param string $location Page location
+     *
+     * @return \stdClass[]
+     */
+    public function getRegisteredFiles($type, $location) {
+        if (!isset($this->externals[$type])) {
+            return [];
+        }
+
+        $ret = [];
+        $items = $this->externals[$type]->getElements();
+        $items = array_filter($items, function($v) use ($location) {
+            return ($v->location == $location);
+        });
+
+        foreach ($items as $item) {
+            $ret[] = clone $item;
+        }
+
+        return $ret;
+    }
+
+    /**
+     * Unregister all files
+     *
+     * @return void
+     */
+    public function reset() {
+        $this->externals = [];
+        $this->externals_map = [];
+    }
+	
+    /**
+     * Bootstraps the externals data structure
+     *
+     * @param string $type The type of external, js or css.
+     * @return void
+     */
+    protected function setupType($type) {
+        if (!isset($this->externals[$type])) {
+            $this->externals[$type] = new \ElggPriorityList();
+        }
+	
+        if (!isset($this->externals_map[$type])) {
+            $this->externals_map[$type] = [];
+        }
+    }
 }

engine/classes/Elgg/Database/AccessCollections.php

Indentation +823 added lines, -823 removed lines

@@ -23,171 +23,171 @@ 
  */
 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 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 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,
-			ElggStaticVariableCache $cache,
-			PluginHooksService $hooks,
-			ElggSession $session,
-			Translator $translator) {
-		$this->config = $config;
-		$this->db = $db;
-		$this->entities = $entities;
-		$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 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 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,
+            ElggStaticVariableCache $cache,
+            PluginHooksService $hooks,
+            ElggSession $session,
+            Translator $translator) {
+        $this->config = $config;
+        $this->db = $db;
+        $this->entities = $entities;
+        $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
@@ -197,686 +197,686 @@ 
 							   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 = elgg_check_access_overrides($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'] = elgg_check_access_overrides($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 = elgg_check_access_overrides($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'] = elgg_check_access_overrides($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']) . ')';
-		}
-
-		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);
+            // 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']) . ')';
+        }
+
+        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 (elgg_check_access_overrides($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 = "
+        $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 (elgg_check_access_overrides($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
@@ -884,58 +884,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();
+    }
 
 }

views/default/languages.js.php

Indentation +4 added lines, -4 removed lines

@@ -9,13 +9,13 @@
 $translations = $all_translations['en'];
 
 if ($language != 'en' && !isset($all_translations[$language])) {
-	// try to reload missing translations
-	reload_all_translations();
-	$all_translations = _elgg_services()->translator->getLoadedTranslations();
+    // try to reload missing translations
+    reload_all_translations();
+    $all_translations = _elgg_services()->translator->getLoadedTranslations();
 }
 
 if ($language != 'en' && isset($all_translations[$language])) {
-	$translations = array_merge($translations, $all_translations[$language]);
+    $translations = array_merge($translations, $all_translations[$language]);
 }
 
 ?>

index.php

Indentation +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 $autoload_path = __DIR__ . '/vendor/autoload.php';
 $autoload_available = include_once($autoload_path);
 if (!$autoload_available) {
-	die("Couldn't include '$autoload_path'. Did you run `composer install`?");
+    die("Couldn't include '$autoload_path'. Did you run `composer install`?");
 }
 
 return \Elgg\Application::index();

engine/classes/ElggSite.php

Indentation +115 added lines, -115 removed lines

@@ -23,135 +23,135 @@
  */
 class ElggSite extends \ElggEntity {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function getType() {
-		return 'site';
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function getType() {
+        return 'site';
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function save() {
-		$db = $this->getDatabase();
-		$row = $db->getDataRow("
+    /**
+     * {@inheritdoc}
+     */
+    public function save() {
+        $db = $this->getDatabase();
+        $row = $db->getDataRow("
 			SELECT guid FROM {$db->prefix}sites_entity
 		");
-		if ($row) {
-			if ($row->guid == $this->attributes['guid']) {
-				// can save active site
-				return parent::save();
-			}
+        if ($row) {
+            if ($row->guid == $this->attributes['guid']) {
+                // can save active site
+                return parent::save();
+            }
 
-			_elgg_services()->logger->error('More than 1 site entity cannot be created.');
-			return false;
-		}
+            _elgg_services()->logger->error('More than 1 site entity cannot be created.');
+            return false;
+        }
 
-		return parent::save(); // TODO: Change the autogenerated stub
-	}
+        return parent::save(); // TODO: Change the autogenerated stub
+    }
 
-	/**
-	 * Delete the site.
-	 *
-	 * @note You cannot delete the current site.
-	 *
-	 * @return bool
-	 * @throws SecurityException
-	 */
-	public function delete() {
-		if ($this->guid == 1) {
-			throw new \SecurityException('You cannot delete the current site');
-		}
+    /**
+     * Delete the site.
+     *
+     * @note You cannot delete the current site.
+     *
+     * @return bool
+     * @throws SecurityException
+     */
+    public function delete() {
+        if ($this->guid == 1) {
+            throw new \SecurityException('You cannot delete the current site');
+        }
 
-		return parent::delete();
-	}
+        return parent::delete();
+    }
 
-	/**
-	 * Disable the site
-	 *
-	 * @note You cannot disable the current site.
-	 *
-	 * @param string $reason    Optional reason for disabling
-	 * @param bool   $recursive Recursively disable all contained entities?
-	 *
-	 * @return bool
-	 * @throws SecurityException
-	 */
-	public function disable($reason = "", $recursive = true) {
-		if ($this->guid == 1) {
-			throw new \SecurityException('You cannot disable the current site');
-		}
+    /**
+     * Disable the site
+     *
+     * @note You cannot disable the current site.
+     *
+     * @param string $reason    Optional reason for disabling
+     * @param bool   $recursive Recursively disable all contained entities?
+     *
+     * @return bool
+     * @throws SecurityException
+     */
+    public function disable($reason = "", $recursive = true) {
+        if ($this->guid == 1) {
+            throw new \SecurityException('You cannot disable the current site');
+        }
 
-		return parent::disable($reason, $recursive);
-	}
+        return parent::disable($reason, $recursive);
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function __set($name, $value) {
-		if ($name === 'url') {
-			_elgg_services()->logger->warn("ElggSite::url cannot be set");
-			return;
-		}
-		parent::__set($name, $value);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function __set($name, $value) {
+        if ($name === 'url') {
+            _elgg_services()->logger->warn("ElggSite::url cannot be set");
+            return;
+        }
+        parent::__set($name, $value);
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function __get($name) {
-		if ($name === 'url') {
-			return $this->getURL();
-		}
-		return parent::__get($name);
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function __get($name) {
+        if ($name === 'url') {
+            return $this->getURL();
+        }
+        return parent::__get($name);
+    }
 
-	/**
-	 * Returns the URL for this site
-	 *
-	 * @return string The URL
-	 */
-	public function getURL() {
-		return _elgg_config()->wwwroot;
-	}
+    /**
+     * Returns the URL for this site
+     *
+     * @return string The URL
+     */
+    public function getURL() {
+        return _elgg_config()->wwwroot;
+    }
 
-	/**
-	 * {@inheritdoc}
-	 */
-	protected function prepareObject($object) {
-		$object = parent::prepareObject($object);
-		$object->name = $this->getDisplayName();
-		$object->description = $this->description;
-		unset($object->read_access);
-		return $object;
-	}
+    /**
+     * {@inheritdoc}
+     */
+    protected function prepareObject($object) {
+        $object = parent::prepareObject($object);
+        $object->name = $this->getDisplayName();
+        $object->description = $this->description;
+        unset($object->read_access);
+        return $object;
+    }
 
-	/**
-	 * Get the domain for this site
-	 *
-	 * @return string
-	 * @since 1.9
-	 */
-	public function getDomain() {
-		$breakdown = parse_url($this->url);
-		return $breakdown['host'];
-	}
+    /**
+     * Get the domain for this site
+     *
+     * @return string
+     * @since 1.9
+     */
+    public function getDomain() {
+        $breakdown = parse_url($this->url);
+        return $breakdown['host'];
+    }
 
-	/**
-	 * Get the email address for the site
-	 *
-	 * This can be set in the basic site settings or fallback to noreply@domain
-	 *
-	 * @return string
-	 * @since 3.0.0
-	 */
-	public function getEmailAddress() {
-		$email = $this->email;
-		if (empty($email)) {
-			$email = "noreply@{$this->getDomain()}";
-		}
+    /**
+     * Get the email address for the site
+     *
+     * This can be set in the basic site settings or fallback to noreply@domain
+     *
+     * @return string
+     * @since 3.0.0
+     */
+    public function getEmailAddress() {
+        $email = $this->email;
+        if (empty($email)) {
+            $email = "noreply@{$this->getDomain()}";
+        }
 
-		return $email;
-	}
+        return $email;
+    }
 }

engine/classes/ElggSession.php

Indentation +333 added lines, -333 removed lines

@@ -17,340 +17,340 @@
  */
 class ElggSession {
 
-	/**
-	 * @var SessionInterface
-	 */
-	protected $storage;
-
-	/**
-	 * @var \ElggUser|null
-	 */
-	protected $logged_in_user;
-
-	/**
-	 * @var bool
-	 */
-	protected $ignore_access = false;
-
-	/**
-	 * Constructor
-	 *
-	 * @param SessionInterface $storage The underlying Session implementation
-	 * @access private Use elgg_get_session()
-	 */
-	public function __construct(SessionInterface $storage) {
-		$this->storage = $storage;
-	}
-
-	/**
-	 * Start the session
-	 *
-	 * @return boolean
-	 * @throws RuntimeException If session fails to start.
-	 * @since 1.9
-	 */
-	public function start() {
-		$result = $this->storage->start();
-		$this->generateSessionToken();
-		return $result;
-	}
-
-	/**
-	 * Migrates the session to a new session id while maintaining session attributes
-	 *
-	 * @param boolean $destroy Whether to delete the session or let gc handle clean up
-	 * @return boolean
-	 * @since 1.9
-	 */
-	public function migrate($destroy = false) {
-		return $this->storage->migrate($destroy);
-	}
-
-	/**
-	 * Invalidates the session
-	 *
-	 * Deletes session data and session persistence. Starts a new session.
-	 *
-	 * @return boolean
-	 * @since 1.9
-	 */
-	public function invalidate() {
-		$this->storage->clear();
-		$this->logged_in_user = null;
-		$result = $this->migrate(true);
-		$this->generateSessionToken();
-		return $result;
-	}
-
-	/**
-	 * Has the session been started
-	 *
-	 * @return boolean
-	 * @since 1.9
-	 */
-	public function isStarted() {
-		return $this->storage->isStarted();
-	}
-
-	/**
-	 * Get the session ID
-	 *
-	 * @return string
-	 * @since 1.9
-	 */
-	public function getId() {
-		return $this->storage->getId();
-	}
-
-	/**
-	 * Set the session ID
-	 *
-	 * @param string $id Session ID
-	 * @return void
-	 * @since 1.9
-	 */
-	public function setId($id) {
-		$this->storage->setId($id);
-	}
-
-	/**
-	 * Get the session name
-	 *
-	 * @return string
-	 * @since 1.9
-	 */
-	public function getName() {
-		return $this->storage->getName();
-	}
-
-	/**
-	 * Set the session name
-	 *
-	 * @param string $name Session name
-	 * @return void
-	 * @since 1.9
-	 */
-	public function setName($name) {
-		$this->storage->setName($name);
-	}
-
-	/**
-	 * Get an attribute of the session
-	 *
-	 * @param string $name    Name of the attribute to get
-	 * @param mixed  $default Value to return if attribute is not set (default is null)
-	 * @return mixed
-	 */
-	public function get($name, $default = null) {
-		return $this->storage->get($name, $default);
-	}
-
-	/**
-	 * Set an attribute
-	 *
-	 * @param string $name  Name of the attribute to set
-	 * @param mixed  $value Value to be set
-	 * @return void
-	 */
-	public function set($name, $value) {
-		$this->storage->set($name, $value);
-	}
-
-	/**
-	 * Remove an attribute
-	 *
-	 * @param string $name The name of the attribute to remove
-	 * @return mixed The removed attribute
-	 * @since 1.9
-	 */
-	public function remove($name) {
-		return $this->storage->remove($name);
-	}
-
-	/**
-	 * Has the attribute been defined
-	 *
-	 * @param string $name Name of the attribute
-	 * @return bool
-	 * @since 1.9
-	 */
-	public function has($name) {
-		return $this->storage->has($name);
-	}
-
-	/**
-	 * Sets the logged in user
-	 *
-	 * @param \ElggUser $user The user who is logged in
-	 * @return void
-	 * @since 1.9
-	 */
-	public function setLoggedInUser(\ElggUser $user) {
-		$current_user = $this->getLoggedInUser();
-		if ($current_user != $user) {
-			$this->set('guid', $user->guid);
-			$this->logged_in_user = $user;
-			_elgg_services()->entityCache->clear();
-		}
-	}
-
-	/**
-	 * Gets the logged in user
-	 *
-	 * @return \ElggUser|null
-	 * @since 1.9
-	 */
-	public function getLoggedInUser() {
-		return $this->logged_in_user;
-	}
-
-	/**
-	 * Return the current logged in user by guid.
-	 *
-	 * @see elgg_get_logged_in_user_entity()
-	 * @return int
-	 */
-	public function getLoggedInUserGuid() {
-		$user = $this->getLoggedInUser();
-		return $user ? $user->guid : 0;
-	}
+    /**
+     * @var SessionInterface
+     */
+    protected $storage;
+
+    /**
+     * @var \ElggUser|null
+     */
+    protected $logged_in_user;
+
+    /**
+     * @var bool
+     */
+    protected $ignore_access = false;
+
+    /**
+     * Constructor
+     *
+     * @param SessionInterface $storage The underlying Session implementation
+     * @access private Use elgg_get_session()
+     */
+    public function __construct(SessionInterface $storage) {
+        $this->storage = $storage;
+    }
+
+    /**
+     * Start the session
+     *
+     * @return boolean
+     * @throws RuntimeException If session fails to start.
+     * @since 1.9
+     */
+    public function start() {
+        $result = $this->storage->start();
+        $this->generateSessionToken();
+        return $result;
+    }
+
+    /**
+     * Migrates the session to a new session id while maintaining session attributes
+     *
+     * @param boolean $destroy Whether to delete the session or let gc handle clean up
+     * @return boolean
+     * @since 1.9
+     */
+    public function migrate($destroy = false) {
+        return $this->storage->migrate($destroy);
+    }
+
+    /**
+     * Invalidates the session
+     *
+     * Deletes session data and session persistence. Starts a new session.
+     *
+     * @return boolean
+     * @since 1.9
+     */
+    public function invalidate() {
+        $this->storage->clear();
+        $this->logged_in_user = null;
+        $result = $this->migrate(true);
+        $this->generateSessionToken();
+        return $result;
+    }
+
+    /**
+     * Has the session been started
+     *
+     * @return boolean
+     * @since 1.9
+     */
+    public function isStarted() {
+        return $this->storage->isStarted();
+    }
+
+    /**
+     * Get the session ID
+     *
+     * @return string
+     * @since 1.9
+     */
+    public function getId() {
+        return $this->storage->getId();
+    }
+
+    /**
+     * Set the session ID
+     *
+     * @param string $id Session ID
+     * @return void
+     * @since 1.9
+     */
+    public function setId($id) {
+        $this->storage->setId($id);
+    }
+
+    /**
+     * Get the session name
+     *
+     * @return string
+     * @since 1.9
+     */
+    public function getName() {
+        return $this->storage->getName();
+    }
+
+    /**
+     * Set the session name
+     *
+     * @param string $name Session name
+     * @return void
+     * @since 1.9
+     */
+    public function setName($name) {
+        $this->storage->setName($name);
+    }
+
+    /**
+     * Get an attribute of the session
+     *
+     * @param string $name    Name of the attribute to get
+     * @param mixed  $default Value to return if attribute is not set (default is null)
+     * @return mixed
+     */
+    public function get($name, $default = null) {
+        return $this->storage->get($name, $default);
+    }
+
+    /**
+     * Set an attribute
+     *
+     * @param string $name  Name of the attribute to set
+     * @param mixed  $value Value to be set
+     * @return void
+     */
+    public function set($name, $value) {
+        $this->storage->set($name, $value);
+    }
+
+    /**
+     * Remove an attribute
+     *
+     * @param string $name The name of the attribute to remove
+     * @return mixed The removed attribute
+     * @since 1.9
+     */
+    public function remove($name) {
+        return $this->storage->remove($name);
+    }
+
+    /**
+     * Has the attribute been defined
+     *
+     * @param string $name Name of the attribute
+     * @return bool
+     * @since 1.9
+     */
+    public function has($name) {
+        return $this->storage->has($name);
+    }
+
+    /**
+     * Sets the logged in user
+     *
+     * @param \ElggUser $user The user who is logged in
+     * @return void
+     * @since 1.9
+     */
+    public function setLoggedInUser(\ElggUser $user) {
+        $current_user = $this->getLoggedInUser();
+        if ($current_user != $user) {
+            $this->set('guid', $user->guid);
+            $this->logged_in_user = $user;
+            _elgg_services()->entityCache->clear();
+        }
+    }
+
+    /**
+     * Gets the logged in user
+     *
+     * @return \ElggUser|null
+     * @since 1.9
+     */
+    public function getLoggedInUser() {
+        return $this->logged_in_user;
+    }
+
+    /**
+     * Return the current logged in user by guid.
+     *
+     * @see elgg_get_logged_in_user_entity()
+     * @return int
+     */
+    public function getLoggedInUserGuid() {
+        $user = $this->getLoggedInUser();
+        return $user ? $user->guid : 0;
+    }
 	
-	/**
-	 * Returns whether or not the viewer is currently logged in and an admin user.
-	 *
-	 * @return bool
-	 */
-	public function isAdminLoggedIn() {
-		$user = $this->getLoggedInUser();
+    /**
+     * Returns whether or not the viewer is currently logged in and an admin user.
+     *
+     * @return bool
+     */
+    public function isAdminLoggedIn() {
+        $user = $this->getLoggedInUser();
 	
-		return $user && $user->isAdmin();
-	}
+        return $user && $user->isAdmin();
+    }
 	
-	/**
-	 * Returns whether or not the user is currently logged in
-	 *
-	 * @return bool
-	 */
-	public function isLoggedIn() {
-		return (bool) $this->getLoggedInUser();
-	}
-
-	/**
-	 * Remove the logged in user
-	 *
-	 * @return void
-	 * @since 1.9
-	 */
-	public function removeLoggedInUser() {
-		$this->logged_in_user = null;
-		$this->remove('guid');
-		_elgg_services()->entityCache->clear();
-	}
-
-	/**
-	 * Get current ignore access setting.
-	 *
-	 * @return bool
-	 */
-	public function getIgnoreAccess() {
-		return $this->ignore_access;
-	}
-
-	/**
-	 * Set ignore access.
-	 *
-	 * @param bool $ignore Ignore access
-	 *
-	 * @return bool Previous setting
-	 */
-	public function setIgnoreAccess($ignore = true) {
-		_elgg_services()->accessCache->clear();
-
-		$prev = $this->ignore_access;
-		$this->ignore_access = $ignore;
-
-		return $prev;
-	}
-
-	/**
-	 * Adds a token to the session
-	 *
-	 * This is used in creation of CSRF token, and is passed to the client to allow validating tokens
-	 * later, even if the PHP session was destroyed.
-	 *
-	 * @return void
-	 */
-	protected function generateSessionToken() {
-		// Generate a simple token that we store server side
-		if (!$this->has('__elgg_session')) {
-			$this->set('__elgg_session', _elgg_services()->crypto->getRandomString(22));
-		}
-	}
-
-	/**
-	 * Get an isolated ElggSession that does not persist between requests
-	 *
-	 * @return self
-	 */
-	public static function getMock() {
-		$storage = new MockArraySessionStorage();
-		$session = new Session($storage);
-		return new self($session);
-	}
-
-	/**
-	 * Create a session stored in the DB.
-	 *
-	 * @param Config   $config Config
-	 * @param Database $db     Database
-	 *
-	 * @return ElggSession
-	 */
-	public static function fromDatabase(Config $config, Database $db) {
-		$params = $config->getCookieConfig()['session'];
-		$options = [
-			// session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
-			// constructor, so we must capture and inject it directly.
-			'cache_limiter' => session_cache_limiter(),
-
-			'name' => $params['name'],
-			'cookie_path' => $params['path'],
-			'cookie_domain' => $params['domain'],
-			'cookie_secure' => $params['secure'],
-			'cookie_httponly' => $params['httponly'],
-			'cookie_lifetime' => $params['lifetime'],
-		];
-
-		$handler = new DatabaseSessionHandler($db);
-		$storage = new NativeSessionStorage($options, $handler);
-		$session = new Session($storage);
-		return new self($session);
-	}
-
-	/**
-	 * Create a session stored in files
-	 *
-	 * @param Config $config Config
-	 *
-	 * @return ElggSession
-	 */
-	public static function fromFiles(Config $config) {
-		$params = $config->getCookieConfig()['session'];
-		$options = [
-			// session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
-			// constructor, so we must capture and inject it directly.
-			'cache_limiter' => session_cache_limiter(),
-
-			'name' => $params['name'],
-			'cookie_path' => $params['path'],
-			'cookie_domain' => $params['domain'],
-			'cookie_secure' => $params['secure'],
-			'cookie_httponly' => $params['httponly'],
-			'cookie_lifetime' => $params['lifetime'],
-		];
-
-		$storage = new NativeSessionStorage($options);
-		$session = new Session($storage);
-		return new self($session);
-	}
+    /**
+     * Returns whether or not the user is currently logged in
+     *
+     * @return bool
+     */
+    public function isLoggedIn() {
+        return (bool) $this->getLoggedInUser();
+    }
+
+    /**
+     * Remove the logged in user
+     *
+     * @return void
+     * @since 1.9
+     */
+    public function removeLoggedInUser() {
+        $this->logged_in_user = null;
+        $this->remove('guid');
+        _elgg_services()->entityCache->clear();
+    }
+
+    /**
+     * Get current ignore access setting.
+     *
+     * @return bool
+     */
+    public function getIgnoreAccess() {
+        return $this->ignore_access;
+    }
+
+    /**
+     * Set ignore access.
+     *
+     * @param bool $ignore Ignore access
+     *
+     * @return bool Previous setting
+     */
+    public function setIgnoreAccess($ignore = true) {
+        _elgg_services()->accessCache->clear();
+
+        $prev = $this->ignore_access;
+        $this->ignore_access = $ignore;
+
+        return $prev;
+    }
+
+    /**
+     * Adds a token to the session
+     *
+     * This is used in creation of CSRF token, and is passed to the client to allow validating tokens
+     * later, even if the PHP session was destroyed.
+     *
+     * @return void
+     */
+    protected function generateSessionToken() {
+        // Generate a simple token that we store server side
+        if (!$this->has('__elgg_session')) {
+            $this->set('__elgg_session', _elgg_services()->crypto->getRandomString(22));
+        }
+    }
+
+    /**
+     * Get an isolated ElggSession that does not persist between requests
+     *
+     * @return self
+     */
+    public static function getMock() {
+        $storage = new MockArraySessionStorage();
+        $session = new Session($storage);
+        return new self($session);
+    }
+
+    /**
+     * Create a session stored in the DB.
+     *
+     * @param Config   $config Config
+     * @param Database $db     Database
+     *
+     * @return ElggSession
+     */
+    public static function fromDatabase(Config $config, Database $db) {
+        $params = $config->getCookieConfig()['session'];
+        $options = [
+            // session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
+            // constructor, so we must capture and inject it directly.
+            'cache_limiter' => session_cache_limiter(),
+
+            'name' => $params['name'],
+            'cookie_path' => $params['path'],
+            'cookie_domain' => $params['domain'],
+            'cookie_secure' => $params['secure'],
+            'cookie_httponly' => $params['httponly'],
+            'cookie_lifetime' => $params['lifetime'],
+        ];
+
+        $handler = new DatabaseSessionHandler($db);
+        $storage = new NativeSessionStorage($options, $handler);
+        $session = new Session($storage);
+        return new self($session);
+    }
+
+    /**
+     * Create a session stored in files
+     *
+     * @param Config $config Config
+     *
+     * @return ElggSession
+     */
+    public static function fromFiles(Config $config) {
+        $params = $config->getCookieConfig()['session'];
+        $options = [
+            // session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
+            // constructor, so we must capture and inject it directly.
+            'cache_limiter' => session_cache_limiter(),
+
+            'name' => $params['name'],
+            'cookie_path' => $params['path'],
+            'cookie_domain' => $params['domain'],
+            'cookie_secure' => $params['secure'],
+            'cookie_httponly' => $params['httponly'],
+            'cookie_lifetime' => $params['lifetime'],
+        ];
+
+        $storage = new NativeSessionStorage($options);
+        $session = new Session($storage);
+        return new self($session);
+    }
 }

engine/classes/ElggRewriteTester.php

Indentation +219 added lines, -219 removed lines

@@ -10,252 +10,252 @@
  * Test if URL rewriting is working.
  */
 class ElggRewriteTester {
-	protected $webserver;
-	protected $serverSupportsRemoteRead;
-	protected $rewriteTestPassed;
-	protected $htaccessIssue;
+    protected $webserver;
+    protected $serverSupportsRemoteRead;
+    protected $rewriteTestPassed;
+    protected $htaccessIssue;
 
-	/**
-	 * Set the webserver as unknown.
-	 */
-	public function __construct() {
-		$this->webserver = 'unknown';
-	}
+    /**
+     * Set the webserver as unknown.
+     */
+    public function __construct() {
+        $this->webserver = 'unknown';
+    }
 
-	/**
-	 * Run the rewrite test and return a status array
-	 *
-	 * @param string $url  URL of rewrite test
-	 * @param string $path Root directory of Elgg with trailing slash
-	 *
-	 * @return array
-	 */
-	public function run($url, $path) {
+    /**
+     * Run the rewrite test and return a status array
+     *
+     * @param string $url  URL of rewrite test
+     * @param string $path Root directory of Elgg with trailing slash
+     *
+     * @return array
+     */
+    public function run($url, $path) {
 
-		$this->webserver = \ElggRewriteTester::guessWebServer();
+        $this->webserver = \ElggRewriteTester::guessWebServer();
 
-		$this->rewriteTestPassed = $this->runRewriteTest($url);
+        $this->rewriteTestPassed = $this->runRewriteTest($url);
 
-		if ($this->rewriteTestPassed == false) {
-			if ($this->webserver == 'apache' || $this->webserver == 'unknown') {
-				if ($this->createHtaccess($url, $path)) {
-					$this->rewriteTestPassed = $this->runRewriteTest($url);
-				}
-			}
-		}
+        if ($this->rewriteTestPassed == false) {
+            if ($this->webserver == 'apache' || $this->webserver == 'unknown') {
+                if ($this->createHtaccess($url, $path)) {
+                    $this->rewriteTestPassed = $this->runRewriteTest($url);
+                }
+            }
+        }
 
-		return $this->returnStatus($url);
-	}
+        return $this->returnStatus($url);
+    }
 
-	/**
-	 * Guess the web server from $_SERVER['SERVER_SOFTWARE']
-	 *
-	 * @return string
-	 */
-	public static function guessWebServer() {
-		$serverString = strtolower($_SERVER['SERVER_SOFTWARE']);
-		$possibleServers = ['apache', 'nginx', 'lighttpd', 'iis'];
-		foreach ($possibleServers as $server) {
-			if (strpos($serverString, $server) !== false) {
-				return $server;
-			}
-		}
-		return 'unknown';
-	}
+    /**
+     * Guess the web server from $_SERVER['SERVER_SOFTWARE']
+     *
+     * @return string
+     */
+    public static function guessWebServer() {
+        $serverString = strtolower($_SERVER['SERVER_SOFTWARE']);
+        $possibleServers = ['apache', 'nginx', 'lighttpd', 'iis'];
+        foreach ($possibleServers as $server) {
+            if (strpos($serverString, $server) !== false) {
+                return $server;
+            }
+        }
+        return 'unknown';
+    }
 
-	/**
-	 * Guess if url contains subdirectory or not.
-	 *
-	 * @param string $url Rewrite test URL
-	 *
-	 * @return string|bool Subdirectory string with beginning and trailing slash or false if were unable to determine subdirectory
-	 * or pointing at root of domain already
-	 */
-	public function guessSubdirectory($url) {
-		$elements = parse_url($url);
-		if (!$elements || !isset($elements['path'])) {
-			return false;
-		}
-		$subdir = trim(dirname($elements['path']), '/');
-		if (!$subdir) {
-			return false;
-		} else {
-			return "/$subdir/";
-		}
-	}
+    /**
+     * Guess if url contains subdirectory or not.
+     *
+     * @param string $url Rewrite test URL
+     *
+     * @return string|bool Subdirectory string with beginning and trailing slash or false if were unable to determine subdirectory
+     * or pointing at root of domain already
+     */
+    public function guessSubdirectory($url) {
+        $elements = parse_url($url);
+        if (!$elements || !isset($elements['path'])) {
+            return false;
+        }
+        $subdir = trim(dirname($elements['path']), '/');
+        if (!$subdir) {
+            return false;
+        } else {
+            return "/$subdir/";
+        }
+    }
 
-	/**
-	 * Hit the rewrite test URL to determine if the rewrite rules are working
-	 *
-	 * @param string $url Rewrite test URL
-	 *
-	 * @return bool
-	 */
-	public function runRewriteTest($url) {
-		$this->serverSupportsRemoteRead = ($this->fetchUrl($url) === Request::REWRITE_TEST_OUTPUT);
-		return $this->serverSupportsRemoteRead;
-	}
+    /**
+     * Hit the rewrite test URL to determine if the rewrite rules are working
+     *
+     * @param string $url Rewrite test URL
+     *
+     * @return bool
+     */
+    public function runRewriteTest($url) {
+        $this->serverSupportsRemoteRead = ($this->fetchUrl($url) === Request::REWRITE_TEST_OUTPUT);
+        return $this->serverSupportsRemoteRead;
+    }
 	
-	/**
-	 * Check whether the site homepage can be fetched via curl
-	 *
-	 * @return boolean
-	 */
-	public function runLocalhostAccessTest() {
-		$url = _elgg_config()->wwwroot;
-		return (bool) $this->fetchUrl($url);
-	}
+    /**
+     * Check whether the site homepage can be fetched via curl
+     *
+     * @return boolean
+     */
+    public function runLocalhostAccessTest() {
+        $url = _elgg_config()->wwwroot;
+        return (bool) $this->fetchUrl($url);
+    }
 
-	/**
-	 * Fetch a URL
-	 *
-	 * @param string $url The URL
-	 *
-	 * @return string Note that empty string may imply failure in fetching or empty response
-	 */
-	private function fetchUrl($url) {
-		$response = '';
+    /**
+     * Fetch a URL
+     *
+     * @param string $url The URL
+     *
+     * @return string Note that empty string may imply failure in fetching or empty response
+     */
+    private function fetchUrl($url) {
+        $response = '';
 
-		if (ini_get('allow_url_fopen')) {
-			$ctx = stream_context_create([
-				'http' => [
-					'follow_location' => 0,
-					'timeout' => 5,
-				],
-			]);
-			$response = @file_get_contents($url, null, $ctx);
-		}
+        if (ini_get('allow_url_fopen')) {
+            $ctx = stream_context_create([
+                'http' => [
+                    'follow_location' => 0,
+                    'timeout' => 5,
+                ],
+            ]);
+            $response = @file_get_contents($url, null, $ctx);
+        }
 
-		if (!$response && function_exists('curl_init')) {
-			$ch = curl_init();
-			curl_setopt($ch, CURLOPT_URL, $url);
-			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-			curl_setopt($ch, CURLOPT_TIMEOUT, 5);
-			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
-			$response = curl_exec($ch);
-			curl_close($ch);
-		}
+        if (!$response && function_exists('curl_init')) {
+            $ch = curl_init();
+            curl_setopt($ch, CURLOPT_URL, $url);
+            curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+            curl_setopt($ch, CURLOPT_TIMEOUT, 5);
+            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
+            $response = curl_exec($ch);
+            curl_close($ch);
+        }
 
-		return (string) $response;
-	}
+        return (string) $response;
+    }
 
-	/**
-	 * Create Elgg's .htaccess file or confirm that it exists
-	 *
-	 * @param string $url URL of rewrite test
-	 *
-	 * @return bool
-	 */
-	public function createHtaccess($url) {
-		$root = Directory\Local::projectRoot();
-		$file = $root->getFile(".htaccess");
+    /**
+     * Create Elgg's .htaccess file or confirm that it exists
+     *
+     * @param string $url URL of rewrite test
+     *
+     * @return bool
+     */
+    public function createHtaccess($url) {
+        $root = Directory\Local::projectRoot();
+        $file = $root->getFile(".htaccess");
 
-		if ($file->exists()) {
-			// check that this is the Elgg .htaccess
-			$data = $file->getContents();
-			if ($data === false) {
-				// don't have permission to read the file
-				$this->htaccessIssue = 'read_permission';
-				return false;
-			}
+        if ($file->exists()) {
+            // check that this is the Elgg .htaccess
+            $data = $file->getContents();
+            if ($data === false) {
+                // don't have permission to read the file
+                $this->htaccessIssue = 'read_permission';
+                return false;
+            }
 
-			if (strpos($data, 'Elgg') === false) {
-				$this->htaccessIssue = 'non_elgg_htaccess';
-				return false;
-			}
+            if (strpos($data, 'Elgg') === false) {
+                $this->htaccessIssue = 'non_elgg_htaccess';
+                return false;
+            }
 
-			// check if this is an old Elgg htaccess
-			if (strpos($data, 'RewriteRule ^rewrite.php$ install.php') == false) {
-				$this->htaccessIssue = 'old_elgg_htaccess';
-				return false;
-			}
-			return true;
-		}
+            // check if this is an old Elgg htaccess
+            if (strpos($data, 'RewriteRule ^rewrite.php$ install.php') == false) {
+                $this->htaccessIssue = 'old_elgg_htaccess';
+                return false;
+            }
+            return true;
+        }
 
-		if (!is_writable($root->getPath())) {
-			$this->htaccessIssue = 'write_permission';
-			return false;
-		}
+        if (!is_writable($root->getPath())) {
+            $this->htaccessIssue = 'write_permission';
+            return false;
+        }
 
-		// create the .htaccess file
-		$result = copy(Paths::elgg() . "install/config/htaccess.dist", $file->getPath());
-		if (!$result) {
-			$this->htaccessIssue = 'cannot_copy';
-			return false;
-		}
+        // create the .htaccess file
+        $result = copy(Paths::elgg() . "install/config/htaccess.dist", $file->getPath());
+        if (!$result) {
+            $this->htaccessIssue = 'cannot_copy';
+            return false;
+        }
 		
-		// does default RewriteBase work already?
-		if (!$this->runRewriteTest($url)) {
-			//try to rewrite to guessed subdirectory
-			if ($subdir = $this->guessSubdirectory($url)) {
-				$contents = $file->getContents();
-				$contents = preg_replace("/#RewriteBase \/(\r?\n)/", "RewriteBase $subdir\$1", $contents);
-				if ($contents) {
-					$file->putContents($contents);
-				}
-			}
-		}
+        // does default RewriteBase work already?
+        if (!$this->runRewriteTest($url)) {
+            //try to rewrite to guessed subdirectory
+            if ($subdir = $this->guessSubdirectory($url)) {
+                $contents = $file->getContents();
+                $contents = preg_replace("/#RewriteBase \/(\r?\n)/", "RewriteBase $subdir\$1", $contents);
+                if ($contents) {
+                    $file->putContents($contents);
+                }
+            }
+        }
 
-		return true;
-	}
+        return true;
+    }
 
-	/**
-	 * Create the status array required by the ElggInstaller
-	 *
-	 * @param string $url Rewrite test URL
-	 *
-	 * @return array
-	 */
-	protected function returnStatus($url) {
-		if ($this->rewriteTestPassed) {
-			return [
-				'severity' => 'pass',
-				'message' => _elgg_services()->translator->translate('install:check:rewrite:success'),
-			];
-		}
+    /**
+     * Create the status array required by the ElggInstaller
+     *
+     * @param string $url Rewrite test URL
+     *
+     * @return array
+     */
+    protected function returnStatus($url) {
+        if ($this->rewriteTestPassed) {
+            return [
+                'severity' => 'pass',
+                'message' => _elgg_services()->translator->translate('install:check:rewrite:success'),
+            ];
+        }
 
-		if ($this->serverSupportsRemoteRead == false) {
-			$msg = _elgg_services()->translator->translate('install:warning:rewrite:unknown', [$url]);
-			$msg .= elgg_view('install/js_rewrite_check', ['url' => $url]);
+        if ($this->serverSupportsRemoteRead == false) {
+            $msg = _elgg_services()->translator->translate('install:warning:rewrite:unknown', [$url]);
+            $msg .= elgg_view('install/js_rewrite_check', ['url' => $url]);
 			
-			return [
-				'severity' => 'warning',
-				'message' => $msg,
-			];
-		}
+            return [
+                'severity' => 'warning',
+                'message' => $msg,
+            ];
+        }
 
-		if ($this->webserver == 'apache') {
-			$serverString = _elgg_services()->translator->translate('install:error:rewrite:apache');
-			$msg = "$serverString\n\n";
-			if (!isset($this->htaccessIssue)) {
-				$msg .= _elgg_services()->translator->translate('install:error:rewrite:allowoverride');
-				$msg .= elgg_view('install/js_rewrite_check', ['url' => $url]);
+        if ($this->webserver == 'apache') {
+            $serverString = _elgg_services()->translator->translate('install:error:rewrite:apache');
+            $msg = "$serverString\n\n";
+            if (!isset($this->htaccessIssue)) {
+                $msg .= _elgg_services()->translator->translate('install:error:rewrite:allowoverride');
+                $msg .= elgg_view('install/js_rewrite_check', ['url' => $url]);
 			
-				return [
-					'severity' => 'warning',
-					'message' => $msg,
-				];
-			}
-			$msg .= _elgg_services()->translator->translate("install:error:rewrite:htaccess:{$this->htaccessIssue}");
-			return [
-				'severity' => 'warning',
-				'message' => $msg,
-			];
-		}
+                return [
+                    'severity' => 'warning',
+                    'message' => $msg,
+                ];
+            }
+            $msg .= _elgg_services()->translator->translate("install:error:rewrite:htaccess:{$this->htaccessIssue}");
+            return [
+                'severity' => 'warning',
+                'message' => $msg,
+            ];
+        }
 
-		if ($this->webserver != 'unknown') {
-			$serverString = _elgg_services()->translator->translate("install:error:rewrite:{$this->webserver}");
-			$msg = "$serverString\n\n";
-			$msg .= _elgg_services()->translator->translate("install:error:rewrite:altserver");
-			return [
-				'severity' => 'warning',
-				'message' => $msg,
-			];
-		}
+        if ($this->webserver != 'unknown') {
+            $serverString = _elgg_services()->translator->translate("install:error:rewrite:{$this->webserver}");
+            $msg = "$serverString\n\n";
+            $msg .= _elgg_services()->translator->translate("install:error:rewrite:altserver");
+            return [
+                'severity' => 'warning',
+                'message' => $msg,
+            ];
+        }
 
-		return [
-			'severity' => 'warning',
-			'message' => _elgg_services()->translator->translate('install:error:rewrite:unknown'),
-		];
-	}
+        return [
+            'severity' => 'warning',
+            'message' => _elgg_services()->translator->translate('install:error:rewrite:unknown'),
+        ];
+    }
 }