archive/nextcloud_server
0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-03-18 10:13:32 +00:00
Code Issues Projects Releases Wiki Activity

Add example to DocBlock

Browse source 
Signed-off-by: Christopher Ng <chrng8@gmail.com>
This commit is contained in:
Christopher Ng 2022-03-17 04:26:24 +00:00
parent 2d9d0702f0
commit c505bb1449
1 changed files with 34 additions and 0 deletions

34
lib/public/Accounts/IAccount.php
View file

@ -76,6 +76,40 @@ interface IAccount extends \JsonSerializable {
*
* @param array<string, array<string, string>>|array<string, array<int, array<string, string>>> $properties
*
* e.g. `[
* 'displayname' => [
* 'name' => 'displayname',
* 'value' => 'Jonathan Smith',
* 'scope' => 'v2-federated',
* 'verified' => '0',
* 'verificationData' => '',
* ],
* 'email' => [
* 'name' => 'email',
* 'value' => 'jonathan@example.org',
* 'scope' => 'v2-federated',
* 'verified' => '0',
* 'verificationData' => '',
* ],
* // ...
* 'additional_mail' => [
* [
* 'name' => 'additional_mail',
* 'value' => 'jon@example.org',
* 'scope' => 'v2-local',
* 'verified' => '0',
* 'verificationData' => '',
* ],
* [
* 'name' => 'additional_mail',
* 'value' => 'jon@earth.org',
* 'scope' => 'v2-local',
* 'verified' => '0',
* 'verificationData' => '',
* ],
* ],
* ]`
*
* @since 24.0.0
*/
public function setAllPropertiesFromJson(array $properties): IAccount;