Merge pull request #331 from W0rma/update-coding-standard

doctrine/coding-standard v12

composer.json

@@ -25,7 +25,7 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^7 | ^9.5.10",
-        "doctrine/coding-standard": "^5.0 | ^8.0",
+        "doctrine/coding-standard": "^12.0",
         "doctrine/persistence": "^1.3.4 | ^2.0 | ^3.0",
         "pagerfanta/core": "^2.4 || ^3.0",
         "phpdocumentor/type-resolver": "^1.5.1",

phpcs.xml.dist

@@ -31,12 +31,17 @@
         <exclude name="SlevomatCodingStandard.ControlStructures.AssignmentInCondition.AssignmentInCondition"/>
         <exclude name="SlevomatCodingStandard.ControlStructures.EarlyExit"/>
 
+        <exclude name="SlevomatCodingStandard.Commenting.RequireOneLineDocComment.MultiLineDocComment"/>
         <exclude name="SlevomatCodingStandard.Commenting.RequireOneLinePropertyDocComment"/>
 
         <exclude name="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceEqualOperator.RequiredNullCoalesceEqualOperator"/>
 
         <exclude name="SlevomatCodingStandard.Classes.SuperfluousTraitNaming.SuperfluousSuffix"/>
 
+        <exclude name="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall.MissingTrailingComma"/>
+
+        <exclude name="SlevomatCodingStandard.PHP.RequireNowdoc.RequiredNowdoc"/>
+
         <exclude name="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint"/>
         <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint"/>
 
@@ -99,10 +104,6 @@
         <exclude-pattern>tests/*</exclude-pattern>
     </rule>
 
-    <rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements">
-        <exclude-pattern>tests/*</exclude-pattern>
-    </rule>
-
     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
         <properties>
             <property name="annotationsGroups" type="array">

src/Configuration/Metadata/Driver/AnnotationDriver.php

@@ -28,7 +28,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     protected function getClassAnnotations(\ReflectionClass $class): array
     {

src/Configuration/Metadata/Driver/AttributeDriver.php

@@ -7,7 +7,7 @@
 class AttributeDriver extends AnnotationOrAttributeDriver
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     protected function getClassAnnotations(\ReflectionClass $class): array
     {

src/Configuration/Metadata/Driver/CheckExpressionTrait.php

@@ -16,7 +16,6 @@ trait CheckExpressionTrait
 
     /**
      * @param mixed $exp
-     * @param array $names
      *
      * @return Expression|mixed
      */

src/Configuration/Metadata/Driver/XmlDriver.php

