PHPDoc additions

Author: lrljoe

src/DataTransferObjects/DebuggableData.php

@@ -6,13 +6,15 @@
 
 class DebuggableData
 {
-    public DataTableComponent $component;
-
-    public function __construct(DataTableComponent $component)
+    public function __construct(public DataTableComponent $component)
     {
-        $this->component = $component;
     }
 
+    /**
+     * Returns data to an array
+     *
+     * @return array<mixed>
+     */
     public function toArray(): array
     {
         return [

src/DataTransferObjects/FilterGenericData.php

@@ -4,25 +4,15 @@
 
 class FilterGenericData
 {
-    public string $tableName;
-
-    public string $filterLayout;
-
-    public bool $isTailwind = false;
-
-    public bool $isBootstrap4 = false;
-
-    public bool $isBootstrap5 = false;
-
-    public function __construct(string $tableName, string $filterLayout, bool $isTailwind = false, bool $isBootstrap4 = false, bool $isBootstrap5 = false)
+    public function __construct(public string $tableName, public string $filterLayout, public bool $isTailwind = false, public bool $isBootstrap4 = false, public bool $isBootstrap5 = false)
     {
-        $this->tableName = $tableName;
-        $this->filterLayout = $filterLayout;
-        $this->isTailwind = $isTailwind;
-        $this->isBootstrap4 = $isBootstrap4;
-        $this->isBootstrap5 = $isBootstrap5;
     }
 
+    /**
+     * Convert To Array
+     *
+     * @return array<mixed>
+     */
     public function toArray(): array
     {
         return [

src/DataTransferObjects/Filters/FilterPillData.php

@@ -31,61 +31,131 @@ public static function make(string $filterKey, string $filterPillTitle, string|a
         return new self($filterKey, $filterPillTitle, $filterPillValue, $separator, $isAnExternalLivewireFilter, $hasCustomPillBlade, $customPillBlade, $filterPillsItemAttributes, $renderPillsAsHtml, $watchForEvents, $customResetButtonAttributes, $renderPillsTitleAsHtml);
     }
 
+    /**
+     * Get the Filter Key
+     *
+     * @return string
+     */
+    public function getFilterKey(): string
+    {
+        return $this->filterKey;
+    }
+
+    /**
+     * Get the title for the Filter Pill
+     *
+     * @return string
+     */
     public function getTitle(): string
     {
         return $this->filterPillTitle;
     }
-
+    
+    /**
+     * Get The Filter Pill Value
+     *
+     * @return array<mixed>|string|null
+     */
     public function getPillValue(): array|string|null
     {
         return $this->filterPillValue;
     }
 
+    /**
+     * Determing if there is a Custom Pill blade set
+     *
+     * @return boolean
+     */
     public function getHasCustomPillBlade(): bool
     {
         return $this->hasCustomPillBlade;
     }
 
+    /**
+     * Get The Custom Pill Blade (if set)
+     *
+     * @return string|null
+     */
     public function getCustomPillBlade(): ?string
     {
         return $this->customPillBlade;
     }
 
+    /**
+     * Get Custom Reset Button Attributes
+     *
+     * @return array<mixed>
+     */
     public function getCustomResetButtonAttributes(): array
     {
         return $this->customResetButtonAttributes;
     }
 
+    /**
+     * Determine of this is an External Livewire Filter
+     *
+     * @return integer
+     */
     public function getIsAnExternalLivewireFilter(): int
     {
         return intval($this->isAnExternalLivewireFilter);
     }
 
+    /**
+     * Get the Separator for Pill Values
+     *
+     * @return string
+     */
     public function getSeparator(): string
     {
         return $this->separator;
     }
 
+    /**
+     * Determine if Pills should render as HTML
+     *
+     * @return integer
+     */
     public function shouldUsePillsAsHtml(): int
     {
         return intval($this->renderPillsAsHtml);
     }
 
+    /**
+     * Determine if Pill Title should render as HTML
+     *
+     * @return integer
+     */
     public function shouldUsePillsTitleAsHtml(): int
     {
         return intval($this->renderPillsTitleAsHtml);
     }
 
+    /**
+     * Determine if Should watch for Events (i.e. is an External Filter)
+     *
+     * @return integer
+     */
     public function shouldWatchForEvents(): int
     {
         return intval($this->watchForEvents);
     }
 
+    /**
+     * Determine if Pill Value is an Array
+     *
+     * @return boolean
+     */
     public function isPillValueAnArray(): bool
     {
         return ! is_null($this->filterPillValue) && is_array($this->filterPillValue);
     }
 
+    /**
+     * Return the separator separated value for the pill
+     *
+     * @return string|null
+     */
     public function getSeparatedPillValue(): ?string
     {
         if ($this->isPillValueAnArray()) {
@@ -95,6 +165,11 @@ public function getSeparatedPillValue(): ?string
         }
     }
 
+    /**
+     * Return the safe, separator separated value for the pill
+     *
+     * @return string|null
+     */
     public function getSafeSeparatedPillValue(): ?string
     {
         $string = $this->getSeparatedPillValue();
@@ -103,11 +178,21 @@ public function getSafeSeparatedPillValue(): ?string
 
     }
 
+    /**
+     * Get the attributes for the Filter Pills Item
+     *
+     * @return array<mixed>
+     */
     public function getFilterPillsItemAttributes(): array
     {
         return array_merge(['default' => true, 'default-colors' => true, 'default-styling' => true, 'default-text' => true], $this->filterPillsItemAttributes);
     }
 
+    /**
+     * Get the Display Data for the Filter Pills
+     *
+     * @return array<mixed>
+     */
     public function getFilterPillDisplayDataArray(): array
     {
         $array = [];
@@ -118,13 +203,26 @@ public function getFilterPillDisplayDataArray(): array
         return $this->getInternalFilterPillDisplayDataArray($array);
     }
 
+    
+    /**
+     * Get the Display Data for the Filter Pills
+     *
+     * @param array<mixed> $array
+     * @return array<mixed>
+     */
     public function getExternalFilterPillDisplayDataArray(array $array = []): array
     {
         $array[$this->shouldUsePillsAsHtml() ? 'x-html' : 'x-text'] = 'displayString';
 
         return $array;
     }
 
+    /**
+     * Get the Display Data for the Filter Pills
+     *
+     * @param array<mixed> $array
+     * @return array<mixed>
+     */
     public function getInternalFilterPillDisplayDataArray(array $array = []): array
     {
 
@@ -135,20 +233,40 @@ public function getInternalFilterPillDisplayDataArray(array $array = []): array
         return $array;
     }
 
+    /**
+     * Get the Display Data for the Filter Pills Title
+     *
+     * @param array<mixed> $array
+     * @return array<mixed>
+     */
     public function getFilterTitleDisplayDataArray(array $array = []): array
     {
         $array[$this->shouldUsePillsTitleAsHtml() ? 'x-html' : 'x-text'] = 'localFilterTitle';
 
         return $array;
     }
 
+    /**
+     * Get the initial setup data
+     *
+     * @param string $filterKey
+     * @param boolean $shouldWatch
+     * @return array<mixed>
+     */
     public function getPillSetupData(string $filterKey = '', bool $shouldWatch = false): array
     {
         $array = array_merge(['filterKey' => $filterKey, 'watchForEvents' => $shouldWatch], $this->toArray());
 
         return $array;
     }
 
+    /**
+     * Calculate Any Reset Button Attributes
+     *
+     * @param string $filterKey
+     * @param array<mixed> $filterPillsResetFilterButtonAttributes
+     * @return array<mixed>
+     */
     public function getCalculatedCustomResetButtonAttributes(string $filterKey, array $filterPillsResetFilterButtonAttributes): array
     {
         return array_merge(
@@ -165,10 +283,15 @@ public function getCalculatedCustomResetButtonAttributes(string $filterKey, arra
         );
     }
 
+    /**
+     * Returns the data to an array
+     *
+     * @return array<mixed>
+     */
     public function toArray(): array
     {
         return [
-            'filterKey' => $this->filterKey,
+            'filterKey' => $this->getFilterKey(),
             'filterPillTitle' => $this->getTitle(),
             'filterPillValue' => $this->getPillValue(),
             'isAnExternalLivewireFilter' => $this->getIsAnExternalLivewireFilter(),