Merge branch '9-ajouter-analyseurs-phpstan-phpmd' into 'develop'

Resolve "Ajouter analyseurs (Phpstan, phpmd....)" Closes #9 See merge request SQLI/sqli-eztoolbox!7
sqli · Mar 4, 2024 · 71102b1 · 71102b1
2 parents c48e768 + 61db284
commit 71102b1
Show file tree

Hide file tree

Showing 37 changed files with 873 additions and 644 deletions.
diff --git a/Annotations/SQLIAnnotationManager.php b/Annotations/SQLIAnnotationManager.php
@@ -80,107 +80,130 @@ protected function getSQLIAnnotations(): array
             $path = $this->projectDir . '/src/' . $directory;
             $finder = new Finder();
             $finder->depth(0)->files()->in($path);
+            $annotatedClasses = $this->getAnnotatedClassesArray($finder, $namespace, $annotatedClasses);
+        }
+
+        return $annotatedClasses;
+    }
 
-            /** @var SplFileInfo $file */
-            foreach ($finder as $file) {
-                $className = $file->getBasename('.php');
-                $classNamespace = "$namespace\\$className";
-                // Create reflection class from generated namespace to read annotation
-                $class = new ReflectionClass($classNamespace);
-
-                // Search if $class use an SQLIClassAnnotation
-                $classAnnotation = $this
-                    ->annotationReader
-                    ->getClassAnnotation($class, SQLIEntity::class);
-                // Check if $class use Doctrine\Entity annotation
-                $classDoctrineAnnotation = $this
-                    ->annotationReader
-                    ->getClassAnnotation($class, Entity::class);
-
-                if (!$classAnnotation || !$classDoctrineAnnotation) {
-                    // No SQLIClassAnnotation or isn't an entity, ignore her
-                    continue;
-                }
-
-                // Prepare properties
-                $properties = [];
-                $compoundPrimaryKey = [];
-
-                $reflectionProperties = $class->getProperties();
-                foreach ($reflectionProperties as $reflectionProperty) {
-
-                    // Accessibility of each property
-                    $accessibility = "public"; // public
-                    if ($reflectionProperty->isPrivate()) {
-                        $accessibility = "private"; // private
-                    } elseif ($reflectionProperty->isProtected()) {
-                        $accessibility = "protected"; // protected
-                    }
-
-                    // Try to get an SQLIPropertyAnnotation
-                    $visible = true;
-                    $readonly = false;
-                    $required = true;
-                    $columnType = "string";
-                    $description = null;
-                    $choices = null;
-                    $extraLink = null;
-
-                    $propertyAnnotation = $this
-                        ->annotationReader
-                        ->getPropertyAnnotation($reflectionProperty, SQLIEntityProperty::class);
-
-                    if ($propertyAnnotation instanceof SQLIEntityProperty) {
-                        // Check if a visibility information defined on entity's property thanks to 'visible' annotation
-                        $visible = $propertyAnnotation->isVisible();
-                        // Check if property must be only in readonly
-                        $readonly = $propertyAnnotation->isReadonly();
-                        // Get property description
-                        $description = $propertyAnnotation->getDescription();
-                        // Get choices
-                        $choices = $propertyAnnotation->getChoices();
-                        $extraLink = $propertyAnnotation->getExtraLink();
-                    }
-
-                    // Check if nullable is sets to true
-                    $nullablePropertyAnnotation = $this
-                        ->annotationReader
-                        ->getPropertyAnnotation($reflectionProperty, Column::class);
-                    if ($nullablePropertyAnnotation) {
-                        $columnType = $nullablePropertyAnnotation->type;
-                        $required = $columnType == "boolean" ? false : !boolval($nullablePropertyAnnotation->nullable);
-                    }
-
-                    $properties[$reflectionProperty->getName()] = [
-                        'accessibility' => $accessibility,
-                        'visible' => $visible,
-                        'readonly' => $readonly,
-                        'required' => $required,
-                        'type' => $columnType,
-                        'description' => $description,
-                        'choices' => $choices,
-                        'extra_link' => $extraLink,
-                    ];
-
-                    // Build primary key from Doctrine\Id annotation
-                    if ($this->annotationReader->getPropertyAnnotation($reflectionProperty, Id::class)) {
-                        $compoundPrimaryKey[] = $reflectionProperty->getName();
-                    }
-                }
-
-                /** @var SQLIClassAnnotation $classAnnotation */
-                $annotationClassname = substr(strrchr(get_class($classAnnotation), '\\'), 1);
-
-                $annotatedClasses[$annotationClassname][$classNamespace] =
-                    [
-                        'classname' => $className,
-                        'annotation' => $classAnnotation,
-                        'properties' => $properties,
-                        'primary_key' => $compoundPrimaryKey,
-                    ];
+    /**
+     * @param Finder $finder
+     * @param mixed $namespace
+     * @param array $annotatedClasses
+     * @return array
+     * @throws ReflectionException
+     */
+    public function getAnnotatedClassesArray(Finder $finder, mixed $namespace, array $annotatedClasses): array
+    {
+        /** @var SplFileInfo $file */
+        foreach ($finder as $file) {
+            $className = $file->getBasename('.php');
+            $classNamespace = "$namespace\\$className";
+            // Create reflection class from generated namespace to read annotation
+            $class = new ReflectionClass($classNamespace);
+
+            // Search if $class use an SQLIClassAnnotation
+            $classAnnotation = $this
+                ->annotationReader
+                ->getClassAnnotation($class, SQLIEntity::class);
+            // Check if $class use Doctrine\Entity annotation
+            $classDoctrineAnnotation = $this
+                ->annotationReader
+                ->getClassAnnotation($class, Entity::class);
+
+            if (!$classAnnotation || !$classDoctrineAnnotation) {
+                // No SQLIClassAnnotation or isn't an entity, ignore her
+                continue;
             }
-        }
 
+            // Prepare properties
+            $properties = [];
+            $compoundPrimaryKey = [];
+
+            $reflectionProperties = $class->getProperties();
+            list($properties, $compoundPrimaryKey) = $this->getAnnotatedProperties($reflectionProperties, $properties, $compoundPrimaryKey);
+
+            /** @var SQLIClassAnnotation $classAnnotation */
+            $annotationClassname = substr(strrchr(get_class($classAnnotation), '\\'), 1);
+
+            $annotatedClasses[$annotationClassname][$classNamespace] =
+                [
+                    'classname' => $className,
+                    'annotation' => $classAnnotation,
+                    'properties' => $properties,
+                    'primary_key' => $compoundPrimaryKey,
+                ];
+        }
         return $annotatedClasses;
     }
