Update for docblocks

Author: jpresutti

BaseMapper.php

@@ -28,6 +28,7 @@
 use Feast\Interfaces\DatabaseFactoryInterface;
 use Feast\Interfaces\DatabaseInterface;
 use PDO;
+use stdClass;
 
 /**
  * @psalm-consistent-constructor
@@ -42,6 +43,10 @@ abstract class BaseMapper
     public const NOT_NULL = 'not_null';
     protected DatabaseInterface $connection;
 
+    /**
+     * @throws ServiceContainer\NotFoundException
+     * @throws ServerFailureException
+     */
     public function __construct()
     {
         $this->connection = di(DatabaseFactoryInterface::class)->getConnection((string)static::CONNECTION);
@@ -72,7 +77,7 @@ protected function map(array $row, array $dataTypes): BaseModel
                 }
                 $return->$key = match ($dataTypes[$key]) {
                     Date::class => Date::createFromString((string)$val),
-                    \stdClass::class => (object)json_decode(
+                    stdClass::class => (object)json_decode(
                         (string)$val
                     ),
                     'int' => (int)$val,
@@ -221,18 +226,16 @@ public function fetchOne(Query $select = null): ?BaseModel
         $select = $select ?? $this->getQueryBase();
 
         $select->limit(1);
-        /** @var BaseModel|null $return */
-        $return = $this->fetchAll($select)->first();
-
-        return $return;
+        /** @var BaseModel|null */
+        return $this->fetchAll($select)->first();
     }
 
     /**
      * Fetch all record. Optionally, pass in query object to filter on.
      *
      * @param Query|null $select
      * @return Set
-     * @throws ServerFailureException|ServiceContainer\NotFoundException
+     * @throws ServerFailureException|ServiceContainer\NotFoundException|Exception
      */
     public function fetchAll(Query $select = null): Set
     {
@@ -313,7 +316,7 @@ protected function buildFieldDataForSave(BaseModel|null $originalObject, array $
         $return = [];
         /**
          * @var string $field
-         * @var int|string|Date|null|\stdClass|array $val
+         * @var int|string|Date|null|stdClass|array $val
          */
         foreach ($fields as $field => $val) {
             if ($originalObject !== null && $originalObject->$field === $val) {
@@ -322,7 +325,7 @@ protected function buildFieldDataForSave(BaseModel|null $originalObject, array $
             if ($val instanceof Date) {
                 $val = $val->getFormattedDate();
             }
-            if ($val instanceof \stdClass || is_array($val)) {
+            if ($val instanceof stdClass || is_array($val)) {
                 $val = json_encode($val);
             }
             $return[$field] = $val;
@@ -398,7 +401,7 @@ public function delete(BaseModel $record): int
                 $recordPrimaryKey
             );
             $statement = $update->execute();
-            
+
             $this->onDelete($record);
             return $statement->rowCount();
         }

BaseModel.php

@@ -32,11 +32,17 @@ abstract class BaseModel
     protected const MAPPER_NAME = null;
     protected ?BaseModel $originalModel = null;
 
+    /**
+     * @throws InvalidOptionException
+     */
     public function __set(string $name, mixed $value): void
     {
         throw new InvalidOptionException('Invalid option for model', 500);
     }
 
+    /**
+     * @throws InvalidOptionException
+     */
     public function __get(string $name): void
     {
         throw new InvalidOptionException('Invalid option for model', 500);

Binary.php

@@ -30,7 +30,9 @@
 use Feast\Controllers\TemplateController;
 use Feast\Exception\NotFoundException;
 use Feast\Interfaces\MainInterface;
+use ReflectionClass;
 use ReflectionException;
+use ReflectionMethod;
 
 class Binary
 {
@@ -216,10 +218,9 @@ private function help(string $command): void
     /**
      * Process description attribute and return whether any methods were found.
      *
-     * @param \ReflectionMethod $method
-     * @return bool
+     * @param ReflectionMethod $method
      */
-    private function processCliMethods(\ReflectionMethod $method): bool
+    private function processCliMethods(ReflectionMethod $method): void
     {
         $name = NameHelper::getMethodNameAsCallableAction($method->getName());
         $class = NameHelper::getControllerClassName($method->getDeclaringClass());
@@ -238,7 +239,6 @@ private function processCliMethods(\ReflectionMethod $method): bool
 
             $this->terminal->message($actionItem->description);
         }
-        return true;
     }
 
     /**
@@ -259,12 +259,14 @@ private function analyzeFeast(array $classes = [
     {
         /** @var class-string $class */
         foreach ($classes as $class) {
-            $this->processCliClass(new \ReflectionClass($class));
+            $this->processCliClass(new ReflectionClass($class));
         }
     }
 
     /**
      * Process all custom actions in the CLI module.
+     *
+     * @throws ReflectionException
      */
     private function analyzeCli(): void
     {
@@ -278,7 +280,7 @@ private function analyzeCli(): void
                 // Load class info
                 /** @var class-string $className */
                 $className = '\\Modules\\CLI\\Controllers\\' . substr($classFile, 0, -4);
-                $class = new \ReflectionClass($className);
+                $class = new ReflectionClass($className);
 
                 // Parse class and methods
                 $this->processCliClass($class);
@@ -289,9 +291,9 @@ private function analyzeCli(): void
     /**
      * Parse all descriptions for a class and return if any methods had a description.
      *
-     * @param \ReflectionClass $class
+     * @param ReflectionClass $class
      */
-    private function processCliClass(\ReflectionClass $class): void
+    private function processCliClass(ReflectionClass $class): void
     {
         $className = NameHelper::getControllerClassName($class);
         $this->terminal->command($className);

CliController.php

@@ -22,13 +22,17 @@
 
 use Feast\Interfaces\ConfigInterface;
 use Feast\Interfaces\ControllerInterface;
+use Feast\ServiceContainer\NotFoundException;
 use Feast\ServiceContainer\ServiceContainer;
 
 abstract class CliController implements ControllerInterface
 {
     protected Terminal $terminal;
     protected CliArguments $cliArguments;
 
+    /**
+     * @throws NotFoundException
+     */
     public function __construct(
         ServiceContainer $di,
         ?ConfigInterface $config = null,

Collection/CollectionList.php

@@ -20,14 +20,15 @@
 
 namespace Feast\Collection;
 
+use ArrayAccess;
 use Feast\Exception\ServerFailureException;
 
 /**
  * Class to interact with arrays as key=>value lists
  *
  * @package Feast\Collection
  */
-class CollectionList implements \ArrayAccess,Collection
+class CollectionList implements ArrayAccess, Collection
 {
     use \Feast\Traits\Collection;
 
@@ -48,7 +49,6 @@ public function __construct(protected string $type = 'mixed', array $values = []
         $this->addAll($values);
     }
 
-
     /**
      * Add or replace an element to/in the collection
      *
@@ -117,13 +117,10 @@ public function offsetExists($offset): bool
      */
     public function offsetGet($offset): string|int|bool|float|object|array|null
     {
-        /** @var string|int|bool|float|object|array|null $var */
-        $var = $this->array[$offset] ?? null;
-
-        return $var;
+        /** @var string|int|bool|float|object|array|null */
+        return $this->array[$offset] ?? null;
     }
 
-
     /**
      * Set element by offset
      *
@@ -138,13 +135,12 @@ public function offsetSet($offset, $value): void
 
     /**
      * Unset element (if it exists) by offset
-     * 
+     *
      * @param string|int $offset
      */
     public function offsetUnset($offset): void
     {
         unset($this->array[$offset]);
     }
 
-
 }

Collection/Set.php

@@ -20,6 +20,8 @@
 
 namespace Feast\Collection;
 
+use ArrayAccess;
+use Countable;
 use Feast\Exception\InvalidOptionException;
 use Feast\Exception\ServerFailureException;
 use Feast\Exception\InvalidArgumentException;
@@ -30,7 +32,7 @@
  *
  * @package Feast\Set
  */
-class Set implements Iterator, Collection, \ArrayAccess, \Countable
+class Set implements Iterator, Collection, ArrayAccess, Countable
 {
     use \Feast\Traits\Collection;
 
@@ -55,7 +57,7 @@ public function __construct(
         }
         $this->addAll($values);
     }
-    
+
     /**
      * Add a value to the set
      *
@@ -85,10 +87,10 @@ public function addAll(array $values): void
             $this->add($value);
         }
     }
-    
+
     /**
      * Set element by offset (disabled)
-     * 
+     *
      * @param string|int $offset
      * @param mixed $value
      * @throws ServerFailureException
@@ -111,9 +113,9 @@ public function offsetUnset($offset): void
 
     /**
      * Merge two sets together
-     * 
+     *
      * For a merge to be allowed, the type for the two sets MUST be the same.
-     * 
+     *
      * @param Set $dataToMerge
      * @return static
      * @throws InvalidArgumentException
@@ -133,12 +135,12 @@ public function merge(Set $dataToMerge): static
 
     /**
      * Get minimum value from set.
-     * 
+     *
      * If key is passed and the collection type is not a scalar, then the value used is for the specified
      * key on the objects. If key is not passed, this will operate on float/int sets only. If key is passed
-     * and the collection is not an object type, or no key is passed and it is an object type, an 
+     * and the collection is not an object type, or no key is passed and it is an object type, an
      * InvalidOptionException is thrown.
-     * 
+     *
      * @param string|null $key
      * @return int|float|null
      * @throws InvalidOptionException
@@ -265,10 +267,8 @@ public function product(?string $key = null): float
      */
     public function offsetGet($offset): string|int|bool|float|object|array|null
     {
-        /** @var string|int|bool|float|object|array|null $var */
-        $var = $this->array[$offset] ?? null;
-
-        return $var;
+        /** @var string|int|bool|float|object|array|null */
+        return $this->array[$offset] ?? null;
     }
 
     /**