reuse Payload for fillProperties() (decrease complexity. resolves #…

…13
php-slack · Feb 3, 2021 · 53a102b · 53a102b
1 parent b26b2a7
commit 53a102b
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 63 deletions.
diff --git a/src/ActionConfirmation.php b/src/ActionConfirmation.php
@@ -1,7 +1,7 @@
 <?php
 namespace Maknz\Slack;
 
-class ActionConfirmation
+class ActionConfirmation extends Payload
 {
     /**
      * The required title for the pop up window.
@@ -31,29 +31,26 @@ class ActionConfirmation
      */
     protected $dismissText;
 
+    /**
+     * Internal attribute to property map.
+     *
+     * @var array
+     */
+    protected static $availableAttributes = [
+        'title'        => 'title',
+        'text'         => 'text',
+        'ok_text'      => 'ok_text',
+        'dismiss_text' => 'dismiss_text',
+    ];
+
     /**
      * Instantiate a new ActionConfirmation.
      *
      * @param array $attributes
-     * @return void
      */
     public function __construct(array $attributes)
     {
-        if (isset($attributes['title'])) {
-            $this->setTitle($attributes['title']);
-        }
-
-        if (isset($attributes['text'])) {
-            $this->setText($attributes['text']);
-        }
-
-        if (isset($attributes['ok_text'])) {
-            $this->setOkText($attributes['ok_text']);
-        }
-
-        if (isset($attributes['dismiss_text'])) {
-            $this->setDismissText($attributes['dismiss_text']);
-        }
+        parent::__construct($attributes);
     }
 
     /**

diff --git a/src/AttachmentAction.php b/src/AttachmentAction.php
@@ -3,7 +3,7 @@
 
 use InvalidArgumentException;
 
-class AttachmentAction
+class AttachmentAction extends Payload
 {
     const TYPE_BUTTON = 'button';
 
@@ -60,42 +60,31 @@ class AttachmentAction
      */
     protected $confirm;
 
+    /**
+     * Internal attribute to property map.
+     *
+     * @var array
+     */
+    protected static $availableAttributes = [
+        'name'    => 'name',
+        'text'    => 'text',
+        'style'   => 'style',
+        'type'    => 'type',
+        'url'     => 'url',
+        'value'   => 'value',
+        'confirm' => 'confirm',
+    ];
+
     /**
      * Instantiate a new AttachmentAction.
      *
      * @param array $attributes
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function __construct(array $attributes)
     {
-        if (isset($attributes['name'])) {
-            $this->setName($attributes['name']);
-        }
-
-        if (isset($attributes['text'])) {
-            $this->setText($attributes['text']);
-        }
-
-        if (isset($attributes['style'])) {
-            $this->setStyle($attributes['style']);
-        }
-
-        if (isset($attributes['type'])) {
-            $this->setType($attributes['type']);
-        }
-
-        if (isset($attributes['url'])) {
-            $this->setUrl($attributes['url']);
-        }
-
-        if (isset($attributes['value'])) {
-            $this->setValue($attributes['value']);
-        }
-
-        if (isset($attributes['confirm'])) {
-            $this->setConfirm($attributes['confirm']);
-        }
+        parent::__construct($attributes);
     }
 
     /**
@@ -225,7 +214,7 @@ public function getConfirm()
      *
      * @return AttachmentAction
      *
-     * @throws \InvalidArgumentException
+     * @throws InvalidArgumentException
      */
     public function setConfirm($confirm)
     {

diff --git a/src/AttachmentField.php b/src/AttachmentField.php
@@ -1,7 +1,7 @@
 <?php
 namespace Maknz\Slack;
 
-class AttachmentField implements Field
+class AttachmentField extends Payload implements Field
 {
     /**
      * The required title field of the field.
@@ -25,25 +25,25 @@ class AttachmentField implements Field
      */
     protected $short = false;
 
+    /**
+     * Internal attribute to property map.
+     *
+     * @var array
+     */
+    protected static $availableAttributes = [
+        'title' => 'title',
+        'value' => 'value',
+        'short' => 'short',
+    ];
+
     /**
      * Instantiate a new AttachmentField.
      *
      * @param array $attributes
-     * @return void
      */
     public function __construct(array $attributes)
     {
-        if (isset($attributes['title'])) {
-            $this->setTitle($attributes['title']);
-        }
-
-        if (isset($attributes['value'])) {
-            $this->setValue($attributes['value']);
-        }
-
-        if (isset($attributes['short'])) {
-            $this->setShort($attributes['short']);
-        }
+        parent::__construct($attributes);
     }
 
     /**

diff --git a/src/Payload.php b/src/Payload.php
@@ -16,13 +16,25 @@ abstract class Payload
      * @param array $attributes
      */
     public function __construct(array $attributes)
+    {
+        $this->fillProperties($attributes);
+    }
+
+    /**
+     * @param array $attributes
+     *
+     * @return $this
+     */
+    protected function fillProperties(array $attributes): self
     {
         foreach ($attributes as $attribute => $value) {
             $setter = self::getAttributeSetter($attribute);
             if ($setter !== null) {
                 $this->$setter($value);
             }
         }
+
+        return $this;
     }
 
     /**
@@ -32,7 +44,7 @@ public function __construct(array $attributes)
      *
      * @return null|string
      */
-    protected static function getAttributeSetter(string $attribute)
+    private static function getAttributeSetter(string $attribute)
     {
         $property = self::getAttributeProperty($attribute);
 
@@ -46,7 +58,7 @@ protected static function getAttributeSetter(string $attribute)
      *
      * @return string|null
      */
-    protected static function getAttributeProperty(string $attribute)
+    private static function getAttributeProperty(string $attribute)
     {
         return static::$availableAttributes[$attribute] ?? null;
     }
@@ -58,7 +70,7 @@ protected static function getAttributeProperty(string $attribute)
      *
      * @return string
      */
-    protected static function propertyToSetter(string $property): string
+    private static function propertyToSetter(string $property): string
     {
         $property = str_replace('_', ' ', $property);
         $property = ucwords($property);