FilterPillData and StandardFilterPillData phpdocs

Author: lrljoe

src/DataTransferObjects/Filters/FilterPillData.php

@@ -33,6 +33,8 @@ public static function make(string $filterKey, string $filterPillTitle, string|a
 
     /**
      * Get the Filter Key
+     *
+     * @return string
      */
     public function getFilterKey(): string
     {
@@ -41,6 +43,8 @@ public function getFilterKey(): string
 
     /**
      * Get the title for the Filter Pill
+     *
+     * @return string
      */
     public function getTitle(): string
     {
@@ -59,6 +63,8 @@ public function getPillValue(): array|string|null
 
     /**
      * Determing if there is a Custom Pill blade set
+     *
+     * @return boolean
      */
     public function getHasCustomPillBlade(): bool
     {
@@ -67,6 +73,8 @@ public function getHasCustomPillBlade(): bool
 
     /**
      * Get The Custom Pill Blade (if set)
+     *
+     * @return string|null
      */
     public function getCustomPillBlade(): ?string
     {
@@ -85,6 +93,8 @@ public function getCustomResetButtonAttributes(): array
 
     /**
      * Determine of this is an External Livewire Filter
+     *
+     * @return integer
      */
     public function getIsAnExternalLivewireFilter(): int
     {
@@ -93,6 +103,8 @@ public function getIsAnExternalLivewireFilter(): int
 
     /**
      * Get the Separator for Pill Values
+     *
+     * @return string
      */
     public function getSeparator(): string
     {
@@ -101,6 +113,8 @@ public function getSeparator(): string
 
     /**
      * Determine if Pills should render as HTML
+     *
+     * @return integer
      */
     public function shouldUsePillsAsHtml(): int
     {
@@ -109,6 +123,8 @@ public function shouldUsePillsAsHtml(): int
 
     /**
      * Determine if Pill Title should render as HTML
+     *
+     * @return integer
      */
     public function shouldUsePillsTitleAsHtml(): int
     {
@@ -117,14 +133,18 @@ public function shouldUsePillsTitleAsHtml(): int
 
     /**
      * Determine if Should watch for Events (i.e. is an External Filter)
+     *
+     * @return integer
      */
-    public function shouldWatchForEvents(): int
+     public function shouldWatchForEvents(): int
     {
         return intval($this->watchForEvents);
     }
 
     /**
      * Determine if Pill Value is an Array
+     *
+     * @return boolean
      */
     public function isPillValueAnArray(): bool
     {
@@ -133,6 +153,8 @@ public function isPillValueAnArray(): bool
 
     /**
      * Return the separator separated value for the pill
+     *
+     * @return string|null
      */
     public function getSeparatedPillValue(): ?string
     {
@@ -145,6 +167,8 @@ public function getSeparatedPillValue(): ?string
 
     /**
      * Return the safe, separator separated value for the pill
+     *
+     * @return string|null
      */
     public function getSafeSeparatedPillValue(): ?string
     {
@@ -224,6 +248,8 @@ public function getFilterTitleDisplayDataArray(array $array = []): array
     /**
      * Get the initial setup data
      *
+     * @param string $filterKey
+     * @param boolean $shouldWatch
      * @return array<mixed>
      */
     public function getPillSetupData(string $filterKey = '', bool $shouldWatch = false): array
@@ -236,7 +262,8 @@ public function getPillSetupData(string $filterKey = '', bool $shouldWatch = fal
     /**
      * Calculate Any Reset Button Attributes
      *
-     * @param  array<mixed>  $filterPillsResetFilterButtonAttributes
+     * @param string $filterKey
+     * @param array<mixed> $filterPillsResetFilterButtonAttributes
      * @return array<mixed>
      */
     public function getCalculatedCustomResetButtonAttributes(string $filterKey, array $filterPillsResetFilterButtonAttributes): array

src/DataTransferObjects/Filters/StandardFilterPillData.php

@@ -11,26 +11,50 @@ public static function make(string $filterPillTitle, string $filterSelectName, s
         return new self($filterPillTitle, $filterSelectName, $filterPillValue, $renderPillsAsHtml);
     }
 
+    /**
+     * Get the Pill Title
+     *
+     * @return string
+     */
     public function getTitle(): string
     {
         return $this->filterPillTitle;
     }
 
+    /**
+     * Get the Filter Select Name
+     *
+     * @return string
+     */
     public function getSelectName(): string
     {
         return $this->filterSelectName;
     }
 
+    /**
+     * Get The Pill Value
+     *
+     * @return string
+     */
     public function getPillValue(): string
     {
         return $this->filterPillValue;
     }
 
+    /**
+     * Should Use Pills as HTML
+     *
+     * @return boolean
+     */
     public function shouldUsePillsAsHtml(): bool
     {
         return $this->renderPillsAsHtml;
     }
-
+    /**
+     * Returns the data to an array
+     *
+     * @return array<mixed>
+     */
     public function toArray(): array
     {
         return [