Update for micro/dto

Micro-PHP · Jul 6, 2024 · 9b1628d · 9b1628d
1 parent 30894ba
commit 9b1628d
Show file tree

Hide file tree

Showing 53 changed files with 130 additions and 381 deletions.
diff --git a/ClassDef/ClassDefinition.php b/ClassDef/ClassDefinition.php
@@ -17,19 +17,10 @@
 
 class ClassDefinition
 {
-    /**
-     * @var string
-     */
     private string $extends = ClassMetadataHelperInterface::PROPERTY_TYPE_ABSTRACT_CLASS;
 
-    /**
-     * @var string
-     */
     private string $namespace = '';
 
-    /**
-     * @var string
-     */
     private string $name = '';
 
     /**
@@ -52,49 +43,31 @@ class ClassDefinition
      */
     private array $comments = [];
 
-    /**
-     * @return string
-     */
     public function getExtends(): string
     {
         return $this->extends;
     }
 
-    /**
-     * @param string $extends
-     */
     public function setExtends(string $extends): void
     {
         $this->extends = $extends;
     }
 
-    /**
-     * @return string
-     */
     public function getNamespace(): string
     {
         return $this->namespace;
     }
 
-    /**
-     * @param string $namespace
-     */
     public function setNamespace(string $namespace): void
     {
         $this->namespace = $namespace;
     }
 
-    /**
-     * @return string
-     */
     public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * @param string $name
-     */
     public function setName(string $name): void
     {
         $this->name = $name;
@@ -108,11 +81,6 @@ public function getProperties(): iterable
         return $this->properties;
     }
 
-    /**
-     * @param PropertyDefinition $propertyDefinition
-     *
-     * @return $this
-     */
     public function addProperty(PropertyDefinition $propertyDefinition): self
     {
         $this->properties[] = $propertyDefinition;
@@ -145,11 +113,6 @@ public function getComments(): iterable
         return $this->comments;
     }
 
-    /**
-     * @param string $comment
-     *
-     * @return $this
-     */
     public function addComment(string $comment): self
     {
         if (!\in_array($comment, $this->comments)) {

diff --git a/ClassDef/MethodDefinition.php b/ClassDef/MethodDefinition.php
@@ -18,49 +18,41 @@ class MethodDefinition
     private string $visibility = 'public';
 
     private string $name = '';
+
     /**
      * @var string[]
      */
     private array $typesReturn = [];
+
     /**
      * @var PropertyDefinition[]
      */
     private array $args = [];
 
     private string $body = '';
+
     /**
      * @var string[]
      */
     private array $comments = [];
+
     private bool $isStatic = false;
 
-    /**
-     * @return string
-     */
     public function getVisibility(): string
     {
         return $this->visibility;
     }
 
-    /**
-     * @param string $visibility
-     */
     public function setVisibility(string $visibility): void
     {
         $this->visibility = $visibility;
     }
 
-    /**
-     * @return string
-     */
     public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * @param string $name
-     */
     public function setName(string $name): void
     {
         $this->name = $name;
@@ -98,17 +90,11 @@ public function setArgs(array $args): void
         $this->args = $args;
     }
 
-    /**
-     * @return string
-     */
     public function getBody(): string
     {
         return $this->body;
     }
 
-    /**
-     * @param string $body
-     */
     public function setBody(string $body): void
     {
         $this->body = $body;
@@ -122,17 +108,11 @@ public function getComments(): array
         return $this->comments;
     }
 
-    /**
-     * @return bool
-     */
     public function isStatic(): bool
     {
         return $this->isStatic;
     }
 
-    /**
-     * @param bool $isStatic
-     */
     public function setIsStatic(bool $isStatic): void
     {
         $this->isStatic = $isStatic;

diff --git a/ClassDef/PropertyDefinition.php b/ClassDef/PropertyDefinition.php
@@ -15,12 +15,13 @@
 
 class PropertyDefinition
 {
-    private string $name;
+    private string $name = '';
 
     /**
      * @var string[]
      */
     private array $comments = [];
+
     /**
      * @var string[]
      */
@@ -32,24 +33,14 @@ class PropertyDefinition
     private array $attributes = [];
 
     private bool $isRequired = false;
-    private bool $isCollection = false;
 
-    public function __construct()
-    {
-        $this->name = '';
-    }
+    private bool $isCollection = false;
 
-    /**
-     * @return string
-     */
     public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * @param string $name
-     */
     public function setName(string $name): void
     {
         $this->name = $name;
@@ -86,43 +77,28 @@ public function setTypes(array $types): void
         $this->types = $types;
     }
 
-    /**
-     * @return bool
-     */
     public function isRequired(): bool
     {
         return $this->isRequired;
     }
 
-    /**
-     * @param bool $isRequired
-     */
     public function setIsRequired(bool $isRequired): void
     {
         $this->isRequired = $isRequired;
     }
 
-    /**
-     * @return bool
-     */
     public function isCollection(): bool
     {
         return $this->isCollection;
     }
 
-    /**
-     * @param bool $isCollection
-     */
     public function setIsCollection(bool $isCollection): void
     {
         $this->isCollection = $isCollection;
     }
 
     /**
-     * @param string               $attributeName
      * @param array<string, mixed> $arguments
-     *
-     * @return $this
      */
     public function addAttribute(string $attributeName, array $arguments): self
     {

diff --git a/ClassGeneratorFacadeDefault.php b/ClassGeneratorFacadeDefault.php
@@ -18,25 +18,18 @@
 class ClassGeneratorFacadeDefault extends GeneratorFacade
 {
     /**
-     * @param array<string>        $filesSchemeCollection
-     * @param string               $outputPath
-     * @param string               $namespaceGeneral
-     * @param string               $classSuffix
-     * @param LoggerInterface|null $logger
+     * @param array<string>    $filesSchemeCollection
      */
     public function __construct(
-        private array $filesSchemeCollection,
-        private string $outputPath,
-        private string $namespaceGeneral = '',
-        private string $classSuffix = 'Transfer',
-        private null|LoggerInterface $logger = null
+        private readonly array $filesSchemeCollection,
+        private readonly string $outputPath,
+        private readonly string $namespaceGeneral = '',
+        private readonly string $classSuffix = 'Transfer',
+        private readonly ?LoggerInterface $logger = null
     ) {
         parent::__construct($this->createDefaultDependencyInjectionObject());
     }
 
-    /**
-     * @return DependencyInjectionInterface
-     */
     protected function createDefaultDependencyInjectionObject(): DependencyInjectionInterface
     {
         return new DependencyInjection(

diff --git a/DependencyInjection.php b/DependencyInjection.php
@@ -83,7 +83,7 @@
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 
-class DependencyInjection implements DependencyInjectionInterface
+readonly class DependencyInjection implements DependencyInjectionInterface
 {
     /**
      * @param string[] $filesSchemeCollection

diff --git a/DependencyInjectionInterface.php b/DependencyInjectionInterface.php
@@ -22,33 +22,15 @@
 
 interface DependencyInjectionInterface
 {
-    /**
-     * @return LoggerInterface
-     */
     public function getLogger(): LoggerInterface;
 
-    /**
-     * @return CollectionPreparationInterface
-     */
     public function createClassPreparationProcessor(): CollectionPreparationInterface;
 
-    /**
-     * @return ClassMetadataHelper
-     */
     public function createClassMetadataHelper(): ClassMetadataHelper;
 
-    /**
-     * @return WriterInterface
-     */
     public function createWriter(): WriterInterface;
 
-    /**
-     * @return ReaderInterface
-     */
     public function createReader(): ReaderInterface;
 
-    /**
-     * @return RendererInterface
-     */
     public function createRenderer(): RendererInterface;
 }
diff --git a/DtoFacadeInterface.php b/DtoFacadeInterface.php
@@ -15,13 +15,7 @@
 
 interface DtoFacadeInterface
 {
-    /**
-     * @return GeneratorFacadeInterface
-     */
     public function createGenerator(): GeneratorFacadeInterface;
 
-    /**
-     * @return SerializerFacadeInterface
-     */
     public function createSerializer(): SerializerFacadeInterface;
 }
diff --git a/Generator/Generator.php b/Generator/Generator.php
@@ -20,7 +20,7 @@
 use Micro\Library\DTO\Writer\WriterInterface;
 use Psr\Log\LoggerInterface;
 
-class Generator
+readonly class Generator
 {
     public function __construct(
         private ReaderInterface $reader,
@@ -31,9 +31,6 @@ public function __construct(
     ) {
     }
 
-    /**
-     * @return void
-     */
     public function generate(): void
     {
         /** @var ClassDefinition $classDef */

diff --git a/GeneratorFacade.php b/GeneratorFacade.php
@@ -18,13 +18,10 @@
 class GeneratorFacade implements GeneratorFacadeInterface
 {
     public function __construct(
-        private DependencyInjectionInterface $dependencyInjection
+        private readonly DependencyInjectionInterface $dependencyInjection
     ) {
     }
 
-    /**
-     * {@inheritDoc}
-     */
     public function generate(): void
     {
         $generator = new Generator(