Improve typehints

Author: bryannielsen

CHANGELOG.md

@@ -10,6 +10,7 @@
 - Filesystem errors on some Windows environments when running coilpack install command
 - GraphQL fieldtype modifier registration bug
 - Use coding standard
+- Improved typehints
 
 ## [0.0.1] - 2022-12-29
 

src/Fieldtypes/Fieldtype.php

@@ -7,7 +7,7 @@
 
 abstract class Fieldtype
 {
-    public function __construct($name, $id = null)
+    public function __construct(string $name, $id = null)
     {
         $this->name = $name;
         $this->id = $id;
@@ -19,14 +19,14 @@ public function __construct($name, $id = null)
      * @param  FieldContent  $content
      * @return FieldtypeOutput
      */
-    abstract public function apply(FieldContent $content, $parameters = []);
+    abstract public function apply(FieldContent $content, array $parameters = []);
 
     public function modifiers()
     {
         return [];
     }
 
-    public function callModifier(FieldContent $content, $name, $parameters)
+    public function callModifier(FieldContent $content, string $name, array $parameters = [])
     {
         if (array_key_exists($name, $this->modifiers()) && $this->modifiers()[$name] instanceof Modifier) {
             return $this->modifiers()[$name]->handle($content, $parameters);

src/Fieldtypes/File.php

@@ -8,7 +8,7 @@
 
 class File extends Generic
 {
-    public function apply(FieldContent $content, $parameters = [])
+    public function apply(FieldContent $content, array $parameters = [])
     {
         $handler = $this->getHandler();
         $data = $handler->pre_process($content->data);

src/Fieldtypes/FluidField.php

@@ -10,7 +10,8 @@
 
 class FluidField extends Fieldtype
 {
-    public function apply(FieldContent $content, $parameters = [])
+
+    public function apply(FieldContent $content, array $parameters = [])
     {
         $data = $this->loadData($content);
 

src/Fieldtypes/Generic.php

@@ -10,7 +10,7 @@ class Generic extends Fieldtype
 {
     private $handler = null;
 
-    public function __construct($name, $id = null)
+    public function __construct(string $name, $id = null)
     {
         $this->name = $name;
         $this->id = $id;
@@ -34,19 +34,23 @@ public function getHandler()
         return $this->handler;
     }
 
-    public function apply(FieldContent $content, $parameters = [])
+    public function apply(FieldContent $content, array $parameters = [])
     {
         $handler = $this->getHandler();
 
         $data = $content->getAttribute('data');
-        $processed = $handler->replace_tag($data, $parameters);
 
-        return FieldtypeOutput::make($processed);
+        $output = \Expressionengine\Coilpack\Facades\Coilpack::isolateTemplateLibrary(function ($template) use ($handler, $data, $parameters) {
+            $output = $handler->replace_tag($data, $parameters);
+            // If the Fieldtype stored data for us in the template library that is preferable to the generated output
+            return $template->get_data() ?: $output;
+        });
+
+        return FieldtypeOutput::make($output);
     }
 
     public function modifiers()
     {
-        // return [];
         // @todo Cache this statically
         return collect(get_class_methods($this->getHandler()))->flatMap(function ($method) {
             if (Str::startsWith($method, 'replace_') && $method !== 'replace_tag') {

src/Fieldtypes/Grid.php

@@ -14,14 +14,14 @@
 
 class Grid extends Fieldtype implements GeneratesGraphType, ListsGraphType
 {
-    public function apply(FieldContent $content, $parameters = [])
+    public function apply(FieldContent $content, array $parameters = [])
     {
         $data = $this->loadData($content, $parameters);
 
         return FieldtypeOutput::make($data);
     }
 
-    protected function loadData(FieldContent $content, $parameters = [])
+    protected function loadData(FieldContent $content, array $parameters = [])
     {
         if (! isset($content->entry_id)) {
             return [];

src/Fieldtypes/OptionFieldtype.php

@@ -7,7 +7,7 @@
 
 class OptionFieldtype extends Generic
 {
-    public function apply(FieldContent $content, $parameters = [])
+    public function apply(FieldContent $content, array $parameters = [])
     {
         $handler = $this->getHandler();
 

src/Models/FieldContent.php

@@ -40,7 +40,13 @@ public function getFieldtype()
         return $this->fieldtype;
     }
 
-    public function value($parameters = [])
+    /**
+     * Get the value of this Field Content by applying the fieldtype
+     *
+     * @param  array  $parameters
+     * @return \Expressionengine\Coilpack\FieldtypeOutput
+     */
+    public function value(array $parameters = [])
     {
         // should hash and cache params too
         if (empty($parameters) && array_key_exists('value', $this->attributes)) {
@@ -57,14 +63,14 @@ public function value($parameters = [])
         return $value;
     }
 
-    public function callModifier($name, $parameters = [])
+    public function callModifier(string $name, $parameters = [])
     {
         $fieldtype = $this->getFieldtype();
 
-        return $fieldtype->callModifier($this, $name, $parameters);
+        return $fieldtype->callModifier($this, $name, is_array($parameters) ? $parameters : []);
     }
 
-    public function getIterator()
+    public function getIterator(): \Traversable
     {
         return new \ArrayIterator($this->value()->getIterator());
     }