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] = [];
+        }
+    }
 }

Spacing +1 added lines, -1 removed lines

@@ -180,7 +180,7 @@
 			return $v->loaded == true && $v->location == $location;
 		});
 		if ($items) {
-			array_walk($items, function(&$v, $k){
+			array_walk($items, function(&$v, $k) {
 				$v = $v->url;
 			});
 		}

engine/classes/Elgg/I18n/Translator.php

Spacing +5 added lines, -5 removed lines

@@ -65,7 +65,7 @@ 
 	 */
 	public function __construct(Config $config) {
 		$this->config = $config;
-		$this->defaultPath = dirname(dirname(dirname(dirname(__DIR__)))) . "/languages/";
+		$this->defaultPath = dirname(dirname(dirname(dirname(__DIR__))))."/languages/";
 	}
 
 	/**
@@ -98,7 +98,7 @@ 
 	public function translate($message_key, array $args = [], $language = "") {
 		if (!is_string($message_key) || strlen($message_key) < 1) {
 			_elgg_services()->logger->warn(
-				'$message_key needs to be a string in ' . __METHOD__ . '(), ' . gettype($message_key) . ' provided'
+				'$message_key needs to be a string in '.__METHOD__.'(), '.gettype($message_key).' provided'
 			);
 			return '';
 		}
@@ -327,7 +327,7 @@ 
 	 * @return bool Success
 	 */
 	public function registerPluginTranslations($path) {
-		$languages_path = rtrim($path, "\\/") . "/languages";
+		$languages_path = rtrim($path, "\\/")."/languages";
 
 		// don't need to have translations
 		if (!is_dir($languages_path)) {
@@ -385,7 +385,7 @@ 
 			}
 
 			if (in_array($language_file, $load_language_files) || $load_all) {
-				$result = (include $path . $language_file);
+				$result = (include $path.$language_file);
 				if ($result === false) {
 					$return = false;
 					continue;
@@ -466,7 +466,7 @@ 
 			
 			$completeness = $this->getLanguageCompleteness($k);
 			if ($completeness < 100) {
-				$installed[$k] .= " (" . $completeness . "% " . $this->translate('complete') . ")";
+				$installed[$k] .= " (".$completeness."% ".$this->translate('complete').")";
 			}
 		}
 

Indentation +729 added lines, -729 removed lines

@@ -12,737 +12,737 @@
  */
 class Translator {
 
-	/**
-	 * @var Config
-	 */
-	private $config;
-
-	/**
-	 * @var array
-	 */
-	private $translations = [];
-
-	/**
-	 * @var bool
-	 */
-	private $is_initialized = false;
-
-	/**
-	 * @var string
-	 */
-	private $current_language = null;
-
-	/**
-	 * Paths to scan for autoloading languages.
-	 *
-	 * Languages are automatically loaded for the site or
-	 * user's default language.  Plugins can extend or override strings.
-	 * language_paths is an array of paths to scan for PHP files matching
-	 * the default language.  The order of paths is determined by the plugin load order,
-	 * with later entries overriding earlier.  Language files within these paths are
-	 * named as the two-letter ISO 639-1 country codes for the language they represent.
-	 *
-	 * @link http://en.wikipedia.org/wiki/ISO_639-1
-	 *
-	 * @var array (paths are keys)
-	 */
-	private $language_paths = [];
-
-	/**
-	 * @var bool
-	 */
-	private $was_reloaded = false;
-
-	/**
-	 * @var bool
-	 */
-	private $loaded_from_cache = false;
-
-	/**
-	 * Constructor
-	 *
-	 * @param Config $config Elgg config
-	 */
-	public function __construct(Config $config) {
-		$this->config = $config;
-		$this->defaultPath = dirname(dirname(dirname(dirname(__DIR__)))) . "/languages/";
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function wasLoadedFromCache() {
-		return $this->loaded_from_cache;
-	}
-
-	/**
-	 * Get a map of all loaded translations
-	 *
-	 * @return array
-	 */
-	public function getLoadedTranslations() {
-		return $this->translations;
-	}
-
-	/**
-	 * Given a message key, returns an appropriately translated full-text string
-	 *
-	 * @param string $message_key The short message code
-	 * @param array  $args        An array of arguments to pass through vsprintf().
-	 * @param string $language    Optionally, the standard language code
-	 *                            (defaults to site/user default, then English)
-	 *
-	 * @return string Either the translated string, the English string,
-	 * or the original language string.
-	 */
-	public function translate($message_key, array $args = [], $language = "") {
-		if (!is_string($message_key) || strlen($message_key) < 1) {
-			_elgg_services()->logger->warn(
-				'$message_key needs to be a string in ' . __METHOD__ . '(), ' . gettype($message_key) . ' provided'
-			);
-			return '';
-		}
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @var array
+     */
+    private $translations = [];
+
+    /**
+     * @var bool
+     */
+    private $is_initialized = false;
+
+    /**
+     * @var string
+     */
+    private $current_language = null;
+
+    /**
+     * Paths to scan for autoloading languages.
+     *
+     * Languages are automatically loaded for the site or
+     * user's default language.  Plugins can extend or override strings.
+     * language_paths is an array of paths to scan for PHP files matching
+     * the default language.  The order of paths is determined by the plugin load order,
+     * with later entries overriding earlier.  Language files within these paths are
+     * named as the two-letter ISO 639-1 country codes for the language they represent.
+     *
+     * @link http://en.wikipedia.org/wiki/ISO_639-1
+     *
+     * @var array (paths are keys)
+     */
+    private $language_paths = [];
+
+    /**
+     * @var bool
+     */
+    private $was_reloaded = false;
+
+    /**
+     * @var bool
+     */
+    private $loaded_from_cache = false;
+
+    /**
+     * Constructor
+     *
+     * @param Config $config Elgg config
+     */
+    public function __construct(Config $config) {
+        $this->config = $config;
+        $this->defaultPath = dirname(dirname(dirname(dirname(__DIR__)))) . "/languages/";
+    }
+
+    /**
+     * @return bool
+     */
+    public function wasLoadedFromCache() {
+        return $this->loaded_from_cache;
+    }
+
+    /**
+     * Get a map of all loaded translations
+     *
+     * @return array
+     */
+    public function getLoadedTranslations() {
+        return $this->translations;
+    }
+
+    /**
+     * Given a message key, returns an appropriately translated full-text string
+     *
+     * @param string $message_key The short message code
+     * @param array  $args        An array of arguments to pass through vsprintf().
+     * @param string $language    Optionally, the standard language code
+     *                            (defaults to site/user default, then English)
+     *
+     * @return string Either the translated string, the English string,
+     * or the original language string.
+     */
+    public function translate($message_key, array $args = [], $language = "") {
+        if (!is_string($message_key) || strlen($message_key) < 1) {
+            _elgg_services()->logger->warn(
+                '$message_key needs to be a string in ' . __METHOD__ . '(), ' . gettype($message_key) . ' provided'
+            );
+            return '';
+        }
 		
-		if ($this->current_language === null) {
-			$this->current_language = $this->getCurrentLanguage();
-		}
-		if (!$language) {
-			$language = $this->current_language;
-		}
-
-		$this->ensureTranslationsLoaded($language);
-
-		$notice = '';
-		$string = $message_key;
-
-		// avoid dupes without overhead of array_unique
-		$langs[$language] = true;
-		$langs['en'] = true;
-
-		foreach (array_keys($langs) as $try_lang) {
-			if (isset($this->translations[$try_lang][$message_key])) {
-				$string = $this->translations[$try_lang][$message_key];
-
-				// only pass through if we have arguments to allow backward compatibility
-				// with manual sprintf() calls.
-				if ($args) {
-					$string = vsprintf($string, $args);
-				}
-
-				break;
-			} else {
-				$notice = sprintf(
-					'Missing %s translation for "%s" language key',
-					($try_lang === 'en') ? 'English' : $try_lang,
-					$message_key
-				);
-			}
-		}
-
-		if ($notice) {
-			_elgg_services()->logger->notice($notice);
-		}
-
-		return $string;
-	}
-
-	/**
-	 * Add a translation.
-	 *
-	 * Translations are arrays in the Zend Translation array format, eg:
-	 *
-	 *	$english = array('message1' => 'message1', 'message2' => 'message2');
-	 *  $german = array('message1' => 'Nachricht1','message2' => 'Nachricht2');
-	 *
-	 * @param string $country_code   Standard country code (eg 'en', 'nl', 'es')
-	 * @param array  $language_array Formatted array of strings
-	 *
-	 * @return bool Depending on success
-	 */
-	public function addTranslation($country_code, $language_array) {
-		$country_code = strtolower($country_code);
-		$country_code = trim($country_code);
-
-		if (!is_array($language_array) || $country_code === "") {
-			return false;
-		}
-
-		if (count($language_array) > 0) {
-			if (!isset($this->translations[$country_code])) {
-				$this->translations[$country_code] = $language_array;
-			} else {
-				$this->translations[$country_code] = $language_array + $this->translations[$country_code];
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get the current system/user language or "en".
-	 *
-	 * @return string The language code for the site/user or "en" if not set
-	 */
-	public function getCurrentLanguage() {
-		$language = $this->detectLanguage();
-
-		if (!$language) {
-			$language = 'en';
-		}
-
-		return $language;
-	}
-
-	/**
-	 * Detect the current system/user language or false.
-	 *
-	 * @return string The language code (eg "en") or false if not set
-	 */
-	public function detectLanguage() {
-		$url_lang = _elgg_services()->input->get('hl');
-		if ($url_lang) {
-			return $url_lang;
-		}
-
-		$user = _elgg_services()->session->getLoggedInUser();
-		$language = false;
-
-		if (($user) && ($user->language)) {
-			$language = $user->language;
-		}
-
-		if (!$language) {
-			$site_language = $this->config->language;
-			if ($site_language) {
-				$language = $site_language;
-			}
-		}
-
-		return $language ? $language : false;
-	}
-
-	/**
-	 * Load both core and plugin translations
-	 *
-	 * By default this loads only English and the language of the logged
-	 * in user.
-	 *
-	 * The optional $language argument can be used to load translations
-	 * on-demand in case we need to translate something to a language not
-	 * loaded by default for the current request.
-	 *
-	 * @param string $language Language code
-	 * @access private
-	 */
-	public function loadTranslations($language = null) {
-		if (elgg_is_system_cache_enabled()) {
-			$loaded = true;
-
-			if ($language) {
-				$languages = [$language];
-			} else {
-				$languages = array_unique(['en', $this->getCurrentLanguage()]);
-			}
-
-			foreach ($languages as $language) {
-				$data = elgg_load_system_cache("$language.lang");
-				if ($data) {
-					$this->addTranslation($language, unserialize($data));
-				} else {
-					$loaded = false;
-				}
-			}
-
-			if ($loaded) {
-				$this->loaded_from_cache = true;
-				$this->language_paths[$this->defaultPath] = true;
-				$this->is_initialized = true;
-				return;
-			}
-		}
-
-		// load core translations from languages directory
-		$this->registerTranslations($this->defaultPath, false, $language);
-
-		// Plugin translation have already been loaded for the default
-		// languages by ElggApplication::bootCore(), so there's no need
-		// to continue unless loading a specific language on-demand
-		if ($language) {
-			$this->loadPluginTranslations($language);
-		}
-	}
-
-	/**
-	 * Load plugin translations for a language
-	 *
-	 * This is needed only if the current request uses a language
-	 * that is neither English of the same as the language of the
-	 * logged in user.
-	 *
-	 * @param string $language Language code
-	 * @return void
-	 * @throws \PluginException
-	 */
-	private function loadPluginTranslations($language) {
-		// Get active plugins
-		$plugins = _elgg_services()->plugins->find('active');
-
-		if (!$plugins) {
-			// Active plugins were not found, so no need to register plugin translations
-			return;
-		}
-
-		foreach ($plugins as $plugin) {
-			$languages_path = "{$plugin->getPath()}languages/";
-
-			if (!is_dir($languages_path)) {
-				// This plugin doesn't have anything to translate
-				continue;
-			}
-
-			$language_file = "{$languages_path}{$language}.php";
-
-			if (!file_exists($language_file)) {
-				// This plugin doesn't have translations for the requested language
-
-				$name = $plugin->getDisplayName();
-				_elgg_services()->logger->notice("Plugin $name is missing translations for $language language");
-
-				continue;
-			}
-
-			// Register translations from the plugin languages directory
-			if (!$this->registerTranslations($languages_path, false, $language)) {
-				throw new \PluginException(sprintf('Cannot register languages for plugin %s (guid: %s) at %s.',
-					[$plugin->getID(), $plugin->guid, $languages_path]));
-			}
-		}
-	}
-
-	/**
-	 * Registers translations in a directory assuming the standard plugin layout.
-	 *
-	 * @param string $path Without the trailing slash.
-	 *
-	 * @return bool Success
-	 */
-	public function registerPluginTranslations($path) {
-		$languages_path = rtrim($path, "\\/") . "/languages";
-
-		// don't need to have translations
-		if (!is_dir($languages_path)) {
-			return true;
-		}
-
-		return $this->registerTranslations($languages_path);
-	}
-
-	/**
-	 * When given a full path, finds translation files and loads them
-	 *
-	 * @param string $path     Full path
-	 * @param bool   $load_all If true all languages are loaded, if
-	 *                         false only the current language + en are loaded
-	 * @param string $language Language code
-	 *
-	 * @return bool success
-	 */
-	public function registerTranslations($path, $load_all = false, $language = null) {
-		$path = sanitise_filepath($path);
-
-		// Make a note of this path just in case we need to register this language later
-		$this->language_paths[$path] = true;
-		$this->is_initialized = true;
-
-		_elgg_services()->logger->info("Translations loaded from: $path");
-
-		if ($language) {
-			$load_language_files = ["$language.php"];
-			$load_all = false;
-		} else {
-			// Get the current language based on site defaults and user preference
-			$current_language = $this->getCurrentLanguage();
-
-			$load_language_files = [
-				'en.php',
-				"$current_language.php"
-			];
-
-			$load_language_files = array_unique($load_language_files);
-		}
-
-		$handle = opendir($path);
-		if (!$handle) {
-			_elgg_services()->logger->error("Could not open language path: $path");
-			return false;
-		}
-
-		$return = true;
-		while (false !== ($language_file = readdir($handle))) {
-			// ignore bad files
-			if (substr($language_file, 0, 1) == '.' || substr($language_file, -4) !== '.php') {
-				continue;
-			}
-
-			if (in_array($language_file, $load_language_files) || $load_all) {
-				$result = (include $path . $language_file);
-				if ($result === false) {
-					$return = false;
-					continue;
-				} elseif (is_array($result)) {
-					$this->addTranslation(basename($language_file, '.php'), $result);
-				}
-			}
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Reload all translations from all registered paths.
-	 *
-	 * This is only called by functions which need to know all possible translations.
-	 *
-	 * @todo Better on demand loading based on language_paths array
-	 *
-	 * @return void
-	 */
-	public function reloadAllTranslations() {
-		if ($this->was_reloaded) {
-			return;
-		}
-
-		if ($this->loaded_from_cache) {
-			$cache = elgg_get_system_cache();
-			$cache_dir = $cache->getVariable("cache_path");
-			$filenames = elgg_get_file_list($cache_dir, [], [], [".lang"]);
-			foreach ($filenames as $filename) {
-				// Look for files matching for example 'en.lang', 'cmn.lang' or 'pt_br.lang'.
-				// Note that this regex is just for the system cache. The original language
-				// files are allowed to have uppercase letters (e.g. pt_BR.php).
-				if (preg_match('/(([a-z]{2,3})(_[a-z]{2})?)\.lang$/', $filename, $matches)) {
-					$language = $matches[1];
-					$data = elgg_load_system_cache("$language.lang");
-					if ($data) {
-						$this->addTranslation($language, unserialize($data));
-					}
-				}
-			}
-		} else {
-			foreach (array_keys($this->language_paths) as $path) {
-				$this->registerTranslations($path, true);
-			}
-		}
-
-		$this->was_reloaded = true;
-	}
-
-	/**
-	 * Return an array of installed translations as an associative
-	 * array "two letter code" => "native language name".
-	 *
-	 * @return array
-	 */
-	public function getInstalledTranslations() {
-		// Ensure that all possible translations are loaded
-		$this->reloadAllTranslations();
-
-		$installed = [];
-
-		$admin_logged_in = _elgg_services()->session->isAdminLoggedIn();
-
-		foreach ($this->translations as $k => $v) {
-			if ($this->languageKeyExists($k, $k)) {
-				$lang = $this->translate($k, [], $k);
-			} else {
-				$lang = $this->translate($k);
-			}
+        if ($this->current_language === null) {
+            $this->current_language = $this->getCurrentLanguage();
+        }
+        if (!$language) {
+            $language = $this->current_language;
+        }
+
+        $this->ensureTranslationsLoaded($language);
+
+        $notice = '';
+        $string = $message_key;
+
+        // avoid dupes without overhead of array_unique
+        $langs[$language] = true;
+        $langs['en'] = true;
+
+        foreach (array_keys($langs) as $try_lang) {
+            if (isset($this->translations[$try_lang][$message_key])) {
+                $string = $this->translations[$try_lang][$message_key];
+
+                // only pass through if we have arguments to allow backward compatibility
+                // with manual sprintf() calls.
+                if ($args) {
+                    $string = vsprintf($string, $args);
+                }
+
+                break;
+            } else {
+                $notice = sprintf(
+                    'Missing %s translation for "%s" language key',
+                    ($try_lang === 'en') ? 'English' : $try_lang,
+                    $message_key
+                );
+            }
+        }
+
+        if ($notice) {
+            _elgg_services()->logger->notice($notice);
+        }
+
+        return $string;
+    }
+
+    /**
+     * Add a translation.
+     *
+     * Translations are arrays in the Zend Translation array format, eg:
+     *
+     *	$english = array('message1' => 'message1', 'message2' => 'message2');
+     *  $german = array('message1' => 'Nachricht1','message2' => 'Nachricht2');
+     *
+     * @param string $country_code   Standard country code (eg 'en', 'nl', 'es')
+     * @param array  $language_array Formatted array of strings
+     *
+     * @return bool Depending on success
+     */
+    public function addTranslation($country_code, $language_array) {
+        $country_code = strtolower($country_code);
+        $country_code = trim($country_code);
+
+        if (!is_array($language_array) || $country_code === "") {
+            return false;
+        }
+
+        if (count($language_array) > 0) {
+            if (!isset($this->translations[$country_code])) {
+                $this->translations[$country_code] = $language_array;
+            } else {
+                $this->translations[$country_code] = $language_array + $this->translations[$country_code];
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the current system/user language or "en".
+     *
+     * @return string The language code for the site/user or "en" if not set
+     */
+    public function getCurrentLanguage() {
+        $language = $this->detectLanguage();
+
+        if (!$language) {
+            $language = 'en';
+        }
+
+        return $language;
+    }
+
+    /**
+     * Detect the current system/user language or false.
+     *
+     * @return string The language code (eg "en") or false if not set
+     */
+    public function detectLanguage() {
+        $url_lang = _elgg_services()->input->get('hl');
+        if ($url_lang) {
+            return $url_lang;
+        }
+
+        $user = _elgg_services()->session->getLoggedInUser();
+        $language = false;
+
+        if (($user) && ($user->language)) {
+            $language = $user->language;
+        }
+
+        if (!$language) {
+            $site_language = $this->config->language;
+            if ($site_language) {
+                $language = $site_language;
+            }
+        }
+
+        return $language ? $language : false;
+    }
+
+    /**
+     * Load both core and plugin translations
+     *
+     * By default this loads only English and the language of the logged
+     * in user.
+     *
+     * The optional $language argument can be used to load translations
+     * on-demand in case we need to translate something to a language not
+     * loaded by default for the current request.
+     *
+     * @param string $language Language code
+     * @access private
+     */
+    public function loadTranslations($language = null) {
+        if (elgg_is_system_cache_enabled()) {
+            $loaded = true;
+
+            if ($language) {
+                $languages = [$language];
+            } else {
+                $languages = array_unique(['en', $this->getCurrentLanguage()]);
+            }
+
+            foreach ($languages as $language) {
+                $data = elgg_load_system_cache("$language.lang");
+                if ($data) {
+                    $this->addTranslation($language, unserialize($data));
+                } else {
+                    $loaded = false;
+                }
+            }
+
+            if ($loaded) {
+                $this->loaded_from_cache = true;
+                $this->language_paths[$this->defaultPath] = true;
+                $this->is_initialized = true;
+                return;
+            }
+        }
+
+        // load core translations from languages directory
+        $this->registerTranslations($this->defaultPath, false, $language);
+
+        // Plugin translation have already been loaded for the default
+        // languages by ElggApplication::bootCore(), so there's no need
+        // to continue unless loading a specific language on-demand
+        if ($language) {
+            $this->loadPluginTranslations($language);
+        }
+    }
+
+    /**
+     * Load plugin translations for a language
+     *
+     * This is needed only if the current request uses a language
+     * that is neither English of the same as the language of the
+     * logged in user.
+     *
+     * @param string $language Language code
+     * @return void
+     * @throws \PluginException
+     */
+    private function loadPluginTranslations($language) {
+        // Get active plugins
+        $plugins = _elgg_services()->plugins->find('active');
+
+        if (!$plugins) {
+            // Active plugins were not found, so no need to register plugin translations
+            return;
+        }
+
+        foreach ($plugins as $plugin) {
+            $languages_path = "{$plugin->getPath()}languages/";
+
+            if (!is_dir($languages_path)) {
+                // This plugin doesn't have anything to translate
+                continue;
+            }
+
+            $language_file = "{$languages_path}{$language}.php";
+
+            if (!file_exists($language_file)) {
+                // This plugin doesn't have translations for the requested language
+
+                $name = $plugin->getDisplayName();
+                _elgg_services()->logger->notice("Plugin $name is missing translations for $language language");
+
+                continue;
+            }
+
+            // Register translations from the plugin languages directory
+            if (!$this->registerTranslations($languages_path, false, $language)) {
+                throw new \PluginException(sprintf('Cannot register languages for plugin %s (guid: %s) at %s.',
+                    [$plugin->getID(), $plugin->guid, $languages_path]));
+            }
+        }
+    }
+
+    /**
+     * Registers translations in a directory assuming the standard plugin layout.
+     *
+     * @param string $path Without the trailing slash.
+     *
+     * @return bool Success
+     */
+    public function registerPluginTranslations($path) {
+        $languages_path = rtrim($path, "\\/") . "/languages";
+
+        // don't need to have translations
+        if (!is_dir($languages_path)) {
+            return true;
+        }
+
+        return $this->registerTranslations($languages_path);
+    }
+
+    /**
+     * When given a full path, finds translation files and loads them
+     *
+     * @param string $path     Full path
+     * @param bool   $load_all If true all languages are loaded, if
+     *                         false only the current language + en are loaded
+     * @param string $language Language code
+     *
+     * @return bool success
+     */
+    public function registerTranslations($path, $load_all = false, $language = null) {
+        $path = sanitise_filepath($path);
+
+        // Make a note of this path just in case we need to register this language later
+        $this->language_paths[$path] = true;
+        $this->is_initialized = true;
+
+        _elgg_services()->logger->info("Translations loaded from: $path");
+
+        if ($language) {
+            $load_language_files = ["$language.php"];
+            $load_all = false;
+        } else {
+            // Get the current language based on site defaults and user preference
+            $current_language = $this->getCurrentLanguage();
+
+            $load_language_files = [
+                'en.php',
+                "$current_language.php"
+            ];
+
+            $load_language_files = array_unique($load_language_files);
+        }
+
+        $handle = opendir($path);
+        if (!$handle) {
+            _elgg_services()->logger->error("Could not open language path: $path");
+            return false;
+        }
+
+        $return = true;
+        while (false !== ($language_file = readdir($handle))) {
+            // ignore bad files
+            if (substr($language_file, 0, 1) == '.' || substr($language_file, -4) !== '.php') {
+                continue;
+            }
+
+            if (in_array($language_file, $load_language_files) || $load_all) {
+                $result = (include $path . $language_file);
+                if ($result === false) {
+                    $return = false;
+                    continue;
+                } elseif (is_array($result)) {
+                    $this->addTranslation(basename($language_file, '.php'), $result);
+                }
+            }
+        }
+
+        return $return;
+    }
+
+    /**
+     * Reload all translations from all registered paths.
+     *
+     * This is only called by functions which need to know all possible translations.
+     *
+     * @todo Better on demand loading based on language_paths array
+     *
+     * @return void
+     */
+    public function reloadAllTranslations() {
+        if ($this->was_reloaded) {
+            return;
+        }
+
+        if ($this->loaded_from_cache) {
+            $cache = elgg_get_system_cache();
+            $cache_dir = $cache->getVariable("cache_path");
+            $filenames = elgg_get_file_list($cache_dir, [], [], [".lang"]);
+            foreach ($filenames as $filename) {
+                // Look for files matching for example 'en.lang', 'cmn.lang' or 'pt_br.lang'.
+                // Note that this regex is just for the system cache. The original language
+                // files are allowed to have uppercase letters (e.g. pt_BR.php).
+                if (preg_match('/(([a-z]{2,3})(_[a-z]{2})?)\.lang$/', $filename, $matches)) {
+                    $language = $matches[1];
+                    $data = elgg_load_system_cache("$language.lang");
+                    if ($data) {
+                        $this->addTranslation($language, unserialize($data));
+                    }
+                }
+            }
+        } else {
+            foreach (array_keys($this->language_paths) as $path) {
+                $this->registerTranslations($path, true);
+            }
+        }
+
+        $this->was_reloaded = true;
+    }
+
+    /**
+     * Return an array of installed translations as an associative
+     * array "two letter code" => "native language name".
+     *
+     * @return array
+     */
+    public function getInstalledTranslations() {
+        // Ensure that all possible translations are loaded
+        $this->reloadAllTranslations();
+
+        $installed = [];
+
+        $admin_logged_in = _elgg_services()->session->isAdminLoggedIn();
+
+        foreach ($this->translations as $k => $v) {
+            if ($this->languageKeyExists($k, $k)) {
+                $lang = $this->translate($k, [], $k);
+            } else {
+                $lang = $this->translate($k);
+            }
 			
-			$installed[$k] = $lang;
+            $installed[$k] = $lang;
 			
-			if (!$admin_logged_in || ($k === 'en')) {
-				continue;
-			}
+            if (!$admin_logged_in || ($k === 'en')) {
+                continue;
+            }
 			
-			$completeness = $this->getLanguageCompleteness($k);
-			if ($completeness < 100) {
-				$installed[$k] .= " (" . $completeness . "% " . $this->translate('complete') . ")";
-			}
-		}
-
-		return $installed;
-	}
-
-	/**
-	 * Return the level of completeness for a given language code (compared to english)
-	 *
-	 * @param string $language Language
-	 *
-	 * @return int
-	 */
-	public function getLanguageCompleteness($language) {
-
-
-		// Ensure that all possible translations are loaded
-		$this->reloadAllTranslations();
-
-		$language = sanitise_string($language);
-
-		$en = count($this->translations['en']);
-
-		$missing = $this->getMissingLanguageKeys($language);
-		if ($missing) {
-			$missing = count($missing);
-		} else {
-			$missing = 0;
-		}
-
-		$lang = $en - $missing;
-
-		return round(($lang / $en) * 100, 2);
-	}
-
-	/**
-	 * Return the translation keys missing from a given language,
-	 * or those that are identical to the english version.
-	 *
-	 * @param string $language The language
-	 *
-	 * @return mixed
-	 */
-	public function getMissingLanguageKeys($language) {
-
-
-		// Ensure that all possible translations are loaded
-		$this->reloadAllTranslations();
-
-		$missing = [];
-
-		foreach ($this->translations['en'] as $k => $v) {
-			if ((!isset($this->translations[$language][$k]))
-			|| ($this->translations[$language][$k] == $this->translations['en'][$k])) {
-				$missing[] = $k;
-			}
-		}
-
-		if (count($missing)) {
-			return $missing;
-		}
-
-		return false;
-	}
-
-	/**
-	 * Check if a given language key exists
-	 *
-	 * @param string $key      The translation key
-	 * @param string $language The specific language to check
-	 *
-	 * @return bool
-	 * @since 1.11
-	 */
-	function languageKeyExists($key, $language = 'en') {
-		if (empty($key)) {
-			return false;
-		}
-
-		$this->ensureTranslationsLoaded($language);
-
-		if (!array_key_exists($language, $this->translations)) {
-			return false;
-		}
-
-		return array_key_exists($key, $this->translations[$language]);
-	}
-
-	/**
-	 * Make sure translations are loaded
-	 *
-	 * @param string $language Language
-	 * @return void
-	 */
-	private function ensureTranslationsLoaded($language) {
-		if (!$this->is_initialized) {
-			// this means we probably had an exception before translations were initialized
-			$this->registerTranslations($this->defaultPath);
-		}
-
-		if (!isset($this->translations[$language])) {
-			// The language being requested is not the same as the language of the
-			// logged in user, so we will have to load it separately. (Most likely
-			// we're sending a notification and the recipient is using a different
-			// language than the logged in user.)
-			$this->loadTranslations($language);
-		}
-	}
-
-	/**
-	 * Returns an array of language codes.
-	 *
-	 * @return array
-	 */
-	public static function getAllLanguageCodes() {
-		return [
-			"aa", // "Afar"
-			"ab", // "Abkhazian"
-			"af", // "Afrikaans"
-			"am", // "Amharic"
-			"ar", // "Arabic"
-			"as", // "Assamese"
-			"ay", // "Aymara"
-			"az", // "Azerbaijani"
-			"ba", // "Bashkir"
-			"be", // "Byelorussian"
-			"bg", // "Bulgarian"
-			"bh", // "Bihari"
-			"bi", // "Bislama"
-			"bn", // "Bengali; Bangla"
-			"bo", // "Tibetan"
-			"br", // "Breton"
-			"ca", // "Catalan"
-			"cmn", // "Mandarin Chinese" // ISO 639-3
-			"co", // "Corsican"
-			"cs", // "Czech"
-			"cy", // "Welsh"
-			"da", // "Danish"
-			"de", // "German"
-			"dz", // "Bhutani"
-			"el", // "Greek"
-			"en", // "English"
-			"eo", // "Esperanto"
-			"es", // "Spanish"
-			"et", // "Estonian"
-			"eu", // "Basque"
-			"eu_es", // "Basque (Spain)"
-			"fa", // "Persian"
-			"fi", // "Finnish"
-			"fj", // "Fiji"
-			"fo", // "Faeroese"
-			"fr", // "French"
-			"fy", // "Frisian"
-			"ga", // "Irish"
-			"gd", // "Scots / Gaelic"
-			"gl", // "Galician"
-			"gn", // "Guarani"
-			"gu", // "Gujarati"
-			"he", // "Hebrew"
-			"ha", // "Hausa"
-			"hi", // "Hindi"
-			"hr", // "Croatian"
-			"hu", // "Hungarian"
-			"hy", // "Armenian"
-			"ia", // "Interlingua"
-			"id", // "Indonesian"
-			"ie", // "Interlingue"
-			"ik", // "Inupiak"
-			"is", // "Icelandic"
-			"it", // "Italian"
-			"iu", // "Inuktitut"
-			"iw", // "Hebrew (obsolete)"
-			"ja", // "Japanese"
-			"ji", // "Yiddish (obsolete)"
-			"jw", // "Javanese"
-			"ka", // "Georgian"
-			"kk", // "Kazakh"
-			"kl", // "Greenlandic"
-			"km", // "Cambodian"
-			"kn", // "Kannada"
-			"ko", // "Korean"
-			"ks", // "Kashmiri"
-			"ku", // "Kurdish"
-			"ky", // "Kirghiz"
-			"la", // "Latin"
-			"ln", // "Lingala"
-			"lo", // "Laothian"
-			"lt", // "Lithuanian"
-			"lv", // "Latvian/Lettish"
-			"mg", // "Malagasy"
-			"mi", // "Maori"
-			"mk", // "Macedonian"
-			"ml", // "Malayalam"
-			"mn", // "Mongolian"
-			"mo", // "Moldavian"
-			"mr", // "Marathi"
-			"ms", // "Malay"
-			"mt", // "Maltese"
-			"my", // "Burmese"
-			"na", // "Nauru"
-			"ne", // "Nepali"
-			"nl", // "Dutch"
-			"no", // "Norwegian"
-			"oc", // "Occitan"
-			"om", // "(Afan) Oromo"
-			"or", // "Oriya"
-			"pa", // "Punjabi"
-			"pl", // "Polish"
-			"ps", // "Pashto / Pushto"
-			"pt", // "Portuguese"
-			"pt_br", // "Portuguese (Brazil)"
-			"qu", // "Quechua"
-			"rm", // "Rhaeto-Romance"
-			"rn", // "Kirundi"
-			"ro", // "Romanian"
-			"ro_ro", // "Romanian (Romania)"
-			"ru", // "Russian"
-			"rw", // "Kinyarwanda"
-			"sa", // "Sanskrit"
-			"sd", // "Sindhi"
-			"sg", // "Sangro"
-			"sh", // "Serbo-Croatian"
-			"si", // "Singhalese"
-			"sk", // "Slovak"
-			"sl", // "Slovenian"
-			"sm", // "Samoan"
-			"sn", // "Shona"
-			"so", // "Somali"
-			"sq", // "Albanian"
-			"sr", // "Serbian"
-			"sr_latin", // "Serbian (Latin)"
-			"ss", // "Siswati"
-			"st", // "Sesotho"
-			"su", // "Sundanese"
-			"sv", // "Swedish"
-			"sw", // "Swahili"
-			"ta", // "Tamil"
-			"te", // "Tegulu"
-			"tg", // "Tajik"
-			"th", // "Thai"
-			"ti", // "Tigrinya"
-			"tk", // "Turkmen"
-			"tl", // "Tagalog"
-			"tn", // "Setswana"
-			"to", // "Tonga"
-			"tr", // "Turkish"
-			"ts", // "Tsonga"
-			"tt", // "Tatar"
-			"tw", // "Twi"
-			"ug", // "Uigur"
-			"uk", // "Ukrainian"
-			"ur", // "Urdu"
-			"uz", // "Uzbek"
-			"vi", // "Vietnamese"
-			"vo", // "Volapuk"
-			"wo", // "Wolof"
-			"xh", // "Xhosa"
-			"yi", // "Yiddish"
-			"yo", // "Yoruba"
-			"za", // "Zuang"
-			"zh", // "Chinese"
-			"zh_hans", // "Chinese Simplified"
-			"zu", // "Zulu"
-		];
-	}
-
-	/**
-	 * Normalize a language code (e.g. from Transifex)
-	 *
-	 * @param string $code Language code
-	 *
-	 * @return string
-	 */
-	public static function normalizeLanguageCode($code) {
-		$code = strtolower($code);
-		$code = preg_replace('~[^a-z0-9]~', '_', $code);
-		return $code;
-	}
+            $completeness = $this->getLanguageCompleteness($k);
+            if ($completeness < 100) {
+                $installed[$k] .= " (" . $completeness . "% " . $this->translate('complete') . ")";
+            }
+        }
+
+        return $installed;
+    }
+
+    /**
+     * Return the level of completeness for a given language code (compared to english)
+     *
+     * @param string $language Language
+     *
+     * @return int
+     */
+    public function getLanguageCompleteness($language) {
+
+
+        // Ensure that all possible translations are loaded
+        $this->reloadAllTranslations();
+
+        $language = sanitise_string($language);
+
+        $en = count($this->translations['en']);
+
+        $missing = $this->getMissingLanguageKeys($language);
+        if ($missing) {
+            $missing = count($missing);
+        } else {
+            $missing = 0;
+        }
+
+        $lang = $en - $missing;
+
+        return round(($lang / $en) * 100, 2);
+    }
+
+    /**
+     * Return the translation keys missing from a given language,
+     * or those that are identical to the english version.
+     *
+     * @param string $language The language
+     *
+     * @return mixed
+     */
+    public function getMissingLanguageKeys($language) {
+
+
+        // Ensure that all possible translations are loaded
+        $this->reloadAllTranslations();
+
+        $missing = [];
+
+        foreach ($this->translations['en'] as $k => $v) {
+            if ((!isset($this->translations[$language][$k]))
+            || ($this->translations[$language][$k] == $this->translations['en'][$k])) {
+                $missing[] = $k;
+            }
+        }
+
+        if (count($missing)) {
+            return $missing;
+        }
+
+        return false;
+    }
+
+    /**
+     * Check if a given language key exists
+     *
+     * @param string $key      The translation key
+     * @param string $language The specific language to check
+     *
+     * @return bool
+     * @since 1.11
+     */
+    function languageKeyExists($key, $language = 'en') {
+        if (empty($key)) {
+            return false;
+        }
+
+        $this->ensureTranslationsLoaded($language);
+
+        if (!array_key_exists($language, $this->translations)) {
+            return false;
+        }
+
+        return array_key_exists($key, $this->translations[$language]);
+    }
+
+    /**
+     * Make sure translations are loaded
+     *
+     * @param string $language Language
+     * @return void
+     */
+    private function ensureTranslationsLoaded($language) {
+        if (!$this->is_initialized) {
+            // this means we probably had an exception before translations were initialized
+            $this->registerTranslations($this->defaultPath);
+        }
+
+        if (!isset($this->translations[$language])) {
+            // The language being requested is not the same as the language of the
+            // logged in user, so we will have to load it separately. (Most likely
+            // we're sending a notification and the recipient is using a different
+            // language than the logged in user.)
+            $this->loadTranslations($language);
+        }
+    }
+
+    /**
+     * Returns an array of language codes.
+     *
+     * @return array
+     */
+    public static function getAllLanguageCodes() {
+        return [
+            "aa", // "Afar"
+            "ab", // "Abkhazian"
+            "af", // "Afrikaans"
+            "am", // "Amharic"
+            "ar", // "Arabic"
+            "as", // "Assamese"
+            "ay", // "Aymara"
+            "az", // "Azerbaijani"
+            "ba", // "Bashkir"
+            "be", // "Byelorussian"
+            "bg", // "Bulgarian"
+            "bh", // "Bihari"
+            "bi", // "Bislama"
+            "bn", // "Bengali; Bangla"
+            "bo", // "Tibetan"
+            "br", // "Breton"
+            "ca", // "Catalan"
+            "cmn", // "Mandarin Chinese" // ISO 639-3
+            "co", // "Corsican"
+            "cs", // "Czech"
+            "cy", // "Welsh"
+            "da", // "Danish"
+            "de", // "German"
+            "dz", // "Bhutani"
+            "el", // "Greek"
+            "en", // "English"
+            "eo", // "Esperanto"
+            "es", // "Spanish"
+            "et", // "Estonian"
+            "eu", // "Basque"
+            "eu_es", // "Basque (Spain)"
+            "fa", // "Persian"
+            "fi", // "Finnish"
+            "fj", // "Fiji"
+            "fo", // "Faeroese"
+            "fr", // "French"
+            "fy", // "Frisian"
+            "ga", // "Irish"
+            "gd", // "Scots / Gaelic"
+            "gl", // "Galician"
+            "gn", // "Guarani"
+            "gu", // "Gujarati"
+            "he", // "Hebrew"
+            "ha", // "Hausa"
+            "hi", // "Hindi"
+            "hr", // "Croatian"
+            "hu", // "Hungarian"
+            "hy", // "Armenian"
+            "ia", // "Interlingua"
+            "id", // "Indonesian"
+            "ie", // "Interlingue"
+            "ik", // "Inupiak"
+            "is", // "Icelandic"
+            "it", // "Italian"
+            "iu", // "Inuktitut"
+            "iw", // "Hebrew (obsolete)"
+            "ja", // "Japanese"
+            "ji", // "Yiddish (obsolete)"
+            "jw", // "Javanese"
+            "ka", // "Georgian"
+            "kk", // "Kazakh"
+            "kl", // "Greenlandic"
+            "km", // "Cambodian"
+            "kn", // "Kannada"
+            "ko", // "Korean"
+            "ks", // "Kashmiri"
+            "ku", // "Kurdish"
+            "ky", // "Kirghiz"
+            "la", // "Latin"
+            "ln", // "Lingala"
+            "lo", // "Laothian"
+            "lt", // "Lithuanian"
+            "lv", // "Latvian/Lettish"
+            "mg", // "Malagasy"
+            "mi", // "Maori"
+            "mk", // "Macedonian"
+            "ml", // "Malayalam"
+            "mn", // "Mongolian"
+            "mo", // "Moldavian"
+            "mr", // "Marathi"
+            "ms", // "Malay"
+            "mt", // "Maltese"
+            "my", // "Burmese"
+            "na", // "Nauru"
+            "ne", // "Nepali"
+            "nl", // "Dutch"
+            "no", // "Norwegian"
+            "oc", // "Occitan"
+            "om", // "(Afan) Oromo"
+            "or", // "Oriya"
+            "pa", // "Punjabi"
+            "pl", // "Polish"
+            "ps", // "Pashto / Pushto"
+            "pt", // "Portuguese"
+            "pt_br", // "Portuguese (Brazil)"
+            "qu", // "Quechua"
+            "rm", // "Rhaeto-Romance"
+            "rn", // "Kirundi"
+            "ro", // "Romanian"
+            "ro_ro", // "Romanian (Romania)"
+            "ru", // "Russian"
+            "rw", // "Kinyarwanda"
+            "sa", // "Sanskrit"
+            "sd", // "Sindhi"
+            "sg", // "Sangro"
+            "sh", // "Serbo-Croatian"
+            "si", // "Singhalese"
+            "sk", // "Slovak"
+            "sl", // "Slovenian"
+            "sm", // "Samoan"
+            "sn", // "Shona"
+            "so", // "Somali"
+            "sq", // "Albanian"
+            "sr", // "Serbian"
+            "sr_latin", // "Serbian (Latin)"
+            "ss", // "Siswati"
+            "st", // "Sesotho"
+            "su", // "Sundanese"
+            "sv", // "Swedish"
+            "sw", // "Swahili"
+            "ta", // "Tamil"
+            "te", // "Tegulu"
+            "tg", // "Tajik"
+            "th", // "Thai"
+            "ti", // "Tigrinya"
+            "tk", // "Turkmen"
+            "tl", // "Tagalog"
+            "tn", // "Setswana"
+            "to", // "Tonga"
+            "tr", // "Turkish"
+            "ts", // "Tsonga"
+            "tt", // "Tatar"
+            "tw", // "Twi"
+            "ug", // "Uigur"
+            "uk", // "Ukrainian"
+            "ur", // "Urdu"
+            "uz", // "Uzbek"
+            "vi", // "Vietnamese"
+            "vo", // "Volapuk"
+            "wo", // "Wolof"
+            "xh", // "Xhosa"
+            "yi", // "Yiddish"
+            "yo", // "Yoruba"
+            "za", // "Zuang"
+            "zh", // "Chinese"
+            "zh_hans", // "Chinese Simplified"
+            "zu", // "Zulu"
+        ];
+    }
+
+    /**
+     * Normalize a language code (e.g. from Transifex)
+     *
+     * @param string $code Language code
+     *
+     * @return string
+     */
+    public static function normalizeLanguageCode($code) {
+        $code = strtolower($code);
+        $code = preg_replace('~[^a-z0-9]~', '_', $code);
+        return $code;
+    }
 }

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

engine/classes/Elgg/Database/SiteSecret.php

Spacing +1 added lines, -1 removed lines

@@ -108,7 +108,7 @@
 	 * @return SiteSecret
 	 */
 	public static function regenerate(ElggCrypto $crypto, ConfigTable $table) {
-		$key = 'z' . $crypto->getRandomString(31);
+		$key = 'z'.$crypto->getRandomString(31);
 
 		$table->set(self::CONFIG_KEY, $key);
 

Indentation +128 added lines, -128 removed lines

@@ -22,132 +22,132 @@
  */
 class SiteSecret {
 
-	const CONFIG_KEY = '__site_secret__';
-
-	/**
-	 * Constructor
-	 *
-	 * @param string $key Site key (32 hex chars, or "z" and 31 base64 chars)
-	 */
-	public function __construct($key) {
-		$this->key = $key;
-	}
-
-	/**
-	 * @var string
-	 */
-	private $key;
-
-	/**
-	 * Returns the site secret.
-	 *
-	 * Used to generate difficult to guess hashes for sessions and action tokens.
-	 *
-	 * @param bool $raw If true, a binary key will be returned
-	 *
-	 * @return string Site secret.
-	 * @access private
-	 */
-	public function get($raw = false) {
-		if (!$this->key) {
-			throw new \RuntimeException('Secret key is not set');
-		}
-
-		if (!$raw) {
-			return $this->key;
-		}
-
-		// try to return binary key
-		if ($this->key[0] === 'z') {
-			// new keys are "z" + base64URL
-			$base64 = strtr(substr($this->key, 1), '-_', '+/');
-			$key = base64_decode($base64);
-			if ($key !== false) {
-				return $key;
-			}
-
-			// on failure, at least return string key :/
-			return $this->key;
-		}
-
-		// old keys are hex
-		return hex2bin($this->key);
-	}
-
-	/**
-	 * Get the strength of the site secret
-	 *
-	 * If "weak" or "moderate" is returned, this assumes we're running on the same system that created
-	 * the key.
-	 *
-	 * @return string "strong", "moderate", or "weak"
-	 * @access private
-	 */
-	public function getStrength() {
-		$secret = $this->get();
-		if ($secret[0] !== 'z') {
-			$rand_max = getrandmax();
-			if ($rand_max < pow(2, 16)) {
-				return 'weak';
-			}
-			if ($rand_max < pow(2, 32)) {
-				return 'moderate';
-			}
-		}
-		return 'strong';
-	}
-
-	/**
-	 * Initialise the site secret (32 bytes: "z" to indicate format + 186-bit key in Base64 URL)
-	 * and save to config table.
-	 *
-	 * Used during installation or regeneration.
-	 *
-	 * @param ElggCrypto  $crypto Crypto service
-	 * @param ConfigTable $table  Config table
-	 * @return SiteSecret
-	 */
-	public static function regenerate(ElggCrypto $crypto, ConfigTable $table) {
-		$key = 'z' . $crypto->getRandomString(31);
-
-		$table->set(self::CONFIG_KEY, $key);
-
-		return new self($key);
-	}
-
-	/**
-	 * Create from config/storage.
-	 *
-	 * @param ConfigTable $table Config table
-	 *
-	 * @return SiteSecret
-	 * @throws \InstallationException
-	 */
-	public static function fromDatabase(ConfigTable $table) {
-		$key = $table->get(self::CONFIG_KEY);
-		if (!$key) {
-			throw new \InstallationException('Site secret is not in the config table.');
-		}
-
-		return new self($key);
-	}
-
-	/**
-	 * Create from a config value. If successful, the value will be erased from config.
-	 *
-	 * @param ElggConfig $config Config
-	 *
-	 * @return SiteSecret|false
-	 */
-	public static function fromConfig(ElggConfig $config) {
-		$key = $config->{self::CONFIG_KEY};
-		if (!$key) {
-			return false;
-		}
-
-		// Don't leave this sitting around in config, in case it gets dumped
-		unset($config->{self::CONFIG_KEY});
-
-		return new self($key);
-	}
+    const CONFIG_KEY = '__site_secret__';
+
+    /**
+     * Constructor
+     *
+     * @param string $key Site key (32 hex chars, or "z" and 31 base64 chars)
+     */
+    public function __construct($key) {
+        $this->key = $key;
+    }
+
+    /**
+     * @var string
+     */
+    private $key;
+
+    /**
+     * Returns the site secret.
+     *
+     * Used to generate difficult to guess hashes for sessions and action tokens.
+     *
+     * @param bool $raw If true, a binary key will be returned
+     *
+     * @return string Site secret.
+     * @access private
+     */
+    public function get($raw = false) {
+        if (!$this->key) {
+            throw new \RuntimeException('Secret key is not set');
+        }
+
+        if (!$raw) {
+            return $this->key;
+        }
+
+        // try to return binary key
+        if ($this->key[0] === 'z') {
+            // new keys are "z" + base64URL
+            $base64 = strtr(substr($this->key, 1), '-_', '+/');
+            $key = base64_decode($base64);
+            if ($key !== false) {
+                return $key;
+            }
+
+            // on failure, at least return string key :/
+            return $this->key;
+        }
+
+        // old keys are hex
+        return hex2bin($this->key);
+    }
+
+    /**
+     * Get the strength of the site secret
+     *
+     * If "weak" or "moderate" is returned, this assumes we're running on the same system that created
+     * the key.
+     *
+     * @return string "strong", "moderate", or "weak"
+     * @access private
+     */
+    public function getStrength() {
+        $secret = $this->get();
+        if ($secret[0] !== 'z') {
+            $rand_max = getrandmax();
+            if ($rand_max < pow(2, 16)) {
+                return 'weak';
+            }
+            if ($rand_max < pow(2, 32)) {
+                return 'moderate';
+            }
+        }
+        return 'strong';
+    }
+
+    /**
+     * Initialise the site secret (32 bytes: "z" to indicate format + 186-bit key in Base64 URL)
+     * and save to config table.
+     *
+     * Used during installation or regeneration.
+     *
+     * @param ElggCrypto  $crypto Crypto service
+     * @param ConfigTable $table  Config table
+     * @return SiteSecret
+     */
+    public static function regenerate(ElggCrypto $crypto, ConfigTable $table) {
+        $key = 'z' . $crypto->getRandomString(31);
+
+        $table->set(self::CONFIG_KEY, $key);
+
+        return new self($key);
+    }
+
+    /**
+     * Create from config/storage.
+     *
+     * @param ConfigTable $table Config table
+     *
+     * @return SiteSecret
+     * @throws \InstallationException
+     */
+    public static function fromDatabase(ConfigTable $table) {
+        $key = $table->get(self::CONFIG_KEY);
+        if (!$key) {
+            throw new \InstallationException('Site secret is not in the config table.');
+        }
+
+        return new self($key);
+    }
+
+    /**
+     * Create from a config value. If successful, the value will be erased from config.
+     *
+     * @param ElggConfig $config Config
+     *
+     * @return SiteSecret|false
+     */
+    public static function fromConfig(ElggConfig $config) {
+        $key = $config->{self::CONFIG_KEY};
+        if (!$key) {
+            return false;
+        }
+
+        // Don't leave this sitting around in config, in case it gets dumped
+        unset($config->{self::CONFIG_KEY});
+
+        return new self($key);
+    }
 }

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/ElggPlugin.php

Spacing +4 added lines, -4 removed lines

@@ -59,7 +59,7 @@ 
 		if (is_object($path)) {
 			// database object
 			parent::__construct($path);
-			$this->path = _elgg_config()->plugins_path . $this->getID();
+			$this->path = _elgg_config()->plugins_path.$this->getID();
 			_elgg_cache_plugin_by_id($this);
 			return;
 		}
@@ -147,7 +147,7 @@ 
 	 * @deprecated 3.0
 	 */
 	public function getFriendlyName() {
-		elgg_deprecated_notice(__METHOD__ . ' is deprecated. Use getDisplayName().', '3.0');
+		elgg_deprecated_notice(__METHOD__.' is deprecated. Use getDisplayName().', '3.0');
 	
 		return $this->getDisplayName();
 	}
@@ -1233,7 +1233,7 @@ 
 			}
 			$this->manifest = $package->getManifest();
 		} catch (Exception $e) {
-			_elgg_services()->logger->warn("Failed to load manifest for plugin $this->guid. " . $e->getMessage());
+			_elgg_services()->logger->warn("Failed to load manifest for plugin $this->guid. ".$e->getMessage());
 			$this->errorMsg = $e->getmessage();
 		}
 
@@ -1253,7 +1253,7 @@ 
 		try {
 			$this->package = new \ElggPluginPackage($this->path, false);
 		} catch (Exception $e) {
-			_elgg_services()->logger->warn("Failed to load package for $this->guid. " . $e->getMessage());
+			_elgg_services()->logger->warn("Failed to load package for $this->guid. ".$e->getMessage());
 			$this->errorMsg = $e->getmessage();
 		}
 

Indentation +1195 added lines, -1195 removed lines

@@ -12,1252 +12,1252 @@
  * @subpackage Plugins.Settings
  */
 class ElggPlugin extends \ElggObject {
-	private $package;
-	private $manifest;
-
-	/**
-	 * Data from static config file. null if not yet read.
-	 *
-	 * @var array|null
-	 */
-	private $static_config;
-
-	private $path;
-	private $errorMsg = '';
-
-	/**
-	 * Set subtype to 'plugin'
-	 *
-	 * @return void
-	 */
-	protected function initializeAttributes() {
-		parent::initializeAttributes();
-
-		$this->attributes['subtype'] = "plugin";
-
-		// plugins must be public.
-		$this->access_id = ACCESS_PUBLIC;
-	}
-
-	/**
-	 * Creates a new plugin from path
-	 *
-	 * @note Internal: also supports database objects
-	 *
-	 * @warning Unlike other \ElggEntity objects, you cannot null instantiate
-	 *          \ElggPlugin. You must provide the path to the plugin directory.
-	 *
-	 * @param string $path The absolute path of the plugin
-	 *
-	 * @throws PluginException
-	 */
-	public function __construct($path) {
-		if (!$path) {
-			throw new \PluginException("ElggPlugin cannot be null instantiated. You must pass a full path.");
-		}
-
-		if (is_object($path)) {
-			// database object
-			parent::__construct($path);
-			$this->path = _elgg_config()->plugins_path . $this->getID();
-			_elgg_cache_plugin_by_id($this);
-			return;
-		}
-
-		if (is_numeric($path)) {
-			// guid
-			// @todo plugins with directory names of '12345'
-			throw new \InvalidArgumentException('$path cannot be a GUID');
-		}
-
-		$this->initializeAttributes();
-
-		// path checking is done in the package
-		$path = sanitise_filepath($path);
-		$this->path = $path;
-		$path_parts = explode('/', rtrim($path, '/'));
-		$plugin_id = array_pop($path_parts);
-		$this->title = $plugin_id;
-
-		// check if we're loading an existing plugin
-		$existing_plugin = elgg_get_plugin_from_id($plugin_id);
-
-		if ($existing_plugin) {
-			$this->load((object) ['guid' => $existing_plugin->guid]);
-		}
-
-		_elgg_cache_plugin_by_id($this);
-	}
-
-	/**
-	 * Save the plugin object.  Make sure required values exist.
-	 *
-	 * @see \ElggObject::save()
-	 * @return bool
-	 */
-	public function save() {
-		// own by the current site so users can be deleted without affecting plugins
-		$site = elgg_get_site_entity();
-		$this->attributes['owner_guid'] = $site->guid;
-		$this->attributes['container_guid'] = $site->guid;
+    private $package;
+    private $manifest;
+
+    /**
+     * Data from static config file. null if not yet read.
+     *
+     * @var array|null
+     */
+    private $static_config;
+
+    private $path;
+    private $errorMsg = '';
+
+    /**
+     * Set subtype to 'plugin'
+     *
+     * @return void
+     */
+    protected function initializeAttributes() {
+        parent::initializeAttributes();
+
+        $this->attributes['subtype'] = "plugin";
+
+        // plugins must be public.
+        $this->access_id = ACCESS_PUBLIC;
+    }
+
+    /**
+     * Creates a new plugin from path
+     *
+     * @note Internal: also supports database objects
+     *
+     * @warning Unlike other \ElggEntity objects, you cannot null instantiate
+     *          \ElggPlugin. You must provide the path to the plugin directory.
+     *
+     * @param string $path The absolute path of the plugin
+     *
+     * @throws PluginException
+     */
+    public function __construct($path) {
+        if (!$path) {
+            throw new \PluginException("ElggPlugin cannot be null instantiated. You must pass a full path.");
+        }
+
+        if (is_object($path)) {
+            // database object
+            parent::__construct($path);
+            $this->path = _elgg_config()->plugins_path . $this->getID();
+            _elgg_cache_plugin_by_id($this);
+            return;
+        }
+
+        if (is_numeric($path)) {
+            // guid
+            // @todo plugins with directory names of '12345'
+            throw new \InvalidArgumentException('$path cannot be a GUID');
+        }
+
+        $this->initializeAttributes();
+
+        // path checking is done in the package
+        $path = sanitise_filepath($path);
+        $this->path = $path;
+        $path_parts = explode('/', rtrim($path, '/'));
+        $plugin_id = array_pop($path_parts);
+        $this->title = $plugin_id;
+
+        // check if we're loading an existing plugin
+        $existing_plugin = elgg_get_plugin_from_id($plugin_id);
+
+        if ($existing_plugin) {
+            $this->load((object) ['guid' => $existing_plugin->guid]);
+        }
+
+        _elgg_cache_plugin_by_id($this);
+    }
+
+    /**
+     * Save the plugin object.  Make sure required values exist.
+     *
+     * @see \ElggObject::save()
+     * @return bool
+     */
+    public function save() {
+        // own by the current site so users can be deleted without affecting plugins
+        $site = elgg_get_site_entity();
+        $this->attributes['owner_guid'] = $site->guid;
+        $this->attributes['container_guid'] = $site->guid;
 		
-		if (parent::save()) {
-			// make sure we have a priority
-			$priority = $this->getPriority();
-			if ($priority === false || $priority === null) {
-				return $this->setPriority('last');
-			}
-		} else {
-			return false;
-		}
-	}
-
-
-	// Plugin ID and path
-
-	/**
-	 * Returns the ID (dir name) of this plugin
-	 *
-	 * @return string
-	 */
-	public function getID() {
-		return $this->title;
-	}
-
-	/**
-	 * Returns the manifest's name if available, otherwise the ID.
-	 *
-	 * @return string
-	 * @since 3.0
-	 */
-	public function getDisplayName() {
-		$manifest = $this->getManifest();
-		if ($manifest) {
-			return $manifest->getName();
-		}
-
-		return $this->getID();
-	}
-
-	/**
-	 * Returns the manifest's name if available, otherwise the ID.
-	 *
-	 * @return string
-	 * @since 1.8.1
-	 * @deprecated 3.0
-	 */
-	public function getFriendlyName() {
-		elgg_deprecated_notice(__METHOD__ . ' is deprecated. Use getDisplayName().', '3.0');
+        if (parent::save()) {
+            // make sure we have a priority
+            $priority = $this->getPriority();
+            if ($priority === false || $priority === null) {
+                return $this->setPriority('last');
+            }
+        } else {
+            return false;
+        }
+    }
+
+
+    // Plugin ID and path
+
+    /**
+     * Returns the ID (dir name) of this plugin
+     *
+     * @return string
+     */
+    public function getID() {
+        return $this->title;
+    }
+
+    /**
+     * Returns the manifest's name if available, otherwise the ID.
+     *
+     * @return string
+     * @since 3.0
+     */
+    public function getDisplayName() {
+        $manifest = $this->getManifest();
+        if ($manifest) {
+            return $manifest->getName();
+        }
+
+        return $this->getID();
+    }
+
+    /**
+     * Returns the manifest's name if available, otherwise the ID.
+     *
+     * @return string
+     * @since 1.8.1
+     * @deprecated 3.0
+     */
+    public function getFriendlyName() {
+        elgg_deprecated_notice(__METHOD__ . ' is deprecated. Use getDisplayName().', '3.0');
 	
-		return $this->getDisplayName();
-	}
-
-	/**
-	 * Returns the plugin's full path with trailing slash.
-	 *
-	 * @return string
-	 */
-	public function getPath() {
-		return sanitise_filepath($this->path);
-	}
-
-	/**
-	 * Get a value from the plugins's static config file.
-	 *
-	 * @note If the system cache is on, Elgg APIs should not call this on every request.
-	 *
-	 * @param string $key     Config key
-	 * @param mixed  $default Value returned if missing
-	 *
-	 * @return mixed
-	 * @throws PluginException
-	 * @access private
-	 * @internal For Elgg internal use only
-	 */
-	public function getStaticConfig($key, $default = null) {
-		if ($this->static_config === null) {
-			$this->static_config = [];
-
-			if ($this->canReadFile(ElggPluginPackage::STATIC_CONFIG_FILENAME)) {
-				$this->static_config = $this->includeFile(ElggPluginPackage::STATIC_CONFIG_FILENAME);
-			}
-		}
-
-		if (array_key_exists($key, $this->static_config)) {
-			return $this->static_config[$key];
-		} else {
-			return $default;
-		}
-	}
-
-	/**
-	 * Sets the location of this plugin.
-	 *
-	 * @param string $id The path to the plugin's dir.
-	 * @return bool
-	 */
-	public function setID($id) {
-		return $this->attributes['title'] = $id;
-	}
-
-	/**
-	 * Returns an array of available markdown files for this plugin
-	 *
-	 * @return array
-	 */
-	public function getAvailableTextFiles() {
-		$filenames = $this->getPackage()->getTextFilenames();
-
-		$files = [];
-		foreach ($filenames as $filename) {
-			if ($this->canReadFile($filename)) {
-				$files[$filename] = "$this->path/$filename";
-			}
-		}
-
-		return $files;
-	}
-
-	// Load Priority
-
-	/**
-	 * Gets the plugin's load priority.
-	 *
-	 * @return int
-	 */
-	public function getPriority() {
-		$name = _elgg_namespace_plugin_private_setting('internal', 'priority');
-		return $this->getSetting($name);
-	}
-
-	/**
-	 * Sets the priority of the plugin
-	 *
-	 * @param mixed $priority The priority to set. One of +1, -1, first, last, or a number.
-	 *                        If given a number, this will displace all plugins at that number
-	 *                        and set their priorities +1
-	 * @return bool
-	 */
-	public function setPriority($priority) {
-		if (!$this->guid) {
-			return false;
-		}
-
-		$db = $this->getDatabase();
-		$name = _elgg_namespace_plugin_private_setting('internal', 'priority');
-		// if no priority assume a priority of 1
-		$old_priority = (int) $this->getPriority();
-		$old_priority = (!$old_priority) ? 1 : $old_priority;
-		$max_priority = _elgg_get_max_plugin_priority();
-
-		// can't use switch here because it's not strict and
-		// php evaluates +1 == 1
-		if ($priority === '+1') {
-			$priority = $old_priority + 1;
-		} elseif ($priority === '-1') {
-			$priority = $old_priority - 1;
-		} elseif ($priority === 'first') {
-			$priority = 1;
-		} elseif ($priority === 'last') {
-			$priority = $max_priority;
-		}
-
-		// should be a number by now
-		if ($priority > 0) {
-			if (!is_numeric($priority)) {
-				return false;
-			}
-
-			// there's nothing above the max.
-			if ($priority > $max_priority) {
-				$priority = $max_priority;
-			}
-
-			// there's nothing below 1.
-			if ($priority < 1) {
-				$priority = 1;
-			}
-
-			if ($priority > $old_priority) {
-				$op = '-';
-				$where = "CAST(value as unsigned) BETWEEN $old_priority AND $priority";
-			} else {
-				$op = '+';
-				$where = "CAST(value as unsigned) BETWEEN $priority AND $old_priority";
-			}
-
-			// displace the ones affected by this change
-			$q = "UPDATE {$db->prefix}private_settings
+        return $this->getDisplayName();
+    }
+
+    /**
+     * Returns the plugin's full path with trailing slash.
+     *
+     * @return string
+     */
+    public function getPath() {
+        return sanitise_filepath($this->path);
+    }
+
+    /**
+     * Get a value from the plugins's static config file.
+     *
+     * @note If the system cache is on, Elgg APIs should not call this on every request.
+     *
+     * @param string $key     Config key
+     * @param mixed  $default Value returned if missing
+     *
+     * @return mixed
+     * @throws PluginException
+     * @access private
+     * @internal For Elgg internal use only
+     */
+    public function getStaticConfig($key, $default = null) {
+        if ($this->static_config === null) {
+            $this->static_config = [];
+
+            if ($this->canReadFile(ElggPluginPackage::STATIC_CONFIG_FILENAME)) {
+                $this->static_config = $this->includeFile(ElggPluginPackage::STATIC_CONFIG_FILENAME);
+            }
+        }
+
+        if (array_key_exists($key, $this->static_config)) {
+            return $this->static_config[$key];
+        } else {
+            return $default;
+        }
+    }
+
+    /**
+     * Sets the location of this plugin.
+     *
+     * @param string $id The path to the plugin's dir.
+     * @return bool
+     */
+    public function setID($id) {
+        return $this->attributes['title'] = $id;
+    }
+
+    /**
+     * Returns an array of available markdown files for this plugin
+     *
+     * @return array
+     */
+    public function getAvailableTextFiles() {
+        $filenames = $this->getPackage()->getTextFilenames();
+
+        $files = [];
+        foreach ($filenames as $filename) {
+            if ($this->canReadFile($filename)) {
+                $files[$filename] = "$this->path/$filename";
+            }
+        }
+
+        return $files;
+    }
+
+    // Load Priority
+
+    /**
+     * Gets the plugin's load priority.
+     *
+     * @return int
+     */
+    public function getPriority() {
+        $name = _elgg_namespace_plugin_private_setting('internal', 'priority');
+        return $this->getSetting($name);
+    }
+
+    /**
+     * Sets the priority of the plugin
+     *
+     * @param mixed $priority The priority to set. One of +1, -1, first, last, or a number.
+     *                        If given a number, this will displace all plugins at that number
+     *                        and set their priorities +1
+     * @return bool
+     */
+    public function setPriority($priority) {
+        if (!$this->guid) {
+            return false;
+        }
+
+        $db = $this->getDatabase();
+        $name = _elgg_namespace_plugin_private_setting('internal', 'priority');
+        // if no priority assume a priority of 1
+        $old_priority = (int) $this->getPriority();
+        $old_priority = (!$old_priority) ? 1 : $old_priority;
+        $max_priority = _elgg_get_max_plugin_priority();
+
+        // can't use switch here because it's not strict and
+        // php evaluates +1 == 1
+        if ($priority === '+1') {
+            $priority = $old_priority + 1;
+        } elseif ($priority === '-1') {
+            $priority = $old_priority - 1;
+        } elseif ($priority === 'first') {
+            $priority = 1;
+        } elseif ($priority === 'last') {
+            $priority = $max_priority;
+        }
+
+        // should be a number by now
+        if ($priority > 0) {
+            if (!is_numeric($priority)) {
+                return false;
+            }
+
+            // there's nothing above the max.
+            if ($priority > $max_priority) {
+                $priority = $max_priority;
+            }
+
+            // there's nothing below 1.
+            if ($priority < 1) {
+                $priority = 1;
+            }
+
+            if ($priority > $old_priority) {
+                $op = '-';
+                $where = "CAST(value as unsigned) BETWEEN $old_priority AND $priority";
+            } else {
+                $op = '+';
+                $where = "CAST(value as unsigned) BETWEEN $priority AND $old_priority";
+            }
+
+            // displace the ones affected by this change
+            $q = "UPDATE {$db->prefix}private_settings
 				SET value = CAST(value as unsigned) $op 1
 				WHERE entity_guid != $this->guid
 				AND name = '$name'
 				AND $where";
 
-			if (!$db->updateData($q)) {
-				return false;
-			}
-
-			// set this priority
-			if ($this->setPrivateSetting($name, $priority)) {
-				return true;
-			} else {
-				return false;
-			}
-		}
-
-		return false;
-	}
-
-
-	// Plugin settings
-
-	/**
-	 * Returns a plugin setting
-	 *
-	 * @param string $name    The setting name
-	 * @param mixed  $default The default value to return if none is set
-	 * @return mixed
-	 */
-	public function getSetting($name, $default = null) {
-		$values = $this->getAllSettings();
-
-		return elgg_extract($name, $values, $default);
-	}
-
-	/**
-	 * Returns an array of all settings saved for this plugin.
-	 *
-	 * @note Unlike user settings, plugin settings are not namespaced.
-	 *
-	 * @return array An array of key/value pairs.
-	 */
-	public function getAllSettings() {
+            if (!$db->updateData($q)) {
+                return false;
+            }
+
+            // set this priority
+            if ($this->setPrivateSetting($name, $priority)) {
+                return true;
+            } else {
+                return false;
+            }
+        }
+
+        return false;
+    }
+
+
+    // Plugin settings
+
+    /**
+     * Returns a plugin setting
+     *
+     * @param string $name    The setting name
+     * @param mixed  $default The default value to return if none is set
+     * @return mixed
+     */
+    public function getSetting($name, $default = null) {
+        $values = $this->getAllSettings();
+
+        return elgg_extract($name, $values, $default);
+    }
+
+    /**
+     * Returns an array of all settings saved for this plugin.
+     *
+     * @note Unlike user settings, plugin settings are not namespaced.
+     *
+     * @return array An array of key/value pairs.
+     */
+    public function getAllSettings() {
 		
-		$defaults = $this->getStaticConfig('settings', []);
-		$values = _elgg_services()->pluginSettingsCache->getAll($this->guid);
+        $defaults = $this->getStaticConfig('settings', []);
+        $values = _elgg_services()->pluginSettingsCache->getAll($this->guid);
 		
-		if ($values !== null) {
-			return array_merge($defaults, $values);
-		}
+        if ($values !== null) {
+            return array_merge($defaults, $values);
+        }
 
-		if (!$this->guid) {
-			return false;
-		}
+        if (!$this->guid) {
+            return false;
+        }
 
-		$db_prefix = _elgg_config()->dbprefix;
-		// need to remove all namespaced private settings.
-		$us_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+        $db_prefix = _elgg_config()->dbprefix;
+        // need to remove all namespaced private settings.
+        $us_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
 
-		// Get private settings for user
-		$q = "SELECT * FROM {$db_prefix}private_settings
+        // Get private settings for user
+        $q = "SELECT * FROM {$db_prefix}private_settings
 			WHERE entity_guid = $this->guid
 			AND name NOT LIKE '$us_prefix%'";
 
-		$private_settings = $this->getDatabase()->getData($q);
-
-		$return = [];
-
-		if ($private_settings) {
-			foreach ($private_settings as $setting) {
-				$return[$setting->name] = $setting->value;
-			}
-		}
-
-		return array_merge($defaults, $return);
-	}
-
-	/**
-	 * Set a plugin setting for the plugin
-	 *
-	 * @todo This will only work once the plugin has a GUID.
-	 *
-	 * @param string $name  The name to set
-	 * @param string $value The value to set
-	 *
-	 * @return bool
-	 */
-	public function setSetting($name, $value) {
-		if (!$this->guid) {
-			return false;
-		}
+        $private_settings = $this->getDatabase()->getData($q);
+
+        $return = [];
+
+        if ($private_settings) {
+            foreach ($private_settings as $setting) {
+                $return[$setting->name] = $setting->value;
+            }
+        }
+
+        return array_merge($defaults, $return);
+    }
+
+    /**
+     * Set a plugin setting for the plugin
+     *
+     * @todo This will only work once the plugin has a GUID.
+     *
+     * @param string $name  The name to set
+     * @param string $value The value to set
+     *
+     * @return bool
+     */
+    public function setSetting($name, $value) {
+        if (!$this->guid) {
+            return false;
+        }
 		
-		// Hook to validate setting
-		$value = elgg_trigger_plugin_hook('setting', 'plugin', [
-			'plugin_id' => $this->getID(),
-			'plugin' => $this,
-			'name' => $name,
-			'value' => $value,
-		], $value);
+        // Hook to validate setting
+        $value = elgg_trigger_plugin_hook('setting', 'plugin', [
+            'plugin_id' => $this->getID(),
+            'plugin' => $this,
+            'name' => $name,
+            'value' => $value,
+        ], $value);
 		
-		if (is_array($value)) {
-			elgg_log('Plugin settings cannot store arrays.', 'ERROR');
-			return false;
-		}
+        if (is_array($value)) {
+            elgg_log('Plugin settings cannot store arrays.', 'ERROR');
+            return false;
+        }
 		
-		return $this->setPrivateSetting($name, $value);
-	}
-
-	/**
-	 * Removes a plugin setting name and value.
-	 *
-	 * @param string $name The setting name to remove
-	 *
-	 * @return bool
-	 */
-	public function unsetSetting($name) {
-		return remove_private_setting($this->guid, $name);
-	}
-
-	/**
-	 * Removes all settings for this plugin.
-	 *
-	 * @todo Should be a better way to do this without dropping to raw SQL.
-	 * @todo If we could namespace the plugin settings this would be cleaner.
-	 * @todo this shouldn't work because ps_prefix will be empty string
-	 * @return bool
-	 */
-	public function unsetAllSettings() {
-		_elgg_services()->pluginSettingsCache->clear($this->guid);
-		_elgg_services()->boot->invalidateCache();
-
-		$db = $this->getDatabase();
-		$us_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
-		$is_prefix = _elgg_namespace_plugin_private_setting('internal', '', $this->getID());
-
-		$q = "DELETE FROM {$db->prefix}private_settings
+        return $this->setPrivateSetting($name, $value);
+    }
+
+    /**
+     * Removes a plugin setting name and value.
+     *
+     * @param string $name The setting name to remove
+     *
+     * @return bool
+     */
+    public function unsetSetting($name) {
+        return remove_private_setting($this->guid, $name);
+    }
+
+    /**
+     * Removes all settings for this plugin.
+     *
+     * @todo Should be a better way to do this without dropping to raw SQL.
+     * @todo If we could namespace the plugin settings this would be cleaner.
+     * @todo this shouldn't work because ps_prefix will be empty string
+     * @return bool
+     */
+    public function unsetAllSettings() {
+        _elgg_services()->pluginSettingsCache->clear($this->guid);
+        _elgg_services()->boot->invalidateCache();
+
+        $db = $this->getDatabase();
+        $us_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+        $is_prefix = _elgg_namespace_plugin_private_setting('internal', '', $this->getID());
+
+        $q = "DELETE FROM {$db->prefix}private_settings
 			WHERE entity_guid = $this->guid
 			AND name NOT LIKE '$us_prefix%'
 			AND name NOT LIKE '$is_prefix%'";
 
-		return $db->deleteData($q);
-	}
-
-
-	// User settings
-
-	/**
-	 * Returns a user's setting for this plugin
-	 *
-	 * @param string $name      The setting name
-	 * @param int    $user_guid The user GUID
-	 * @param mixed  $default   The default value to return if none is set
-	 *
-	 * @return mixed The setting string value, the default value or false if there is no user
-	 */
-	public function getUserSetting($name, $user_guid = 0, $default = null) {
-		$values = $this->getAllUserSettings($user_guid);
-		if ($values === false) {
-			return false;
-		}
+        return $db->deleteData($q);
+    }
+
+
+    // User settings
+
+    /**
+     * Returns a user's setting for this plugin
+     *
+     * @param string $name      The setting name
+     * @param int    $user_guid The user GUID
+     * @param mixed  $default   The default value to return if none is set
+     *
+     * @return mixed The setting string value, the default value or false if there is no user
+     */
+    public function getUserSetting($name, $user_guid = 0, $default = null) {
+        $values = $this->getAllUserSettings($user_guid);
+        if ($values === false) {
+            return false;
+        }
 		
-		return elgg_extract($name, $values, $default);
-	}
-
-	/**
-	 * Returns an array of all user settings saved for this plugin for the user.
-	 *
-	 * @note Plugin settings are saved with a prefix. This removes that prefix.
-	 *
-	 * @param int $user_guid The user GUID. Defaults to logged in.
-	 * @return array An array of key/value pairs.
-	 */
-	public function getAllUserSettings($user_guid = 0) {
-		$user_guid = (int) $user_guid;
-
-		if ($user_guid) {
-			$user = get_entity($user_guid);
-		} else {
-			$user = _elgg_services()->session->getLoggedInUser();
-		}
-
-		if (!($user instanceof \ElggUser)) {
-			return false;
-		}
-
-		$defaults = $this->getStaticConfig('user_settings', []);
+        return elgg_extract($name, $values, $default);
+    }
+
+    /**
+     * Returns an array of all user settings saved for this plugin for the user.
+     *
+     * @note Plugin settings are saved with a prefix. This removes that prefix.
+     *
+     * @param int $user_guid The user GUID. Defaults to logged in.
+     * @return array An array of key/value pairs.
+     */
+    public function getAllUserSettings($user_guid = 0) {
+        $user_guid = (int) $user_guid;
+
+        if ($user_guid) {
+            $user = get_entity($user_guid);
+        } else {
+            $user = _elgg_services()->session->getLoggedInUser();
+        }
+
+        if (!($user instanceof \ElggUser)) {
+            return false;
+        }
+
+        $defaults = $this->getStaticConfig('user_settings', []);
 		
-		$db_prefix = _elgg_config()->dbprefix;
-		// send an empty name so we just get the first part of the namespace
-		$ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
-		$ps_prefix_len = strlen($ps_prefix);
+        $db_prefix = _elgg_config()->dbprefix;
+        // send an empty name so we just get the first part of the namespace
+        $ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+        $ps_prefix_len = strlen($ps_prefix);
 
-		// Get private settings for user
-		$q = "SELECT * FROM {$db_prefix}private_settings
+        // Get private settings for user
+        $q = "SELECT * FROM {$db_prefix}private_settings
 			WHERE entity_guid = {$user->guid}
 			AND name LIKE '$ps_prefix%'";
 
-		$private_settings = $this->getDatabase()->getData($q);
-
-		$return = [];
-
-		if ($private_settings) {
-			foreach ($private_settings as $setting) {
-				$name = substr($setting->name, $ps_prefix_len);
-				$value = $setting->value;
-
-				$return[$name] = $value;
-			}
-		}
-
-		return array_merge($defaults, $return);
-	}
-
-	/**
-	 * Sets a user setting for a plugin
-	 *
-	 * @param string $name      The setting name
-	 * @param string $value     The setting value
-	 * @param int    $user_guid The user GUID
-	 *
-	 * @return mixed The new setting ID or false
-	 */
-	public function setUserSetting($name, $value, $user_guid = 0) {
-		$user_guid = (int) $user_guid;
-
-		if ($user_guid) {
-			$user = get_entity($user_guid);
-		} else {
-			$user = _elgg_services()->session->getLoggedInUser();
-		}
-
-		if (!($user instanceof \ElggUser)) {
-			return false;
-		}
-
-		// Hook to validate setting
-		// note: this doesn't pass the namespaced name
-		$value = _elgg_services()->hooks->trigger('usersetting', 'plugin', [
-			'user' => $user,
-			'plugin' => $this,
-			'plugin_id' => $this->getID(),
-			'name' => $name,
-			'value' => $value
-		], $value);
+        $private_settings = $this->getDatabase()->getData($q);
+
+        $return = [];
+
+        if ($private_settings) {
+            foreach ($private_settings as $setting) {
+                $name = substr($setting->name, $ps_prefix_len);
+                $value = $setting->value;
+
+                $return[$name] = $value;
+            }
+        }
+
+        return array_merge($defaults, $return);
+    }
+
+    /**
+     * Sets a user setting for a plugin
+     *
+     * @param string $name      The setting name
+     * @param string $value     The setting value
+     * @param int    $user_guid The user GUID
+     *
+     * @return mixed The new setting ID or false
+     */
+    public function setUserSetting($name, $value, $user_guid = 0) {
+        $user_guid = (int) $user_guid;
+
+        if ($user_guid) {
+            $user = get_entity($user_guid);
+        } else {
+            $user = _elgg_services()->session->getLoggedInUser();
+        }
+
+        if (!($user instanceof \ElggUser)) {
+            return false;
+        }
+
+        // Hook to validate setting
+        // note: this doesn't pass the namespaced name
+        $value = _elgg_services()->hooks->trigger('usersetting', 'plugin', [
+            'user' => $user,
+            'plugin' => $this,
+            'plugin_id' => $this->getID(),
+            'name' => $name,
+            'value' => $value
+        ], $value);
 		
-		if (is_array($value)) {
-			elgg_log('Plugin user settings cannot store arrays.', 'ERROR');
-			return false;
-		}
+        if (is_array($value)) {
+            elgg_log('Plugin user settings cannot store arrays.', 'ERROR');
+            return false;
+        }
 		
-		// set the namespaced name.
-		$name = _elgg_namespace_plugin_private_setting('user_setting', $name, $this->getID());
-
-		return set_private_setting($user->guid, $name, $value);
-	}
-
-	/**
-	 * Removes a user setting name and value.
-	 *
-	 * @param string $name      The user setting name
-	 * @param int    $user_guid The user GUID
-	 * @return bool
-	 */
-	public function unsetUserSetting($name, $user_guid = 0) {
-		$user_guid = (int) $user_guid;
-
-		if ($user_guid) {
-			$user = get_entity($user_guid);
-		} else {
-			$user = _elgg_services()->session->getLoggedInUser();
-		}
-
-		if (!($user instanceof \ElggUser)) {
-			return false;
-		}
-
-		// set the namespaced name.
-		$name = _elgg_namespace_plugin_private_setting('user_setting', $name, $this->getID());
-
-		return remove_private_setting($user->guid, $name);
-	}
-
-	/**
-	 * Removes all User Settings for this plugin for a particular user
-	 *
-	 * Use {@link removeAllUsersSettings()} to remove all user
-	 * settings for all users.  (Note the plural 'Users'.)
-	 *
-	 * @warning 0 does not equal logged in user for this method!
-	 * @todo fix that
-	 *
-	 * @param int $user_guid The user GUID to remove user settings.
-	 * @return bool
-	 */
-	public function unsetAllUserSettings($user_guid) {
-		$db = $this->getDatabase();
-		$ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
-
-		$q = "DELETE FROM {$db->prefix}private_settings
+        // set the namespaced name.
+        $name = _elgg_namespace_plugin_private_setting('user_setting', $name, $this->getID());
+
+        return set_private_setting($user->guid, $name, $value);
+    }
+
+    /**
+     * Removes a user setting name and value.
+     *
+     * @param string $name      The user setting name
+     * @param int    $user_guid The user GUID
+     * @return bool
+     */
+    public function unsetUserSetting($name, $user_guid = 0) {
+        $user_guid = (int) $user_guid;
+
+        if ($user_guid) {
+            $user = get_entity($user_guid);
+        } else {
+            $user = _elgg_services()->session->getLoggedInUser();
+        }
+
+        if (!($user instanceof \ElggUser)) {
+            return false;
+        }
+
+        // set the namespaced name.
+        $name = _elgg_namespace_plugin_private_setting('user_setting', $name, $this->getID());
+
+        return remove_private_setting($user->guid, $name);
+    }
+
+    /**
+     * Removes all User Settings for this plugin for a particular user
+     *
+     * Use {@link removeAllUsersSettings()} to remove all user
+     * settings for all users.  (Note the plural 'Users'.)
+     *
+     * @warning 0 does not equal logged in user for this method!
+     * @todo fix that
+     *
+     * @param int $user_guid The user GUID to remove user settings.
+     * @return bool
+     */
+    public function unsetAllUserSettings($user_guid) {
+        $db = $this->getDatabase();
+        $ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+
+        $q = "DELETE FROM {$db->prefix}private_settings
 			WHERE entity_guid = $user_guid
 			AND name LIKE '$ps_prefix%'";
 
-		return $db->deleteData($q);
-	}
-
-	/**
-	 * Removes this plugin's user settings for all users.
-	 *
-	 * Use {@link removeAllUserSettings()} if you just want to remove
-	 * settings for a single user.
-	 *
-	 * @return bool
-	 */
-	public function unsetAllUsersSettings() {
-		$db = $this->getDatabase();
-		$ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
-
-		$q = "DELETE FROM {$db->prefix}private_settings
+        return $db->deleteData($q);
+    }
+
+    /**
+     * Removes this plugin's user settings for all users.
+     *
+     * Use {@link removeAllUserSettings()} if you just want to remove
+     * settings for a single user.
+     *
+     * @return bool
+     */
+    public function unsetAllUsersSettings() {
+        $db = $this->getDatabase();
+        $ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+
+        $q = "DELETE FROM {$db->prefix}private_settings
 			WHERE name LIKE '$ps_prefix%'";
 
-		return $db->deleteData($q);
-	}
-
-
-	// validation
-
-	/**
-	 * Returns if the plugin is complete, meaning has all required files
-	 * and Elgg can read them and they make sense.
-	 *
-	 * @todo bad name? This could be confused with isValid() from \ElggPluginPackage.
-	 *
-	 * @return bool
-	 */
-	public function isValid() {
-		if (!$this->getID()) {
-			$this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:MissingID', [$this->guid]);
-			return false;
-		}
-
-		if (!$this->getPackage() instanceof \ElggPluginPackage) {
-			$this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:NoPluginPackagePackage', [$this->getID(), $this->guid]);
-			return false;
-		}
-
-		if (!$this->getPackage()->isValid()) {
-			$this->errorMsg = $this->getPackage()->getError();
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Is this plugin active?
-	 *
-	 * @return bool
-	 */
-	public function isActive() {
-		if (!$this->guid) {
-			return false;
-		}
-
-		$site = elgg_get_site_entity();
-
-		if (!($site instanceof \ElggSite)) {
-			return false;
-		}
-
-		return check_entity_relationship($this->guid, 'active_plugin', $site->guid);
-	}
-
-	/**
-	 * Checks if this plugin can be activated on the current
-	 * Elgg installation.
-	 *
-	 * @return bool
-	 */
-	public function canActivate() {
-		if ($this->isActive()) {
-			return false;
-		}
-
-		if ($this->getPackage()) {
-			$result = $this->getPackage()->isValid() && $this->getPackage()->checkDependencies();
-			if (!$result) {
-				$this->errorMsg = $this->getPackage()->getError();
-			}
-
-			return $result;
-		}
-
-		return false;
-	}
-
-
-	// activating and deactivating
-
-	/**
-	 * Actives the plugin for the current site.
-	 *
-	 * @return bool
-	 */
-	public function activate() {
-		if ($this->isActive()) {
-			return false;
-		}
-
-		if (!$this->canActivate()) {
-			return false;
-		}
-
-		// Check this before setting status because the file could potentially throw
-		if (!$this->isStaticConfigValid()) {
-			return false;
-		}
-
-		if (!$this->setStatus(true)) {
-			return false;
-		}
-
-		// perform tasks and emit events
-		// emit an event. returning false will make this not be activated.
-		// we need to do this after it's been fully activated
-		// or the deactivate will be confused.
-		$params = [
-			'plugin_id' => $this->getID(),
-			'plugin_entity' => $this,
-		];
-
-		$return = _elgg_services()->hooks->getEvents()->trigger('activate', 'plugin', $params);
-
-		// if there are any on_enable functions, start the plugin now and run them
-		// Note: this will not run re-run the init hooks!
-		if ($return) {
-			$this->activateEntities();
+        return $db->deleteData($q);
+    }
+
+
+    // validation
+
+    /**
+     * Returns if the plugin is complete, meaning has all required files
+     * and Elgg can read them and they make sense.
+     *
+     * @todo bad name? This could be confused with isValid() from \ElggPluginPackage.
+     *
+     * @return bool
+     */
+    public function isValid() {
+        if (!$this->getID()) {
+            $this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:MissingID', [$this->guid]);
+            return false;
+        }
+
+        if (!$this->getPackage() instanceof \ElggPluginPackage) {
+            $this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:NoPluginPackagePackage', [$this->getID(), $this->guid]);
+            return false;
+        }
+
+        if (!$this->getPackage()->isValid()) {
+            $this->errorMsg = $this->getPackage()->getError();
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Is this plugin active?
+     *
+     * @return bool
+     */
+    public function isActive() {
+        if (!$this->guid) {
+            return false;
+        }
+
+        $site = elgg_get_site_entity();
+
+        if (!($site instanceof \ElggSite)) {
+            return false;
+        }
+
+        return check_entity_relationship($this->guid, 'active_plugin', $site->guid);
+    }
+
+    /**
+     * Checks if this plugin can be activated on the current
+     * Elgg installation.
+     *
+     * @return bool
+     */
+    public function canActivate() {
+        if ($this->isActive()) {
+            return false;
+        }
+
+        if ($this->getPackage()) {
+            $result = $this->getPackage()->isValid() && $this->getPackage()->checkDependencies();
+            if (!$result) {
+                $this->errorMsg = $this->getPackage()->getError();
+            }
+
+            return $result;
+        }
+
+        return false;
+    }
+
+
+    // activating and deactivating
+
+    /**
+     * Actives the plugin for the current site.
+     *
+     * @return bool
+     */
+    public function activate() {
+        if ($this->isActive()) {
+            return false;
+        }
+
+        if (!$this->canActivate()) {
+            return false;
+        }
+
+        // Check this before setting status because the file could potentially throw
+        if (!$this->isStaticConfigValid()) {
+            return false;
+        }
+
+        if (!$this->setStatus(true)) {
+            return false;
+        }
+
+        // perform tasks and emit events
+        // emit an event. returning false will make this not be activated.
+        // we need to do this after it's been fully activated
+        // or the deactivate will be confused.
+        $params = [
+            'plugin_id' => $this->getID(),
+            'plugin_entity' => $this,
+        ];
+
+        $return = _elgg_services()->hooks->getEvents()->trigger('activate', 'plugin', $params);
+
+        // if there are any on_enable functions, start the plugin now and run them
+        // Note: this will not run re-run the init hooks!
+        if ($return) {
+            $this->activateEntities();
 			
-			if ($this->canReadFile('activate.php')) {
-				$flags = ELGG_PLUGIN_INCLUDE_START | ELGG_PLUGIN_REGISTER_CLASSES |
-						ELGG_PLUGIN_REGISTER_LANGUAGES | ELGG_PLUGIN_REGISTER_VIEWS | ELGG_PLUGIN_REGISTER_WIDGETS | ELGG_PLUGIN_REGISTER_ACTIONS;
+            if ($this->canReadFile('activate.php')) {
+                $flags = ELGG_PLUGIN_INCLUDE_START | ELGG_PLUGIN_REGISTER_CLASSES |
+                        ELGG_PLUGIN_REGISTER_LANGUAGES | ELGG_PLUGIN_REGISTER_VIEWS | ELGG_PLUGIN_REGISTER_WIDGETS | ELGG_PLUGIN_REGISTER_ACTIONS;
 
-				$this->start($flags);
+                $this->start($flags);
 
-				$return = $this->includeFile('activate.php');
-			}
-		}
+                $return = $this->includeFile('activate.php');
+            }
+        }
 
-		if ($return === false) {
-			$this->deactivate();
-		}
+        if ($return === false) {
+            $this->deactivate();
+        }
 
-		_elgg_services()->hooks->getEvents()->trigger('cache:flush', 'system');
+        _elgg_services()->hooks->getEvents()->trigger('cache:flush', 'system');
 		
-		return $return;
-	}
-
-	/**
-	 * Checks if this plugin can be deactivated on the current
-	 * Elgg installation. Validates that this plugin has no
-	 * active dependants.
-	 *
-	 * @return bool
-	 */
-	public function canDeactivate() {
-		if (!$this->isActive()) {
-			return false;
-		}
-
-		$dependents = [];
-
-		$active_plugins = elgg_get_plugins();
-
-		foreach ($active_plugins as $plugin) {
-			$manifest = $plugin->getManifest();
-			if (!$manifest) {
-				return true;
-			}
-			$requires = $manifest->getRequires();
-
-			foreach ($requires as $required) {
-				if ($required['type'] == 'plugin' && $required['name'] == $this->getID()) {
-					// there are active dependents
-					$dependents[$manifest->getPluginID()] = $plugin;
-				}
-			}
-		}
-
-		if (!empty($dependents)) {
-			$list = array_map(function(\ElggPlugin $plugin) {
-				$css_id = preg_replace('/[^a-z0-9-]/i', '-', $plugin->getManifest()->getID());
-				return elgg_view('output/url', [
-					'text' => $plugin->getDisplayName(),
-					'href' => "#$css_id",
-				]);
-			}, $dependents);
-			$name = $this->getDisplayName();
-			$list = implode(', ', $list);
-			$this->errorMsg = elgg_echo('ElggPlugin:Dependencies:ActiveDependent', [$name, $list]);
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Deactivates the plugin.
-	 *
-	 * @return bool
-	 */
-	public function deactivate() {
-		if (!$this->isActive()) {
-			return false;
-		}
-
-		if (!$this->canDeactivate()) {
-			return false;
-		}
+        return $return;
+    }
+
+    /**
+     * Checks if this plugin can be deactivated on the current
+     * Elgg installation. Validates that this plugin has no
+     * active dependants.
+     *
+     * @return bool
+     */
+    public function canDeactivate() {
+        if (!$this->isActive()) {
+            return false;
+        }
+
+        $dependents = [];
+
+        $active_plugins = elgg_get_plugins();
+
+        foreach ($active_plugins as $plugin) {
+            $manifest = $plugin->getManifest();
+            if (!$manifest) {
+                return true;
+            }
+            $requires = $manifest->getRequires();
+
+            foreach ($requires as $required) {
+                if ($required['type'] == 'plugin' && $required['name'] == $this->getID()) {
+                    // there are active dependents
+                    $dependents[$manifest->getPluginID()] = $plugin;
+                }
+            }
+        }
+
+        if (!empty($dependents)) {
+            $list = array_map(function(\ElggPlugin $plugin) {
+                $css_id = preg_replace('/[^a-z0-9-]/i', '-', $plugin->getManifest()->getID());
+                return elgg_view('output/url', [
+                    'text' => $plugin->getDisplayName(),
+                    'href' => "#$css_id",
+                ]);
+            }, $dependents);
+            $name = $this->getDisplayName();
+            $list = implode(', ', $list);
+            $this->errorMsg = elgg_echo('ElggPlugin:Dependencies:ActiveDependent', [$name, $list]);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Deactivates the plugin.
+     *
+     * @return bool
+     */
+    public function deactivate() {
+        if (!$this->isActive()) {
+            return false;
+        }
+
+        if (!$this->canDeactivate()) {
+            return false;
+        }
 		
-		// emit an event. returning false will cause this to not be deactivated.
-		$params = [
-			'plugin_id' => $this->getID(),
-			'plugin_entity' => $this,
-		];
-
-		$return = _elgg_services()->hooks->getEvents()->trigger('deactivate', 'plugin', $params);
-
-		// run any deactivate code
-		if ($return) {
-			if ($this->canReadFile('deactivate.php')) {
-				$return = $this->includeFile('deactivate.php');
-			}
+        // emit an event. returning false will cause this to not be deactivated.
+        $params = [
+            'plugin_id' => $this->getID(),
+            'plugin_entity' => $this,
+        ];
+
+        $return = _elgg_services()->hooks->getEvents()->trigger('deactivate', 'plugin', $params);
+
+        // run any deactivate code
+        if ($return) {
+            if ($this->canReadFile('deactivate.php')) {
+                $return = $this->includeFile('deactivate.php');
+            }
 			
-			$this->deactivateEntities();
-		}
-
-		if ($return === false) {
-			return false;
-		} else {
-			_elgg_services()->hooks->getEvents()->trigger('cache:flush', 'system');
-			return $this->setStatus(false);
-		}
-	}
-
-	/**
-	 * Start the plugin.
-	 *
-	 * @param int $flags Start flags for the plugin. See the constants in lib/plugins.php for details.
-	 * @return true
-	 * @throws PluginException
-	 */
-	public function start($flags) {
-
-		// include classes
-		if ($flags & ELGG_PLUGIN_REGISTER_CLASSES) {
-			$this->registerClasses();
+            $this->deactivateEntities();
+        }
+
+        if ($return === false) {
+            return false;
+        } else {
+            _elgg_services()->hooks->getEvents()->trigger('cache:flush', 'system');
+            return $this->setStatus(false);
+        }
+    }
+
+    /**
+     * Start the plugin.
+     *
+     * @param int $flags Start flags for the plugin. See the constants in lib/plugins.php for details.
+     * @return true
+     * @throws PluginException
+     */
+    public function start($flags) {
+
+        // include classes
+        if ($flags & ELGG_PLUGIN_REGISTER_CLASSES) {
+            $this->registerClasses();
 			
-			$autoload_file = 'vendor/autoload.php';
-			if ($this->canReadFile($autoload_file)) {
-				require_once "{$this->path}/{$autoload_file}";
-			}
-		}
-
-		// include languages
-		if ($flags & ELGG_PLUGIN_REGISTER_LANGUAGES) {
-			// should be loaded before the first function that touches the static config (elgg-plugin.php)
-			// so translations can be used... for example in registering widgets
-			$this->registerLanguages();
-		}
+            $autoload_file = 'vendor/autoload.php';
+            if ($this->canReadFile($autoload_file)) {
+                require_once "{$this->path}/{$autoload_file}";
+            }
+        }
+
+        // include languages
+        if ($flags & ELGG_PLUGIN_REGISTER_LANGUAGES) {
+            // should be loaded before the first function that touches the static config (elgg-plugin.php)
+            // so translations can be used... for example in registering widgets
+            $this->registerLanguages();
+        }
 		
-		// include start file if it exists
-		if ($flags & ELGG_PLUGIN_INCLUDE_START) {
-			if ($this->canReadFile('start.php')) {
-				$this->includeFile('start.php');
-			}
+        // include start file if it exists
+        if ($flags & ELGG_PLUGIN_INCLUDE_START) {
+            if ($this->canReadFile('start.php')) {
+                $this->includeFile('start.php');
+            }
 			
-			$this->registerEntities();
-		}
+            $this->registerEntities();
+        }
 		
-		// include views
-		if ($flags & ELGG_PLUGIN_REGISTER_VIEWS) {
-			$this->registerViews();
-		}
-
-		// include actions
-		if ($flags & ELGG_PLUGIN_REGISTER_ACTIONS) {
-			$this->registerActions();
-		}
-
-		// include widgets
-		if ($flags & ELGG_PLUGIN_REGISTER_WIDGETS) {
-			// should load after views because those are used during registration
-			$this->registerWidgets();
-		}
-
-		return true;
-	}
-
-	/**
-	 * Includes one of the plugins files
-	 *
-	 * @param string $filename The name of the file
-	 *
-	 * @throws PluginException
-	 * @return mixed The return value of the included file (or 1 if there is none)
-	 */
-	protected function includeFile($filename) {
-		$filepath = "$this->path/$filename";
-
-		if (!$this->canReadFile($filename)) {
-			$msg = _elgg_services()->translator->translate('ElggPlugin:Exception:CannotIncludeFile',
-							[$filename, $this->getID(), $this->guid, $this->path]);
-			throw new \PluginException($msg);
-		}
-
-		try {
-			$ret = include $filepath;
-		} catch (Exception $e) {
-			$msg = _elgg_services()->translator->translate('ElggPlugin:Exception:IncludeFileThrew',
-				[$filename, $this->getID(), $this->guid, $this->path]);
-			throw new \PluginException($msg, 0, $e);
-		}
-
-		return $ret;
-	}
-
-	/**
-	 * Checks whether a plugin file with the given name exists
-	 *
-	 * @param string $filename The name of the file
-	 * @return bool
-	 */
-	protected function canReadFile($filename) {
-		$path = "{$this->path}/$filename";
-		return is_file($path) && is_readable($path);
-	}
-
-	/**
-	 * If a static config file is present, is it a serializable array?
-	 *
-	 * @return bool
-	 * @throws PluginException
-	 */
-	private function isStaticConfigValid() {
-		if (!$this->canReadFile(ElggPluginPackage::STATIC_CONFIG_FILENAME)) {
-			return true;
-		}
-
-		ob_start();
-		$value = $this->includeFile(ElggPluginPackage::STATIC_CONFIG_FILENAME);
-		if (ob_get_clean() !== '') {
-			$this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:activate:ConfigSentOutput');
-			return false;
-		}
-
-		// make sure can serialize
-		$value = @unserialize(serialize($value));
-		if (!is_array($value)) {
-			$this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:activate:BadConfigFormat');
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Registers the plugin's views
-	 *
-	 * @throws PluginException
-	 * @return void
-	 */
-	protected function registerViews() {
-		$views = _elgg_services()->views;
-
-		// Declared views first
-		$file = "{$this->path}/views.php";
-		if (is_file($file)) {
-			$spec = Includer::includeFile($file);
-			if (is_array($spec)) {
-				$views->mergeViewsSpec($spec);
-			}
-		}
-
-		$spec = $this->getStaticConfig('views');
-		if ($spec) {
-			$views->mergeViewsSpec($spec);
-		}
-
-		// Allow /views directory files to override
-		if (!$views->registerPluginViews($this->path, $failed_dir)) {
-			$key = 'ElggPlugin:Exception:CannotRegisterViews';
-			$args = [$this->getID(), $this->guid, $failed_dir];
-			$msg = _elgg_services()->translator->translate($key, $args);
-			throw new \PluginException($msg);
-		}
-	}
-
-	/**
-	 * Registers the plugin's entities
-	 *
-	 * @return void
-	 */
-	protected function registerEntities() {
-
-		$spec = (array) $this->getStaticConfig('entities', []);
-		if (empty($spec)) {
-			return;
-		}
+        // include views
+        if ($flags & ELGG_PLUGIN_REGISTER_VIEWS) {
+            $this->registerViews();
+        }
+
+        // include actions
+        if ($flags & ELGG_PLUGIN_REGISTER_ACTIONS) {
+            $this->registerActions();
+        }
+
+        // include widgets
+        if ($flags & ELGG_PLUGIN_REGISTER_WIDGETS) {
+            // should load after views because those are used during registration
+            $this->registerWidgets();
+        }
+
+        return true;
+    }
+
+    /**
+     * Includes one of the plugins files
+     *
+     * @param string $filename The name of the file
+     *
+     * @throws PluginException
+     * @return mixed The return value of the included file (or 1 if there is none)
+     */
+    protected function includeFile($filename) {
+        $filepath = "$this->path/$filename";
+
+        if (!$this->canReadFile($filename)) {
+            $msg = _elgg_services()->translator->translate('ElggPlugin:Exception:CannotIncludeFile',
+                            [$filename, $this->getID(), $this->guid, $this->path]);
+            throw new \PluginException($msg);
+        }
+
+        try {
+            $ret = include $filepath;
+        } catch (Exception $e) {
+            $msg = _elgg_services()->translator->translate('ElggPlugin:Exception:IncludeFileThrew',
+                [$filename, $this->getID(), $this->guid, $this->path]);
+            throw new \PluginException($msg, 0, $e);
+        }
+
+        return $ret;
+    }
+
+    /**
+     * Checks whether a plugin file with the given name exists
+     *
+     * @param string $filename The name of the file
+     * @return bool
+     */
+    protected function canReadFile($filename) {
+        $path = "{$this->path}/$filename";
+        return is_file($path) && is_readable($path);
+    }
+
+    /**
+     * If a static config file is present, is it a serializable array?
+     *
+     * @return bool
+     * @throws PluginException
+     */
+    private function isStaticConfigValid() {
+        if (!$this->canReadFile(ElggPluginPackage::STATIC_CONFIG_FILENAME)) {
+            return true;
+        }
+
+        ob_start();
+        $value = $this->includeFile(ElggPluginPackage::STATIC_CONFIG_FILENAME);
+        if (ob_get_clean() !== '') {
+            $this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:activate:ConfigSentOutput');
+            return false;
+        }
+
+        // make sure can serialize
+        $value = @unserialize(serialize($value));
+        if (!is_array($value)) {
+            $this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:activate:BadConfigFormat');
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Registers the plugin's views
+     *
+     * @throws PluginException
+     * @return void
+     */
+    protected function registerViews() {
+        $views = _elgg_services()->views;
+
+        // Declared views first
+        $file = "{$this->path}/views.php";
+        if (is_file($file)) {
+            $spec = Includer::includeFile($file);
+            if (is_array($spec)) {
+                $views->mergeViewsSpec($spec);
+            }
+        }
+
+        $spec = $this->getStaticConfig('views');
+        if ($spec) {
+            $views->mergeViewsSpec($spec);
+        }
+
+        // Allow /views directory files to override
+        if (!$views->registerPluginViews($this->path, $failed_dir)) {
+            $key = 'ElggPlugin:Exception:CannotRegisterViews';
+            $args = [$this->getID(), $this->guid, $failed_dir];
+            $msg = _elgg_services()->translator->translate($key, $args);
+            throw new \PluginException($msg);
+        }
+    }
+
+    /**
+     * Registers the plugin's entities
+     *
+     * @return void
+     */
+    protected function registerEntities() {
+
+        $spec = (array) $this->getStaticConfig('entities', []);
+        if (empty($spec)) {
+            return;
+        }
 		
-		foreach ($spec as $entity) {
-			if (isset($entity['type'], $entity['subtype'], $entity['searchable']) && $entity['searchable']) {
-				elgg_register_entity_type($entity['type'], $entity['subtype']);
-			}
-		}
-	}
-
-	/**
-	 * Registers the plugin's actions provided in the plugin config file
-	 *
-	 * @return void
-	 */
-	protected function registerActions() {
-		self::addActionsFromStaticConfig($this->getStaticConfig('actions', []), $this->getPath());
-	}
-
-	/**
-	 * Register a plugin's actions provided in the config file
-	 *
-	 * @todo move to a static config service
-	 *
-	 * @param array  $spec      'actions' section of static config
-	 * @param string $root_path Plugin path
-	 *
-	 * @return void
-	 * @access private
-	 * @internal
-	 */
-	public static function addActionsFromStaticConfig(array $spec, $root_path) {
-		$actions = _elgg_services()->actions;
-		$root_path = rtrim($root_path, '/\\');
-
-		foreach ($spec as $action => $action_spec) {
-			if (!is_array($action_spec)) {
-				continue;
-			}
-
-			$options = [
-				'access' => 'logged_in',
-				'filename' => '', // assuming core action is registered
-			];
-
-			$options = array_merge($options, $action_spec);
-
-			$filename = "$root_path/actions/{$action}.php";
-			if (is_file($filename)) {
-				$options['filename'] = $filename;
-			}
-
-			$actions->register($action, $options['filename'], $options['access']);
-		}
-	}
-
-	/**
-	 * Registers the plugin's widgets provided in the plugin config file
-	 *
-	 * @throws PluginException
-	 * @return void
-	 */
-	protected function registerWidgets() {
-		$widgets = _elgg_services()->widgets;
+        foreach ($spec as $entity) {
+            if (isset($entity['type'], $entity['subtype'], $entity['searchable']) && $entity['searchable']) {
+                elgg_register_entity_type($entity['type'], $entity['subtype']);
+            }
+        }
+    }
+
+    /**
+     * Registers the plugin's actions provided in the plugin config file
+     *
+     * @return void
+     */
+    protected function registerActions() {
+        self::addActionsFromStaticConfig($this->getStaticConfig('actions', []), $this->getPath());
+    }
+
+    /**
+     * Register a plugin's actions provided in the config file
+     *
+     * @todo move to a static config service
+     *
+     * @param array  $spec      'actions' section of static config
+     * @param string $root_path Plugin path
+     *
+     * @return void
+     * @access private
+     * @internal
+     */
+    public static function addActionsFromStaticConfig(array $spec, $root_path) {
+        $actions = _elgg_services()->actions;
+        $root_path = rtrim($root_path, '/\\');
+
+        foreach ($spec as $action => $action_spec) {
+            if (!is_array($action_spec)) {
+                continue;
+            }
+
+            $options = [
+                'access' => 'logged_in',
+                'filename' => '', // assuming core action is registered
+            ];
+
+            $options = array_merge($options, $action_spec);
+
+            $filename = "$root_path/actions/{$action}.php";
+            if (is_file($filename)) {
+                $options['filename'] = $filename;
+            }
+
+            $actions->register($action, $options['filename'], $options['access']);
+        }
+    }
+
+    /**
+     * Registers the plugin's widgets provided in the plugin config file
+     *
+     * @throws PluginException
+     * @return void
+     */
+    protected function registerWidgets() {
+        $widgets = _elgg_services()->widgets;
 		
-		$spec = (array) $this->getStaticConfig('widgets', []);
-		foreach ($spec as $widget_id => $widget_definition) {
-			if (!is_array($widget_definition)) {
-				continue;
-			}
-			if (!isset($widget_definition['id'])) {
-				$widget_definition['id'] = $widget_id;
-			}
+        $spec = (array) $this->getStaticConfig('widgets', []);
+        foreach ($spec as $widget_id => $widget_definition) {
+            if (!is_array($widget_definition)) {
+                continue;
+            }
+            if (!isset($widget_definition['id'])) {
+                $widget_definition['id'] = $widget_id;
+            }
 			
-			$definition = \Elgg\WidgetDefinition::factory($widget_definition);
+            $definition = \Elgg\WidgetDefinition::factory($widget_definition);
 			
-			$widgets->registerType($definition);
-		}
-	}
-
-	/**
-	 * Registers the plugin's languages
-	 *
-	 * @throws PluginException
-	 * @return true
-	 */
-	protected function registerLanguages() {
-		return _elgg_services()->translator->registerPluginTranslations($this->path);
-	}
-
-	/**
-	 * Registers the plugin's classes
-	 *
-	 * @throws PluginException
-	 * @return true
-	 */
-	protected function registerClasses() {
-		$classes_path = "$this->path/classes";
-
-		if (is_dir($classes_path)) {
-			_elgg_services()->autoloadManager->addClasses($classes_path);
-		}
-
-		return true;
-	}
-
-	/**
-	 * Activates the plugin's entities
-	 *
-	 * @return void
-	 */
-	protected function activateEntities() {
-		$spec = (array) $this->getStaticConfig('entities', []);
-		if (empty($spec)) {
-			return;
-		}
+            $widgets->registerType($definition);
+        }
+    }
+
+    /**
+     * Registers the plugin's languages
+     *
+     * @throws PluginException
+     * @return true
+     */
+    protected function registerLanguages() {
+        return _elgg_services()->translator->registerPluginTranslations($this->path);
+    }
+
+    /**
+     * Registers the plugin's classes
+     *
+     * @throws PluginException
+     * @return true
+     */
+    protected function registerClasses() {
+        $classes_path = "$this->path/classes";
+
+        if (is_dir($classes_path)) {
+            _elgg_services()->autoloadManager->addClasses($classes_path);
+        }
+
+        return true;
+    }
+
+    /**
+     * Activates the plugin's entities
+     *
+     * @return void
+     */
+    protected function activateEntities() {
+        $spec = (array) $this->getStaticConfig('entities', []);
+        if (empty($spec)) {
+            return;
+        }
 		
-		foreach ($spec as $entity) {
-			if (isset($entity['type'], $entity['subtype'], $entity['class'])) {
-				if (get_subtype_id($entity['type'], $entity['subtype'])) {
-					update_subtype($entity['type'], $entity['subtype'], $entity['class']);
-				} else {
-					add_subtype($entity['type'], $entity['subtype'], $entity['class']);
-				}
-			}
-		}
-	}
-
-	/**
-	 * Deactivates the plugin's entities
-	 *
-	 * @return void
-	 */
-	protected function deactivateEntities() {
-		$spec = (array) $this->getStaticConfig('entities', []);
-		if (empty($spec)) {
-			return;
-		}
+        foreach ($spec as $entity) {
+            if (isset($entity['type'], $entity['subtype'], $entity['class'])) {
+                if (get_subtype_id($entity['type'], $entity['subtype'])) {
+                    update_subtype($entity['type'], $entity['subtype'], $entity['class']);
+                } else {
+                    add_subtype($entity['type'], $entity['subtype'], $entity['class']);
+                }
+            }
+        }
+    }
+
+    /**
+     * Deactivates the plugin's entities
+     *
+     * @return void
+     */
+    protected function deactivateEntities() {
+        $spec = (array) $this->getStaticConfig('entities', []);
+        if (empty($spec)) {
+            return;
+        }
 		
-		foreach ($spec as $entity) {
-			if (isset($entity['type'], $entity['subtype'], $entity['class'])) {
-				update_subtype($entity['type'], $entity['subtype']);
-			}
-		}
-	}
-
-	/**
-	 * Get an attribute or private setting value
-	 *
-	 * @param string $name Name of the attribute or private setting
-	 * @return mixed
-	 */
-	public function __get($name) {
-		// See if its in our base attribute
-		if (array_key_exists($name, $this->attributes)) {
-			return $this->attributes[$name];
-		}
-
-		$result = $this->getPrivateSetting($name);
-		if ($result !== null) {
-			return $result;
-		}
-		$defaults = $this->getStaticConfig('settings', []);
-		return elgg_extract($name, $defaults, $result);
-	}
-
-	/**
-	 * Set a value as private setting or attribute.
-	 *
-	 * Attributes include title and description.
-	 *
-	 * @param string $name  Name of the attribute or private_setting
-	 * @param mixed  $value Value to be set
-	 * @return void
-	 */
-	public function __set($name, $value) {
-		if (array_key_exists($name, $this->attributes)) {
-			// Check that we're not trying to change the guid!
-			if ((array_key_exists('guid', $this->attributes)) && ($name == 'guid')) {
-				return;
-			}
-
-			$this->attributes[$name] = $value;
-		} else {
-			// to make sure we trigger the correct hooks
-			$this->setSetting($name, $value);
-		}
-	}
-
-	/**
-	 * Sets the plugin to active or inactive.
-	 *
-	 * @param bool $active Set to active or inactive
-	 *
-	 * @return bool
-	 */
-	private function setStatus($active) {
-		if (!$this->guid) {
-			return false;
-		}
-
-		$site = elgg_get_site_entity();
-		if ($active) {
-			$result = add_entity_relationship($this->guid, 'active_plugin', $site->guid);
-		} else {
-			$result = remove_entity_relationship($this->guid, 'active_plugin', $site->guid);
-		}
-
-		_elgg_invalidate_plugins_provides_cache();
-		_elgg_services()->boot->invalidateCache();
-
-		return $result;
-	}
-
-	/**
-	 * Returns the last error message registered.
-	 *
-	 * @return string|null
-	 */
-	public function getError() {
-		return $this->errorMsg;
-	}
-
-	/**
-	 * Returns this plugin's \ElggPluginManifest object
-	 *
-	 * @return \ElggPluginManifest|null
-	 */
-	public function getManifest() {
-		if ($this->manifest instanceof \ElggPluginManifest) {
-			return $this->manifest;
-		}
-
-		try {
-			$package = $this->getPackage();
-			if (!$package) {
-				throw new \Exception('Package cannot be loaded');
-			}
-			$this->manifest = $package->getManifest();
-		} catch (Exception $e) {
-			_elgg_services()->logger->warn("Failed to load manifest for plugin $this->guid. " . $e->getMessage());
-			$this->errorMsg = $e->getmessage();
-		}
-
-		return $this->manifest;
-	}
-
-	/**
-	 * Returns this plugin's \ElggPluginPackage object
-	 *
-	 * @return \ElggPluginPackage|null
-	 */
-	public function getPackage() {
-		if ($this->package instanceof \ElggPluginPackage) {
-			return $this->package;
-		}
-
-		try {
-			$this->package = new \ElggPluginPackage($this->path, false);
-		} catch (Exception $e) {
-			_elgg_services()->logger->warn("Failed to load package for $this->guid. " . $e->getMessage());
-			$this->errorMsg = $e->getmessage();
-		}
-
-		return $this->package;
-	}
+        foreach ($spec as $entity) {
+            if (isset($entity['type'], $entity['subtype'], $entity['class'])) {
+                update_subtype($entity['type'], $entity['subtype']);
+            }
+        }
+    }
+
+    /**
+     * Get an attribute or private setting value
+     *
+     * @param string $name Name of the attribute or private setting
+     * @return mixed
+     */
+    public function __get($name) {
+        // See if its in our base attribute
+        if (array_key_exists($name, $this->attributes)) {
+            return $this->attributes[$name];
+        }
+
+        $result = $this->getPrivateSetting($name);
+        if ($result !== null) {
+            return $result;
+        }
+        $defaults = $this->getStaticConfig('settings', []);
+        return elgg_extract($name, $defaults, $result);
+    }
+
+    /**
+     * Set a value as private setting or attribute.
+     *
+     * Attributes include title and description.
+     *
+     * @param string $name  Name of the attribute or private_setting
+     * @param mixed  $value Value to be set
+     * @return void
+     */
+    public function __set($name, $value) {
+        if (array_key_exists($name, $this->attributes)) {
+            // Check that we're not trying to change the guid!
+            if ((array_key_exists('guid', $this->attributes)) && ($name == 'guid')) {
+                return;
+            }
+
+            $this->attributes[$name] = $value;
+        } else {
+            // to make sure we trigger the correct hooks
+            $this->setSetting($name, $value);
+        }
+    }
+
+    /**
+     * Sets the plugin to active or inactive.
+     *
+     * @param bool $active Set to active or inactive
+     *
+     * @return bool
+     */
+    private function setStatus($active) {
+        if (!$this->guid) {
+            return false;
+        }
+
+        $site = elgg_get_site_entity();
+        if ($active) {
+            $result = add_entity_relationship($this->guid, 'active_plugin', $site->guid);
+        } else {
+            $result = remove_entity_relationship($this->guid, 'active_plugin', $site->guid);
+        }
+
+        _elgg_invalidate_plugins_provides_cache();
+        _elgg_services()->boot->invalidateCache();
+
+        return $result;
+    }
+
+    /**
+     * Returns the last error message registered.
+     *
+     * @return string|null
+     */
+    public function getError() {
+        return $this->errorMsg;
+    }
+
+    /**
+     * Returns this plugin's \ElggPluginManifest object
+     *
+     * @return \ElggPluginManifest|null
+     */
+    public function getManifest() {
+        if ($this->manifest instanceof \ElggPluginManifest) {
+            return $this->manifest;
+        }
+
+        try {
+            $package = $this->getPackage();
+            if (!$package) {
+                throw new \Exception('Package cannot be loaded');
+            }
+            $this->manifest = $package->getManifest();
+        } catch (Exception $e) {
+            _elgg_services()->logger->warn("Failed to load manifest for plugin $this->guid. " . $e->getMessage());
+            $this->errorMsg = $e->getmessage();
+        }
+
+        return $this->manifest;
+    }
+
+    /**
+     * Returns this plugin's \ElggPluginPackage object
+     *
+     * @return \ElggPluginPackage|null
+     */
+    public function getPackage() {
+        if ($this->package instanceof \ElggPluginPackage) {
+            return $this->package;
+        }
+
+        try {
+            $this->package = new \ElggPluginPackage($this->path, false);
+        } catch (Exception $e) {
+            _elgg_services()->logger->warn("Failed to load package for $this->guid. " . $e->getMessage());
+            $this->errorMsg = $e->getmessage();
+        }
+
+        return $this->package;
+    }
 }