Elgg / Elgg

install/cli/travis_installer.php

Spacing +4 added lines, -4 removed lines

@@ -17,7 +17,7 @@ 
 	exit(2);
 }
 
-require_once __DIR__ . "/../../autoloader.php";
+require_once __DIR__."/../../autoloader.php";
 
 $installer = new ElggInstaller();
 
@@ -36,7 +36,7 @@ 
 	'sitename' => 'Elgg Travis Site',
 	'siteemail' => 'no_reply@travis.elgg.org',
 	'wwwroot' => 'http://localhost:8888/',
-	'dataroot' => getenv('HOME') . '/elgg_data/',
+	'dataroot' => getenv('HOME').'/elgg_data/',
 
 	// admin account
 	'displayname' => 'Administrator',
@@ -56,7 +56,7 @@ 
 $version = elgg_get_version(true);
 
 // at this point installation has completed (otherwise an exception halted execution).
-echo "Elgg $version install successful" . PHP_EOL;
-echo "wwwroot: " . elgg_get_config('wwwroot') . PHP_EOL;
+echo "Elgg $version install successful".PHP_EOL;
+echo "wwwroot: ".elgg_get_config('wwwroot').PHP_EOL;
 
 

engine/classes/Elgg/Database/Seeds/Seed.php

Doc Comments +2 added lines, -2 removed lines