+
+    /**
+     * @param array $reflectionProperties
+     * @param array $properties
+     * @param array $compoundPrimaryKey
+     * @return array
+     */
+    public function getAnnotatedProperties(array $reflectionProperties, array $properties, array $compoundPrimaryKey): array
+    {
+        foreach ($reflectionProperties as $reflectionProperty) {
+            // Accessibility of each property
+            $accessibility = "public"; // public
+            if ($reflectionProperty->isPrivate()) {
+                $accessibility = "private"; // private
+            } elseif ($reflectionProperty->isProtected()) {
+                $accessibility = "protected"; // protected
+            }
+
+            // Try to get an SQLIPropertyAnnotation
+            $visible = true;
+            $readonly = false;
+            $required = true;
+            $columnType = "string";
+            $description = null;
+            $choices = null;
+            $extraLink = null;
+
+            $propertyAnnotation = $this
+                ->annotationReader
+                ->getPropertyAnnotation($reflectionProperty, SQLIEntityProperty::class);
+
+            if ($propertyAnnotation instanceof SQLIEntityProperty) {
+                // Check if a visibility information defined on entity's property thanks to 'visible' annotation
+                $visible = $propertyAnnotation->isVisible();
+                // Check if property must be only in readonly
+                $readonly = $propertyAnnotation->isReadonly();
+                // Get property description
+                $description = $propertyAnnotation->getDescription();
+                // Get choices
+                $choices = $propertyAnnotation->getChoices();
+                $extraLink = $propertyAnnotation->getExtraLink();
+            }
+
+            // Check if nullable is sets to true
+            $nullablePropertyAnnotation = $this
+                ->annotationReader
+                ->getPropertyAnnotation($reflectionProperty, Column::class);
+            if ($nullablePropertyAnnotation) {
+                $columnType = $nullablePropertyAnnotation->type;
+                $required = $columnType == "boolean" ? false : !(bool)$nullablePropertyAnnotation->nullable;
+            }
+
+            $properties[$reflectionProperty->getName()] = [
+                'accessibility' => $accessibility,
+                'visible' => $visible,
+                'readonly' => $readonly,
+                'required' => $required,
+                'type' => $columnType,
+                'description' => $description,
+                'choices' => $choices,
+                'extra_link' => $extraLink,
+            ];
+
+            // Build primary key from Doctrine\Id annotation
+            if ($this->annotationReader->getPropertyAnnotation($reflectionProperty, Id::class)) {
+                $compoundPrimaryKey[] = $reflectionProperty->getName();
+            }
+        }
+        return array($properties, $compoundPrimaryKey);
+    }
 }
diff --git a/Attributes/Attribute/SQLIToolBoxClassAttribute.php b/Attributes/Attribute/SQLIToolBoxClassAttribute.php
@@ -1,7 +1,7 @@
-<?php
-
-namespace SQLI\EzToolboxBundle\Attributes\Attribute;
-
-interface SQLIToolBoxClassAttribute
-{
-}
+<?php
+
+namespace SQLI\EzToolboxBundle\Attributes\Attribute;
+
+interface SQLIToolBoxClassAttribute
+{
+}
diff --git a/Attributes/Attribute/SQLIToolBoxClassProperty.php b/Attributes/Attribute/SQLIToolBoxClassProperty.php
@@ -1,7 +1,7 @@
-<?php
-
-namespace SQLI\EzToolboxBundle\Attributes\Attribute;
-
-interface SQLIToolBoxClassProperty
-{
-}
+<?php
+
+namespace SQLI\EzToolboxBundle\Attributes\Attribute;
+
+interface SQLIToolBoxClassProperty
+{
+}