Event action system

app/Bus/Events/ActionInterface.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of Cachet.
+ *
+ * (c) Alt Three Services Limited
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace CachetHQ\Cachet\Bus\Events;
+
+/**
+ * This is the action interface.
+ *
+ * @author Graham Campbell <[email protected]>
+ * @author James Brooks <[email protected]>
+ */
+interface ActionInterface
+{
+    /**
+     * Get the event action.
+     *
+     * @return array
+     */
+    public function getAction();
+}

app/Bus/Events/Component/ComponentEventInterface.php

@@ -13,6 +13,12 @@
 
 use CachetHQ\Cachet\Bus\Events\EventInterface;
 
+/**
+ * This is the component event interface.
+ *
+ * @author Graham Campbell <[email protected]>
+ * @author James Brooks <[email protected]>
+ */
 interface ComponentEventInterface extends EventInterface
 {
     //

app/Bus/Events/Component/ComponentStatusWasUpdatedEvent.php

@@ -11,15 +11,24 @@
 
 namespace CachetHQ\Cachet\Bus\Events\Component;
 
+use CachetHQ\Cachet\Bus\Events\ActionInterface;
 use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\User;
 
 /**
  * This is the component status was updated event.
  *
  * @author James Brooks <[email protected]>
  */
-final class ComponentStatusWasUpdatedEvent implements ComponentEventInterface
+final class ComponentStatusWasUpdatedEvent implements ActionInterface, ComponentEventInterface
 {
+    /**
+     * The user who updated the component.
+     *
+     * @var \CachetHQ\Cachet\Models\User
+     */
+    public $user;
+
     /**
      * The component that was updated.
      *
@@ -44,14 +53,16 @@ final class ComponentStatusWasUpdatedEvent implements ComponentEventInterface
     /**
      * Create a new component was updated event instance.
      *
+     * @param \CachetHQ\Cachet\Models\User      $user
      * @param \CachetHQ\Cachet\Models\Component $component
      * @param int                               $original_status
      * @param int                               $new_status
      *
      * @return void
      */
-    public function __construct(Component $component, $original_status, $new_status)
+    public function __construct(User $user, Component $component, $original_status, $new_status)
     {
+        $this->user = $user;
         $this->component = $component;
         $this->original_status = $original_status;
         $this->new_status = $new_status;
@@ -66,4 +77,17 @@ public function __toString()
     {
         return 'Component status was updated.';
     }
+
+    /**
+     * Get the event action.
+     *
+     * @return array
+     */
+    public function getAction()
+    {
+        return [
+            'user'        => $this->user,
+            'description' => (string) $this,
+        ];
+    }
 }

app/Bus/Events/Component/ComponentWasAddedEvent.php

@@ -11,10 +11,19 @@
 
 namespace CachetHQ\Cachet\Bus\Events\Component;
 
+use CachetHQ\Cachet\Bus\Events\ActionInterface;
 use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\User;
 
-final class ComponentWasAddedEvent implements ComponentEventInterface
+final class ComponentWasAddedEvent implements ActionInterface, ComponentEventInterface
 {
+    /**
+     * The user who added the component.
+     *
+     * @var \CachetHQ\Cachet\Models\User
+     */
+    public $user;
+
     /**
      * The component that was added.
      *
@@ -25,12 +34,14 @@ final class ComponentWasAddedEvent implements ComponentEventInterface
     /**
      * Create a new component was added event instance.
      *
+     * @param \CachetHQ\Cachet\Models\User      $user
      * @param \CachetHQ\Cachet\Models\Component $component
      *
      * @return void
      */
-    public function __construct(Component $component)
+    public function __construct(User $user, Component $component)
     {
+        $this->user = $user;
         $this->component = $component;
     }
 
@@ -43,4 +54,17 @@ public function __toString()
     {
         return 'Component was added.';
     }
+
+    /**
+     * Get the event action.
+     *
+     * @return array
+     */
+    public function getAction()
+    {
+        return [
+            'user'        => $this->user,
+            'description' => (string) $this,
+        ];
+    }
 }

app/Bus/Events/Component/ComponentWasRemovedEvent.php

@@ -11,10 +11,24 @@
 
 namespace CachetHQ\Cachet\Bus\Events\Component;
 
+use CachetHQ\Cachet\Bus\Events\ActionInterface;
 use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\User;
 
-final class ComponentWasRemovedEvent implements ComponentEventInterface
+/**
+ * This is the component was removed event class.
+ *
+ * @author James Brooks <[email protected]>
+ */
+final class ComponentWasRemovedEvent implements ActionInterface, ComponentEventInterface
 {
+    /**
+     * The user who removed the component.
+     *
+     * @var \CachetHQ\Cachet\Models\User
+     */
+    public $user;
+
     /**
      * The component that was removed.
      *
@@ -25,12 +39,14 @@ final class ComponentWasRemovedEvent implements ComponentEventInterface
     /**
      * Create a new component was removed event instance.
      *
+     * @param \CachetHQ\Cachet\Models\User      $user
      * @param \CachetHQ\Cachet\Models\Component $component
      *
      * @return void
      */
-    public function __construct(Component $component)
+    public function __construct(User $user, Component $component)
     {
+        $this->user = $user;
         $this->component = $component;
     }
 
@@ -43,4 +59,17 @@ public function __toString()
     {
         return 'Component was removed.';
     }
+
+    /**
+     * Get the event action.
+     *
+     * @return array
+     */
+    public function getAction()
+    {
+        return [
+            'user'        => $this->user,
+            'description' => (string) $this,
+        ];
+    }
 }

app/Bus/Events/Component/ComponentWasUpdatedEvent.php

@@ -11,16 +11,25 @@
 
 namespace CachetHQ\Cachet\Bus\Events\Component;
 
+use CachetHQ\Cachet\Bus\Events\ActionInterface;
 use CachetHQ\Cachet\Models\Component;
+use CachetHQ\Cachet\Models\User;
 
 /**
  * This is the component was updated event class.
  *
  * @author James Brooks <[email protected]>
  * @author Graham Campbell <[email protected]>
  */
-final class ComponentWasUpdatedEvent implements ComponentEventInterface
+final class ComponentWasUpdatedEvent implements ActionInterface, ComponentEventInterface
 {
+    /**
+     * The user who updated the component.
+     *
+     * @var \CachetHQ\Cachet\Models\User
+     */
+    public $user;
+
     /**
      * The component that was updated.
      *
@@ -31,12 +40,14 @@ final class ComponentWasUpdatedEvent implements ComponentEventInterface
     /**
      * Create a new component was updated event instance.
      *
+     * @param \CachetHQ\Cachet\Models\User      $user
      * @param \CachetHQ\Cachet\Models\Component $component
      *
      * @return void
      */
-    public function __construct(Component $component)
+    public function __construct(User $user, Component $component)
     {
+        $this->user = $user;
         $this->component = $component;
     }
 
@@ -49,4 +60,17 @@ public function __toString()
     {
         return 'Component was updated.';
     }
+
+    /**
+     * Get the event action.
+     *
+     * @return array
+     */
+    public function getAction()
+    {
+        return [
+            'user'        => $this->user,
+            'description' => (string) $this,
+        ];
+    }
 }

app/Bus/Events/ComponentGroup/ComponentGroupEventInterface.php

@@ -13,6 +13,12 @@
 
 use CachetHQ\Cachet\Bus\Events\EventInterface;
 
+/**
+ * This is the component group event interface.
+ *
+ * @author Graham Campbell <[email protected]>
+ * @author James Brooks <[email protected]>
+ */
 interface ComponentGroupEventInterface extends EventInterface
 {
     //

app/Bus/Events/ComponentGroup/ComponentGroupWasAddedEvent.php

@@ -11,10 +11,19 @@
 
 namespace CachetHQ\Cachet\Bus\Events\ComponentGroup;
 
+use CachetHQ\Cachet\Bus\Events\ActionInterface;
 use CachetHQ\Cachet\Models\ComponentGroup;
+use CachetHQ\Cachet\Models\User;
 
-final class ComponentGroupWasAddedEvent implements ComponentGroupEventInterface
+final class ComponentGroupWasAddedEvent implements ActionInterface, ComponentGroupEventInterface
 {
+    /**
+     * The user who added the component group.
+     *
+     * @var \CachetHQ\Cachet\Models\User
+     */
+    public $user;
+
     /**
      * The component group that was added.
      *
@@ -25,12 +34,14 @@ final class ComponentGroupWasAddedEvent implements ComponentGroupEventInterface
     /**
      * Create a new component group was added event instance.
      *
+     * @param \CachetHQ\Cachet\Models\User           $group
      * @param \CachetHQ\Cachet\Models\ComponentGroup $group
      *
      * @return void
      */
-    public function __construct(ComponentGroup $group)
+    public function __construct(User $user, ComponentGroup $group)
     {
+        $this->user = $user;
         $this->group = $group;
     }
 
@@ -43,4 +54,17 @@ public function __toString()
     {
         return 'Component Group was added.';
     }
+
+    /**
+     * Get the event action.
+     *
+     * @return array
+     */
+    public function getAction()
+    {
+        return [
+            'user'        => $this->user,
+            'description' => (string) $this,
+        ];
+    }
 }