@@ -263,7 +263,7 @@ 
 
 	/**
 	 * Create a new faker object
-	 * @return ElggObject|false
+	 * @return string|null
 	 */
 	public function createObject(array $attributes = [], array $metadata = []) {
 
@@ -368,7 +368,7 @@ 
 	 *
 	 * @param int[] $exclude GUIDs to exclude
 	 *
-	 * @return ElggUser|false
+	 * @return integer
 	 */
 	public function getRandomUser(array $exclude = []) {
 

Indentation +662 added lines, -662 removed lines

@@ -17,687 +17,687 @@
  */
 abstract class Seed {
 
-	/**
-	 * @var int Max number of items to be created by the seed
-	 */
-	protected $limit = 20;
-
-	/**
-	 * @var \Faker\Generator
-	 */
-	protected $faker;
-
-	/**
-	 * Seed constructor.
-	 *
-	 * @param string $locale Locale
-	 */
-	public function __construct($locale = 'en_US') {
-		$this->faker = Factory::create($locale);
-	}
-
-	/**
-	 * Populate database
-	 * @return mixed
-	 */
-	abstract function seed();
-
-	/**
-	 * Removed seeded rows from database
-	 * @return mixed
-	 */
-	abstract function unseed();
-
-	/**
-	 * Get site domain
-	 * @return string
-	 */
-	public function getDomain() {
-		return elgg_get_site_entity()->getDomain();
-	}
-
-	/**
-	 * Create a new faker user
-	 * @return ElggUser|false
-	 */
-	public function createUser(array $attributes = [], array $metadata = []) {
-
-		$metadata['__faker'] = true;
-
-		if (empty($attributes['password'])) {
-			$attributes['password'] = generate_random_cleartext_password();
-		}
-
-		if (empty($attributes['username'])) {
-			$attributes['name'] = $this->faker->name;
-		}
-
-		if (empty($attributes['username'])) {
-			$attributes['username'] = $this->getRandomUsername($attributes['name']);
-		}
-
-		if (empty($attributes['email'])) {
-			$attributes['email'] = "{$attributes['username']}@{$this->getDomain()}";
-			if (!filter_var($attributes['email'], FILTER_VALIDATE_EMAIL)) {
-				// Travis tests use localhost as the domain name, which generates invalid email addresses
-				$attributes['email'] = "{$attributes['username']}@localhost.com";
-			}
-		}
-
-		$user = false;
-
-		try {
-			$guid = register_user($attributes['username'], $attributes['password'], $attributes['name'], $attributes['email']);
-			$user = get_entity($guid);
-			/* @var $user ElggUser */
-
-			elgg_set_user_validation_status($guid, $this->faker->boolean(), 'seeder');
-
-			$user->setNotificationSetting('email', false);
-			$user->setNotificationSetting('site', true);
-
-			$profile_fields = elgg_get_config('profile_fields');
-
-			$user = $this->populateMetadata($user, $profile_fields, $metadata);
-
-			$user->save();
-
-			$this->createIcon($user);
-			$this->createComments($user);
-			$this->createLikes($user);
-
-			$this->log("Created new user $user->name [guid: $user->guid]");
+    /**
+     * @var int Max number of items to be created by the seed
+     */
+    protected $limit = 20;
+
+    /**
+     * @var \Faker\Generator
+     */
+    protected $faker;
+
+    /**
+     * Seed constructor.
+     *
+     * @param string $locale Locale
+     */
+    public function __construct($locale = 'en_US') {
+        $this->faker = Factory::create($locale);
+    }
+
+    /**
+     * Populate database
+     * @return mixed
+     */
+    abstract function seed();
+
+    /**
+     * Removed seeded rows from database
+     * @return mixed
+     */
+    abstract function unseed();
+
+    /**
+     * Get site domain
+     * @return string
+     */
+    public function getDomain() {
+        return elgg_get_site_entity()->getDomain();
+    }
+
+    /**
+     * Create a new faker user
+     * @return ElggUser|false
+     */
+    public function createUser(array $attributes = [], array $metadata = []) {
+
+        $metadata['__faker'] = true;
+
+        if (empty($attributes['password'])) {
+            $attributes['password'] = generate_random_cleartext_password();
+        }
+
+        if (empty($attributes['username'])) {
+            $attributes['name'] = $this->faker->name;
+        }
+
+        if (empty($attributes['username'])) {
+            $attributes['username'] = $this->getRandomUsername($attributes['name']);
+        }
+
+        if (empty($attributes['email'])) {
+            $attributes['email'] = "{$attributes['username']}@{$this->getDomain()}";
+            if (!filter_var($attributes['email'], FILTER_VALIDATE_EMAIL)) {
+                // Travis tests use localhost as the domain name, which generates invalid email addresses
+                $attributes['email'] = "{$attributes['username']}@localhost.com";
+            }
+        }
+
+        $user = false;
+
+        try {
+            $guid = register_user($attributes['username'], $attributes['password'], $attributes['name'], $attributes['email']);
+            $user = get_entity($guid);
+            /* @var $user ElggUser */
+
+            elgg_set_user_validation_status($guid, $this->faker->boolean(), 'seeder');
+
+            $user->setNotificationSetting('email', false);
+            $user->setNotificationSetting('site', true);
+
+            $profile_fields = elgg_get_config('profile_fields');
+
+            $user = $this->populateMetadata($user, $profile_fields, $metadata);
+
+            $user->save();
+
+            $this->createIcon($user);
+            $this->createComments($user);
+            $this->createLikes($user);
+
+            $this->log("Created new user $user->name [guid: $user->guid]");
 
-			return $user;
-		} catch (Exception $e) {
-			if ($user && $user->guid) {
-				$user->delete();
-			}
-
-			$this->log($e->getMessage());
-
-			return false;
-		}
-
-	}
+            return $user;
+        } catch (Exception $e) {
+            if ($user && $user->guid) {
+                $user->delete();
+            }
+
+            $this->log($e->getMessage());
+
+            return false;
+        }
+
+    }
 
-	/**
-	 * Create a new faker group
-	 * @return ElggGroup|false
-	 */
-	public function createGroup(array $attributes = [], array $metadata = []) {
+    /**
+     * Create a new faker group
+     * @return ElggGroup|false
+     */
+    public function createGroup(array $attributes = [], array $metadata = []) {
 
-		$metadata['__faker'] = true;
+        $metadata['__faker'] = true;
 
-		if (empty($attributes['access_id'])) {
-			$attributes['access_id'] = ACCESS_PUBLIC;
-		}
+        if (empty($attributes['access_id'])) {
+            $attributes['access_id'] = ACCESS_PUBLIC;
+        }
 
-		if (empty($metadata['content_access_mode'])) {
-			$metadata['content_access_mode'] = ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED;
-		}
+        if (empty($metadata['content_access_mode'])) {
+            $metadata['content_access_mode'] = ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED;
+        }
 
-		if (empty($metadata['membership'])) {
-			$metadata['membership'] = ACCESS_PUBLIC;
-		}
+        if (empty($metadata['membership'])) {
+            $metadata['membership'] = ACCESS_PUBLIC;
+        }
 
-		if (empty($attributes['name'])) {
-			$attributes['name'] = $this->faker->sentence();
-		}
+        if (empty($attributes['name'])) {
+            $attributes['name'] = $this->faker->sentence();
+        }
 
-		if (empty($attributes['description'])) {
-			$attributes['description'] = $this->faker->text($this->faker->numberBetween(500, 1000));
-		}
+        if (empty($attributes['description'])) {
+            $attributes['description'] = $this->faker->text($this->faker->numberBetween(500, 1000));
+        }
 
-		if (empty($attributes['owner_guid'])) {
-			$user = $this->getRandomUser();
-			if (!$user) {
-				$user = $this->createUser();
-			}
+        if (empty($attributes['owner_guid'])) {
+            $user = $this->getRandomUser();
+            if (!$user) {
+                $user = $this->createUser();
+            }
 
-			$attributes['owner_guid'] = $user->guid;
-		}
+            $attributes['owner_guid'] = $user->guid;
+        }
 
-		if (empty($attributes['container_guid'])) {
-			$attributes['container_guid'] = $attributes['owner_guid'];
-		}
+        if (empty($attributes['container_guid'])) {
+            $attributes['container_guid'] = $attributes['owner_guid'];
+        }
 
-		$owner = get_entity($attributes['owner_guid']);
-		if (!$owner) {
-			return false;
-		}
+        $owner = get_entity($attributes['owner_guid']);
+        if (!$owner) {
+            return false;
+        }
 
-		$container = get_entity($attributes['container_guid']);
-		if (!$container) {
-			return false;
-		}
+        $container = get_entity($attributes['container_guid']);
+        if (!$container) {
+            return false;
+        }
 
-		$tool_options = elgg_get_config('group_tool_options');
-		if ($tool_options) {
-			foreach ($tool_options as $group_option) {
-				$option_toggle_name = $group_option->name . "_enable";
-				$option_default = $group_option->default_on ? 'yes' : 'no';
-				$metadata[$option_toggle_name] = $option_default;
-			}
-		}
+        $tool_options = elgg_get_config('group_tool_options');
+        if ($tool_options) {
+            foreach ($tool_options as $group_option) {
+                $option_toggle_name = $group_option->name . "_enable";
+                $option_default = $group_option->default_on ? 'yes' : 'no';
+                $metadata[$option_toggle_name] = $option_default;
+            }
+        }
 
-		if ($this->faker->boolean(20)) {
-			$metadata['featured_group'] = 'yes';
-		}
+        if ($this->faker->boolean(20)) {
+            $metadata['featured_group'] = 'yes';
+        }
 
-		$group = false;
+        $group = false;
 
-		try {
+        try {
 
-			$group = new ElggGroup();
-			foreach ($attributes as $name => $value) {
-				$group->$name = $value;
-			}
+            $group = new ElggGroup();
+            foreach ($attributes as $name => $value) {
+                $group->$name = $value;
+            }
 
-			$group = $this->populateMetadata($group, elgg_get_config('group'), $metadata);
+            $group = $this->populateMetadata($group, elgg_get_config('group'), $metadata);
 
-			$group->save();
+            $group->save();
 
-			if ($group->access_id == ACCESS_PRIVATE) {
-				$group->access_id = $group->group_acl;
-				$group->save();
-			}
-
-			$group->join(get_entity($attributes['owner_guid']));
-
-			$this->createIcon($group);
-
-			$this->createComments($group);
-			$this->createLikes($group);
-
-			elgg_create_river_item([
-				'view' => 'river/group/create',
-				'action_type' => 'create',
-				'subject_guid' => $owner->guid,
-				'object_guid' => $group->guid,
-				'target_guid' => $container->guid,
-			]);
-
-			$this->log("Created new group $group->name [guid: $group->guid]");
-
-			return $group;
-		} catch (Exception $e) {
-			if ($group && $group->guid) {
-				$group->delete();
-			}
-
-			$this->log($e->getMessage());
-
-			return false;
-		}
-
-	}
-
-	/**
-	 * Create a new faker object
-	 * @return ElggObject|false
-	 */
-	public function createObject(array $attributes = [], array $metadata = []) {
-
-		$metadata['__faker'] = true;
-
-		if (empty($attributes['title'])) {
-			$attributes['title'] = $this->faker->sentence();
-		}
-
-		if (empty($attributes['description'])) {
-			$attributes['description'] = $this->faker->text($this->faker->numberBetween(500, 1000));
-		}
-
-		if (empty($attributes['container_guid'])) {
-			if ($this->faker->boolean()) {
-				$container = $this->getRandomGroup();
-			} else {
-				$container = $this->getRandomUser();
-			}
-
-			$attributes['container_guid'] = $container->guid;
-		}
-
-		if (empty($attributes['subtype'])) {
-			$attributes['subtype'] = strtolower($this->faker->word);
-		}
-
-		if (empty($metadata['tags'])) {
-			$metadata['tags'] = $this->faker->words(10);
-		}
-
-		if (empty($attributes['owner_guid'])) {
-			if ($container instanceof ElggGroup) {
-				$members = elgg_get_entities_from_relationship([
-					'types' => 'user',
-					'relationship' => 'member',
-					'relationship_guid' => $container->guid,
-					'inverse_relationship' => true,
-					'limit' => 0,
-					'metadata_names' => '__faker',
-					'order_by' => 'RAND()',
-				]);
-				$owner = array_shift($members);
-			} else {
-				$owner = $container;
-			}
-
-			$attributes['owner_guid'] = $owner->guid;
-		}
-
-		$owner = get_entity($attributes['owner_guid']);
-		if (!$owner) {
-			return false;
-		}
-
-		$container = get_entity($attributes['container_guid']);
-		if (!$container) {
-			return false;
-		}
-
-		if (empty($attributes['access_id'])) {
-			$attributes['access_id'] = $this->getRandomAccessId($owner, $container);
-		}
-
-		$object = false;
-
-		try {
-			$class = get_subtype_class('object', $attributes['subtype']);
-			if ($class && class_exists($class)) {
-				$object = new $class();
-			} else {
-				$object = new ElggObject();
-			}
-			foreach ($attributes as $name => $value) {
-				$object->$name = $value;
-			}
-
-			$object = $this->populateMetadata($object, [], $metadata);
-
-			$object->save();
-
-			$this->createComments($object);
-			$this->createLikes($object);
-
-			$type_str = elgg_echo("item:object:{$object->getSubtype()}");
-
-			$this->log("Created new item in $type_str $object->title [guid: $object->guid]");
-
-			return $object;
-		} catch (Exception $e) {
-			if ($object && $object->guid) {
-				$object->delete();
-			}
-
-			$this->log($e->getMessage());
-
-			return false;
-		}
-
-	}
-
-	/**
-	 * Returns random fake user
-	 *
-	 * @param int[] $exclude GUIDs to exclude
-	 *
-	 * @return ElggUser|false
-	 */
-	public function getRandomUser(array $exclude = []) {
-
-		$exclude[] = 0;
-		$exclude_in = implode(',', array_map(function ($e) {
-			return (int) $e;
-		}, $exclude));
-
-		$users = elgg_get_entities_from_metadata([
-			'types' => 'user',
-			'metadata_names' => ['__faker'],
-			'limit' => 1,
-			'wheres' => [
-				"e.guid NOT IN ($exclude_in)",
-			],
-			'order_by' => 'RAND()',
-		]);
-
-		return $users ? $users[0] : false;
-	}
-
-	/**
-	 * Returns random fake group
-	 *
-	 * @param int[] $exclude GUIDs to exclude
-	 *
-	 * @return ElggGroup|false
-	 */
-	public function getRandomGroup(array $exclude = []) {
-
-		$exclude[] = 0;
-		$exclude_in = implode(',', array_map(function ($e) {
-			return (int) $e;
-		}, $exclude));
-
-		$groups = elgg_get_entities_from_metadata([
-			'types' => 'group',
-			'metadata_names' => ['__faker'],
-			'limit' => 1,
-			'wheres' => [
-				"e.guid NOT IN ($exclude_in)",
-			],
-			'order_by' => 'RAND()',
-		]);
-
-		return $groups ? $groups[0] : false;
-	}
-
-	/**
-	 * Get random access id
-	 *
-	 * @param ElggUser   $user      User
-	 * @param ElggEntity $container Container
-	 *
-	 * @return int
-	 */
-	public function getRandomAccessId(\ElggUser $user = null, ElggEntity $container = null) {
-
-		$params = [
-			'container_guid' => $container->guid,
-		];
-
-		$access_array = get_write_access_array($user->guid, null, null, $params);
-
-		$access_key = array_rand($access_array, 1);
-
-		return $access_array[$access_key];
-	}
-
-	/**
-	 * Generates a unique available and valid username
-	 *
-	 * @param string $base_name Display name, email or other prefix to use as basis
-	 *
-	 * @return string
-	 */
-	public function getRandomUsername($base_name = 'user') {
-
-		$available = false;
-
-		$base_name = iconv('UTF-8', 'ASCII//TRANSLIT', $base_name);
-		$blacklist = '/[\x{0080}-\x{009f}\x{00a0}\x{2000}-\x{200f}\x{2028}-\x{202f}\x{3000}\x{e000}-\x{f8ff}]/u';
-		$blacklist2 = [
-			' ',
-			'\'',
-			'/',
-			'\\',
-			'"',
-			'*',
-			'&',
-			'?',
-			'#',
-			'%',
-			'^',
-			'(',
-			')',
-			'{',
-			'}',
-			'[',
-			']',
-			'~',
-			'?',
-			'<',
-			'>',
-			';',
-			'|',
-			'¬',
-			'`',
-			'@',
-			'-',
-			'+',
-			'='
-		];
-
-		$base_name = preg_replace($blacklist, '', $base_name);
-		$base_name = str_replace($blacklist2, '.', $base_name);
-
-		$ia = elgg_set_ignore_access(true);
-
-		$ha = access_get_show_hidden_status();
-		access_show_hidden_entities(true);
-
-		$minlength = elgg_get_config('minusername') ? : 4;
-		if ($base_name) {
-			$fill = $minlength - strlen($base_name);
-		} else {
-			$fill = 8;
-		}
-
-		$separator = '.';
-
-		if ($fill > 0) {
-			$suffix = (new ElggCrypto())->getRandomString($fill);
-			$base_name = "$base_name$separator$suffix";
-		}
-
-		$iterator = 0;
-		while (!$available) {
-			if ($iterator > 0) {
-				$base_name = "$base_name$separator$iterator";
-			}
-			$user = get_user_by_username($base_name);
-			$available = !$user;
-			try {
-				if ($available) {
-					validate_username($base_name);
-				}
-			} catch (\Exception $e) {
-				if ($iterator >= 10) {
-					// too many failed attempts
-					$base_name = (new ElggCrypto())->getRandomString(8);
-				}
-			}
-
-			$iterator++;
-		}
-
-		access_show_hidden_entities($ha);
-		elgg_set_ignore_access($ia);
-
-		return strtolower($base_name);
-	}
-
-	/**
-	 * Set random metadata
-	 *
-	 * @param ElggEntity $entity   Entity
-	 * @param array      $fields   An array of profile fields in $name => $input_type format
-	 * @param array      $metadata Other metadata $name => $value pairs to set
-	 *
-	 * @return ElggEntity
-	 */
-	public function populateMetadata(ElggEntity $entity, array $fields = [], array $metadata = []) {
-
-		foreach ($fields as $name => $type) {
-			if (isset($metadata[$name])) {
-				continue;
-			}
-
-			switch ($name) {
-				case 'phone' :
-				case 'mobile' :
-					$metadata[$name] = $this->faker->phoneNumber;
-					break;
-
-				default :
-					switch ($type) {
-						case 'plaintext' :
-						case 'longtext' :
-							$metadata[$name] = $this->faker->text($this->faker->numberBetween(500, 1000));
-							break;
-
-						case 'text' :
-							$metadata[$name] = $this->faker->sentence;
-							break;
-
-						case 'tags' :
-							$metadata[$name] = $this->faker->words(10);
-							break;
-
-						case 'url' :
-							$metadata[$name] = $this->faker->url;
-
-						case 'email' :
-							$metadata[$name] = $this->faker->email;
-							break;
-
-						case 'number' :
-							$metadata[$name] = $this->faker->randomNumber();
-							break;
-
-						case 'date' :
-							$metadata[$name] = $this->faker->unixTime;
-							break;
-
-						case 'password' :
-							$metadata[$name] = generate_random_cleartext_password();
-							break;
-
-						case 'location' :
-							$metadata[$name] = $this->faker->address;
-							$metadata['geo:lat'] = $this->faker->latitude;
-							$metadata['geo:long'] = $this->faker->longitude;
-							break;
-
-						case 'email' :
-							$metadata[$name] = $this->faker->address;
-							$metadata['geo:lat'] = $this->faker->latitude;
-							$metadata['geo:long'] = $this->faker->longitude;
-							break;
-
-						default :
-							$metadata[$name] = '';
-							break;
-					}
-
-					break;
-			}
-		}
-
-		foreach ($metadata as $key => $value) {
-			$entity->$key = $value;
-		}
-
-		return $entity;
-	}
-
-	/**
-	 * Create an icon for an entity
-	 *
-	 * @param ElggEntity $entity Entity
-	 *
-	 * @return bool
-	 */
-	public function createIcon(ElggEntity $entity) {
-
-		$icon_url = $this->faker->imageURL();
-
-		$file_contents = file_get_contents($icon_url);
-
-		$tmp = new \ElggFile();
-		$tmp->owner_guid = $entity->guid;
-		$tmp->setFilename("tmp/icon_src.jpg");
-		$tmp->open('write');
-		$tmp->write($file_contents);
-		$tmp->close();
-
-		$result = $entity->saveIconFromElggFile($tmp);
-
-		$tmp->delete();
-
-		if ($result && $entity instanceof ElggUser) {
-			elgg_create_river_item([
-				'view' => 'river/user/default/profileiconupdate',
-				'action_type' => 'update',
-				'subject_guid' => $entity->guid,
-				'object_guid' => $entity->guid,
-			]);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Create comments/replies
-	 *
-	 * @param ElggEntity $entity Entity to comment on
-	 * @param int        $limit  Number of comments to create
-	 *
-	 * @return int Number of generated comments
-	 */
-	public function createComments(ElggEntity $entity, $limit = null) {
-
-		$success = 0;
-
-		if (!$limit) {
-			$limit = $this->faker->numberBetween(1, 20);
-		}
-
-		while ($success < $limit) {
-
-			$comment = new ElggObject();
-			$comment->subtype = $entity->getSubtype() == 'discussion' ? 'discussion_reply' : 'comment';
-			$comment->owner_guid = $this->getRandomUser()->guid ? : $entity->owner_guid;
-			$comment->container_guid = $entity->guid;
-			$comment->description = $this->faker->paragraph;
-
-			if ($comment->save()) {
-				$success++;
-			}
-		}
-
-		return $success;
-
-	}
-
-	/**
-	 * Create likes
-	 *
-	 * @param ElggEntity $entity Entity to like
-	 * @param int        $limit  Number of likes to create
-	 *
-	 * @return int
-	 */
-	public function createLikes(ElggEntity $entity, $limit = null) {
-
-		$success = 0;
-
-		if (!$limit) {
-			$limit = $this->faker->numberBetween(1, 20);
-		}
-
-		while ($success < $limit) {
-			if ($entity->annotate('likes', true, $entity->access_id, $this->getRandomUser()->guid)) {
-				$success++;
-			}
-		}
-
-		return $success;
-	}
-
-	/**
-	 * Log a message
-	 *
-	 * @param string $msg Message to log
-	 *
-	 * @return void
-	 */
-	public function log($msg, $level = 'NOTICE') {
-
-		if (php_sapi_name() === 'cli') {
-			$handle = $level === 'ERROR' ? STDERR : STDOUT;
-			fwrite($handle, $msg . PHP_EOL);
-		} else {
-			elgg_log($msg, $level);
-		}
-	}
+            if ($group->access_id == ACCESS_PRIVATE) {
+                $group->access_id = $group->group_acl;
+                $group->save();
+            }
+
+            $group->join(get_entity($attributes['owner_guid']));
+
+            $this->createIcon($group);
+
+            $this->createComments($group);
+            $this->createLikes($group);
+
+            elgg_create_river_item([
+                'view' => 'river/group/create',
+                'action_type' => 'create',
+                'subject_guid' => $owner->guid,
+                'object_guid' => $group->guid,
+                'target_guid' => $container->guid,
+            ]);
+
+            $this->log("Created new group $group->name [guid: $group->guid]");
+
+            return $group;
+        } catch (Exception $e) {
+            if ($group && $group->guid) {
+                $group->delete();
+            }
+
+            $this->log($e->getMessage());
+
+            return false;
+        }
+
+    }
+
+    /**
+     * Create a new faker object
+     * @return ElggObject|false
+     */
+    public function createObject(array $attributes = [], array $metadata = []) {
+
+        $metadata['__faker'] = true;
+
+        if (empty($attributes['title'])) {
+            $attributes['title'] = $this->faker->sentence();
+        }
+
+        if (empty($attributes['description'])) {
+            $attributes['description'] = $this->faker->text($this->faker->numberBetween(500, 1000));
+        }
+
+        if (empty($attributes['container_guid'])) {
+            if ($this->faker->boolean()) {
+                $container = $this->getRandomGroup();
+            } else {
+                $container = $this->getRandomUser();
+            }
+
+            $attributes['container_guid'] = $container->guid;
+        }
+
+        if (empty($attributes['subtype'])) {
+            $attributes['subtype'] = strtolower($this->faker->word);
+        }
+
+        if (empty($metadata['tags'])) {
+            $metadata['tags'] = $this->faker->words(10);
+        }
+
+        if (empty($attributes['owner_guid'])) {
+            if ($container instanceof ElggGroup) {
+                $members = elgg_get_entities_from_relationship([
+                    'types' => 'user',
+                    'relationship' => 'member',
+                    'relationship_guid' => $container->guid,
+                    'inverse_relationship' => true,
+                    'limit' => 0,
+                    'metadata_names' => '__faker',
+                    'order_by' => 'RAND()',
+                ]);
+                $owner = array_shift($members);
+            } else {
+                $owner = $container;
+            }
+
+            $attributes['owner_guid'] = $owner->guid;
+        }
+
+        $owner = get_entity($attributes['owner_guid']);
+        if (!$owner) {
+            return false;
+        }
+
+        $container = get_entity($attributes['container_guid']);
+        if (!$container) {
+            return false;
+        }
+
+        if (empty($attributes['access_id'])) {
+            $attributes['access_id'] = $this->getRandomAccessId($owner, $container);
+        }
+
+        $object = false;
+
+        try {
+            $class = get_subtype_class('object', $attributes['subtype']);
+            if ($class && class_exists($class)) {
+                $object = new $class();
+            } else {
+                $object = new ElggObject();
+            }
+            foreach ($attributes as $name => $value) {
+                $object->$name = $value;
+            }
+
+            $object = $this->populateMetadata($object, [], $metadata);
+
+            $object->save();
+
+            $this->createComments($object);
+            $this->createLikes($object);
+
+            $type_str = elgg_echo("item:object:{$object->getSubtype()}");
+
+            $this->log("Created new item in $type_str $object->title [guid: $object->guid]");
+
+            return $object;
+        } catch (Exception $e) {
+            if ($object && $object->guid) {
+                $object->delete();
+            }
+
+            $this->log($e->getMessage());
+
+            return false;
+        }
+
+    }
+
+    /**
+     * Returns random fake user
+     *
+     * @param int[] $exclude GUIDs to exclude
+     *
+     * @return ElggUser|false
+     */
+    public function getRandomUser(array $exclude = []) {
+
+        $exclude[] = 0;
+        $exclude_in = implode(',', array_map(function ($e) {
+            return (int) $e;
+        }, $exclude));
+
+        $users = elgg_get_entities_from_metadata([
+            'types' => 'user',
+            'metadata_names' => ['__faker'],
+            'limit' => 1,
+            'wheres' => [
+                "e.guid NOT IN ($exclude_in)",
+            ],
+            'order_by' => 'RAND()',
+        ]);
+
+        return $users ? $users[0] : false;
+    }
+
+    /**
+     * Returns random fake group
+     *
+     * @param int[] $exclude GUIDs to exclude
+     *
+     * @return ElggGroup|false
+     */
+    public function getRandomGroup(array $exclude = []) {
+
+        $exclude[] = 0;
+        $exclude_in = implode(',', array_map(function ($e) {
+            return (int) $e;
+        }, $exclude));
+
+        $groups = elgg_get_entities_from_metadata([
+            'types' => 'group',
+            'metadata_names' => ['__faker'],
+            'limit' => 1,
+            'wheres' => [
+                "e.guid NOT IN ($exclude_in)",
+            ],
+            'order_by' => 'RAND()',
+        ]);
+
+        return $groups ? $groups[0] : false;
+    }
+
+    /**
+     * Get random access id
+     *
+     * @param ElggUser   $user      User
+     * @param ElggEntity $container Container
+     *
+     * @return int
+     */
+    public function getRandomAccessId(\ElggUser $user = null, ElggEntity $container = null) {
+
+        $params = [
+            'container_guid' => $container->guid,
+        ];
+
+        $access_array = get_write_access_array($user->guid, null, null, $params);
+
+        $access_key = array_rand($access_array, 1);
+
+        return $access_array[$access_key];
+    }
+
+    /**
+     * Generates a unique available and valid username
+     *
+     * @param string $base_name Display name, email or other prefix to use as basis
+     *
+     * @return string
+     */
+    public function getRandomUsername($base_name = 'user') {
+
+        $available = false;
+
+        $base_name = iconv('UTF-8', 'ASCII//TRANSLIT', $base_name);
+        $blacklist = '/[\x{0080}-\x{009f}\x{00a0}\x{2000}-\x{200f}\x{2028}-\x{202f}\x{3000}\x{e000}-\x{f8ff}]/u';
+        $blacklist2 = [
+            ' ',
+            '\'',
+            '/',
+            '\\',
+            '"',
+            '*',
+            '&',
+            '?',
+            '#',
+            '%',
+            '^',
+            '(',
+            ')',
+            '{',
+            '}',
+            '[',
+            ']',
+            '~',
+            '?',
+            '<',
+            '>',
+            ';',
+            '|',
+            '¬',
+            '`',
+            '@',
+            '-',
+            '+',
+            '='
+        ];
+
+        $base_name = preg_replace($blacklist, '', $base_name);
+        $base_name = str_replace($blacklist2, '.', $base_name);
+
+        $ia = elgg_set_ignore_access(true);
+
+        $ha = access_get_show_hidden_status();
+        access_show_hidden_entities(true);
+
+        $minlength = elgg_get_config('minusername') ? : 4;
+        if ($base_name) {
+            $fill = $minlength - strlen($base_name);
+        } else {
+            $fill = 8;
+        }
+
+        $separator = '.';
+
+        if ($fill > 0) {
+            $suffix = (new ElggCrypto())->getRandomString($fill);
+            $base_name = "$base_name$separator$suffix";
+        }
+
+        $iterator = 0;
+        while (!$available) {
+            if ($iterator > 0) {
+                $base_name = "$base_name$separator$iterator";
+            }
+            $user = get_user_by_username($base_name);
+            $available = !$user;
+            try {
+                if ($available) {
+                    validate_username($base_name);
+                }
+            } catch (\Exception $e) {
+                if ($iterator >= 10) {
+                    // too many failed attempts
+                    $base_name = (new ElggCrypto())->getRandomString(8);
+                }
+            }
+
+            $iterator++;
+        }
+
+        access_show_hidden_entities($ha);
+        elgg_set_ignore_access($ia);
+
+        return strtolower($base_name);
+    }
+
+    /**
+     * Set random metadata
+     *
+     * @param ElggEntity $entity   Entity
+     * @param array      $fields   An array of profile fields in $name => $input_type format
+     * @param array      $metadata Other metadata $name => $value pairs to set
+     *
+     * @return ElggEntity
+     */
+    public function populateMetadata(ElggEntity $entity, array $fields = [], array $metadata = []) {
+
+        foreach ($fields as $name => $type) {
+            if (isset($metadata[$name])) {
+                continue;
+            }
+
+            switch ($name) {
+                case 'phone' :
+                case 'mobile' :
+                    $metadata[$name] = $this->faker->phoneNumber;
+                    break;
+
+                default :
+                    switch ($type) {
+                        case 'plaintext' :
+                        case 'longtext' :
+                            $metadata[$name] = $this->faker->text($this->faker->numberBetween(500, 1000));
+                            break;
+
+                        case 'text' :
+                            $metadata[$name] = $this->faker->sentence;
+                            break;
+
+                        case 'tags' :
+                            $metadata[$name] = $this->faker->words(10);
+                            break;
+
+                        case 'url' :
+                            $metadata[$name] = $this->faker->url;
+
+                        case 'email' :
+                            $metadata[$name] = $this->faker->email;
+                            break;
+
+                        case 'number' :
+                            $metadata[$name] = $this->faker->randomNumber();
+                            break;
+
+                        case 'date' :
+                            $metadata[$name] = $this->faker->unixTime;
+                            break;
+
+                        case 'password' :
+                            $metadata[$name] = generate_random_cleartext_password();
+                            break;
+
+                        case 'location' :
+                            $metadata[$name] = $this->faker->address;
+                            $metadata['geo:lat'] = $this->faker->latitude;
+                            $metadata['geo:long'] = $this->faker->longitude;
+                            break;
+
+                        case 'email' :
+                            $metadata[$name] = $this->faker->address;
+                            $metadata['geo:lat'] = $this->faker->latitude;
+                            $metadata['geo:long'] = $this->faker->longitude;
+                            break;
+
+                        default :
+                            $metadata[$name] = '';
+                            break;
+                    }
+
+                    break;
+            }
+        }
+
+        foreach ($metadata as $key => $value) {
+            $entity->$key = $value;
+        }
+
+        return $entity;
+    }
+
+    /**
+     * Create an icon for an entity
+     *
+     * @param ElggEntity $entity Entity
+     *
+     * @return bool
+     */
+    public function createIcon(ElggEntity $entity) {
+
+        $icon_url = $this->faker->imageURL();
+
+        $file_contents = file_get_contents($icon_url);
+
+        $tmp = new \ElggFile();
+        $tmp->owner_guid = $entity->guid;
+        $tmp->setFilename("tmp/icon_src.jpg");
+        $tmp->open('write');
+        $tmp->write($file_contents);
+        $tmp->close();
+
+        $result = $entity->saveIconFromElggFile($tmp);
+
+        $tmp->delete();
+
+        if ($result && $entity instanceof ElggUser) {
+            elgg_create_river_item([
+                'view' => 'river/user/default/profileiconupdate',
+                'action_type' => 'update',
+                'subject_guid' => $entity->guid,
+                'object_guid' => $entity->guid,
+            ]);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Create comments/replies
+     *
+     * @param ElggEntity $entity Entity to comment on
+     * @param int        $limit  Number of comments to create
+     *
+     * @return int Number of generated comments
+     */
+    public function createComments(ElggEntity $entity, $limit = null) {
+
+        $success = 0;
+
+        if (!$limit) {
+            $limit = $this->faker->numberBetween(1, 20);
+        }
+
+        while ($success < $limit) {
+
+            $comment = new ElggObject();
+            $comment->subtype = $entity->getSubtype() == 'discussion' ? 'discussion_reply' : 'comment';
+            $comment->owner_guid = $this->getRandomUser()->guid ? : $entity->owner_guid;
+            $comment->container_guid = $entity->guid;
+            $comment->description = $this->faker->paragraph;
+
+            if ($comment->save()) {
+                $success++;
+            }
+        }
+
+        return $success;
+
+    }
+
+    /**
+     * Create likes
+     *
+     * @param ElggEntity $entity Entity to like
+     * @param int        $limit  Number of likes to create
+     *
+     * @return int
+     */
+    public function createLikes(ElggEntity $entity, $limit = null) {
+
+        $success = 0;
+
+        if (!$limit) {
+            $limit = $this->faker->numberBetween(1, 20);
+        }
+
+        while ($success < $limit) {
+            if ($entity->annotate('likes', true, $entity->access_id, $this->getRandomUser()->guid)) {
+                $success++;
+            }
+        }
+
+        return $success;
+    }
+
+    /**
+     * Log a message
+     *
+     * @param string $msg Message to log
+     *
+     * @return void
+     */
+    public function log($msg, $level = 'NOTICE') {
+
+        if (php_sapi_name() === 'cli') {
+            $handle = $level === 'ERROR' ? STDERR : STDOUT;
+            fwrite($handle, $msg . PHP_EOL);
+        } else {
+            elgg_log($msg, $level);
+        }
+    }
 }
\ No newline at end of file

Spacing +6 added lines, -6 removed lines

@@ -175,7 +175,7 @@ 
 		$tool_options = elgg_get_config('group_tool_options');
 		if ($tool_options) {
 			foreach ($tool_options as $group_option) {
-				$option_toggle_name = $group_option->name . "_enable";
+				$option_toggle_name = $group_option->name."_enable";
 				$option_default = $group_option->default_on ? 'yes' : 'no';
 				$metadata[$option_toggle_name] = $option_default;
 			}
@@ -347,7 +347,7 @@ 
 	public function getRandomUser(array $exclude = []) {
 
 		$exclude[] = 0;
-		$exclude_in = implode(',', array_map(function ($e) {
+		$exclude_in = implode(',', array_map(function($e) {
 			return (int) $e;
 		}, $exclude));
 
@@ -374,7 +374,7 @@ 
 	public function getRandomGroup(array $exclude = []) {
 
 		$exclude[] = 0;
-		$exclude_in = implode(',', array_map(function ($e) {
+		$exclude_in = implode(',', array_map(function($e) {
 			return (int) $e;
 		}, $exclude));
 
@@ -465,7 +465,7 @@ 
 		$ha = access_get_show_hidden_status();
 		access_show_hidden_entities(true);
 
-		$minlength = elgg_get_config('minusername') ? : 4;
+		$minlength = elgg_get_config('minusername') ?: 4;
 		if ($base_name) {
 			$fill = $minlength - strlen($base_name);
 		} else {
@@ -646,7 +646,7 @@ 
 
 			$comment = new ElggObject();
 			$comment->subtype = $entity->getSubtype() == 'discussion' ? 'discussion_reply' : 'comment';
-			$comment->owner_guid = $this->getRandomUser()->guid ? : $entity->owner_guid;
+			$comment->owner_guid = $this->getRandomUser()->guid ?: $entity->owner_guid;
 			$comment->container_guid = $entity->guid;
 			$comment->description = $this->faker->paragraph;
 
@@ -695,7 +695,7 @@ 
 
 		if (php_sapi_name() === 'cli') {
 			$handle = $level === 'ERROR' ? STDERR : STDOUT;
-			fwrite($handle, $msg . PHP_EOL);
+			fwrite($handle, $msg.PHP_EOL);
 		} else {
 			elgg_log($msg, $level);
 		}

engine/lib/notification.php

Indentation +336 added lines, -336 removed lines

@@ -63,7 +63,7 @@ 
  * @since 1.9
  */
 function elgg_register_notification_event($object_type, $object_subtype, array $actions = array()) {
-	_elgg_services()->notifications->registerEvent($object_type, $object_subtype, $actions);
+    _elgg_services()->notifications->registerEvent($object_type, $object_subtype, $actions);
 }
 
 /**
@@ -75,7 +75,7 @@ 
  * @since 1.9
  */
 function elgg_unregister_notification_event($object_type, $object_subtype) {
-	return _elgg_services()->notifications->unregisterEvent($object_type, $object_subtype);
+    return _elgg_services()->notifications->unregisterEvent($object_type, $object_subtype);
 }
 
 /**
@@ -91,7 +91,7 @@ 
  * @since 1.9
  */
 function elgg_register_notification_method($name) {
-	_elgg_services()->notifications->registerMethod($name);
+    _elgg_services()->notifications->registerMethod($name);
 }
 
 /**
@@ -107,7 +107,7 @@ 
  * @since 2.3
  */
 function elgg_get_notification_methods() {
-	return _elgg_services()->notifications->getMethods();
+    return _elgg_services()->notifications->getMethods();
 }
 
 /**
@@ -119,7 +119,7 @@ 
  * @since 1.9
  */
 function elgg_unregister_notification_method($name) {
-	return _elgg_services()->notifications->unregisterMethod($name);
+    return _elgg_services()->notifications->unregisterMethod($name);
 }
 
 /**
@@ -132,10 +132,10 @@ 
  * @since 1.9
  */
 function elgg_add_subscription($user_guid, $method, $target_guid) {
-	$methods = _elgg_services()->notifications->getMethods();
-	$db = _elgg_services()->db;
-	$subs = new \Elgg\Notifications\SubscriptionsService($db, $methods);
-	return $subs->addSubscription($user_guid, $method, $target_guid);
+    $methods = _elgg_services()->notifications->getMethods();
+    $db = _elgg_services()->db;
+    $subs = new \Elgg\Notifications\SubscriptionsService($db, $methods);
+    return $subs->addSubscription($user_guid, $method, $target_guid);
 }
 
 /**
@@ -148,10 +148,10 @@ 
  * @since 1.9
  */
 function elgg_remove_subscription($user_guid, $method, $target_guid) {
-	$methods = _elgg_services()->notifications->getMethods();
-	$db = _elgg_services()->db;
-	$subs = new \Elgg\Notifications\SubscriptionsService($db, $methods);
-	return $subs->removeSubscription($user_guid, $method, $target_guid);
+    $methods = _elgg_services()->notifications->getMethods();
+    $db = _elgg_services()->db;
+    $subs = new \Elgg\Notifications\SubscriptionsService($db, $methods);
+    return $subs->removeSubscription($user_guid, $method, $target_guid);
 }
 
 /**
@@ -169,10 +169,10 @@ 
  * @todo deprecate once new subscriptions system has been added
  */
 function elgg_get_subscriptions_for_container($container_guid) {
-	$methods = _elgg_services()->notifications->getMethods();
-	$db = _elgg_services()->db;
-	$subs = new \Elgg\Notifications\SubscriptionsService($db, $methods);
-	return $subs->getSubscriptionsForContainer($container_guid);
+    $methods = _elgg_services()->notifications->getMethods();
+    $db = _elgg_services()->db;
+    $subs = new \Elgg\Notifications\SubscriptionsService($db, $methods);
+    return $subs->getSubscriptionsForContainer($container_guid);
 }
 
 /**
@@ -191,17 +191,17 @@ 
  * @since 1.9
  */
 function _elgg_enqueue_notification_event($action, $type, $object) {
-	_elgg_services()->notifications->enqueueEvent($action, $type, $object);
+    _elgg_services()->notifications->enqueueEvent($action, $type, $object);
 }
 
 /**
  * @access private
  */
 function _elgg_notifications_cron() {
-	// calculate when we should stop
-	// @todo make configurable?
-	$stop_time = time() + 45;
-	_elgg_services()->notifications->processQueue($stop_time);
+    // calculate when we should stop
+    // @todo make configurable?
+    $stop_time = time() + 45;
+    _elgg_services()->notifications->processQueue($stop_time);
 }
 
 /**
@@ -216,39 +216,39 @@ 
  */
 function _elgg_send_email_notification($hook, $type, $result, $params) {
 	
-	if ($result === true) {
-		// assume someone else already sent the message
-		return;
-	}
+    if ($result === true) {
+        // assume someone else already sent the message
+        return;
+    }
 	
-	/* @var \Elgg\Notifications\Notification $message */
-	$message = $params['notification'];
-
-	$sender = $message->getSender();
-	$recipient = $message->getRecipient();
-
-	if (!$sender) {
-		return false;
-	}
-
-	if (!$recipient || !$recipient->email) {
-		return false;
-	}
-
-	$to = $recipient->email;
-
-	$site = elgg_get_site_entity();
-	// If there's an email address, use it - but only if it's not from a user.
-	if (!($sender instanceof \ElggUser) && $sender->email) {
-		$from = $sender->email;
-	} else if ($site->email) {
-		$from = $site->email;
-	} else {
-		// If all else fails, use the domain of the site.
-		$from = 'noreply@' . $site->getDomain();
-	}
-
-	return elgg_send_email($from, $to, $message->subject, $message->body, $params);
+    /* @var \Elgg\Notifications\Notification $message */
+    $message = $params['notification'];
+
+    $sender = $message->getSender();
+    $recipient = $message->getRecipient();
+
+    if (!$sender) {
+        return false;
+    }
+
+    if (!$recipient || !$recipient->email) {
+        return false;
+    }
+
+    $to = $recipient->email;
+
+    $site = elgg_get_site_entity();
+    // If there's an email address, use it - but only if it's not from a user.
+    if (!($sender instanceof \ElggUser) && $sender->email) {
+        $from = $sender->email;
+    } else if ($site->email) {
+        $from = $site->email;
+    } else {
+        // If all else fails, use the domain of the site.
+        $from = 'noreply@' . $site->getDomain();
+    }
+
+    return elgg_send_email($from, $to, $message->subject, $message->body, $params);
 }
 
 /**
@@ -267,19 +267,19 @@ 
  */
 function _elgg_notifications_smtp_default_message_id_header($hook, $type, $returnvalue, $params) {
 	
-	if (!is_array($returnvalue) || !is_array($returnvalue['params'])) {
-		// another hook handler returned a non-array, let's not override it
-		return;
-	}
+    if (!is_array($returnvalue) || !is_array($returnvalue['params'])) {
+        // another hook handler returned a non-array, let's not override it
+        return;
+    }
 	
-	$hostname = parse_url(elgg_get_site_url(), PHP_URL_HOST);
-	$url_path = parse_url(elgg_get_site_url(), PHP_URL_PATH);
+    $hostname = parse_url(elgg_get_site_url(), PHP_URL_HOST);
+    $url_path = parse_url(elgg_get_site_url(), PHP_URL_PATH);
 	
-	$mt = microtime(true);
+    $mt = microtime(true);
 	
-	$returnvalue['headers']['Message-ID'] = "{$url_path}.default.{$mt}@{$hostname}";
+    $returnvalue['headers']['Message-ID'] = "{$url_path}.default.{$mt}@{$hostname}";
 	
-	return $returnvalue;
+    return $returnvalue;
 }
 /**
  * Adds default thread SMTP headers to group messages correctly.
@@ -294,66 +294,66 @@ 
  */
 function _elgg_notifications_smtp_thread_headers($hook, $type, $returnvalue, $params) {
 
-	if (!is_array($returnvalue) || !is_array($returnvalue['params'])) {
-		// another hook handler returned a non-array, let's not override it
-		return;
-	}
-
-	$notificationParams = elgg_extract('params', $returnvalue, array());
-	/** @var \Elgg\Notifications\Notification */
-	$notification = elgg_extract('notification', $notificationParams);
-
-	if (!($notification instanceof \Elgg\Notifications\Notification)) {
-		return $returnvalue;
-	}
-
-	$hostname = parse_url(elgg_get_site_url(), PHP_URL_HOST);
-	$urlPath = parse_url(elgg_get_site_url(), PHP_URL_PATH);
-
-	$object = elgg_extract('object', $notification->params);
-	/** @var \Elgg\Notifications\Event $event */
-	$event = elgg_extract('event', $notification->params);
-
-	if (($object instanceof \ElggEntity) && ($event instanceof \Elgg\Notifications\NotificationEvent)) {
-		if ($event->getAction() === 'create') {
-			// create event happens once per entity and we need to guarantee message id uniqueness
-			// and at the same time have thread message id that we don't need to store
-			$messageId = "{$urlPath}.entity.{$object->guid}@{$hostname}";
-		} else {
-			$mt = microtime(true);
-			$messageId = "{$urlPath}.entity.{$object->guid}.$mt@{$hostname}";
-		}
-		$returnvalue['headers']["Message-ID"] = $messageId;
-		$container = $object->getContainerEntity();
-
-		// let's just thread comments by default
-		if (($container instanceof \ElggEntity) && ($object instanceof \ElggComment)) {
-
-			$threadMessageId = "<{$urlPath}.entity.{$container->guid}@{$hostname}>";
-			$returnvalue['headers']['In-Reply-To'] = $threadMessageId;
-			$returnvalue['headers']['References'] = $threadMessageId;
-		}
-	}
-
-	return $returnvalue;
+    if (!is_array($returnvalue) || !is_array($returnvalue['params'])) {
+        // another hook handler returned a non-array, let's not override it
+        return;
+    }
+
+    $notificationParams = elgg_extract('params', $returnvalue, array());
+    /** @var \Elgg\Notifications\Notification */
+    $notification = elgg_extract('notification', $notificationParams);
+
+    if (!($notification instanceof \Elgg\Notifications\Notification)) {
+        return $returnvalue;
+    }
+
+    $hostname = parse_url(elgg_get_site_url(), PHP_URL_HOST);
+    $urlPath = parse_url(elgg_get_site_url(), PHP_URL_PATH);
+
+    $object = elgg_extract('object', $notification->params);
+    /** @var \Elgg\Notifications\Event $event */
+    $event = elgg_extract('event', $notification->params);
+
+    if (($object instanceof \ElggEntity) && ($event instanceof \Elgg\Notifications\NotificationEvent)) {
+        if ($event->getAction() === 'create') {
+            // create event happens once per entity and we need to guarantee message id uniqueness
+            // and at the same time have thread message id that we don't need to store
+            $messageId = "{$urlPath}.entity.{$object->guid}@{$hostname}";
+        } else {
+            $mt = microtime(true);
+            $messageId = "{$urlPath}.entity.{$object->guid}.$mt@{$hostname}";
+        }
+        $returnvalue['headers']["Message-ID"] = $messageId;
+        $container = $object->getContainerEntity();
+
+        // let's just thread comments by default
+        if (($container instanceof \ElggEntity) && ($object instanceof \ElggComment)) {
+
+            $threadMessageId = "<{$urlPath}.entity.{$container->guid}@{$hostname}>";
+            $returnvalue['headers']['In-Reply-To'] = $threadMessageId;
+            $returnvalue['headers']['References'] = $threadMessageId;
+        }
+    }
+
+    return $returnvalue;
 }
 
 /**
  * @access private
  */
 function _elgg_notifications_init() {
-	elgg_register_plugin_hook_handler('cron', 'minute', '_elgg_notifications_cron', 100);
-	elgg_register_event_handler('all', 'all', '_elgg_enqueue_notification_event', 700);
-
-	// add email notifications
-	elgg_register_notification_method('email');
-	elgg_register_plugin_hook_handler('send', 'notification:email', '_elgg_send_email_notification');
-	elgg_register_plugin_hook_handler('email', 'system', '_elgg_notifications_smtp_default_message_id_header', 1);
-	elgg_register_plugin_hook_handler('email', 'system', '_elgg_notifications_smtp_thread_headers');
-
-	// add ability to set personal notification method
-	elgg_extend_view('forms/account/settings', 'core/settings/account/notifications');
-	elgg_register_plugin_hook_handler('usersettings:save', 'user', '_elgg_save_notification_user_settings');
+    elgg_register_plugin_hook_handler('cron', 'minute', '_elgg_notifications_cron', 100);
+    elgg_register_event_handler('all', 'all', '_elgg_enqueue_notification_event', 700);
+
+    // add email notifications
+    elgg_register_notification_method('email');
+    elgg_register_plugin_hook_handler('send', 'notification:email', '_elgg_send_email_notification');
+    elgg_register_plugin_hook_handler('email', 'system', '_elgg_notifications_smtp_default_message_id_header', 1);
+    elgg_register_plugin_hook_handler('email', 'system', '_elgg_notifications_smtp_thread_headers');
+
+    // add ability to set personal notification method
+    elgg_extend_view('forms/account/settings', 'core/settings/account/notifications');
+    elgg_register_plugin_hook_handler('usersettings:save', 'user', '_elgg_save_notification_user_settings');
 }
 
 /**
@@ -373,74 +373,74 @@ 
  */
 function _elgg_notify_user($to, $from, $subject, $message, array $params = null, $methods_override = "") {
 
-	$notify_service = _elgg_services()->notifications;
-
-	// Sanitise
-	if (!is_array($to)) {
-		$to = array((int) $to);
-	}
-	$from = (int) $from;
-	//$subject = sanitise_string($subject);
-	// Get notification methods
-	if (($methods_override) && (!is_array($methods_override))) {
-		$methods_override = array($methods_override);
-	}
-
-	$result = array();
-
-	foreach ($to as $guid) {
-		// Results for a user are...
-		$result[$guid] = array();
-
-		if ($guid) { // Is the guid > 0?
-			// Are we overriding delivery?
-			$methods = $methods_override;
-			if (!$methods) {
-				$tmp = get_user_notification_settings($guid);
-				$methods = array();
-				// $tmp may be false. don't cast
-				if (is_object($tmp)) {
-					foreach ($tmp as $k => $v) {
-						// Add method if method is turned on for user!
-						if ($v) {
-							$methods[] = $k;
-						}
-					}
-				}
-			}
-
-			if ($methods) {
-				// Deliver
-				foreach ($methods as $method) {
-
-					$handler = $notify_service->getDeprecatedHandler($method);
-					/* @var callable $handler */
-					if (!$handler || !is_callable($handler)) {
-						elgg_log("No handler registered for the method $method", 'WARNING');
-						continue;
-					}
-
-					elgg_log("Sending message to $guid using $method");
-
-					// Trigger handler and retrieve result.
-					try {
-						$result[$guid][$method] = call_user_func(
-							$handler,
-							$from ? get_entity($from) : null,
-							get_entity($guid),
-							$subject,
-							$message,
-							$params
-						);
-					} catch (Exception $e) {
-						error_log($e->getMessage());
-					}
-				}
-			}
-		}
-	}
-
-	return $result;
+    $notify_service = _elgg_services()->notifications;
+
+    // Sanitise
+    if (!is_array($to)) {
+        $to = array((int) $to);
+    }
+    $from = (int) $from;
+    //$subject = sanitise_string($subject);
+    // Get notification methods
+    if (($methods_override) && (!is_array($methods_override))) {
+        $methods_override = array($methods_override);
+    }
+
+    $result = array();
+
+    foreach ($to as $guid) {
+        // Results for a user are...
+        $result[$guid] = array();
+
+        if ($guid) { // Is the guid > 0?
+            // Are we overriding delivery?
+            $methods = $methods_override;
+            if (!$methods) {
+                $tmp = get_user_notification_settings($guid);
+                $methods = array();
+                // $tmp may be false. don't cast
+                if (is_object($tmp)) {
+                    foreach ($tmp as $k => $v) {
+                        // Add method if method is turned on for user!
+                        if ($v) {
+                            $methods[] = $k;
+                        }
+                    }
+                }
+            }
+
+            if ($methods) {
+                // Deliver
+                foreach ($methods as $method) {
+
+                    $handler = $notify_service->getDeprecatedHandler($method);
+                    /* @var callable $handler */
+                    if (!$handler || !is_callable($handler)) {
+                        elgg_log("No handler registered for the method $method", 'WARNING');
+                        continue;
+                    }
+
+                    elgg_log("Sending message to $guid using $method");
+
+                    // Trigger handler and retrieve result.
+                    try {
+                        $result[$guid][$method] = call_user_func(
+                            $handler,
+                            $from ? get_entity($from) : null,
+                            get_entity($guid),
+                            $subject,
+                            $message,
+                            $params
+                        );
+                    } catch (Exception $e) {
+                        error_log($e->getMessage());
+                    }
+                }
+            }
+        }
+    }
+
+    return $result;
 }
 
 /**
@@ -493,30 +493,30 @@ 
  */
 function notify_user($to, $from = 0, $subject = '', $message = '', array $params = array(), $methods_override = null) {
 
-	$params['subject'] = $subject;
-	$params['body'] = $message;
-	$params['methods_override'] = $methods_override;
-
-	if ($from) {
-		$sender = get_entity($from);
-	} else {
-		$sender = elgg_get_site_entity();
-	}
-	if (!$sender) {
-		return [];
-	}
-
-	$recipients = [];
-	$to = (array) $to;
-	foreach ($to as $guid) {
-		$recipient = get_entity($guid);
-		if (!$recipient) {
-			continue;
-		}
-		$recipients[] = $recipient;
-	}
-
-	return _elgg_services()->notifications->sendInstantNotifications($sender, $recipients, $params);
+    $params['subject'] = $subject;
+    $params['body'] = $message;
+    $params['methods_override'] = $methods_override;
+
+    if ($from) {
+        $sender = get_entity($from);
+    } else {
+        $sender = elgg_get_site_entity();
+    }
+    if (!$sender) {
+        return [];
+    }
+
+    $recipients = [];
+    $to = (array) $to;
+    foreach ($to as $guid) {
+        $recipient = get_entity($guid);
+        if (!$recipient) {
+            continue;
+        }
+        $recipients[] = $recipient;
+    }
+
+    return _elgg_services()->notifications->sendInstantNotifications($sender, $recipients, $params);
 }
 
 /**
@@ -529,18 +529,18 @@ 
  */
 function get_user_notification_settings($user_guid = 0) {
 
-	elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::getNotificationSettings()', '2.3');
+    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::getNotificationSettings()', '2.3');
 
-	if ((int) $user_guid == 0) {
-		$user_guid = elgg_get_logged_in_user_guid();
-	}
+    if ((int) $user_guid == 0) {
+        $user_guid = elgg_get_logged_in_user_guid();
+    }
 
-	$user = get_entity($user_guid);
-	if (!$user instanceof \ElggUser) {
-		return false;
-	}
+    $user = get_entity($user_guid);
+    if (!$user instanceof \ElggUser) {
+        return false;
+    }
 
-	return (object) $user->getNotificationSettings();
+    return (object) $user->getNotificationSettings();
 }
 
 /**
@@ -554,26 +554,26 @@ 
  * @deprecated 2.3
  */
 function set_user_notification_setting($user_guid, $method, $value) {
-	elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::setNotificationSetting()', '2.3');
-
-	if (!$user_guid) {
-		$user_guid = elgg_get_logged_in_user_guid();
-	}
-	$user = get_entity($user_guid);
-	if (!$user instanceof \ElggUser) {
-		return false;
-	}
-
-	if (is_string($value)) {
-		$value = strtolower($value);
-	}
-	if ($value == 'yes' || $value == 'on' || $value == 'enabled') {
-		$value = true;
-	} else if ($value == 'no' || $value == 'off' || $value == 'disabled') {
-		$value = false;
-	}
-
-	return $user->setNotificationSetting($method, (bool) $value);
+    elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::setNotificationSetting()', '2.3');
+
+    if (!$user_guid) {
+        $user_guid = elgg_get_logged_in_user_guid();
+    }
+    $user = get_entity($user_guid);
+    if (!$user instanceof \ElggUser) {
+        return false;
+    }
+
+    if (is_string($value)) {
+        $value = strtolower($value);
+    }
+    if ($value == 'yes' || $value == 'on' || $value == 'enabled') {
+        $value = true;
+    } else if ($value == 'no' || $value == 'off' || $value == 'disabled') {
+        $value = false;
+    }
+
+    return $user->setNotificationSetting($method, (bool) $value);
 }
 
 /**
@@ -590,79 +590,79 @@ 
  * @since 1.7.2
  */
 function elgg_send_email($from, $to, $subject, $body, array $params = null) {
-	if (!$from) {
-		$msg = "Missing a required parameter, '" . 'from' . "'";
-		throw new \NotificationException($msg);
-	}
-
-	if (!$to) {
-		$msg = "Missing a required parameter, '" . 'to' . "'";
-		throw new \NotificationException($msg);
-	}
-
-	$headers = array(
-		"Content-Type" => "text/plain; charset=UTF-8; format=flowed",
-		"MIME-Version" => "1.0",
-		"Content-Transfer-Encoding" => "8bit",
-	);
-
-	// return true/false to stop elgg_send_email() from sending
-	$mail_params = array(
-		'to' => $to,
-		'from' => $from,
-		'subject' => $subject,
-		'body' => $body,
-		'headers' => $headers,
-		'params' => $params,
-	);
-
-	// $mail_params is passed as both params and return value. The former is for backwards
-	// compatibility. The latter is so handlers can now alter the contents/headers of
-	// the email by returning the array
-	$result = _elgg_services()->hooks->trigger('email', 'system', $mail_params, $mail_params);
-	if (!is_array($result)) {
-		// don't need null check: Handlers can't set a hook value to null!
-		return (bool) $result;
-	}
-
-	// strip name from to and from
-
-	$to_address = Address::fromString($result['to']);
-	$from_address = Address::fromString($result['from']);
-
-
-	$subject = elgg_strip_tags($result['subject']);
-	$subject = html_entity_decode($subject, ENT_QUOTES, 'UTF-8');
-	// Sanitise subject by stripping line endings
-	$subject = preg_replace("/(\r\n|\r|\n)/", " ", $subject);
-	$subject = trim($subject);
-
-	$body = elgg_strip_tags($result['body']);
-	$body = html_entity_decode($body, ENT_QUOTES, 'UTF-8');
-	$body = wordwrap($body);
-
-	$message = new Message();
-	$message->setEncoding('UTF-8');
-	$message->addFrom($from_address);
-	$message->addTo($to_address);
-	$message->setSubject($subject);
-	$message->setBody($body);
-
-	foreach ($result['headers'] as $headerName => $headerValue) {
-		// Create a headerline in the format 'name: value'
-		// This is done to force correct class detection for each header type
-		// which influences the output of the header in the message
-		$message->getHeaders()->addHeaderLine("{$headerName}: {$headerValue}");
-	}
-
-	try {
-		_elgg_services()->mailer->send($message);
-	} catch (\Zend\Mail\Exception\RuntimeException $e) {
-		_elgg_services()->logger->error($e->getMessage());
-		return false;
-	}
-
-	return true;
+    if (!$from) {
+        $msg = "Missing a required parameter, '" . 'from' . "'";
+        throw new \NotificationException($msg);
+    }
+
+    if (!$to) {
+        $msg = "Missing a required parameter, '" . 'to' . "'";
+        throw new \NotificationException($msg);
+    }
+
+    $headers = array(
+        "Content-Type" => "text/plain; charset=UTF-8; format=flowed",
+        "MIME-Version" => "1.0",
+        "Content-Transfer-Encoding" => "8bit",
+    );
+
+    // return true/false to stop elgg_send_email() from sending
+    $mail_params = array(
+        'to' => $to,
+        'from' => $from,
+        'subject' => $subject,
+        'body' => $body,
+        'headers' => $headers,
+        'params' => $params,
+    );
+
+    // $mail_params is passed as both params and return value. The former is for backwards
+    // compatibility. The latter is so handlers can now alter the contents/headers of
+    // the email by returning the array
+    $result = _elgg_services()->hooks->trigger('email', 'system', $mail_params, $mail_params);
+    if (!is_array($result)) {
+        // don't need null check: Handlers can't set a hook value to null!
+        return (bool) $result;
+    }
+
+    // strip name from to and from
+
+    $to_address = Address::fromString($result['to']);
+    $from_address = Address::fromString($result['from']);
+
+
+    $subject = elgg_strip_tags($result['subject']);
+    $subject = html_entity_decode($subject, ENT_QUOTES, 'UTF-8');
+    // Sanitise subject by stripping line endings
+    $subject = preg_replace("/(\r\n|\r|\n)/", " ", $subject);
+    $subject = trim($subject);
+
+    $body = elgg_strip_tags($result['body']);
+    $body = html_entity_decode($body, ENT_QUOTES, 'UTF-8');
+    $body = wordwrap($body);
+
+    $message = new Message();
+    $message->setEncoding('UTF-8');
+    $message->addFrom($from_address);
+    $message->addTo($to_address);
+    $message->setSubject($subject);
+    $message->setBody($body);
+
+    foreach ($result['headers'] as $headerName => $headerValue) {
+        // Create a headerline in the format 'name: value'
+        // This is done to force correct class detection for each header type
+        // which influences the output of the header in the message
+        $message->getHeaders()->addHeaderLine("{$headerName}: {$headerValue}");
+    }
+
+    try {
+        _elgg_services()->mailer->send($message);
+    } catch (\Zend\Mail\Exception\RuntimeException $e) {
+        _elgg_services()->logger->error($e->getMessage());
+        return false;
+    }
+
+    return true;
 }
 
 /**
@@ -673,44 +673,44 @@ 
  */
 function _elgg_save_notification_user_settings() {
 
-	$user = elgg_get_logged_in_user_entity();
-	if (!$user) {
-		return;
-	}
+    $user = elgg_get_logged_in_user_entity();
+    if (!$user) {
+        return;
+    }
 
-	$method = get_input('method');
+    $method = get_input('method');
 
-	$current_settings = $user->getNotificationSettings();
+    $current_settings = $user->getNotificationSettings();
 
-	$result = false;
-	foreach ($method as $k => $v) {
-		// check if setting has changed and skip if not
-		if ($current_settings[$k] == ($v == 'yes')) {
-			continue;
-		}
+    $result = false;
+    foreach ($method as $k => $v) {
+        // check if setting has changed and skip if not
+        if ($current_settings[$k] == ($v == 'yes')) {
+            continue;
+        }
 
-		$result = $user->setNotificationSetting($k, ($v == 'yes'));
-		if (!$result) {
-			register_error(elgg_echo('notifications:usersettings:save:fail'));
-		}
-	}
+        $result = $user->setNotificationSetting($k, ($v == 'yes'));
+        if (!$result) {
+            register_error(elgg_echo('notifications:usersettings:save:fail'));
+        }
+    }
 
-	if ($result) {
-		system_message(elgg_echo('notifications:usersettings:save:ok'));
-	}
+    if ($result) {
+        system_message(elgg_echo('notifications:usersettings:save:ok'));
+    }
 }
 
 /**
  * @access private
  */
 function _elgg_notifications_test($hook, $type, $tests) {
-	global $CONFIG;
-	$tests[] = "{$CONFIG->path}engine/tests/ElggCoreDatabaseQueueTest.php";
-	return $tests;
+    global $CONFIG;
+    $tests[] = "{$CONFIG->path}engine/tests/ElggCoreDatabaseQueueTest.php";
+    return $tests;
 }
 
 return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
-	$events->registerHandler('init', 'system', '_elgg_notifications_init');
+    $events->registerHandler('init', 'system', '_elgg_notifications_init');
 
-	$hooks->registerHandler('unit_test', 'system', '_elgg_notifications_test');
+    $hooks->registerHandler('unit_test', 'system', '_elgg_notifications_test');
 };

Spacing +5 added lines, -5 removed lines

@@ -245,7 +245,7 @@ 
 		$from = $site->email;
 	} else {
 		// If all else fails, use the domain of the site.
-		$from = 'noreply@' . $site->getDomain();
+		$from = 'noreply@'.$site->getDomain();
 	}
 
 	return elgg_send_email($from, $to, $message->subject, $message->body, $params);
@@ -529,7 +529,7 @@ 
  */
 function get_user_notification_settings($user_guid = 0) {
 
-	elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::getNotificationSettings()', '2.3');
+	elgg_deprecated_notice(__FUNCTION__.' has been deprecated by ElggUser::getNotificationSettings()', '2.3');
 
 	if ((int) $user_guid == 0) {
 		$user_guid = elgg_get_logged_in_user_guid();
@@ -554,7 +554,7 @@ 
  * @deprecated 2.3
  */
 function set_user_notification_setting($user_guid, $method, $value) {
-	elgg_deprecated_notice(__FUNCTION__ . ' has been deprecated by ElggUser::setNotificationSetting()', '2.3');
+	elgg_deprecated_notice(__FUNCTION__.' has been deprecated by ElggUser::setNotificationSetting()', '2.3');
 
 	if (!$user_guid) {
 		$user_guid = elgg_get_logged_in_user_guid();
@@ -591,12 +591,12 @@ 
  */
 function elgg_send_email($from, $to, $subject, $body, array $params = null) {
 	if (!$from) {
-		$msg = "Missing a required parameter, '" . 'from' . "'";
+		$msg = "Missing a required parameter, '".'from'."'";
 		throw new \NotificationException($msg);
 	}
 
 	if (!$to) {
-		$msg = "Missing a required parameter, '" . 'to' . "'";
+		$msg = "Missing a required parameter, '".'to'."'";
 		throw new \NotificationException($msg);
 	}
 

engine/classes/Elgg/Di/ServiceProvider.php

Indentation +398 added lines, -398 removed lines

@@ -89,402 +89,402 @@
  */
 class ServiceProvider extends \Elgg\Di\DiContainer {
 
-	/**
-	 * Constructor
-	 *
-	 * @param \Elgg\Config $config Elgg Config service
-	 */
-	public function __construct(\Elgg\Config $config) {
-
-		$this->setFactory('classLoader', function(ServiceProvider $c) {
-			$loader = new \Elgg\ClassLoader(new \Elgg\ClassMap());
-			$loader->register();
-			return $loader;
-		});
-
-		$this->setFactory('autoloadManager', function(ServiceProvider $c) {
-			$manager = new \Elgg\AutoloadManager($c->classLoader);
-			if (!$c->config->get('AutoloaderManager_skip_storage')) {
-				$manager->setStorage($c->fileCache);
-				$manager->loadCache();
-			}
-			return $manager;
-		});
-
-		$this->setFactory('accessCache', function(ServiceProvider $c) {
-			return new \ElggStaticVariableCache('access');
-		});
-
-		$this->setFactory('accessCollections', function(ServiceProvider $c) {
-			return new \Elgg\Database\AccessCollections(
-					$c->config, $c->db, $c->entityTable, $c->accessCache, $c->hooks, $c->session, $c->translator);
-		});
-
-		$this->setFactory('actions', function(ServiceProvider $c) {
-			return new \Elgg\ActionsService($c->config, $c->session, $c->crypto);
-		});
-
-		$this->setClassName('adminNotices', \Elgg\Database\AdminNotices::class);
-
-		$this->setFactory('ajax', function(ServiceProvider $c) {
-			return new \Elgg\Ajax\Service($c->hooks, $c->systemMessages, $c->input, $c->amdConfig);
-		});
-
-		$this->setFactory('amdConfig', function(ServiceProvider $c) {
-			$obj = new \Elgg\Amd\Config($c->hooks);
-			$obj->setBaseUrl($c->simpleCache->getRoot());
-			return $obj;
-		});
-
-		$this->setFactory('annotations', function(ServiceProvider $c) {
-			return new \Elgg\Database\Annotations($c->db, $c->session, $c->events);
-		});
-
-		$this->setClassName('autoP', \ElggAutoP::class);
-
-		$this->setFactory('boot', function(ServiceProvider $c) {
-			$boot = new \Elgg\BootService();
-			if ($c->config->getVolatile('enable_profiling')) {
-				$boot->setTimer($c->timer);
-			}
-			return $boot;
-		});
-
-		$this->setValue('config', $config);
-
-		$this->setClassName('configTable', \Elgg\Database\ConfigTable::class);
-
-		$this->setClassName('context', \Elgg\Context::class);
-
-		$this->setFactory('crypto', function(ServiceProvider $c) {
-			return new \ElggCrypto($c->siteSecret);
-		});
-
-		$this->setFactory('datalist', function(ServiceProvider $c) {
-			// TODO(ewinslow): Add back memcached support
-			$db = $c->db;
-			$dbprefix = $db->prefix;
-			$pool = new Pool\InMemory();
-			return new \Elgg\Database\Datalist($pool, $db, $c->logger, "{$dbprefix}datalists");
-		});
-
-		$this->setFactory('db', function(ServiceProvider $c) {
-			// gonna need dbprefix from settings
-			$c->config->loadSettingsFile();
-			$db_config = new \Elgg\Database\Config($c->config->getStorageObject());
-
-			// we inject the logger in _elgg_engine_boot()
-			$db = new \Elgg\Database($db_config);
-
-			if ($c->config->getVolatile('profiling_sql')) {
-				$db->setTimer($c->timer);
-			}
-
-			return $db;
-		});
-
-		$this->setFactory('deprecation', function(ServiceProvider $c) {
-			return new \Elgg\DeprecationService($c->logger);
-		});
-
-		$this->setFactory('entityCache', function(ServiceProvider $c) {
-			return new \Elgg\Cache\EntityCache($c->session, $c->metadataCache);
-		});
-
-		$this->setFactory('entityPreloader', function(ServiceProvider $c) {
-			return new \Elgg\EntityPreloader($c->entityCache, $c->entityTable);
-		});
-
-		$this->setFactory('entityTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\EntityTable(
-				$c->config,
-				$c->db,
-				$c->entityCache,
-				$c->metadataCache,
-				$c->subtypeTable,
-				$c->events,
-				$c->session,
-				$c->translator,
-				$c->logger
-			);
-		});
-
-		$this->setFactory('events', function(ServiceProvider $c) {
-			return $this->resolveLoggerDependencies('events');
-		});
-
-		$this->setFactory('externalFiles', function(ServiceProvider $c) {
-			return new \Elgg\Assets\ExternalFiles($c->config->getStorageObject());
-		});
-
-		$this->setFactory('fileCache', function(ServiceProvider $c) {
-			return new \ElggFileCache($c->config->getCachePath() . 'system_cache/');
-		});
-
-		$this->setFactory('forms', function(ServiceProvider $c) {
-			return new \Elgg\FormsService($c->views, $c->logger);
-		});
-
-		$this->setFactory('hooks', function(ServiceProvider $c) {
-			return $this->resolveLoggerDependencies('hooks');
-		});
-
-		$this->setFactory('iconService', function(ServiceProvider $c) {
-			return new \Elgg\EntityIconService($c->config, $c->hooks, $c->request, $c->logger, $c->entityTable);
-		});
-
-		$this->setClassName('input', \Elgg\Http\Input::class);
-
-		$this->setFactory('imageService', function(ServiceProvider $c) {
-			$imagine = new \Imagine\Gd\Imagine();
-			return new \Elgg\ImageService($imagine, $c->config);
-		});
-
-		$this->setFactory('logger', function(ServiceProvider $c) {
-			return $this->resolveLoggerDependencies('logger');
-		});
-
-		// TODO(evan): Support configurable transports...
-		$this->setClassName('mailer', 'Zend\Mail\Transport\Sendmail');
-
-		$this->setFactory('menus', function(ServiceProvider $c) {
-			return new \Elgg\Menu\Service($c->hooks, $c->config);
-		});
-
-		$this->setFactory('metadataCache', function (ServiceProvider $c) {
-			return new \Elgg\Cache\MetadataCache($c->session);
-		});
-
-		$this->setFactory('memcacheStashPool', function(ServiceProvider $c) {
-			if (!$c->config->getVolatile('memcache')) {
-				return null;
-			}
-
-			$servers = $c->config->getVolatile('memcache_servers');
-			if (!$servers) {
-				return null;
-			}
-			$driver = new \Stash\Driver\Memcache([
-				'servers' => $servers,
-			]);
-			return new \Stash\Pool($driver);
-		});
-
-		$this->setFactory('metadataTable', function(ServiceProvider $c) {
-			// TODO(ewinslow): Use Pool instead of MetadataCache for caching
-			return new \Elgg\Database\MetadataTable(
-				$c->metadataCache, $c->db, $c->entityTable, $c->events, $c->metastringsTable, $c->session);
-		});
-
-		$this->setFactory('metastringsTable', function(ServiceProvider $c) {
-			// TODO(ewinslow): Use memcache-based Pool if available...
-			$pool = new Pool\InMemory();
-			return new \Elgg\Database\MetastringsTable($pool, $c->db);
-		});
-
-		$this->setFactory('mutex', function(ServiceProvider $c) {
-			return new \Elgg\Database\Mutex(
-				$c->db,
-				$c->logger
-			);
-		});
-
-		$this->setFactory('notifications', function(ServiceProvider $c) {
-			// @todo move queue in service provider
-			$queue_name = \Elgg\Notifications\NotificationsService::QUEUE_NAME;
-			$queue = new \Elgg\Queue\DatabaseQueue($queue_name, $c->db);
-			$sub = new \Elgg\Notifications\SubscriptionsService($c->db);
-			return new \Elgg\Notifications\NotificationsService($sub, $queue, $c->hooks, $c->session, $c->translator, $c->entityTable, $c->logger);
-		});
-
-		$this->setClassName('nullCache', \Elgg\Cache\NullCache::class);
-
-		$this->setFactory('persistentLogin', function(ServiceProvider $c) {
-			$global_cookies_config = $c->config->getCookieConfig();
-			$cookie_config = $global_cookies_config['remember_me'];
-			$cookie_name = $cookie_config['name'];
-			$cookie_token = $c->request->cookies->get($cookie_name, '');
-			return new \Elgg\PersistentLoginService(
-				$c->db, $c->session, $c->crypto, $cookie_config, $cookie_token);
-		});
-
-		$this->setClassName('passwords', \Elgg\PasswordService::class);
-
-		$this->setFactory('plugins', function(ServiceProvider $c) {
-			$pool = new Pool\InMemory();
-			$plugins = new \Elgg\Database\Plugins($pool, $c->pluginSettingsCache);
-			if ($c->config->getVolatile('enable_profiling')) {
-				$plugins->setTimer($c->timer);
-			}
-			return $plugins;
-		});
-
-		$this->setClassName('pluginSettingsCache', \Elgg\Cache\PluginSettingsCache::class);
-
-		$this->setFactory('privateSettings', function(ServiceProvider $c) {
-			return new \Elgg\Database\PrivateSettingsTable($c->db, $c->entityTable, $c->pluginSettingsCache);
-		});
-
-		$this->setFactory('publicDb', function(ServiceProvider $c) {
-			return new \Elgg\Application\Database($c->db);
-		});
-
-		$this->setFactory('queryCounter', function(ServiceProvider $c) {
-			return new \Elgg\Database\QueryCounter($c->db);
-		}, false);
-
-		$this->setFactory('redirects', function(ServiceProvider $c) {
-			$url = current_page_url();
-			$is_xhr = $c->request->isXmlHttpRequest();
-			return new \Elgg\RedirectService($c->session, $is_xhr, $c->config->getSiteUrl(), $url);
-		});
-
-		$this->setFactory('relationshipsTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\RelationshipsTable($c->db, $c->entityTable, $c->metadataTable, $c->events);
-		});
-
-		$this->setFactory('request', [\Elgg\Http\Request::class, 'createFromGlobals']);
-
-		$this->setFactory('responseFactory', function(ServiceProvider $c) {
-			if (PHP_SAPI === 'cli') {
-				$transport = new \Elgg\Http\OutputBufferTransport();
-			} else {
-				$transport = new \Elgg\Http\HttpProtocolTransport();
-			}
-			return new \Elgg\Http\ResponseFactory($c->request, $c->hooks, $c->ajax, $transport);
-		});
-
-		$this->setFactory('router', function(ServiceProvider $c) {
-			// TODO(evan): Init routes from plugins or cache
-			$router = new \Elgg\Router($c->hooks);
-			if ($c->config->getVolatile('enable_profiling')) {
-				$router->setTimer($c->timer);
-			}
-			return $router;
-		});
-
-		$this->setFactory('seeder', function(ServiceProvider $c) {
-			return new \Elgg\Database\Seeder($c->hooks);
-		});
-
-		$this->setFactory('serveFileHandler', function(ServiceProvider $c) {
-			return new \Elgg\Application\ServeFileHandler($c->crypto, $c->config);
-		});
-
-		$this->setFactory('session', function(ServiceProvider $c) {
-			$params = $c->config->getCookieConfig()['session'];
-			$options = [
-				// session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
-				// constructor, so we must capture and inject it directly.
-				'cache_limiter' => session_cache_limiter(),
-
-				'name' => $params['name'],
-				'cookie_path' => $params['path'],
-				'cookie_domain' => $params['domain'],
-				'cookie_secure' => $params['secure'],
-				'cookie_httponly' => $params['httponly'],
-				'cookie_lifetime' => $params['lifetime'],
-			];
-
-			$handler = new \Elgg\Http\DatabaseSessionHandler($c->db);
-			$storage = new NativeSessionStorage($options, $handler);
-			$session = new SymfonySession($storage);
-			return new \ElggSession($session);
-		});
-
-		$this->setClassName('urlSigner', \Elgg\Security\UrlSigner::class);
-
-		$this->setFactory('simpleCache', function(ServiceProvider $c) {
-			return new \Elgg\Cache\SimpleCache($c->config, $c->datalist, $c->views);
-		});
-
-		$this->setFactory('siteSecret', function(ServiceProvider $c) {
-			return new \Elgg\Database\SiteSecret($c->datalist);
-		});
-
-		$this->setClassName('stickyForms', \Elgg\Forms\StickyForms::class);
-
-		$this->setFactory('subtypeTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\SubtypeTable($c->db);
-		});
-
-		$this->setFactory('systemCache', function (ServiceProvider $c) {
-			$cache = new \Elgg\Cache\SystemCache($c->fileCache, $c->config, $c->datalist);
-			if ($c->config->getVolatile('enable_profiling')) {
-				$cache->setTimer($c->timer);
-			}
-			return $cache;
-		});
-
-		$this->setFactory('systemMessages', function(ServiceProvider $c) {
-			return new \Elgg\SystemMessagesService($c->session);
-		});
-
-		$this->setClassName('table_columns', \Elgg\Views\TableColumn\ColumnFactory::class);
-
-		$this->setClassName('timer', \Elgg\Timer::class);
-
-		$this->setClassName('translator', \Elgg\I18n\Translator::class);
-
-		$this->setFactory('uploads', function(ServiceProvider $c) {
-			return new \Elgg\UploadService($c->request);
-		});
-
-		$this->setFactory('upgrades', function(ServiceProvider $c) {
-			return new \Elgg\UpgradeService(
-				$c->translator,
-				$c->events,
-				$c->hooks,
-				$c->datalist,
-				$c->logger,
-				$c->mutex
-			);
-		});
-
-		$this->setFactory('userCapabilities', function(ServiceProvider $c) {
-			return new \Elgg\UserCapabilities($c->hooks, $c->entityTable, $c->session);
-		});
-
-		$this->setFactory('usersTable', function(ServiceProvider $c) {
-			return new \Elgg\Database\UsersTable(
-				$c->config,
-				$c->db,
-				$c->entityTable,
-				$c->entityCache,
-				$c->events
-			);
-		});
-
-		$this->setFactory('views', function(ServiceProvider $c) {
-			return new \Elgg\ViewsService($c->hooks, $c->logger);
-		});
-
-		$this->setClassName('widgets', \Elgg\WidgetsService::class);
-
-	}
-
-	/**
-	 * Returns the first requested service of the logger, events, and hooks. It sets the
-	 * hooks and events up in the right order to prevent circular dependency.
-	 *
-	 * @param string $service_needed The service requested first
-	 * @return mixed
-	 */
-	protected function resolveLoggerDependencies($service_needed) {
-		$svcs['hooks'] = new \Elgg\PluginHooksService();
-
-		$svcs['logger'] = new \Elgg\Logger($svcs['hooks'], $this->config, $this->context);
-		$svcs['hooks']->setLogger($svcs['logger']);
-
-		$svcs['events'] = new \Elgg\EventsService();
-		$svcs['events']->setLogger($svcs['logger']);
-		if ($this->config->getVolatile('enable_profiling')) {
-			$svcs['events']->setTimer($this->timer);
-		}
-
-		foreach ($svcs as $key => $service) {
-			$this->setValue($key, $service);
-		}
-		return $svcs[$service_needed];
-	}
+    /**
+     * Constructor
+     *
+     * @param \Elgg\Config $config Elgg Config service
+     */
+    public function __construct(\Elgg\Config $config) {
+
+        $this->setFactory('classLoader', function(ServiceProvider $c) {
+            $loader = new \Elgg\ClassLoader(new \Elgg\ClassMap());
+            $loader->register();
+            return $loader;
+        });
+
+        $this->setFactory('autoloadManager', function(ServiceProvider $c) {
+            $manager = new \Elgg\AutoloadManager($c->classLoader);
+            if (!$c->config->get('AutoloaderManager_skip_storage')) {
+                $manager->setStorage($c->fileCache);
+                $manager->loadCache();
+            }
+            return $manager;
+        });
+
+        $this->setFactory('accessCache', function(ServiceProvider $c) {
+            return new \ElggStaticVariableCache('access');
+        });
+
+        $this->setFactory('accessCollections', function(ServiceProvider $c) {
+            return new \Elgg\Database\AccessCollections(
+                    $c->config, $c->db, $c->entityTable, $c->accessCache, $c->hooks, $c->session, $c->translator);
+        });
+
+        $this->setFactory('actions', function(ServiceProvider $c) {
+            return new \Elgg\ActionsService($c->config, $c->session, $c->crypto);
+        });
+
+        $this->setClassName('adminNotices', \Elgg\Database\AdminNotices::class);
+
+        $this->setFactory('ajax', function(ServiceProvider $c) {
+            return new \Elgg\Ajax\Service($c->hooks, $c->systemMessages, $c->input, $c->amdConfig);
+        });
+
+        $this->setFactory('amdConfig', function(ServiceProvider $c) {
+            $obj = new \Elgg\Amd\Config($c->hooks);
+            $obj->setBaseUrl($c->simpleCache->getRoot());
+            return $obj;
+        });
+
+        $this->setFactory('annotations', function(ServiceProvider $c) {
+            return new \Elgg\Database\Annotations($c->db, $c->session, $c->events);
+        });
+
+        $this->setClassName('autoP', \ElggAutoP::class);
+
+        $this->setFactory('boot', function(ServiceProvider $c) {
+            $boot = new \Elgg\BootService();
+            if ($c->config->getVolatile('enable_profiling')) {
+                $boot->setTimer($c->timer);
+            }
+            return $boot;
+        });
+
+        $this->setValue('config', $config);
+
+        $this->setClassName('configTable', \Elgg\Database\ConfigTable::class);
+
+        $this->setClassName('context', \Elgg\Context::class);
+
+        $this->setFactory('crypto', function(ServiceProvider $c) {
+            return new \ElggCrypto($c->siteSecret);
+        });
+
+        $this->setFactory('datalist', function(ServiceProvider $c) {
+            // TODO(ewinslow): Add back memcached support
+            $db = $c->db;
+            $dbprefix = $db->prefix;
+            $pool = new Pool\InMemory();
+            return new \Elgg\Database\Datalist($pool, $db, $c->logger, "{$dbprefix}datalists");
+        });
+
+        $this->setFactory('db', function(ServiceProvider $c) {
+            // gonna need dbprefix from settings
+            $c->config->loadSettingsFile();
+            $db_config = new \Elgg\Database\Config($c->config->getStorageObject());
+
+            // we inject the logger in _elgg_engine_boot()
+            $db = new \Elgg\Database($db_config);
+
+            if ($c->config->getVolatile('profiling_sql')) {
+                $db->setTimer($c->timer);
+            }
+
+            return $db;
+        });
+
+        $this->setFactory('deprecation', function(ServiceProvider $c) {
+            return new \Elgg\DeprecationService($c->logger);
+        });
+
+        $this->setFactory('entityCache', function(ServiceProvider $c) {
+            return new \Elgg\Cache\EntityCache($c->session, $c->metadataCache);
+        });
+
+        $this->setFactory('entityPreloader', function(ServiceProvider $c) {
+            return new \Elgg\EntityPreloader($c->entityCache, $c->entityTable);
+        });
+
+        $this->setFactory('entityTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\EntityTable(
+                $c->config,
+                $c->db,
+                $c->entityCache,
+                $c->metadataCache,
+                $c->subtypeTable,
+                $c->events,
+                $c->session,
+                $c->translator,
+                $c->logger
+            );
+        });
+
+        $this->setFactory('events', function(ServiceProvider $c) {
+            return $this->resolveLoggerDependencies('events');
+        });
+
+        $this->setFactory('externalFiles', function(ServiceProvider $c) {
+            return new \Elgg\Assets\ExternalFiles($c->config->getStorageObject());
+        });
+
+        $this->setFactory('fileCache', function(ServiceProvider $c) {
+            return new \ElggFileCache($c->config->getCachePath() . 'system_cache/');
+        });
+
+        $this->setFactory('forms', function(ServiceProvider $c) {
+            return new \Elgg\FormsService($c->views, $c->logger);
+        });
+
+        $this->setFactory('hooks', function(ServiceProvider $c) {
+            return $this->resolveLoggerDependencies('hooks');
+        });
+
+        $this->setFactory('iconService', function(ServiceProvider $c) {
+            return new \Elgg\EntityIconService($c->config, $c->hooks, $c->request, $c->logger, $c->entityTable);
+        });
+
+        $this->setClassName('input', \Elgg\Http\Input::class);
+
+        $this->setFactory('imageService', function(ServiceProvider $c) {
+            $imagine = new \Imagine\Gd\Imagine();
+            return new \Elgg\ImageService($imagine, $c->config);
+        });
+
+        $this->setFactory('logger', function(ServiceProvider $c) {
+            return $this->resolveLoggerDependencies('logger');
+        });
+
+        // TODO(evan): Support configurable transports...
+        $this->setClassName('mailer', 'Zend\Mail\Transport\Sendmail');
+
+        $this->setFactory('menus', function(ServiceProvider $c) {
+            return new \Elgg\Menu\Service($c->hooks, $c->config);
+        });
+
+        $this->setFactory('metadataCache', function (ServiceProvider $c) {
+            return new \Elgg\Cache\MetadataCache($c->session);
+        });
+
+        $this->setFactory('memcacheStashPool', function(ServiceProvider $c) {
+            if (!$c->config->getVolatile('memcache')) {
+                return null;
+            }
+
+            $servers = $c->config->getVolatile('memcache_servers');
+            if (!$servers) {
+                return null;
+            }
+            $driver = new \Stash\Driver\Memcache([
+                'servers' => $servers,
+            ]);
+            return new \Stash\Pool($driver);
+        });
+
+        $this->setFactory('metadataTable', function(ServiceProvider $c) {
+            // TODO(ewinslow): Use Pool instead of MetadataCache for caching
+            return new \Elgg\Database\MetadataTable(
+                $c->metadataCache, $c->db, $c->entityTable, $c->events, $c->metastringsTable, $c->session);
+        });
+
+        $this->setFactory('metastringsTable', function(ServiceProvider $c) {
+            // TODO(ewinslow): Use memcache-based Pool if available...
+            $pool = new Pool\InMemory();
+            return new \Elgg\Database\MetastringsTable($pool, $c->db);
+        });
+
+        $this->setFactory('mutex', function(ServiceProvider $c) {
+            return new \Elgg\Database\Mutex(
+                $c->db,
+                $c->logger
+            );
+        });
+
+        $this->setFactory('notifications', function(ServiceProvider $c) {
+            // @todo move queue in service provider
+            $queue_name = \Elgg\Notifications\NotificationsService::QUEUE_NAME;
+            $queue = new \Elgg\Queue\DatabaseQueue($queue_name, $c->db);
+            $sub = new \Elgg\Notifications\SubscriptionsService($c->db);
+            return new \Elgg\Notifications\NotificationsService($sub, $queue, $c->hooks, $c->session, $c->translator, $c->entityTable, $c->logger);
+        });
+
+        $this->setClassName('nullCache', \Elgg\Cache\NullCache::class);
+
+        $this->setFactory('persistentLogin', function(ServiceProvider $c) {
+            $global_cookies_config = $c->config->getCookieConfig();
+            $cookie_config = $global_cookies_config['remember_me'];
+            $cookie_name = $cookie_config['name'];
+            $cookie_token = $c->request->cookies->get($cookie_name, '');
+            return new \Elgg\PersistentLoginService(
+                $c->db, $c->session, $c->crypto, $cookie_config, $cookie_token);
+        });
+
+        $this->setClassName('passwords', \Elgg\PasswordService::class);
+
+        $this->setFactory('plugins', function(ServiceProvider $c) {
+            $pool = new Pool\InMemory();
+            $plugins = new \Elgg\Database\Plugins($pool, $c->pluginSettingsCache);
+            if ($c->config->getVolatile('enable_profiling')) {
+                $plugins->setTimer($c->timer);
+            }
+            return $plugins;
+        });
+
+        $this->setClassName('pluginSettingsCache', \Elgg\Cache\PluginSettingsCache::class);
+
+        $this->setFactory('privateSettings', function(ServiceProvider $c) {
+            return new \Elgg\Database\PrivateSettingsTable($c->db, $c->entityTable, $c->pluginSettingsCache);
+        });
+
+        $this->setFactory('publicDb', function(ServiceProvider $c) {
+            return new \Elgg\Application\Database($c->db);
+        });
+
+        $this->setFactory('queryCounter', function(ServiceProvider $c) {
+            return new \Elgg\Database\QueryCounter($c->db);
+        }, false);
+
+        $this->setFactory('redirects', function(ServiceProvider $c) {
+            $url = current_page_url();
+            $is_xhr = $c->request->isXmlHttpRequest();
+            return new \Elgg\RedirectService($c->session, $is_xhr, $c->config->getSiteUrl(), $url);
+        });
+
+        $this->setFactory('relationshipsTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\RelationshipsTable($c->db, $c->entityTable, $c->metadataTable, $c->events);
+        });
+
+        $this->setFactory('request', [\Elgg\Http\Request::class, 'createFromGlobals']);
+
+        $this->setFactory('responseFactory', function(ServiceProvider $c) {
+            if (PHP_SAPI === 'cli') {
+                $transport = new \Elgg\Http\OutputBufferTransport();
+            } else {
+                $transport = new \Elgg\Http\HttpProtocolTransport();
+            }
+            return new \Elgg\Http\ResponseFactory($c->request, $c->hooks, $c->ajax, $transport);
+        });
+
+        $this->setFactory('router', function(ServiceProvider $c) {
+            // TODO(evan): Init routes from plugins or cache
+            $router = new \Elgg\Router($c->hooks);
+            if ($c->config->getVolatile('enable_profiling')) {
+                $router->setTimer($c->timer);
+            }
+            return $router;
+        });
+
+        $this->setFactory('seeder', function(ServiceProvider $c) {
+            return new \Elgg\Database\Seeder($c->hooks);
+        });
+
+        $this->setFactory('serveFileHandler', function(ServiceProvider $c) {
+            return new \Elgg\Application\ServeFileHandler($c->crypto, $c->config);
+        });
+
+        $this->setFactory('session', function(ServiceProvider $c) {
+            $params = $c->config->getCookieConfig()['session'];
+            $options = [
+                // session.cache_limiter is unfortunately set to "" by the NativeSessionStorage
+                // constructor, so we must capture and inject it directly.
+                'cache_limiter' => session_cache_limiter(),
+
+                'name' => $params['name'],
+                'cookie_path' => $params['path'],
+                'cookie_domain' => $params['domain'],
+                'cookie_secure' => $params['secure'],
+                'cookie_httponly' => $params['httponly'],
+                'cookie_lifetime' => $params['lifetime'],
+            ];
+
+            $handler = new \Elgg\Http\DatabaseSessionHandler($c->db);
+            $storage = new NativeSessionStorage($options, $handler);
+            $session = new SymfonySession($storage);
+            return new \ElggSession($session);
+        });
+
+        $this->setClassName('urlSigner', \Elgg\Security\UrlSigner::class);
+
+        $this->setFactory('simpleCache', function(ServiceProvider $c) {
+            return new \Elgg\Cache\SimpleCache($c->config, $c->datalist, $c->views);
+        });
+
+        $this->setFactory('siteSecret', function(ServiceProvider $c) {
+            return new \Elgg\Database\SiteSecret($c->datalist);
+        });
+
+        $this->setClassName('stickyForms', \Elgg\Forms\StickyForms::class);
+
+        $this->setFactory('subtypeTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\SubtypeTable($c->db);
+        });
+
+        $this->setFactory('systemCache', function (ServiceProvider $c) {
+            $cache = new \Elgg\Cache\SystemCache($c->fileCache, $c->config, $c->datalist);
+            if ($c->config->getVolatile('enable_profiling')) {
+                $cache->setTimer($c->timer);
+            }
+            return $cache;
+        });
+
+        $this->setFactory('systemMessages', function(ServiceProvider $c) {
+            return new \Elgg\SystemMessagesService($c->session);
+        });
+
+        $this->setClassName('table_columns', \Elgg\Views\TableColumn\ColumnFactory::class);
+
+        $this->setClassName('timer', \Elgg\Timer::class);
+
+        $this->setClassName('translator', \Elgg\I18n\Translator::class);
+
+        $this->setFactory('uploads', function(ServiceProvider $c) {
+            return new \Elgg\UploadService($c->request);
+        });
+
+        $this->setFactory('upgrades', function(ServiceProvider $c) {
+            return new \Elgg\UpgradeService(
+                $c->translator,
+                $c->events,
+                $c->hooks,
+                $c->datalist,
+                $c->logger,
+                $c->mutex
+            );
+        });
+
+        $this->setFactory('userCapabilities', function(ServiceProvider $c) {
+            return new \Elgg\UserCapabilities($c->hooks, $c->entityTable, $c->session);
+        });
+
+        $this->setFactory('usersTable', function(ServiceProvider $c) {
+            return new \Elgg\Database\UsersTable(
+                $c->config,
+                $c->db,
+                $c->entityTable,
+                $c->entityCache,
+                $c->events
+            );
+        });
+
+        $this->setFactory('views', function(ServiceProvider $c) {
+            return new \Elgg\ViewsService($c->hooks, $c->logger);
+        });
+
+        $this->setClassName('widgets', \Elgg\WidgetsService::class);
+
+    }
+
+    /**
+     * Returns the first requested service of the logger, events, and hooks. It sets the
+     * hooks and events up in the right order to prevent circular dependency.
+     *
+     * @param string $service_needed The service requested first
+     * @return mixed
+     */
+    protected function resolveLoggerDependencies($service_needed) {
+        $svcs['hooks'] = new \Elgg\PluginHooksService();
+
+        $svcs['logger'] = new \Elgg\Logger($svcs['hooks'], $this->config, $this->context);
+        $svcs['hooks']->setLogger($svcs['logger']);
+
+        $svcs['events'] = new \Elgg\EventsService();
+        $svcs['events']->setLogger($svcs['logger']);
+        if ($this->config->getVolatile('enable_profiling')) {
+            $svcs['events']->setTimer($this->timer);
+        }
+
+        foreach ($svcs as $key => $service) {
+            $this->setValue($key, $service);
+        }
+        return $svcs[$service_needed];
+    }
 }

engine/classes/Elgg/Database/Seeds/Users.php

Indentation +100 added lines, -100 removed lines

@@ -9,105 +9,105 @@
  */
 class Users extends Seed {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function seed() {
-
-		$count_users = function () {
-			return elgg_get_entities_from_metadata([
-				'types' => 'user',
-				'metadata_names' => '__faker',
-				'count' => true,
-			]);
-		};
-
-		$count_friends = function ($user) {
-			return elgg_get_entities_from_relationship([
-				'types' => 'user',
-				'relationship' => 'friend',
-				'relationship_guid' => $user->guid,
-				'inverse_relationship' => false,
-				'metadata_names' => '__faker',
-				'count' => true,
-			]);
-		};
-
-		$exclude = [];
-
-		while ($count_users() < $this->limit) {
-			$user = $this->getRandomUser($exclude);
-			if (!$user) {
-				$user = $this->createUser();
-				if (!$user) {
-					continue;
-				}
-			}
-
-			$exclude[] = $user->guid;
-
-			// Friend the user other members
-			// Create a friend access collection and add some random friends to it
-
-			if ($count_friends($user)) {
-				continue;
-			}
-
-			$collection_id = create_access_collection('Best Fake Friends Collection', $user->guid);
-			if ($collection_id) {
-				$this->log("Created new friend collection for user $user->name [collection_id: $collection_id]");
-			}
-
-			$friends_limit = $this->faker->numberBetween(5, 10);
-
-			$friends_exclude = [$user->guid];
-			while ($count_friends($user) < $friends_limit) {
-
-				$friend = $this->getRandomUser($friends_exclude);
-				if (!$friend) {
-					$this->createUser();
-					if (!$friend) {
-						continue;
-					}
-				}
-
-				$friends_exclude[] = $friend->guid;
-
-				if ($user->addFriend($friend->guid, true)) {
-					$this->log("User $user->name [guid: $user->guid] friended user $friend->name [guid: $friend->guid]");
-					if ($this->faker->boolean() && $collection_id) {
-						add_user_to_access_collection($friend->guid, $collection_id);
-					}
-				}
-			}
-
-		}
-
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function unseed() {
-
-		$users = elgg_get_entities_from_metadata([
-			'types' => 'user',
-			'metadata_names' => '__faker',
-			'limit' => 0,
-			'batch' => true,
-		]);
-
-		/* @var $users \ElggBatch */
-
-		$users->setIncrementOffset(false);
-
-		foreach ($users as $user) {
-			if ($user->delete()) {
-				$this->log("Deleted user $user->guid");
-			} else {
-				$this->log("Failed to delete user $user->guid");
-			}
-		}
-	}
+    /**
+     * {@inheritdoc}
+     */
+    public function seed() {
+
+        $count_users = function () {
+            return elgg_get_entities_from_metadata([
+                'types' => 'user',
+                'metadata_names' => '__faker',
+                'count' => true,
+            ]);
+        };
+
+        $count_friends = function ($user) {
+            return elgg_get_entities_from_relationship([
+                'types' => 'user',
+                'relationship' => 'friend',
+                'relationship_guid' => $user->guid,
+                'inverse_relationship' => false,
+                'metadata_names' => '__faker',
+                'count' => true,
+            ]);
+        };
+
+        $exclude = [];
+
+        while ($count_users() < $this->limit) {
+            $user = $this->getRandomUser($exclude);
+            if (!$user) {
+                $user = $this->createUser();
+                if (!$user) {
+                    continue;
+                }
+            }
+
+            $exclude[] = $user->guid;
+
+            // Friend the user other members
+            // Create a friend access collection and add some random friends to it
+
+            if ($count_friends($user)) {
+                continue;
+            }
+
+            $collection_id = create_access_collection('Best Fake Friends Collection', $user->guid);
+            if ($collection_id) {
+                $this->log("Created new friend collection for user $user->name [collection_id: $collection_id]");
+            }
+
+            $friends_limit = $this->faker->numberBetween(5, 10);
+
+            $friends_exclude = [$user->guid];
+            while ($count_friends($user) < $friends_limit) {
+
+                $friend = $this->getRandomUser($friends_exclude);
+                if (!$friend) {
+                    $this->createUser();
+                    if (!$friend) {
+                        continue;
+                    }
+                }
+
+                $friends_exclude[] = $friend->guid;
+
+                if ($user->addFriend($friend->guid, true)) {
+                    $this->log("User $user->name [guid: $user->guid] friended user $friend->name [guid: $friend->guid]");
+                    if ($this->faker->boolean() && $collection_id) {
+                        add_user_to_access_collection($friend->guid, $collection_id);
+                    }
+                }
+            }
+
+        }
+
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function unseed() {
+
+        $users = elgg_get_entities_from_metadata([
+            'types' => 'user',
+            'metadata_names' => '__faker',
+            'limit' => 0,
+            'batch' => true,
+        ]);
+
+        /* @var $users \ElggBatch */
+
+        $users->setIncrementOffset(false);
+
+        foreach ($users as $user) {
+            if ($user->delete()) {
+                $this->log("Deleted user $user->guid");
+            } else {
+                $this->log("Failed to delete user $user->guid");
+            }
+        }
+    }
 
 }
\ No newline at end of file

Spacing +2 added lines, -2 removed lines

@@ -14,7 +14,7 @@ 
 	 */
 	public function seed() {
 
-		$count_users = function () {
+		$count_users = function() {
 			return elgg_get_entities_from_metadata([
 				'types' => 'user',
 				'metadata_names' => '__faker',
@@ -22,7 +22,7 @@ 
 			]);
 		};
 
-		$count_friends = function ($user) {
+		$count_friends = function($user) {
 			return elgg_get_entities_from_relationship([
 				'types' => 'user',
 				'relationship' => 'friend',

engine/classes/Elgg/Database/Seeds/Groups.php

Spacing +2 added lines, -2 removed lines

@@ -35,7 +35,7 @@ 
 	 */
 	public function seed() {
 
-		$count_groups = function () {
+		$count_groups = function() {
 			return elgg_get_entities_from_metadata([
 				'types' => 'group',
 				'metadata_names' => '__faker',
@@ -43,7 +43,7 @@ 
 			]);
 		};
 
-		$count_members = function ($group) {
+		$count_members = function($group) {
 			return elgg_get_entities_from_relationship([
 				'types' => 'user',
 				'relationship' => 'member',

Indentation +169 added lines, -169 removed lines

@@ -9,173 +9,173 @@
  */
 class Groups extends Seed {
 
-	/**
-	 * @var \ElggUser[]
-	 */
-	private $users;
-
-	private $visibility = [
-		ACCESS_PUBLIC,
-		ACCESS_LOGGED_IN,
-		ACCESS_PRIVATE,
-	];
-
-	private $content_access_modes = [
-		\ElggGroup::CONTENT_ACCESS_MODE_MEMBERS_ONLY,
-		\ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED,
-	];
-
-	private $membership = [
-		ACCESS_PUBLIC,
-		ACCESS_PRIVATE,
-	];
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function seed() {
-
-		$count_groups = function () {
-			return elgg_get_entities_from_metadata([
-				'types' => 'group',
-				'metadata_names' => '__faker',
-				'count' => true,
-			]);
-		};
-
-		$count_members = function ($group) {
-			return elgg_get_entities_from_relationship([
-				'types' => 'user',
-				'relationship' => 'member',
-				'relationship_guid' => $group->getGUID(),
-				'inverse_relationship' => true,
-				'metadata_names' => '__faker',
-				'count' => true,
-			]);
-		};
-
-		$exclude = [];
-
-		while ($count_groups() < $this->limit) {
-			$group = $this->getRandomGroup($exclude);
-			if (!$group) {
-				$group = $this->createGroup([
-					'access_id' => $this->getRandomVisibility(),
-				], [
-					'content_access_mode' => $this->getRandomContentAccessMode(),
-					'membership' => $this->getRandomMembership(),
-				]);
-				if (!$group) {
-					continue;
-				}
-			}
-
-			$exclude[] = $group->guid;
-
-			if ($count_members($group) > 1) {
-				// exclude owner from count
-				continue;
-			}
-
-			$members_limit = $this->faker->numberBetween(5, 10);
-
-			$members_exclude = [];
-
-			while ($count_members($group) - 1 < $members_limit) {
-
-				$member = $this->getRandomUser($members_exclude);
-				if (!$member) {
-					$member = $this->createUser();
-					if (!$member) {
-						continue;
-					}
-				}
-
-				$members_exclude[] = $member->guid;
-
-				if ($group->join($member)) {
-					$this->log("User $member->name [guid: $member->guid] joined group $group->name [guid: $group->guid]");
-				}
-
-				if (!$group->isPublicMembership()) {
-					$invitee = $this->getRandomUser($members_exclude);
-					if ($invitee) {
-						$members_exclude[] = $invitee->guid;
-						if (!check_entity_relationship($invitee->guid, 'member', $group->guid)) {
-							add_entity_relationship($group->guid, 'invited', $invitee->guid);
-							$this->log("User $invitee->name [guid: $invitee->guid] was invited to $group->name [guid: $group->guid]");
-						}
-					}
-
-					$requestor = $this->getRandomUser($members_exclude);
-					if ($requestor) {
-						$members_exclude[] = $requestor->guid;
-						if (!check_entity_relationship($group->guid, 'invited', $requestor->guid)
-							&& !check_entity_relationship($requestor->guid, 'member', $group->guid)
-						) {
-							add_entity_relationship($requestor->guid, 'membership_request', $group->guid);
-							$this->log("User $invitee->name [guid: $invitee->guid] requested to join $group->name [guid: $group->guid]");
-						}
-					}
-				}
-			}
-
-		}
-
-	}
-
-	/**
-	 * {@inheritdoc}
-	 */
-	public function unseed() {
-
-		$groups = elgg_get_entities_from_metadata([
-			'types' => 'group',
-			'metadata_names' => '__faker',
-			'limit' => 0,
-			'batch' => true,
-		]);
-
-		/* @var $groups \ElggBatch */
-
-		$groups->setIncrementOffset(false);
-
-		foreach ($groups as $group) {
-			if ($group->delete()) {
-				$this->log("Deleted group $group->guid");
-			} else {
-				$this->log("Failed to delete group $group->guid");
-			}
-		}
-	}
-
-	/**
-	 * Returns random visibility value
-	 * @return int
-	 */
-	public function getRandomVisibility() {
-		$key = array_rand($this->visibility, 1);
-
-		return $this->visibility[$key];
-	}
-
-	/**
-	 * Returns random content access mode value
-	 * @return string
-	 */
-	public function getRandomContentAccessMode() {
-		$key = array_rand($this->content_access_modes, 1);
-
-		return $this->content_access_modes[$key];
-	}
-
-	/**
-	 * Returns random membership mode
-	 * @return mixed
-	 */
-	public function getRandomMembership() {
-		$key = array_rand($this->membership, 1);
-
-		return $this->membership[$key];
-	}
+    /**
+     * @var \ElggUser[]
+     */
+    private $users;
+
+    private $visibility = [
+        ACCESS_PUBLIC,
+        ACCESS_LOGGED_IN,
+        ACCESS_PRIVATE,
+    ];
+
+    private $content_access_modes = [
+        \ElggGroup::CONTENT_ACCESS_MODE_MEMBERS_ONLY,
+        \ElggGroup::CONTENT_ACCESS_MODE_UNRESTRICTED,
+    ];
+
+    private $membership = [
+        ACCESS_PUBLIC,
+        ACCESS_PRIVATE,
+    ];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function seed() {
+
+        $count_groups = function () {
+            return elgg_get_entities_from_metadata([
+                'types' => 'group',
+                'metadata_names' => '__faker',
+                'count' => true,
+            ]);
+        };
+
+        $count_members = function ($group) {
+            return elgg_get_entities_from_relationship([
+                'types' => 'user',
+                'relationship' => 'member',
+                'relationship_guid' => $group->getGUID(),
+                'inverse_relationship' => true,
+                'metadata_names' => '__faker',
+                'count' => true,
+            ]);
+        };
+
+        $exclude = [];
+
+        while ($count_groups() < $this->limit) {
+            $group = $this->getRandomGroup($exclude);
+            if (!$group) {
+                $group = $this->createGroup([
+                    'access_id' => $this->getRandomVisibility(),
+                ], [
+                    'content_access_mode' => $this->getRandomContentAccessMode(),
+                    'membership' => $this->getRandomMembership(),
+                ]);
+                if (!$group) {
+                    continue;
+                }
+            }
+
+            $exclude[] = $group->guid;
+
+            if ($count_members($group) > 1) {
+                // exclude owner from count
+                continue;
+            }
+
+            $members_limit = $this->faker->numberBetween(5, 10);
+
+            $members_exclude = [];
+
+            while ($count_members($group) - 1 < $members_limit) {
+
+                $member = $this->getRandomUser($members_exclude);
+                if (!$member) {
+                    $member = $this->createUser();
+                    if (!$member) {
+                        continue;
+                    }
+                }
+
+                $members_exclude[] = $member->guid;
+
+                if ($group->join($member)) {
+                    $this->log("User $member->name [guid: $member->guid] joined group $group->name [guid: $group->guid]");
+                }
+
+                if (!$group->isPublicMembership()) {
+                    $invitee = $this->getRandomUser($members_exclude);
+                    if ($invitee) {
+                        $members_exclude[] = $invitee->guid;
+                        if (!check_entity_relationship($invitee->guid, 'member', $group->guid)) {
+                            add_entity_relationship($group->guid, 'invited', $invitee->guid);
+                            $this->log("User $invitee->name [guid: $invitee->guid] was invited to $group->name [guid: $group->guid]");
+                        }
+                    }
+
+                    $requestor = $this->getRandomUser($members_exclude);
+                    if ($requestor) {
+                        $members_exclude[] = $requestor->guid;
+                        if (!check_entity_relationship($group->guid, 'invited', $requestor->guid)
+                            && !check_entity_relationship($requestor->guid, 'member', $group->guid)
+                        ) {
+                            add_entity_relationship($requestor->guid, 'membership_request', $group->guid);
+                            $this->log("User $invitee->name [guid: $invitee->guid] requested to join $group->name [guid: $group->guid]");
+                        }
+                    }
+                }
+            }
+
+        }
+
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function unseed() {
+
+        $groups = elgg_get_entities_from_metadata([
+            'types' => 'group',
+            'metadata_names' => '__faker',
+            'limit' => 0,
+            'batch' => true,
+        ]);
+
+        /* @var $groups \ElggBatch */
+
+        $groups->setIncrementOffset(false);
+
+        foreach ($groups as $group) {
+            if ($group->delete()) {
+                $this->log("Deleted group $group->guid");
+            } else {
+                $this->log("Failed to delete group $group->guid");
+            }
+        }
+    }
+
+    /**
+     * Returns random visibility value
+     * @return int
+     */
+    public function getRandomVisibility() {
+        $key = array_rand($this->visibility, 1);
+
+        return $this->visibility[$key];
+    }
+
+    /**
+     * Returns random content access mode value
+     * @return string
+     */
+    public function getRandomContentAccessMode() {
+        $key = array_rand($this->content_access_modes, 1);
+
+        return $this->content_access_modes[$key];
+    }
+
+    /**
+     * Returns random membership mode
+     * @return mixed
+     */
+    public function getRandomMembership() {
+        $key = array_rand($this->membership, 1);
+
+        return $this->membership[$key];
+    }
 }
\ No newline at end of file

engine/classes/ElggPlugin.php

Indentation +1140 added lines, -1140 removed lines

@@ -12,1182 +12,1182 @@
  * @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_services()->config->getPluginsPath() . $this->getID();
-		} else if (is_numeric($path)) {
-			// guid
-			// @todo plugins with directory names of '12345'
-			elgg_deprecated_notice("Use elgg_get_plugin_from_id() to load a plugin.", 1.9);
-			parent::__construct($path);
-			$this->path = _elgg_services()->config->getPluginsPath() . $this->getID();
-		} else {
-			$this->initializeAttributes();
+    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_services()->config->getPluginsPath() . $this->getID();
+        } else if (is_numeric($path)) {
+            // guid
+            // @todo plugins with directory names of '12345'
+            elgg_deprecated_notice("Use elgg_get_plugin_from_id() to load a plugin.", 1.9);
+            parent::__construct($path);
+            $this->path = _elgg_services()->config->getPluginsPath() . $this->getID();
+        } else {
+            $this->initializeAttributes();
 			
-			$mod_dir = _elgg_services()->config->getPluginsPath();
-
-			// not a full path, so assume a directory name and use the default path
-			if (strpos($path, $mod_dir) !== 0) {
-				elgg_deprecated_notice("You should pass a full path to ElggPlugin.", 1.9);
-				$path = $mod_dir . $path;
-			}
-
-			// 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);
+            $mod_dir = _elgg_services()->config->getPluginsPath();
+
+            // not a full path, so assume a directory name and use the default path
+            if (strpos($path, $mod_dir) !== 0) {
+                elgg_deprecated_notice("You should pass a full path to ElggPlugin.", 1.9);
+                $path = $mod_dir . $path;
+            }
+
+            // 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($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_services()->configTable->get('site');
-		$this->attributes['site_guid'] = $site->guid;
-		$this->attributes['owner_guid'] = $site->guid;
-		$this->attributes['container_guid'] = $site->guid;
+            if ($existing_plugin) {
+                $this->load($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_services()->configTable->get('site');
+        $this->attributes['site_guid'] = $site->guid;
+        $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 1.8.1
-	 */
-	public function getFriendlyName() {
-		$manifest = $this->getManifest();
-		if ($manifest) {
-			return $manifest->getName();
-		}
-
-		return $this->getID();
-	}
-
-	/**
-	 * 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 = array();
-		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->$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
-	 * @param mixed $site_guid Optional site GUID.
-	 * @return bool
-	 */
-	public function setPriority($priority, $site_guid = null) {
-		if (!$this->guid) {
-			return false;
-		}
-
-		$db_prefix = _elgg_services()->configTable->get('dbprefix');
-		$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
+        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 1.8.1
+     */
+    public function getFriendlyName() {
+        $manifest = $this->getManifest();
+        if ($manifest) {
+            return $manifest->getName();
+        }
+
+        return $this->getID();
+    }
+
+    /**
+     * 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 = array();
+        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->$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
+     * @param mixed $site_guid Optional site GUID.
+     * @return bool
+     */
+    public function setPriority($priority, $site_guid = null) {
+        if (!$this->guid) {
+            return false;
+        }
+
+        $db_prefix = _elgg_services()->configTable->get('dbprefix');
+        $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 (!$this->getDatabase()->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 = _elgg_services()->pluginSettingsCache->getAll($this->guid);
-
-		if ($values !== null) {
-			return isset($values[$name]) ? $values[$name] : $default;
-		}
-
-		$val = $this->$name;
-		return $val !== null ? $val : $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() {
-		$values = _elgg_services()->pluginSettingsCache->getAll($this->guid);
-		if ($values !== null) {
-			return $values;
-		}
-
-		if (!$this->guid) {
-			return false;
-		}
-
-		$db_prefix = _elgg_services()->config->get('dbprefix');
-		// need to remove all namespaced private settings.
-		$us_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
-		$is_prefix = _elgg_namespace_plugin_private_setting('internal', '', $this->getID());
-
-		// Get private settings for user
-		$q = "SELECT * FROM {$db_prefix}private_settings
+            if (!$this->getDatabase()->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 = _elgg_services()->pluginSettingsCache->getAll($this->guid);
+
+        if ($values !== null) {
+            return isset($values[$name]) ? $values[$name] : $default;
+        }
+
+        $val = $this->$name;
+        return $val !== null ? $val : $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() {
+        $values = _elgg_services()->pluginSettingsCache->getAll($this->guid);
+        if ($values !== null) {
+            return $values;
+        }
+
+        if (!$this->guid) {
+            return false;
+        }
+
+        $db_prefix = _elgg_services()->config->get('dbprefix');
+        // need to remove all namespaced private settings.
+        $us_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+        $is_prefix = _elgg_namespace_plugin_private_setting('internal', '', $this->getID());
+
+        // Get private settings for user
+        $q = "SELECT * FROM {$db_prefix}private_settings
 			WHERE entity_guid = $this->guid
 			AND name NOT LIKE '$us_prefix%'
 			AND name NOT LIKE '$is_prefix%'";
 
-		$private_settings = $this->getDatabase()->getData($q);
-
-		$return = array();
-
-		if ($private_settings) {
-			foreach ($private_settings as $setting) {
-				$return[$setting->name] = $setting->value;
-			}
-		}
-
-		return $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 = array();
+
+        if ($private_settings) {
+            foreach ($private_settings as $setting) {
+                $return[$setting->name] = $setting->value;
+            }
+        }
+
+        return $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', array(
-			'plugin_id' => $this->getID(),
-			'plugin' => $this,
-			'name' => $name,
-			'value' => $value,
-		), $value);
+        // Hook to validate setting
+        $value = elgg_trigger_plugin_hook('setting', 'plugin', array(
+            '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_prefix = _elgg_services()->configTable->get('dbprefix');
-		$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_prefix = _elgg_services()->configTable->get('dbprefix');
+        $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 $this->getDatabase()->deleteData($q);
-	}
+        return $this->getDatabase()->deleteData($q);
+    }
 
 
-	// User settings
+    // 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) {
-		$user_guid = (int)$user_guid;
+    /**
+     * 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) {
+        $user_guid = (int)$user_guid;
 
-		if ($user_guid) {
-			$user = get_entity($user_guid);
-		} else {
-			$user = _elgg_services()->session->getLoggedInUser();
-		}
+        if ($user_guid) {
+            $user = get_entity($user_guid);
+        } else {
+            $user = _elgg_services()->session->getLoggedInUser();
+        }
 
-		if (!($user instanceof \ElggUser)) {
-			return false;
-		}
+        if (!($user instanceof \ElggUser)) {
+            return false;
+        }
 
-		$name = _elgg_namespace_plugin_private_setting('user_setting', $name, $this->getID());
+        $name = _elgg_namespace_plugin_private_setting('user_setting', $name, $this->getID());
 		
-		$val = get_private_setting($user->guid, $name);
-		return $val !== null ? $val : $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;
-		}
-
-		$db_prefix = _elgg_services()->config->get('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
+        $val = get_private_setting($user->guid, $name);
+        return $val !== null ? $val : $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;
+        }
+
+        $db_prefix = _elgg_services()->config->get('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
 			WHERE entity_guid = {$user->guid}
 			AND name LIKE '$ps_prefix%'";
 
-		$private_settings = $this->getDatabase()->getData($q);
-
-		$return = array();
-
-		if ($private_settings) {
-			foreach ($private_settings as $setting) {
-				$name = substr($setting->name, $ps_prefix_len);
-				$value = $setting->value;
-
-				$return[$name] = $value;
-			}
-		}
-
-		return $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', array(
-			'user' => $user,
-			'plugin' => $this,
-			'plugin_id' => $this->getID(),
-			'name' => $name,
-			'value' => $value
-		), $value);
+        $private_settings = $this->getDatabase()->getData($q);
+
+        $return = array();
+
+        if ($private_settings) {
+            foreach ($private_settings as $setting) {
+                $name = substr($setting->name, $ps_prefix_len);
+                $value = $setting->value;
+
+                $return[$name] = $value;
+            }
+        }
+
+        return $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', array(
+            '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_prefix = _elgg_services()->configTable->get('dbprefix');
-		$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_prefix = _elgg_services()->configTable->get('dbprefix');
+        $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 $this->getDatabase()->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_prefix = _elgg_services()->configTable->get('dbprefix');
-		$ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
-
-		$q = "DELETE FROM {$db_prefix}private_settings
+        return $this->getDatabase()->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_prefix = _elgg_services()->configTable->get('dbprefix');
+        $ps_prefix = _elgg_namespace_plugin_private_setting('user_setting', '', $this->getID());
+
+        $q = "DELETE FROM {$db_prefix}private_settings
 			WHERE name LIKE '$ps_prefix%'";
 
-		return $this->getDatabase()->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', array($this->guid));
-			return false;
-		}
-
-		if (!$this->getPackage() instanceof \ElggPluginPackage) {
-			$this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:NoPluginPackagePackage', array($this->getID(), $this->guid));
-			return false;
-		}
-
-		if (!$this->getPackage()->isValid()) {
-			$this->errorMsg = $this->getPackage()->getError();
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Is this plugin active?
-	 *
-	 * @param int $site_guid Optional site guid.
-	 * @return bool
-	 */
-	public function isActive($site_guid = null) {
-		if (!$this->guid) {
-			return false;
-		}
-
-		if ($site_guid) {
-			$site = get_entity($site_guid);
-		} else {
-			$site = _elgg_services()->configTable->get('site');
-		}
-
-		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.
-	 *
-	 * @todo remove $site_guid param or implement it
-	 *
-	 * @param mixed $site_guid Optional site guid
-	 * @return bool
-	 */
-	public function canActivate($site_guid = null) {
-		if ($this->isActive($site_guid)) {
-			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.
-	 *
-	 * @param mixed $site_guid Optional site GUID.
-	 * @return bool
-	 */
-	public function activate($site_guid = null) {
-		if ($this->isActive($site_guid)) {
-			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, $site_guid)) {
-			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 = array(
-			'plugin_id' => $this->getID(),
-			'plugin_entity' => $this,
-		);
-
-		$return = _elgg_services()->events->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) {
-			if ($this->canReadFile('activate.php')) {
-				$flags = ELGG_PLUGIN_INCLUDE_START | ELGG_PLUGIN_REGISTER_CLASSES |
-						ELGG_PLUGIN_REGISTER_LANGUAGES | ELGG_PLUGIN_REGISTER_VIEWS;
-
-				$this->start($flags);
-
-				$return = $this->includeFile('activate.php');
-			}
-		}
-
-		if ($return === false) {
-			$this->deactivate($site_guid);
-		}
-
-		return $return;
-	}
-
-	/**
-	 * Checks if this plugin can be deactivated on the current
-	 * Elgg installation. Validates that this plugin has no
-	 * active dependants.
-	 *
-	 * @param mixed $site_guid Optional site guid
-	 * @return bool
-	 */
-	public function canDeactivate($site_guid = null) {
-		if (!$this->isActive($site_guid)) {
-			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->getManifest()->getName(),
-					'href' => "#$css_id",
-				]);
-			}, $dependents);
-			$name = $this->getManifest()->getName();
-			$list = implode(', ', $list);
-			$this->errorMsg = elgg_echo('ElggPlugin:Dependencies:ActiveDependent', [$name, $list]);
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Deactivates the plugin.
-	 *
-	 * @param mixed $site_guid Optional site GUID.
-	 * @return bool
-	 */
-	public function deactivate($site_guid = null) {
-		if (!$this->isActive($site_guid)) {
-			return false;
-		}
-
-		if (!$this->canDeactivate($site_guid)) {
-			return false;
-		}
+        return $this->getDatabase()->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', array($this->guid));
+            return false;
+        }
+
+        if (!$this->getPackage() instanceof \ElggPluginPackage) {
+            $this->errorMsg = _elgg_services()->translator->translate('ElggPlugin:NoPluginPackagePackage', array($this->getID(), $this->guid));
+            return false;
+        }
+
+        if (!$this->getPackage()->isValid()) {
+            $this->errorMsg = $this->getPackage()->getError();
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Is this plugin active?
+     *
+     * @param int $site_guid Optional site guid.
+     * @return bool
+     */
+    public function isActive($site_guid = null) {
+        if (!$this->guid) {
+            return false;
+        }
+
+        if ($site_guid) {
+            $site = get_entity($site_guid);
+        } else {
+            $site = _elgg_services()->configTable->get('site');
+        }
+
+        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.
+     *
+     * @todo remove $site_guid param or implement it
+     *
+     * @param mixed $site_guid Optional site guid
+     * @return bool
+     */
+    public function canActivate($site_guid = null) {
+        if ($this->isActive($site_guid)) {
+            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.
+     *
+     * @param mixed $site_guid Optional site GUID.
+     * @return bool
+     */
+    public function activate($site_guid = null) {
+        if ($this->isActive($site_guid)) {
+            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, $site_guid)) {
+            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 = array(
+            'plugin_id' => $this->getID(),
+            'plugin_entity' => $this,
+        );
+
+        $return = _elgg_services()->events->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) {
+            if ($this->canReadFile('activate.php')) {
+                $flags = ELGG_PLUGIN_INCLUDE_START | ELGG_PLUGIN_REGISTER_CLASSES |
+                        ELGG_PLUGIN_REGISTER_LANGUAGES | ELGG_PLUGIN_REGISTER_VIEWS;
+
+                $this->start($flags);
+
+                $return = $this->includeFile('activate.php');
+            }
+        }
+
+        if ($return === false) {
+            $this->deactivate($site_guid);
+        }
+
+        return $return;
+    }
+
+    /**
+     * Checks if this plugin can be deactivated on the current
+     * Elgg installation. Validates that this plugin has no
+     * active dependants.
+     *
+     * @param mixed $site_guid Optional site guid
+     * @return bool
+     */
+    public function canDeactivate($site_guid = null) {
+        if (!$this->isActive($site_guid)) {
+            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->getManifest()->getName(),
+                    'href' => "#$css_id",
+                ]);
+            }, $dependents);
+            $name = $this->getManifest()->getName();
+            $list = implode(', ', $list);
+            $this->errorMsg = elgg_echo('ElggPlugin:Dependencies:ActiveDependent', [$name, $list]);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Deactivates the plugin.
+     *
+     * @param mixed $site_guid Optional site GUID.
+     * @return bool
+     */
+    public function deactivate($site_guid = null) {
+        if (!$this->isActive($site_guid)) {
+            return false;
+        }
+
+        if (!$this->canDeactivate($site_guid)) {
+            return false;
+        }
 		
-		// emit an event. returning false will cause this to not be deactivated.
-		$params = array(
-			'plugin_id' => $this->getID(),
-			'plugin_entity' => $this,
-		);
-
-		$return = _elgg_services()->events->trigger('deactivate', 'plugin', $params);
-
-		// run any deactivate code
-		if ($return) {
-			if ($this->canReadFile('deactivate.php')) {
-				$return = $this->includeFile('deactivate.php');
-			}
-		}
-
-		if ($return === false) {
-			return false;
-		} else {
-			return $this->setStatus(false, $site_guid);
-		}
-	}
-
-	/**
-	 * 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) {
-		//if (!$this->canActivate()) {
-		//	return false;
-		//}
-
-		// include classes
-		if ($flags & ELGG_PLUGIN_REGISTER_CLASSES) {
-			$this->registerClasses();
-		}
+        // emit an event. returning false will cause this to not be deactivated.
+        $params = array(
+            'plugin_id' => $this->getID(),
+            'plugin_entity' => $this,
+        );
+
+        $return = _elgg_services()->events->trigger('deactivate', 'plugin', $params);
+
+        // run any deactivate code
+        if ($return) {
+            if ($this->canReadFile('deactivate.php')) {
+                $return = $this->includeFile('deactivate.php');
+            }
+        }
+
+        if ($return === false) {
+            return false;
+        } else {
+            return $this->setStatus(false, $site_guid);
+        }
+    }
+
+    /**
+     * 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) {
+        //if (!$this->canActivate()) {
+        //	return false;
+        //}
+
+        // include classes
+        if ($flags & ELGG_PLUGIN_REGISTER_CLASSES) {
+            $this->registerClasses();
+        }
 		
-		// include start file
-		if ($flags & ELGG_PLUGIN_INCLUDE_START) {
-			$this->includeFile('start.php');
-		}
-
-		// include views
-		if ($flags & ELGG_PLUGIN_REGISTER_VIEWS) {
-			$this->registerViews();
-		}
-
-		// include languages
-		if ($flags & ELGG_PLUGIN_REGISTER_LANGUAGES) {
-			$this->registerLanguages();
-		}
-
-		return true;
-	}
-
-
-	// start helpers
-
-	/**
-	 * Get the config object in a deprecation wrapper
-	 *
-	 * @return \Elgg\DeprecationWrapper
-	 */
-	protected static function getConfigWrapper() {
-		static $wrapper;
-		if (null === $wrapper) {
-			global $CONFIG;
-			$warning = 'Do not rely on local $CONFIG being available in start.php';
-			$wrapper = new \Elgg\DeprecationWrapper($CONFIG, $warning, "1.10");
-		}
-		return $wrapper;
-	}
-
-	/**
-	 * 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) {
-		// This needs to be here to be backwards compatible for 1.0-1.7.
-		// They expect the global config object to be available in start.php.
-		if ($filename == 'start.php') {
-			$CONFIG = self::getConfigWrapper();
-		}
-
-		$filepath = "$this->path/$filename";
-
-		if (!$this->canReadFile($filename)) {
-			$msg = _elgg_services()->translator->translate('ElggPlugin:Exception:CannotIncludeFile',
-							array($filename, $this->getID(), $this->guid, $this->path));
-			throw new \PluginException($msg);
-		}
-
-		try {
-			$ret = require_once $filepath;
-		} catch (Exception $e) {
-			$msg = _elgg_services()->translator->translate('ElggPlugin:Exception:IncludeFileThrew',
-				array($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 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;
-	}
-
-	/**
-	 * 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];
-		}
-
-		// @todo clean below - getPrivateSetting() should return null now
-		// No, so see if its in the private data store.
-		// get_private_setting() returns false if it doesn't exist
-		$meta = $this->getPrivateSetting($name);
-
-		if ($meta === false) {
-			// Can't find it, so return null
-			return null;
-		}
-
-		return $meta;
-	}
-
-	/**
-	 * Get a value from private settings.
-	 *
-	 * @param string $name Name
-	 * @return mixed
-	 * @deprecated 1.9
-	 */
-	public function get($name) {
-		elgg_deprecated_notice("Use -> instead of get()", 1.9);
-		return $this->__get($name);
-	}
-
-	/**
-	 * 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);
-		}
-	}
-
-	/**
-	 * Save a value as private setting or attribute.
-	 *
-	 * Attributes include title and description.
-	 *
-	 * @param string $name  Name
-	 * @param mixed  $value Value
-	 * @return bool
-	 */
-	public function set($name, $value) {
-		elgg_deprecated_notice("Use -> instead of set()", 1.9);
-		$this->__set($name, $value);
-
-		return true;
-	}
-
-	/**
-	 * Sets the plugin to active or inactive for $site_guid.
-	 *
-	 * @param bool  $active    Set to active or inactive
-	 * @param mixed $site_guid Int for specific site, null for current site.
-	 *
-	 * @return bool
-	 */
-	private function setStatus($active, $site_guid = null) {
-		if (!$this->guid) {
-			return false;
-		}
-
-		if ($site_guid) {
-			$site = get_entity($site_guid);
-
-			if (!($site instanceof \ElggSite)) {
-				return false;
-			}
-		} else {
-			$site = _elgg_services()->configTable->get('site');
-		}
-
-		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;
-	}
+        // include start file
+        if ($flags & ELGG_PLUGIN_INCLUDE_START) {
+            $this->includeFile('start.php');
+        }
+
+        // include views
+        if ($flags & ELGG_PLUGIN_REGISTER_VIEWS) {
+            $this->registerViews();
+        }
+
+        // include languages
+        if ($flags & ELGG_PLUGIN_REGISTER_LANGUAGES) {
+            $this->registerLanguages();
+        }
+
+        return true;
+    }
+
+
+    // start helpers
+
+    /**
+     * Get the config object in a deprecation wrapper
+     *
+     * @return \Elgg\DeprecationWrapper
+     */
+    protected static function getConfigWrapper() {
+        static $wrapper;
+        if (null === $wrapper) {
+            global $CONFIG;
+            $warning = 'Do not rely on local $CONFIG being available in start.php';
+            $wrapper = new \Elgg\DeprecationWrapper($CONFIG, $warning, "1.10");
+        }
+        return $wrapper;
+    }
+
+    /**
+     * 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) {
+        // This needs to be here to be backwards compatible for 1.0-1.7.
+        // They expect the global config object to be available in start.php.
+        if ($filename == 'start.php') {
+            $CONFIG = self::getConfigWrapper();
+        }
+
+        $filepath = "$this->path/$filename";
+
+        if (!$this->canReadFile($filename)) {
+            $msg = _elgg_services()->translator->translate('ElggPlugin:Exception:CannotIncludeFile',
+                            array($filename, $this->getID(), $this->guid, $this->path));
+            throw new \PluginException($msg);
+        }
+
+        try {
+            $ret = require_once $filepath;
+        } catch (Exception $e) {
+            $msg = _elgg_services()->translator->translate('ElggPlugin:Exception:IncludeFileThrew',
+                array($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 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;
+    }
+
+    /**
+     * 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];
+        }
+
+        // @todo clean below - getPrivateSetting() should return null now
+        // No, so see if its in the private data store.
+        // get_private_setting() returns false if it doesn't exist
+        $meta = $this->getPrivateSetting($name);
+
+        if ($meta === false) {
+            // Can't find it, so return null
+            return null;
+        }
+
+        return $meta;
+    }
+
+    /**
+     * Get a value from private settings.
+     *
+     * @param string $name Name
+     * @return mixed
+     * @deprecated 1.9
+     */
+    public function get($name) {
+        elgg_deprecated_notice("Use -> instead of get()", 1.9);
+        return $this->__get($name);
+    }
+
+    /**
+     * 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);
+        }
+    }
+
+    /**
+     * Save a value as private setting or attribute.
+     *
+     * Attributes include title and description.
+     *
+     * @param string $name  Name
+     * @param mixed  $value Value
+     * @return bool
+     */
+    public function set($name, $value) {
+        elgg_deprecated_notice("Use -> instead of set()", 1.9);
+        $this->__set($name, $value);
+
+        return true;
+    }
+
+    /**
+     * Sets the plugin to active or inactive for $site_guid.
+     *
+     * @param bool  $active    Set to active or inactive
+     * @param mixed $site_guid Int for specific site, null for current site.
+     *
+     * @return bool
+     */
+    private function setStatus($active, $site_guid = null) {
+        if (!$this->guid) {
+            return false;
+        }
+
+        if ($site_guid) {
+            $site = get_entity($site_guid);
+
+            if (!($site instanceof \ElggSite)) {
+                return false;
+            }
+        } else {
+            $site = _elgg_services()->configTable->get('site');
+        }
+
+        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;
+    }
 }

mod/web_services/start.php

Indentation +186 added lines, -186 removed lines

@@ -6,42 +6,42 @@ 
 elgg_register_event_handler('init', 'system', 'ws_init');
 
 function ws_init() {
-	$lib_dir = __DIR__ . "/lib";
-	elgg_register_library('elgg:ws', "$lib_dir/web_services.php");
-	elgg_register_library('elgg:ws:api_user', "$lib_dir/api_user.php");
-	elgg_register_library('elgg:ws:client', "$lib_dir/client.php");
-	elgg_register_library('elgg:ws:tokens', "$lib_dir/tokens.php");
-
-	elgg_load_library('elgg:ws:api_user');
-	elgg_load_library('elgg:ws:tokens');
-
-	elgg_register_page_handler('services', 'ws_page_handler');
-
-	// Register a service handler for the default web services
-	// The name rest is a misnomer as they are not RESTful
-	elgg_ws_register_service_handler('rest', 'ws_rest_handler');
-
-	// expose the list of api methods
-	elgg_ws_expose_function("system.api.list", "list_all_apis", null,
-		elgg_echo("system.api.list"), "GET", false, false);
-
-	// The authentication token api
-	elgg_ws_expose_function(
-		"auth.gettoken",
-		"auth_gettoken",
-		array(
-			'username' => array ('type' => 'string'),
-			'password' => array ('type' => 'string'),
-		),
-		elgg_echo('auth.gettoken'),
-		'POST',
-		false,
-		false
-	);
-
-	elgg_register_plugin_hook_handler('unit_test', 'system', 'ws_unit_test');
-
-	elgg_register_plugin_hook_handler('rest:output', 'system.api.list', 'ws_system_api_list_hook');
+    $lib_dir = __DIR__ . "/lib";
+    elgg_register_library('elgg:ws', "$lib_dir/web_services.php");
+    elgg_register_library('elgg:ws:api_user', "$lib_dir/api_user.php");
+    elgg_register_library('elgg:ws:client', "$lib_dir/client.php");
+    elgg_register_library('elgg:ws:tokens', "$lib_dir/tokens.php");
+
+    elgg_load_library('elgg:ws:api_user');
+    elgg_load_library('elgg:ws:tokens');
+
+    elgg_register_page_handler('services', 'ws_page_handler');
+
+    // Register a service handler for the default web services
+    // The name rest is a misnomer as they are not RESTful
+    elgg_ws_register_service_handler('rest', 'ws_rest_handler');
+
+    // expose the list of api methods
+    elgg_ws_expose_function("system.api.list", "list_all_apis", null,
+        elgg_echo("system.api.list"), "GET", false, false);
+
+    // The authentication token api
+    elgg_ws_expose_function(
+        "auth.gettoken",
+        "auth_gettoken",
+        array(
+            'username' => array ('type' => 'string'),
+            'password' => array ('type' => 'string'),
+        ),
+        elgg_echo('auth.gettoken'),
+        'POST',
+        false,
+        false
+    );
+
+    elgg_register_plugin_hook_handler('unit_test', 'system', 'ws_unit_test');
+
+    elgg_register_plugin_hook_handler('rest:output', 'system.api.list', 'ws_system_api_list_hook');
 }
 
 /**
@@ -62,19 +62,19 @@ 
  * @return bool
  */
 function ws_page_handler($segments) {
-	elgg_load_library('elgg:ws');
+    elgg_load_library('elgg:ws');
 
-	if (!isset($segments[0]) || $segments[0] != 'api') {
-		return false;
-	}
-	array_shift($segments);
+    if (!isset($segments[0]) || $segments[0] != 'api') {
+        return false;
+    }
+    array_shift($segments);
 
-	$handler = array_shift($segments);
-	$request = implode('/', $segments);
+    $handler = array_shift($segments);
+    $request = implode('/', $segments);
 
-	service_handler($handler, $request);
+    service_handler($handler, $request);
 
-	return true;
+    return true;
 }
 
 /**
@@ -140,79 +140,79 @@ 
  * @throws InvalidParameterException
  */
 function elgg_ws_expose_function(
-	$method,
-	$function,
-	array $parameters = null,
-	$description = "",
-	$call_method = "GET",
-	$require_api_auth = false,
-	$require_user_auth = false,
-	$assoc = false
+    $method,
+    $function,
+    array $parameters = null,
+    $description = "",
+    $call_method = "GET",
+    $require_api_auth = false,
+    $require_user_auth = false,
+    $assoc = false
 ) {
 
-	global $API_METHODS;
-
-	if (empty($method) || empty($function)) {
-		$msg = elgg_echo('InvalidParameterException:APIMethodOrFunctionNotSet');
-		throw new InvalidParameterException($msg);
-	}
-
-	// does not check whether this method has already been exposed - good idea?
-	$API_METHODS[$method] = array();
-
-	$API_METHODS[$method]["description"] = $description;
-
-	// does not check whether callable - done in execute_method()
-	$API_METHODS[$method]["function"] = $function;
-
-	if ($parameters != NULL) {
-		if (!is_array($parameters)) {
-			$msg = elgg_echo('InvalidParameterException:APIParametersArrayStructure', array($method));
-			throw new InvalidParameterException($msg);
-		}
-
-		// catch common mistake of not setting up param array correctly
-		$first = current($parameters);
-		if (!is_array($first)) {
-			$msg = elgg_echo('InvalidParameterException:APIParametersArrayStructure', array($method));
-			throw new InvalidParameterException($msg);
-		}
-	}
-
-	if ($parameters != NULL) {
-		// ensure the required flag is set correctly in default case for each parameter
-		foreach ($parameters as $key => $value) {
-			// check if 'required' was specified - if not, make it true
-			if (!array_key_exists('required', $value)) {
-				$parameters[$key]['required'] = true;
-			}
-		}
-
-		$API_METHODS[$method]["parameters"] = $parameters;
-	}
-
-	$call_method = strtoupper($call_method);
-	switch ($call_method) {
-		case 'POST' :
-			$API_METHODS[$method]["call_method"] = 'POST';
-			break;
-		case 'GET' :
-			$API_METHODS[$method]["call_method"] = 'GET';
-			break;
-		default :
-			$msg = elgg_echo('InvalidParameterException:UnrecognisedHttpMethod',
-			array($call_method, $method));
-
-			throw new InvalidParameterException($msg);
-	}
-
-	$API_METHODS[$method]["require_api_auth"] = $require_api_auth;
-
-	$API_METHODS[$method]["require_user_auth"] = $require_user_auth;
-
-	$API_METHODS[$method]["assoc"] = (bool)$assoc;
-
-	return true;
+    global $API_METHODS;
+
+    if (empty($method) || empty($function)) {
+        $msg = elgg_echo('InvalidParameterException:APIMethodOrFunctionNotSet');
+        throw new InvalidParameterException($msg);
+    }
+
+    // does not check whether this method has already been exposed - good idea?
+    $API_METHODS[$method] = array();
+
+    $API_METHODS[$method]["description"] = $description;
+
+    // does not check whether callable - done in execute_method()
+    $API_METHODS[$method]["function"] = $function;
+
+    if ($parameters != NULL) {
+        if (!is_array($parameters)) {
+            $msg = elgg_echo('InvalidParameterException:APIParametersArrayStructure', array($method));
+            throw new InvalidParameterException($msg);
+        }
+
+        // catch common mistake of not setting up param array correctly
+        $first = current($parameters);
+        if (!is_array($first)) {
+            $msg = elgg_echo('InvalidParameterException:APIParametersArrayStructure', array($method));
+            throw new InvalidParameterException($msg);
+        }
+    }
+
+    if ($parameters != NULL) {
+        // ensure the required flag is set correctly in default case for each parameter
+        foreach ($parameters as $key => $value) {
+            // check if 'required' was specified - if not, make it true
+            if (!array_key_exists('required', $value)) {
+                $parameters[$key]['required'] = true;
+            }
+        }
+
+        $API_METHODS[$method]["parameters"] = $parameters;
+    }
+
+    $call_method = strtoupper($call_method);
+    switch ($call_method) {
+        case 'POST' :
+            $API_METHODS[$method]["call_method"] = 'POST';
+            break;
+        case 'GET' :
+            $API_METHODS[$method]["call_method"] = 'GET';
+            break;
+        default :
+            $msg = elgg_echo('InvalidParameterException:UnrecognisedHttpMethod',
+            array($call_method, $method));
+
+            throw new InvalidParameterException($msg);
+    }
+
+    $API_METHODS[$method]["require_api_auth"] = $require_api_auth;
+
+    $API_METHODS[$method]["require_user_auth"] = $require_user_auth;
+
+    $API_METHODS[$method]["assoc"] = (bool)$assoc;
+
+    return true;
 }
 
 /**
@@ -222,11 +222,11 @@ 
  * @return void
  */
 function elgg_ws_unexpose_function($method) {
-	global $API_METHODS;
+    global $API_METHODS;
 
-	if (isset($API_METHODS[$method])) {
-		unset($API_METHODS[$method]);
-	}
+    if (isset($API_METHODS[$method])) {
+        unset($API_METHODS[$method]);
+    }
 }
 
 /**
@@ -236,12 +236,12 @@ 
  * @access private
  */
 function list_all_apis() {
-	global $API_METHODS;
+    global $API_METHODS;
 
-	// sort first
-	ksort($API_METHODS);
+    // sort first
+    ksort($API_METHODS);
 
-	return $API_METHODS;
+    return $API_METHODS;
 }
 
 /**
@@ -253,17 +253,17 @@ 
  * @return bool Depending on success
  */
 function elgg_ws_register_service_handler($handler, $function) {
-	global $CONFIG;
+    global $CONFIG;
 
-	if (!isset($CONFIG->servicehandler)) {
-		$CONFIG->servicehandler = array();
-	}
-	if (is_callable($function, true)) {
-		$CONFIG->servicehandler[$handler] = $function;
-		return true;
-	}
+    if (!isset($CONFIG->servicehandler)) {
+        $CONFIG->servicehandler = array();
+    }
+    if (is_callable($function, true)) {
+        $CONFIG->servicehandler[$handler] = $function;
+        return true;
+    }
 
-	return false;
+    return false;
 }
 
 /**
@@ -275,11 +275,11 @@ 
  * @return void
  */
 function elgg_ws_unregister_service_handler($handler) {
-	global $CONFIG;
+    global $CONFIG;
 
-	if (isset($CONFIG->servicehandler, $CONFIG->servicehandler[$handler])) {
-		unset($CONFIG->servicehandler[$handler]);
-	}
+    if (isset($CONFIG->servicehandler, $CONFIG->servicehandler[$handler])) {
+        unset($CONFIG->servicehandler[$handler]);
+    }
 }
 
 /**
@@ -292,58 +292,58 @@ 
  */
 function ws_rest_handler() {
 
-	$viewtype = elgg_get_viewtype();
+    $viewtype = elgg_get_viewtype();
 
-	if (!elgg_view_exists('api/output', $viewtype)) {
-		header("HTTP/1.0 400 Bad Request");
-		header("Content-type: text/plain");
-		echo "Missing view 'api/output' in viewtype '$viewtype'.";
-		if (in_array($viewtype, ['xml', 'php'])) {
-			echo "\nEnable the 'data_views' plugin to add this view.";
-		}
-		exit;
-	}
+    if (!elgg_view_exists('api/output', $viewtype)) {
+        header("HTTP/1.0 400 Bad Request");
+        header("Content-type: text/plain");
+        echo "Missing view 'api/output' in viewtype '$viewtype'.";
+        if (in_array($viewtype, ['xml', 'php'])) {
+            echo "\nEnable the 'data_views' plugin to add this view.";
+        }
+        exit;
+    }
 
-	elgg_load_library('elgg:ws');
+    elgg_load_library('elgg:ws');
 
-	// Register the error handler
-	error_reporting(E_ALL);
-	set_error_handler('_php_api_error_handler');
+    // Register the error handler
+    error_reporting(E_ALL);
+    set_error_handler('_php_api_error_handler');
 
-	// Register a default exception handler
-	set_exception_handler('_php_api_exception_handler');
+    // Register a default exception handler
+    set_exception_handler('_php_api_exception_handler');
 
-	// plugins should return true to control what API and user authentication handlers are registered
-	if (elgg_trigger_plugin_hook('rest', 'init', null, false) == false) {
-		// for testing from a web browser, you can use the session PAM
-		// do not use for production sites!!
-		//register_pam_handler('pam_auth_session');
+    // plugins should return true to control what API and user authentication handlers are registered
+    if (elgg_trigger_plugin_hook('rest', 'init', null, false) == false) {
+        // for testing from a web browser, you can use the session PAM
+        // do not use for production sites!!
+        //register_pam_handler('pam_auth_session');
 
-		// user token can also be used for user authentication
-		register_pam_handler('pam_auth_usertoken');
+        // user token can also be used for user authentication
+        register_pam_handler('pam_auth_usertoken');
 
-		// simple API key check
-		register_pam_handler('api_auth_key', "sufficient", "api");
-		// hmac
-		register_pam_handler('api_auth_hmac', "sufficient", "api");
-	}
+        // simple API key check
+        register_pam_handler('api_auth_key', "sufficient", "api");
+        // hmac
+        register_pam_handler('api_auth_hmac', "sufficient", "api");
+    }
 
-	// Get parameter variables
-	$method = get_input('method');
-	$result = null;
+    // Get parameter variables
+    $method = get_input('method');
+    $result = null;
 
-	// this will throw an exception if authentication fails
-	authenticate_method($method);
+    // this will throw an exception if authentication fails
+    authenticate_method($method);
 
-	$result = execute_method($method);
+    $result = execute_method($method);
 
 
-	if (!($result instanceof GenericResult)) {
-		throw new APIException(elgg_echo('APIException:ApiResultUnknown'));
-	}
+    if (!($result instanceof GenericResult)) {
+        throw new APIException(elgg_echo('APIException:ApiResultUnknown'));
+    }
 
-	// Output the result
-	echo elgg_view_page($method, elgg_view("api/output", array("result" => $result)));
+    // Output the result
+    echo elgg_view_page($method, elgg_view("api/output", array("result" => $result)));
 }
 
 /**
@@ -358,10 +358,10 @@ 
  * @access private
  */
 function ws_unit_test($hook, $type, $value, $params) {
-	elgg_load_library('elgg:ws');
-	elgg_load_library('elgg:ws:client');
-	$value[] = dirname(__FILE__) . '/tests/ElggCoreWebServicesApiTest.php';
-	return $value;
+    elgg_load_library('elgg:ws');
+    elgg_load_library('elgg:ws:client');
+    $value[] = dirname(__FILE__) . '/tests/ElggCoreWebServicesApiTest.php';
+    return $value;
 }
 
 /**
@@ -375,11 +375,11 @@ 
  */
 function ws_system_api_list_hook($hook, $type, $return, $params) {
 
-	if (!empty($return) && is_array($return)) {
-		foreach($return as $method => $settings) {
-			unset($return[$method]['function']);
-		}
-	}
+    if (!empty($return) && is_array($return)) {
+        foreach($return as $method => $settings) {
+            unset($return[$method]['function']);
+        }
+    }
 
-	return $return;
+    return $return;
 }

engine/classes/Elgg/Database/Seeder.php

Indentation +74 added lines, -74 removed lines

@@ -17,79 +17,79 @@
  */
 class Seeder {
 
-	private $seeds = [
-		Users::class,
-		Groups::class,
-		Objects::class,
-	];
-
-	/**
-	 * @var PluginHooksService
-	 */
-	protected $hooks;
-
-	/**
-	 * Seeder constructor.
-	 *
-	 * @param PluginHooksService $hooks Hooks registration service
-	 */
-	public function __construct(PluginHooksService $hooks) {
-		$this->hooks = $hooks;
-	}
-
-	/**
-	 * Load seed scripts
-	 *
-	 * @return void
-	 */
-	public function seed() {
-		$ia = elgg_set_ignore_access(true);
-
-		$ha = access_get_show_hidden_status();
-		access_show_hidden_entities(true);
+    private $seeds = [
+        Users::class,
+        Groups::class,
+        Objects::class,
+    ];
+
+    /**
+     * @var PluginHooksService
+     */
+    protected $hooks;
+
+    /**
+     * Seeder constructor.
+     *
+     * @param PluginHooksService $hooks Hooks registration service
+     */
+    public function __construct(PluginHooksService $hooks) {
+        $this->hooks = $hooks;
+    }
+
+    /**
+     * Load seed scripts
+     *
+     * @return void
+     */
+    public function seed() {
+        $ia = elgg_set_ignore_access(true);
+
+        $ha = access_get_show_hidden_status();
+        access_show_hidden_entities(true);
 		
-		foreach ($this->seeds as $seed) {
-			if (!class_exists($seed)) {
-				continue;
-			}
-			$seed = new $seed();
-			if (!is_subclass_of($seed, Seed::class)) {
-				continue;
-			}
-
-			$seed->seed();
-		}
-
-		access_show_hidden_entities($ha);
-
-		elgg_set_ignore_access($ia);
-	}
-
-	/**
-	 * Remove all seeded entities
-	 * @return void
-	 */
-	public function unseed() {
-
-		$ia = elgg_set_ignore_access(true);
-
-		$ha = access_get_show_hidden_status();
-		access_show_hidden_entities(true);
-
-		foreach ($this->seeds as $seed) {
-			if (!class_exists($seed)) {
-				continue;
-			}
-			$seed = new $seed();
-			if (!is_subclass_of($seed, Seed::class)) {
-				continue;
-			}
-
-			$seed->unseed();
-		}
-
-		access_show_hidden_entities($ha);
-
-		elgg_set_ignore_access($ia);
-	}
+        foreach ($this->seeds as $seed) {
+            if (!class_exists($seed)) {
+                continue;
+            }
+            $seed = new $seed();
+            if (!is_subclass_of($seed, Seed::class)) {
+                continue;
+            }
+
+            $seed->seed();
+        }
+
+        access_show_hidden_entities($ha);
+
+        elgg_set_ignore_access($ia);
+    }
+
+    /**
+     * Remove all seeded entities
+     * @return void
+     */
+    public function unseed() {
+
+        $ia = elgg_set_ignore_access(true);
+
+        $ha = access_get_show_hidden_status();
+        access_show_hidden_entities(true);
+
+        foreach ($this->seeds as $seed) {
+            if (!class_exists($seed)) {
+                continue;
+            }
+            $seed = new $seed();
+            if (!is_subclass_of($seed, Seed::class)) {
+                continue;
+            }
+
+            $seed->unseed();
+        }
+
+        access_show_hidden_entities($ha);
+
+        elgg_set_ignore_access($ia);
+    }
 }
\ No newline at end of file