FolderCollection added

Author: Webklex

README.md

@@ -277,7 +277,7 @@ $aMessage = $oFolder->getMessages('ALL', null, false);
 | connect             | int $attempts                                                                   |                   | Connect to server.                                                                                                            |
 | disconnect          |                                                                                 |                   | Disconnect from server.                                                                                                       |
 | getFolder           | string $folder_name, int $attributes = 32, int or null $delimiter               | Folder            | Get a Folder instance by name                                                                                                 |
-| getFolders          | bool $hierarchical, string or null $parent_folder                               | array             | Get folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array.  |
+| getFolders          | bool $hierarchical, string or null $parent_folder                               | FolderCollection  | Get folders list. If hierarchical order is set to true, it will make a tree of folders, otherwise it will return flat array.  |
 | openFolder          | Folder $folder, $attempts                                                       |                   | Open a given folder.                                                                                                          |
 | createFolder        | string $name                                                                    |                   | Create a new folder.                                                                                                          |
 | getMessages         | Folder $folder, string $criteria, bool $parse_body                              | MessageCollection | Get messages from folder.                                                                                                     |
@@ -369,6 +369,13 @@ Extends [Illuminate\Support\Collection::class](https://laravel.com/api/5.4/Illum
 | -------- | --------------------------------------------------- | :------------------: | -------------------------------- |
 | paginate | int $perPage = 15, $page = null, $pageName = 'page' | LengthAwarePaginator | Paginate the current collection. |
 
+### [FolderCollection::class](src/IMAP/Support/FolderCollection.php)
+Extends [Illuminate\Support\Collection::class](https://laravel.com/api/5.4/Illuminate/Support/Collection.html)
+
+| Method   | Arguments                                           | Return               | Description                      |
+| -------- | --------------------------------------------------- | :------------------: | -------------------------------- |
+| paginate | int $perPage = 15, $page = null, $pageName = 'page' | LengthAwarePaginator | Paginate the current collection. |
+
 ### Known issues
 | Error                                                                     | Solution                                                   |
 | ------------------------------------------------------------------------- | ---------------------------------------------------------- |

src/IMAP/Client.php

@@ -15,6 +15,7 @@
 use Webklex\IMAP\Exceptions\ConnectionFailedException;
 use Webklex\IMAP\Exceptions\GetMessagesFailedException;
 use Webklex\IMAP\Exceptions\MessageSearchValidationException;
+use Webklex\IMAP\Support\FolderCollection;
 use Webklex\IMAP\Support\MessageCollection;
 
 /**
@@ -252,11 +253,11 @@ public function getFolder($folder_name, $attributes = 32, $delimiter = null){
      * @param bool $hierarchical
      * @param null $parent_folder
      *
-     * @return array
+     * @return FolderCollection
      */
     public function getFolders($hierarchical = true, $parent_folder = null) {
         $this->checkConnection();
-        $folders = [];
+        $folders = FolderCollection::make([]);
 
         $pattern = $parent_folder.($hierarchical ? '%' : '*');
 
@@ -270,7 +271,8 @@ public function getFolders($hierarchical = true, $parent_folder = null) {
                 $children = $this->getFolders(true, $pattern);
                 $folder->setChildren($children);
             }
-            $folders[] = $folder;
+
+            $folders->push($folder);
         }
 
         return $folders;

src/IMAP/Folder.php

@@ -14,6 +14,7 @@
 
 use Webklex\IMAP\Exceptions\GetMessagesFailedException;
 use Webklex\IMAP\Exceptions\MessageSearchValidationException;
+use Webklex\IMAP\Support\FolderCollection;
 use Webklex\IMAP\Support\MessageCollection;
 
 /**
@@ -54,7 +55,7 @@ class Folder {
     /**
      * Children folders
      *
-     * @var array
+     * @var FolderCollection|array
      */
     public $children = [];
 
@@ -134,7 +135,7 @@ public function hasChildren() {
     /**
      * Set children.
      *
-     * @param array $children
+     * @param FolderCollection|array $children
      *
      * @return self
      */

src/IMAP/Support/FolderCollection.php

@@ -0,0 +1,22 @@
+<?php
+/*
+* File:     FolderCollection.php
+* Category: Collection
+* Author:   M. Goldenbaum
+* Created:  18.03.18 02:21
+* Updated:  -
+*
+* Description:
+*  -
+*/
+
+namespace Webklex\IMAP\Support;
+
+/**
+ * Class FolderCollection
+ *
+ * @package Webklex\IMAP\Support
+ */
+class FolderCollection extends PaginatedCollection {
+
+}