style: update sources according to phpstan and PSR-12

Author: Thorsten Suckow-Homberg

src/JsonApi/Extensions/Query/Validation/Parameter/RelfieldRule.php

@@ -28,11 +28,11 @@
 
 namespace Conjoon\JsonApi\Extensions\Query\Validation\Parameter;
 
+use Conjoon\Data\Resource\ObjectDescriptionList;
 use Conjoon\Data\Validation\ValidationError;
 use Conjoon\Data\Validation\ValidationErrors;
-use Conjoon\Http\Query\Parameter;
 use Conjoon\JsonApi\Query\Validation\Parameter\FieldsetRule;
-use Conjoon\Data\Resource\ObjectDescriptionList;
+use Conjoon\Net\Uri\Component\Query\Parameter;
 
 /**
  * An extension on sparse fieldset as specified with https://conjoon.org/json-api/ext/relfield.
@@ -54,7 +54,7 @@ class RelfieldRule extends FieldsetRule
      * this server supports wildcards.
      *
      * @param ObjectDescriptionList $resourceDescriptionList
-     * @param array $includes
+     * @param array<int, string> $includes
      * @param bool $wildcardEnabled
      */
     public function __construct(
@@ -84,14 +84,14 @@ public function supports(object $obj): bool
     protected function validateValue(Parameter $parameter, ValidationErrors $errors): bool
     {
         $value          = $parameter->getValue();
-        $name           = $parameter->getName();
-        $type           = $this->getGroupKey($parameter);
-        $resourceFields = $this->getFields($type);
-
-        if ($value === "" || $value === null) {
+        if ($value === "") {
             return true;
         }
 
+        $name   = $parameter->getName();
+        $type   = $this->getGroupKey($parameter);
+        $resourceFields = ($type ? $this->getFields($type) : []) ?? [];
+
         $fields = explode(",", $value);
 
         $wildcards = array_filter($fields, fn ($field) => $field === "*");

src/JsonApi/Query/Query.php

@@ -29,8 +29,8 @@
 
 namespace Conjoon\JsonApi\Query;
 
-use Conjoon\Http\Query\Query as HttpQuery;
 use Conjoon\Data\Resource\ObjectDescription;
+use Conjoon\Net\Uri\Component\Query as HttpQuery;
 
 /**
  * Query validated for JSON:API specifications, providing access to a $resourceTarget

src/JsonApi/Query/Validation/CollectionValidator.php

@@ -29,11 +29,11 @@
 
 namespace Conjoon\JsonApi\Query\Validation;
 
-use Conjoon\Http\Query\Validation\Parameter\ParameterRuleList;
-use Conjoon\Http\Query\Validation\Parameter\ValuesInWhitelistRule;
-use Conjoon\Http\Query\Query as HttpQuery;
-use Conjoon\JsonApi\Query\Query;
 use Conjoon\Data\Resource\ObjectDescription;
+use Conjoon\JsonApi\Query\Query;
+use Conjoon\Net\Uri\Component\Query as HttpQuery;
+use Conjoon\Web\Validation\Parameter\ParameterRuleList;
+use Conjoon\Web\Validation\Parameter\Rule\ValuesInWhitelistRule;
 
 /**
  * Class for validating queries that target resource collections(!) according to JSON:API
@@ -70,9 +70,9 @@ public function getParameterRules(HttpQuery $query): ParameterRuleList
     /**
      * Returns all the parameter names for a collection query, including sorting parameter options.
      *
-     * @param HttpQuery $query
+     * @param Query $query
      *
-     * @return array
+     * @return array<int, string>
      */
     public function getAllowedParameterNames(HttpQuery $query): array
     {
@@ -89,7 +89,7 @@ public function getAllowedParameterNames(HttpQuery $query): array
      * first part of the name is the type of the resource target.
      *
      * @param ObjectDescription $resourceTarget
-     * @return array
+     * @return array<int, string>
      */
     protected function getAvailableSortFields(ObjectDescription $resourceTarget): array
     {
@@ -105,7 +105,7 @@ protected function getAvailableSortFields(ObjectDescription $resourceTarget): ar
      * first part of the name is the type of the resource target, or the related resource target.
      *
      * @param ObjectDescription $resourceTarget
-     * @return array
+     * @return array<int, string>
      */
     protected function getAvailableFields(ObjectDescription $resourceTarget): array
     {

src/JsonApi/Query/Validation/Parameter/FieldsetRule.php

@@ -28,12 +28,12 @@
 
 namespace Conjoon\JsonApi\Query\Validation\Parameter;
 
+use Conjoon\Data\Resource\ObjectDescriptionList;
 use Conjoon\Data\Validation\ValidationError;
 use Conjoon\Data\Validation\ValidationErrors;
-use Conjoon\Http\Query\Parameter;
-use Conjoon\Http\Query\ParameterTrait;
-use Conjoon\Http\Query\Validation\Parameter\ParameterRule;
-use Conjoon\Data\Resource\ObjectDescriptionList;
+use Conjoon\Net\Uri\Component\Query\Parameter;
+use Conjoon\Net\Uri\Component\Query\ParameterTrait;
+use Conjoon\Web\Validation\Parameter\ParameterRule;
 
 /**
  * Validates fieldset parameters of the type "fields[TYPE]=field,field2,field3" given the
@@ -62,7 +62,7 @@ class FieldsetRule extends ParameterRule
     protected ObjectDescriptionList $resourceDescriptionList;
 
     /**
-     * @var array $includes
+     * @var array<int, string> $includes
      */
     protected array $includes;
 
@@ -72,8 +72,8 @@ class FieldsetRule extends ParameterRule
      * and the includes the rule should consider.
      *
      * @param ObjectDescriptionList $resourceDescriptionList
-     * @param array $includes An array with all resource object types requested, against which a parameter's
-     * fieldset must be validated
+     * @param array<int, string> $includes An array with all resource object types requested,
+     * against which a parameter's fieldset must be validated
      */
     public function __construct(ObjectDescriptionList $resourceDescriptionList, array $includes)
     {
@@ -96,7 +96,7 @@ public function getResourceObjectDescriptions(): ObjectDescriptionList
     /**
      * Returns the list of includes this rule was configures with
      *
-     * @return array
+     * @return array<int, string>
      */
     public function getIncludes(): array
     {
@@ -109,6 +109,9 @@ public function getIncludes(): array
      */
     public function supports(object $obj): bool
     {
+        /**
+         * @var Parameter $obj
+         */
         return parent::supports($obj) &&
                $this->isGroupParameter($obj) &&
                $this->getGroupName($obj) === "fields";
@@ -127,7 +130,7 @@ protected function validate(Parameter $parameter, ValidationErrors $errors): boo
             return false;
         }
 
-        $resourceFields = $this->getFields($type);
+        $resourceFields = $type ? $this->getFields($type) : null;
 
         if (!$resourceFields) {
             $errors[] = new ValidationError(
@@ -152,7 +155,7 @@ protected function validate(Parameter $parameter, ValidationErrors $errors): boo
      *
      * @param string $type
      *
-     * @return array|null
+     * @return array<int, string>|null
      */
     protected function getFields(string $type): ?array
     {
@@ -164,7 +167,7 @@ protected function getFields(string $type): ?array
     /**
      * Validates the key for the specified fieldset group parameter.
      *
-     * @param $parameter
+     * @param Parameter $parameter
      * @param ValidationErrors $errors
      *
      * @return bool
@@ -201,9 +204,9 @@ protected function validateValue(Parameter $parameter, ValidationErrors $errors)
     {
         $value = $parameter->getValue();
         $type = $this->getGroupKey($parameter);
-        $resourceFields = $this->getFields($type);
+        $resourceFields = ($type ? $this->getFields($type) : []) ?? [];
 
-        if ($value === "" || $value === null) {
+        if ($value === "") {
             return true;
         }
 
@@ -216,12 +219,12 @@ protected function validateValue(Parameter $parameter, ValidationErrors $errors)
     /**
      * Helper function for validating that the $actualFields appear in $allowedFields.
      *
-     * @param array $actualFields
-     * @param array $allowedFields
+     * @param array<int, string> $actualFields
+     * @param array<int, string> $allowedFields
      * @param Parameter $parameter
      * @param ValidationErrors $errors
      *
-     * @return array
+     * @return bool
      */
     protected function checkFieldList(
         array $actualFields,

src/JsonApi/Query/Validation/Parameter/IncludeRule.php

@@ -29,8 +29,8 @@
 namespace Conjoon\JsonApi\Query\Validation\Parameter;
 
 use Conjoon\Core\Util\ArrayUtil;
-use Conjoon\Http\Query\Parameter;
-use Conjoon\Http\Query\Validation\Parameter\ValueInWhitelistRule;
+use Conjoon\Net\Uri\Component\Query\Parameter;
+use Conjoon\Web\Validation\Parameter\Rule\ValueInWhitelistRule;
 
 /**
  * Class providing functionality for making sure a query's include parameter contains only valid
@@ -66,7 +66,7 @@ protected function isParameterValueValid(Parameter $parameter, $whitelist): bool
      * Returns an empty array for an array string.
      *
      * @param string $value
-     * @return array
+     * @return array<int, string>
      */
     protected function parse(string $value): array
     {
@@ -89,8 +89,8 @@ protected function parse(string $value): array
      * quoted above, the "MailFolder"-value is redundant, so the includes can be merged from
      * ["MailFolder", "MailFolder.MailAccount"] into ["MailFolder.MailAccount"].
      *
-     * @param array $includes
-     * @return array
+     * @param array<int, string> $includes
+     * @return array<int, string>
      */
     protected function merge(array $includes): array
     {

src/JsonApi/Query/Validation/Parameter/PnFilterRule.php

@@ -30,11 +30,11 @@
 
 use Conjoon\Data\Validation\ValidationError;
 use Conjoon\Data\Validation\ValidationErrors;
-use Conjoon\Http\Query\Parameter;
-use Conjoon\Http\Query\Validation\Parameter\JsonEncodedRule;
 use Conjoon\Math\Expression\Operator\FunctionalOperator;
 use Conjoon\Math\Expression\Operator\LogicalOperator;
 use Conjoon\Math\Expression\Operator\RelationalOperator;
+use Conjoon\Net\Uri\Component\Query\Parameter;
+use Conjoon\Web\Validation\Parameter\Rule\JsonEncodedRule;
 
 /**
  * This parameter rule supports validation of filters provided as json encoded objects containing
@@ -53,15 +53,15 @@
 class PnFilterRule extends JsonEncodedRule
 {
     /**
-     * @var array
+     * @var array<int, string>
      */
     protected array $attributes;
 
 
     /**
      * Constructor.
      *
-     * @param array $attributes The list of valid attributes this rule considers.
+     * @param array<int, string> $attributes The list of valid attributes this rule considers.
      */
     public function __construct(array $attributes)
     {
@@ -99,11 +99,9 @@ protected function validate(Parameter $parameter, ValidationErrors $errors): boo
                 }
 
                 //{"OR" : [{"==": ...}, {">=" : ...}}]
-                if ($this->isLogicalOperator($operator)) {
-                    if (count($filter) <= 1) {
-                        return "Logical operator \"$operator\" " .
-                            "expects at least 2 operands, " . count($filter) . " given";
-                    }
+                if (count($filter) <= 1) {
+                    return "Logical operator \"$operator\" " .
+                        "expects at least 2 operands, " . count($filter) . " given";
                 }
 
                 foreach ($filter as $operand) {
@@ -196,7 +194,8 @@ public function getFunctions(): array
     /**
      * Returns all the attribute names this rule considers. The list of rules is dynamic and must be
      * specified with the constructor.
-     * @return void
+     *
+     * @return array<int, string>
      */
     public function getAttributes(): array
     {

src/JsonApi/Query/Validation/Query/QueryRule.php

@@ -28,8 +28,8 @@
 
 namespace Conjoon\JsonApi\Query\Validation\Query;
 
-use Conjoon\Http\Query\Validation\Query\QueryRule as HttpQueryRule;
 use Conjoon\JsonApi\Query\Query;
+use Conjoon\Web\Validation\Query\QueryRule as HttpQueryRule;
 
 /**
  * Rule specific for JsonApi.

src/JsonApi/Query/Validation/Validator.php

@@ -29,17 +29,17 @@
 
 namespace Conjoon\JsonApi\Query\Validation;
 
-use Conjoon\Http\Query\Exception\UnexpectedQueryParameterException;
-use Conjoon\Http\Query\Parameter;
-use Conjoon\Http\Query\Validation\Parameter\ParameterRuleList;
-use Conjoon\Http\Query\Validation\Query\OnlyParameterNamesRule;
-use Conjoon\Http\Query\Validation\Query\QueryRuleList;
-use Conjoon\Http\Query\Validation\Query\RequiredParameterNamesRule;
-use Conjoon\Http\Query\Validation\Validator as HttpQueryValidator;
-use Conjoon\Http\Query\Query as HttpQuery;
 use Conjoon\JsonApi\Query\Query;
 use Conjoon\JsonApi\Query\Validation\Parameter\FieldsetRule;
 use Conjoon\JsonApi\Query\Validation\Parameter\IncludeRule;
+use Conjoon\Net\Uri\Component\Query as HttpQuery;
+use Conjoon\Net\Uri\Component\Query\Parameter;
+use Conjoon\Web\Validation\Exception\UnexpectedQueryParameterException;
+use Conjoon\Web\Validation\Parameter\ParameterRuleList;
+use Conjoon\Web\Validation\Query\QueryRuleList;
+use Conjoon\Web\Validation\Query\Rule\OnlyParameterNamesRule;
+use Conjoon\Web\Validation\Query\Rule\RequiredParameterNamesRule;
+use Conjoon\Web\Validation\QueryValidator as HttpQueryValidator;
 
 /**
  * Class for validating queries that target resource objects. Queries are checked for
@@ -105,7 +105,7 @@ public function getQueryRules(HttpQuery $query): QueryRuleList
      *
      * @param Query $query
      *
-     * @return array
+     * @return array<int, string>
      */
     public function getAllowedParameterNames(HttpQuery $query): array
     {
@@ -123,6 +123,8 @@ public function getAllowedParameterNames(HttpQuery $query): array
 
     /**
      * @inheritdoc
+     *
+     * @return array<int, string>
      */
     public function getRequiredParameterNames(HttpQuery $query): array
     {
@@ -143,7 +145,7 @@ public function getRequiredParameterNames(HttpQuery $query): array
      *
      * @param Parameter $parameter
      *
-     * @return array
+     * @return array<int, string>
      *
      * @throws UnexpectedQueryParameterException
      */
@@ -173,10 +175,10 @@ protected function unfoldInclude(Parameter $parameter): array
      *    // $res: ["MailFolder", "MessageItem"]
      *
      *
-     * @param $relationships
-     * @return array
+     * @param array<int, string> $relationships
+     * @return array<int, string>
      */
-    protected function unfoldRelationships($relationships): array
+    protected function unfoldRelationships(array $relationships): array
     {
         $res = [];