Event system and callbacks added

Author: Webklex

CHANGELOG.md

@@ -6,10 +6,10 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 
 ## [UNRELEASED]
 ### Fixed
-- NaN
+- Quota handling fixed
 
 ### Added
-- NaN
+- Event system and callbacks added
 
 ### Affected Classes
 - NaN

README.md

@@ -28,6 +28,7 @@ The functionality is almost completely integrated and even supports IDLE operati
     - [Message flags](#message-flags)
     - [Attachments](#attachments)
     - [Advanced fetching](#advanced-fetching)
+    - [Events](#events)
     - [Masking](#masking)
     - [Specials](#specials)
 - [Support](#support)
@@ -210,13 +211,13 @@ $oClient->connect();
 ```
 
 #### Idle
-Every time a new message is received the server will notify the client and return the new message.
+Every time a new message is received, the server will notify the client and return the new message.
 ``` php
 /** @var \Webklex\PHPIMAP\Client $oClient */
 
 /** @var \Webklex\PHPIMAP\Folder $oFolder */
 $oFolder->idle(function($message){
-    dump($message->subject);
+    echo $message->subject."\n";
 });
 ```
 
@@ -467,6 +468,39 @@ $aMessage = $oFolder->query()->whereAll()
 ->get();
 ```
 
+#### Events
+The following events are available:
+- `Webklex\PHPIMAP\Events\MessageNewEvent($message)` — can get triggered by `Folder::idle`
+- `Webklex\PHPIMAP\Events\MessageDeletedEvent($message)` — triggered by `Message::delete`
+- `Webklex\PHPIMAP\Events\MessageRestoredEvent($message)` — triggered by `Message::restore`
+- `Webklex\PHPIMAP\Events\MessageMovedEvent($old_message, $new_message)` — triggered by `Message::move`
+- `Webklex\PHPIMAP\Events\MessageCopiedEvent($old_message, $new_message)` — triggered by `Message::copy`
+- `Webklex\PHPIMAP\Events\FlagNewEvent($flag)` — triggered by `Message::setFlag`
+- `Webklex\PHPIMAP\Events\FlagDeletedEvent($flag)` — triggered by `Message::unsetFlag`
+- `Webklex\PHPIMAP\Events\FolderNewEvent($folder)` — can get triggered by `Client::createFolder`
+- `Webklex\PHPIMAP\Events\FolderDeletedEvent($folder)` — triggered by `Folder::delete`
+- `Webklex\PHPIMAP\Events\FolderMovedEvent($old_folder, $new_folder)` — triggered by `Folder::move`
+
+Create and register your own custom event:
+``` php
+class CustomMessageNewEvent extends Webklex\PHPIMAP\Events\MessageNewEvent {
+
+    /**
+     * Create a new event instance.
+     * @var Message[] $messages
+     * @return void
+     */
+    public function __construct($messages) {
+        $this->message = $messages[0];
+        echo "New message: ".$this->message->subject."\n";
+    }
+}
+
+/** @var \Webklex\PHPIMAP\Client $client */
+$client->setEvent("message", "new", CustomMessageNewEvent::class);
+```
+..or set it in your config file under `events.message.new`,
+
 #### Masking
 Laravel-IMAP already comes with two default masks [MessageMask::class](#messagemaskclass) and [AttachmentMask::class](#attachmentmaskclass).
 

src/Client.php

@@ -23,13 +23,15 @@
 use Webklex\PHPIMAP\Support\FolderCollection;
 use Webklex\PHPIMAP\Support\Masks\AttachmentMask;
 use Webklex\PHPIMAP\Support\Masks\MessageMask;
+use Webklex\PHPIMAP\Traits\HasEvents;
 
 /**
  * Class Client
  *
  * @package Webklex\PHPIMAP
  */
 class Client {
+    use HasEvents;
 
 
     /**
@@ -128,6 +130,7 @@ class Client {
     public function __construct($config = []) {
         $this->setConfig($config);
         $this->setMaskFromConfig($config);
+        $this->setEventsFromConfig($config);
     }
 
     /**
@@ -155,6 +158,21 @@ public function setConfig(array $config) {
         return $this;
     }
 
+    /**
+     * Look for a possible events in any available config
+     * @param $config
+     */
+    protected function setEventsFromConfig($config) {
+        $this->events = ClientManager::get("events");
+        if(isset($config['events'])){
+            if(isset($config['events'])) {
+                foreach($config['events'] as $section => $events) {
+                    $this->events[$section] = array_merge($this->events[$section], $events);
+                }
+            }
+        }
+    }
+
     /**
      * Look for a possible mask in any available config
      * @param $config
@@ -383,13 +401,21 @@ public function openFolder($folder) {
      *
      * @return bool
      * @throws ConnectionFailedException
+     * @throws FolderFetchingException
+     * @throws Exceptions\EventNotFoundException
      */
     public function createFolder($folder, $expunge = true) {
         $this->checkConnection();
         $status = $this->connection->createFolder($folder);
         if($expunge) $this->expunge();
 
-        return $status;
+        $folder = $this->getFolder($folder);
+        if($status && $folder) {
+            $event = $this->getEvent("folder", "new");
+            $event::dispatch($folder);
+        }
+
+        return $folder;
     }
 
     /**
@@ -474,6 +500,14 @@ public function getDefaultMessageMask(){
         return $this->default_message_mask;
     }
 
+    /**
+     * @param $section
+     * @return array
+     */
+    public function getDefaultEvents($section){
+        return $this->events[$section];
+    }
+
     /**
      * @param $mask
      *

src/Events/Event.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+
+abstract class Event {
+
+    /**
+     * Dispatch the event with the given arguments.
+     */
+    public static function dispatch() {
+        return new static(func_get_args());
+    }
+}

src/Events/FlagDeletedEvent.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+
+class FlagDeletedEvent extends FlagNewEvent {
+
+}

src/Events/FlagNewEvent.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+use Webklex\PHPIMAP\Message;
+
+class FlagNewEvent extends Event {
+
+    /** @var Message $message */
+    public $message;
+
+    /** @var string $flag */
+    public $flag;
+
+    /**
+     * Create a new event instance.
+     * @var mixed[] $arguments
+     * @return void
+     */
+    public function __construct($arguments) {
+        $this->message = $arguments[0];
+        $this->flag = $arguments[1];
+    }
+}

src/Events/FolderDeletedEvent.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+class FolderDeletedEvent extends FolderNewEvent {
+
+}

src/Events/FolderMovedEvent.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+use Webklex\PHPIMAP\Folder;
+
+class FolderMovedEvent extends Event {
+
+    /** @var Folder $old_folder */
+    public $old_folder;
+    /** @var Folder $new_folder */
+    public $new_folder;
+
+    /**
+     * Create a new event instance.
+     * @var Folder[] $folders
+     * @return void
+     */
+    public function __construct($folders) {
+        $this->old_folder = $folders[0];
+        $this->new_folder = $folders[1];
+    }
+}

src/Events/FolderNewEvent.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+use Webklex\PHPIMAP\Folder;
+
+class FolderNewEvent extends Event {
+
+    /** @var Folder $folder */
+    public $folder;
+
+    /**
+     * Create a new event instance.
+     * @var Folder[] $folders
+     * @return void
+     */
+    public function __construct($folders) {
+        $this->folder = $folders[0];
+    }
+}

src/Events/MessageCopiedEvent.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Webklex\PHPIMAP\Events;
+
+
+class MessageCopiedEvent extends MessageMovedEvent {
+
+}