Merge pull request #70 from tattersoftware/attr

Attribute Shorthand

src/BaseAction.php

@@ -2,6 +2,7 @@
 
 namespace Tatter\Workflows;
 
+use OutOfBoundsException;
 use Tatter\Users\Interfaces\HasPermission;
 use Tatter\Workflows\Controllers\BaseController;
 use Tatter\Workflows\Entities\Job;
@@ -62,6 +63,24 @@ final public static function getAttributes(): array
         return $attributes;
     }
 
+    /**
+     * Returns a single attribute.
+     *
+     * @throws OutOfBoundsException
+     *
+     * @return scalar|null
+     */
+    final public static function attr(string $key)
+    {
+        $attributes = self::getAttributes();
+
+        if (! array_key_exists($key, $attributes)) {
+            throw new OutOfBoundsException('Attribute does not exist: ' . $key);
+        }
+
+        return $attributes[$key];
+    }
+
     /**
      * Runs on a Job when it progresses through the workflow.
      * May throw a WorkflowsException to halt and display a message.

tests/unit/BaseActionTest.php

@@ -1,14 +1,5 @@
 <?php
 
-/**
- * This file is part of Tatter Workflows.
- *
- * (c) 2021 Tatter Software
- *
- * For the full copyright and license information, please view
- * the LICENSE file that was distributed with this source code.
- */
-
 use CodeIgniter\Config\Factories;
 use CodeIgniter\Test\CIUnitTestCase;
 use Tatter\Workflows\BaseAction;
@@ -45,4 +36,18 @@ protected function initialize(): void
 
         $this->assertTrue($action->initialized);
     }
+
+    public function testAttributes(): void
+    {
+        $action                     = new class (new Job()) extends BaseAction {
+            public const ATTRIBUTES = [
+                'name' => 'Banana',
+            ];
+        };
+        $result = $action::getAttributes();
+
+        $this->assertSame('fas fa-tasks', $result['icon']);
+        $this->assertSame('Banana', $result['name']);
+        $this->assertSame('Banana', $action::attr('name'));
+    }
 }