refactor: rename MailAccount's "root" to "subscriptions"

refs conjoon/conjoon#23

Author: ThorstenSuckow

src/Mail/Client/Data/MailAccount.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * php-lib-conjoon
- * Copyright (C) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
+ * Copyright (C) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -56,14 +56,14 @@
  *        "outbox_user"     => "outboxuser",
  *        "outbox_password" => "outboxpassword',
  *        'outbox_secure'   => "tls",
- *        'root'            => "INBOX"
+ *        'subscriptions'   => ["INBOX"]
  *    ]);
  *
  *    $account->getOutboxSecure(); // true
  *    $account->getInboxPort(); // 993
  *    $account->getReplyTo();   // ['name' => 'John Smith', 'address' => '[email protected]'],
  *
- * The property "root" allows for specifying a root mailbox and defaults to "INBOX".
+ * The property "subscriptions" allows for specifying mailbox the account is subscribed to.
  *
  * @package Conjoon\Mail\Client\Data
  *
@@ -82,7 +82,7 @@
  * @method string getOutboxAddress()
  * @method int getOutboxPort()
  * @method string getOutboxSecure()
- * @method array getRoot()
+ * @method array getSubscriptions()
  *
  * @noinspection SpellCheckingInspection
  */
@@ -166,7 +166,7 @@ class MailAccount implements Jsonable, Arrayable
     /**
      * @var array
      */
-    protected array $root = ["INBOX"];
+    protected array $subscriptions = ["INBOX"];
 
     /**
      * MailAccount constructor.
@@ -240,7 +240,7 @@ public function toArray(): array
             "outbox_user" => $this->getOutboxUser(),
             "outbox_password" => $this->getOutboxPassword(),
             "outbox_secure" => $this->getOutboxSecure(),
-            "root" => $this->getRoot()
+            "subscriptions" => $this->getSubscriptions()
         ];
     }
 

src/Mail/Client/Service/DefaultMailFolderService.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * php-lib-conjoon
- * Copyright (C) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
+ * Copyright (C) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -92,10 +92,10 @@ public function getMailClient(): MailClient
     /**
      * @inheritdoc
      */
-    public function getMailFolderChildList(MailAccount $mailAccount): MailFolderChildList
+    public function getMailFolderChildList(MailAccount $mailAccount, array $subscriptions = []): MailFolderChildList
     {
         $mailFolderList = $this->getMailClient()->getMailFolderList($mailAccount);
 
-        return $this->getMailFolderTreeBuilder()->listToTree($mailFolderList, $mailAccount->getRoot());
+        return $this->getMailFolderTreeBuilder()->listToTree($mailFolderList, $subscriptions);
     }
 }

src/Mail/Client/Service/MailFolderService.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * php-lib-conjoon
- * Copyright (C) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
+ * Copyright (C) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -40,6 +40,7 @@ interface MailFolderService
      * MailAccount.
      *
      * @param MailAccount $mailAccount
+     * @param array $subscriptions
      *
      * @return MailFolderChildList An MailFolderChildList of the Mailbox-structure
      * found on the server.
@@ -55,7 +56,7 @@ interface MailFolderService
      *
      * @see \Horde_Imap_Client_Socket
      */
-    public function getMailFolderChildList(MailAccount $mailAccount): MailFolderChildList;
+    public function getMailFolderChildList(MailAccount $mailAccount, array $subscriptions = []): MailFolderChildList;
 
 
     /**

tests/Mail/Client/Data/MailAccountTest.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * php-lib-conjoon
- * Copyright (C) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
+ * Copyright (C) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -59,7 +59,7 @@ class MailAccountTest extends TestCase
         "outbox_user"     => "user",
         "outbox_password" => "password outbox",
         "outbox_secure"   => "ssl",
-        "root"            => ["[Gmail]"]
+        "subscriptions"    => ["[Gmail]"]
     ];
 
 
@@ -81,14 +81,14 @@ public function testGetter()
     {
         $config = $this->accountConfig;
 
-        $oldRoot = $config["root"];
+        $oldRoot = $config["subscriptions"];
         $this->assertSame(["[Gmail]"], $oldRoot);
-        unset($config["root"]);
+        unset($config["subscriptions"]);
 
         $account = new MailAccount($config);
-        $this->assertSame(["INBOX"], $account->getRoot());
+        $this->assertSame(["INBOX"], $account->getSubscriptions());
 
-        $config["root"] = $oldRoot;
+        $config["subscriptions"] = $oldRoot;
         $account = new MailAccount($config);
 
         foreach ($config as $property => $value) {

tests/Mail/Client/Service/DefaultMailFolderServiceTest.php

@@ -3,7 +3,7 @@
 /**
  * conjoon
  * php-lib-conjoon
- * Copyright (C) 2019-2022 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
+ * Copyright (C) 2019-2023 Thorsten Suckow-Homberg https://github.com/conjoon/php-lib-conjoon
  *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
@@ -90,7 +90,7 @@ public function testGetMailFolderChildList()
                 ->with($mailFolderList, ["INBOX"])
                 ->andReturn($resultList);
 
-        $this->assertSame($resultList, $service->getMailFolderChildList($mailAccount));
+        $this->assertSame($resultList, $service->getMailFolderChildList($mailAccount, ["INBOX"]));
     }