add phpdoc

jikan-me · Oct 30, 2022 · d38d4bd · d38d4bd
1 parent 1ad4a23
commit d38d4bd
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 8 deletions.
diff --git a/app/Http/QueryBuilder/Scraper/Query.php b/app/Http/QueryBuilder/Scraper/Query.php
@@ -7,7 +7,13 @@
 
 class Query
 {
+    /**
+     * @var string
+     */
     private string $name;
+    /**
+     * @var mixed
+     */
     private mixed $value;
 
     /**

diff --git a/app/Http/QueryBuilder/Scraper/QueryResolver.php b/app/Http/QueryBuilder/Scraper/QueryResolver.php
@@ -4,12 +4,15 @@
 
 class QueryResolver
 {
+    /**
+     * @var array
+     */
     private array $queries = [];
 
-    public function __construct() {
-        return $this;
-    }
-
+    /**
+     * @param Query $query
+     * @return $this
+     */
     public function setNewQuery(Query $query): self
     {
         $this->queries[] = $query;

diff --git a/app/Http/QueryBuilder/Scraper/ScraperHandler.php b/app/Http/QueryBuilder/Scraper/ScraperHandler.php
@@ -4,9 +4,6 @@
 
 use App\Providers\SerializerFactory;
 
-/**
- *
- */
 class ScraperHandler
 {
     /**
@@ -31,8 +28,9 @@ public function __construct(string $getterFuncName, string $requestResolverClass
             );
     }
 
+
     /**
-     * @return string
+     * @return array
      */
     public function getSerializedJSON(): array
     {

diff --git a/app/Http/Validation/Validation.php b/app/Http/Validation/Validation.php
@@ -4,8 +4,14 @@
 
 abstract class Validation implements ValidationInterface
 {
+    /**
+     * @var array|int|float|string
+     */
     public array|int|float|string $criteria;
 
+    /**
+     * @param array|int|float|string $criteria
+     */
     public function __construct(array|int|float|string $criteria) {
         $this->criteria = $criteria;
     }

diff --git a/app/Http/Validation/ValidationInterface.php b/app/Http/Validation/ValidationInterface.php
@@ -4,5 +4,9 @@
 
 interface ValidationInterface
 {
+    /**
+     * @param mixed $value
+     * @return bool
+     */
     public function validate(mixed $value):bool;
 }
diff --git a/app/Http/Validation/ValidationTypeEnum.php b/app/Http/Validation/ValidationTypeEnum.php
@@ -3,6 +3,10 @@
 
 class ValidationTypeEnum extends Validation
 {
+    /**
+     * @param mixed $value
+     * @return bool
+     */
     public function validate(mixed $value) : bool
     {
         return in_array($value, $this->criteria);