@@ -41,6 +41,7 @@ public function __construct(
         ParserInterface $typeParser
     ) {
         parent::__construct($locator);
+
         $this->relationProvider = $relationProvider;
         $this->expressionLanguage = $expressionLanguage;
         $this->typeParser = $typeParser;
@@ -177,7 +178,7 @@ private function createEmbedded($embedded): Embedded
     {
         $embeddedExclusion = isset($embedded->exclusion) ? $this->parseExclusion($embedded->exclusion) : null;
         $xmlElementName = isset($embedded->attributes('')->{'xml-element-name'}) ? $this->checkExpression((string) $embedded->attributes('')->{'xml-element-name'}) : null;
-        $type = isset($embedded->attributes('')->{'type'}) ? $this->typeParser->parse((string) $embedded->attributes('')->{'type'}) : null;
+        $type = isset($embedded->attributes('')->type) ? $this->typeParser->parse((string) $embedded->attributes('')->type) : null;
 
         return new Embedded(
             $this->checkExpression((string) $embedded->content),

src/Configuration/Metadata/Driver/YamlDriver.php

@@ -40,6 +40,7 @@ public function __construct(
         ParserInterface $typeParser
     ) {
         parent::__construct($locator);
+
         $this->relationProvider = $relationProvider;
         $this->expressionLanguage = $expressionLanguage;
         $this->typeParser = $typeParser;

src/Configuration/Provider/ChainProvider.php

@@ -24,7 +24,7 @@ public function addProvider(RelationProviderInterface $resolver): void
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getRelations(RelationProvider $configuration, string $class): array
     {

src/Configuration/Provider/ExpressionEvaluatorProvider.php

@@ -20,7 +20,7 @@ public function __construct(ExpressionEvaluatorInterface $expressionEvaluator)
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getRelations(RelationProvider $configuration, string $class): array
     {

src/Configuration/Provider/FunctionProvider.php

@@ -9,7 +9,7 @@
 class FunctionProvider implements RelationProviderInterface
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getRelations(RelationProvider $configuration, string $class): array
     {

src/Configuration/Provider/StaticMethodProvider.php

@@ -9,7 +9,7 @@
 class StaticMethodProvider implements RelationProviderInterface
 {
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function getRelations(RelationProvider $configuration, string $class): array
     {

src/Configuration/Relation.php

@@ -39,7 +39,6 @@ class Relation
      * @param string|Expression $name
      * @param string|Route          $href
      * @param Embedded|string|mixed $embedded
-     * @param array                 $attributes
      */
     public function __construct(string $name, $href = null, $embedded = null, array $attributes = [], ?Exclusion $exclusion = null)
     {
@@ -71,9 +70,6 @@ public function getHref()
         return $this->href;
     }
 
-    /**
-     * @return array
-     */
     public function getAttributes(): array
     {
         return $this->attributes;

src/Expression/LinkExpressionFunction.php

@@ -11,8 +11,6 @@ class LinkExpressionFunction implements ExpressionFunctionProviderInterface
 {
     /**
      * @return ExpressionFunction[]
-     *
-     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint
      */
     public function getFunctions(): array
     {

src/Factory/EmbeddedsFactory.php

@@ -48,9 +48,6 @@ public function create(object $object, SerializationContext $context): array
 
         if (null !== ($classMetadata = $this->metadataFactory->getMetadataForClass(get_class($object)))) {
             $langugeData = ['object' => $object, 'context' => $context];
-            /**
-             * @var $relation Relation
-             */
             foreach ($classMetadata->getRelations() as $relation) {
                 if ($this->exclusionManager->shouldSkipEmbedded($object, $relation, $context)) {
                     continue;
@@ -71,7 +68,6 @@ public function create(object $object, SerializationContext $context): array
 
     /**
      * @param mixed $exp
-     * @param array $data
      *
      * @return mixed
      */

src/Factory/LinkFactory.php

@@ -75,7 +75,6 @@ public function createLink(object $object, Relation $relation, SerializationCont
 
     /**
      * @param mixed $exp
-     * @param array $data
      *
      * @return mixed
      */
@@ -88,12 +87,6 @@ private function checkExpression($exp, array $data)
         }
     }
 
-    /**
-     * @param array $array
-     * @param array $data
-     *
-     * @return array
-     */
     private function evaluateArray(array $array, array $data): array
     {
         $newArray = [];

src/Hateoas.php

@@ -28,15 +28,15 @@ public function __construct(SerializerInterface $serializer, LinkHelper $linkHel
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function serialize($data, string $format, ?SerializationContext $context = null, ?string $type = null): string
     {
         return $this->serializer->serialize($data, $format, $context, $type);
     }
 
     /**
-     * {@inheritdoc}
+     * {@inheritDoc}
      */
     public function deserialize(string $data, string $type, string $format, ?DeserializationContext $context = null)
     {

src/HateoasBuilder.php

@@ -303,8 +303,6 @@ public function includeInterfaceMetadata(bool $include): HateoasBuilder
      * Set a map of namespace prefixes to directories.
      *
      * This method overrides any previously defined directories.
-     *
-     * @param array $namespacePrefixToDirMap
      */
     public function setMetadataDirs(array $namespacePrefixToDirMap): HateoasBuilder
     {
@@ -357,8 +355,6 @@ public function addMetadataDir(string $dir, string $namespacePrefix = ''): Hateo
 
     /**
      * Add a map of namespace prefixes to directories.
-     *
-     * @param array $namespacePrefixToDirMap
      */
     public function addMetadataDirs(array $namespacePrefixToDirMap): HateoasBuilder
     {

src/Model/Link.php

@@ -21,19 +21,13 @@ class Link
      */
     private $attributes;
 
-    /**
-     * @param array  $attributes
-     */
     public function __construct(string $rel, string $href, array $attributes = [])
     {
         $this->rel        = $rel;
         $this->href       = $href;
         $this->attributes = $attributes;
     }
 
-    /**
-     * @return array
-     */
     public function getAttributes(): array
     {
         return $this->attributes;

src/Representation/AbstractSegmentedRepresentation.php

@@ -60,8 +60,6 @@ public function getLimit(): int
 
     /**
      * @param  null  $limit
-     *
-     * @return array
      */
     public function getParameters(?int $limit = null): array
     {

src/Representation/OffsetRepresentation.php

@@ -94,8 +94,6 @@ public function getOffset(): ?int
     /**
      * @param  null  $offset
      * @param  null  $limit
-     *
-     * @return array
      */
     public function getParameters(?int $offset = null, ?int $limit = null): array
     {

src/Representation/PaginatedRepresentation.php

@@ -109,8 +109,6 @@ public function getPage(): int
     /**
      * @param  null  $page
      * @param  null  $limit
-     *
-     * @return array
      */
     public function getParameters($page = null, $limit = null): array
     {

src/Representation/RouteAwareRepresentation.php

@@ -46,7 +46,6 @@ class RouteAwareRepresentation
 
     /**
      * @param mixed $inline
-     * @param array $parameters
      */
     public function __construct($inline, string $route, array $parameters = [], bool $absolute = false)
     {
@@ -69,9 +68,6 @@ public function getRoute(): string
         return $this->route;
     }
 
-    /**
-     * @return array
-     */
     public function getParameters(): array
     {
         return $this->parameters;