Add method to set all account properties from json

Signed-off-by: Christopher Ng <chrng8@gmail.com>

Author: Pytal

lib/private/Accounts/Account.php

@@ -72,6 +72,28 @@ public function getProperties(): array {
 		});
 	}
 
+	public function setJsonProperties(array $properties): IAccount {
+		foreach ($properties as $propertyName => $propertyObject) {
+			if ($this->isCollection($propertyName)) {
+				$collection = new AccountPropertyCollection($propertyName);
+				/** @var array<int, IAccountProperty> $collectionProperties */
+				$collectionProperties = [];
+				/** @var array<int, array<string, string>> $propertyObject */
+				foreach ($propertyObject as ['value' => $value, 'scope' => $scope, 'verified' => $verified, 'verificationData' => $verificationData]) {
+					$collectionProperties[] = new AccountProperty($collection->getName(), $value, $scope, $verified, $verificationData);
+				}
+				$collection->setProperties($collectionProperties);
+				$this->setPropertyCollection($collection);
+			} else {
+				/** @var array<string, string> $propertyObject */
+				['value' => $value, 'scope' => $scope, 'verified' => $verified, 'verificationData' => $verificationData] = $propertyObject;
+				$this->setProperty($propertyName, $value, $scope, $verified, $verificationData);
+			}
+		}
+
+		return $this;
+	}
+
 	public function getAllProperties(): Generator {
 		foreach ($this->properties as $propertyObject) {
 			if ($propertyObject instanceof IAccountProperty) {

lib/public/Accounts/IAccount.php

@@ -71,6 +71,15 @@ public function getProperty(string $property): IAccountProperty;
 	 */
 	public function getProperties(): array;
 
+	/**
+	 * Set all properties of an account
+	 *
+	 * @param array<string, array<string, string>>|array<string, array<int, array<string, string>>> $properties
+	 *
+	 * @since 24.0.0
+	 */
+	public function setJsonProperties(array $properties): IAccount;
+
 	/**
 	 * Get all properties of an account. Array indices are numeric. To get
 	 * the property name, call getName() against the value.

tests/lib/Accounts/AccountTest.php

@@ -70,6 +70,31 @@ public function testGetAndGetAllProperties() {
 		$this->assertEquals(array_values($properties), \iterator_to_array($account->getAllProperties()));
 	}
 
+	public function testSetJsonProperties() {
+		$user = $this->createMock(IUser::class);
+		$properties = [
+			IAccountManager::PROPERTY_DISPLAYNAME     => new AccountProperty(IAccountManager::PROPERTY_DISPLAYNAME,     'Steve',                   IAccountManager::SCOPE_FEDERATED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_ADDRESS         => new AccountProperty(IAccountManager::PROPERTY_ADDRESS,         '123 Acorn Avenue',        IAccountManager::SCOPE_FEDERATED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_WEBSITE         => new AccountProperty(IAccountManager::PROPERTY_WEBSITE,         'https://www.example.org', IAccountManager::SCOPE_FEDERATED, IAccountManager::VERIFIED,                 ''),
+			IAccountManager::PROPERTY_EMAIL           => new AccountProperty(IAccountManager::PROPERTY_EMAIL,           'steve@earth.com',         IAccountManager::SCOPE_PUBLISHED, IAccountManager::VERIFICATION_IN_PROGRESS, ''),
+			IAccountManager::PROPERTY_AVATAR          => new AccountProperty(IAccountManager::PROPERTY_AVATAR,          '',                        IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_PHONE           => new AccountProperty(IAccountManager::PROPERTY_PHONE,           '+358407991028',           IAccountManager::SCOPE_LOCAL,     IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_TWITTER         => new AccountProperty(IAccountManager::PROPERTY_TWITTER,         'therealsteve',            IAccountManager::SCOPE_PRIVATE,   IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_ORGANISATION    => new AccountProperty(IAccountManager::PROPERTY_ORGANISATION,    'Steve Incorporated',      IAccountManager::SCOPE_FEDERATED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_ROLE            => new AccountProperty(IAccountManager::PROPERTY_ROLE,            'Founder',                 IAccountManager::SCOPE_FEDERATED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_HEADLINE        => new AccountProperty(IAccountManager::PROPERTY_HEADLINE,        'I am Steve',              IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_BIOGRAPHY       => new AccountProperty(IAccountManager::PROPERTY_BIOGRAPHY,       'Steve is the best',       IAccountManager::SCOPE_LOCAL,     IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::PROPERTY_PROFILE_ENABLED => new AccountProperty(IAccountManager::PROPERTY_PROFILE_ENABLED, '1',                       IAccountManager::SCOPE_FEDERATED, IAccountManager::NOT_VERIFIED,             ''),
+			IAccountManager::COLLECTION_EMAIL => [
+				new AccountProperty(IAccountManager::COLLECTION_EMAIL, 'steve@mars.com',    IAccountManager::SCOPE_PUBLISHED, IAccountManager::NOT_VERIFIED, ''),
+				new AccountProperty(IAccountManager::COLLECTION_EMAIL, 'steve@neptune.com', IAccountManager::SCOPE_FEDERATED, IAccountManager::NOT_VERIFIED, ''),
+			],
+		];
+		$account = new Account($user);
+		$account->setJsonProperties(json_decode(json_encode($properties), true));
+		$this->assertEquals($properties, $account->jsonSerialize());
+	}
+
 	public function testGetFilteredProperties() {
 		$user = $this->createMock(IUser::class);
 		$properties = [