Code chapter 2

Signed-off-by: Howriq <[email protected]>

Author: Howriq

README.md

@@ -19,5 +19,7 @@
     <file>test</file>
 
     <!-- Include all rules from the Laminas Coding Standard -->
-    <rule ref="LaminasCodingStandard" />
+    <rule ref="LaminasCodingStandard" >
+        <exclude-pattern>src/Migrations/*</exclude-pattern>
+    </rule>
 </ruleset>

data/cache/.gitignore

@@ -6,26 +6,76 @@
 
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\ORM\Mapping\EntityListenerResolver;
+use Doctrine\ORM\Mapping\EntityListenerResolver as EntityListenerResolverInterface;
+use Doctrine\Persistence\Mapping\Driver\MappingDriver;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
 use Dot\Cache\Adapter\ArrayAdapter;
 use Dot\Cache\Adapter\FilesystemAdapter;
 use Light\App\Factory\EntityListenerResolverFactory;
 use Light\App\Factory\GetIndexViewHandlerFactory;
 use Light\App\Handler\GetIndexViewHandler;
+use Light\App\Resolver\EntityListenerResolver;
 use Light\App\Types\UuidType;
 use Mezzio\Application;
 use Roave\PsrContainerDoctrine\EntityManagerFactory;
 
+use Symfony\Component\Cache\Adapter\AdapterInterface;
 use function getcwd;
 
+/**
+ * @phpstan-type ConfigType array{
+ *      dependencies: DependenciesType,
+ *      doctrine: DoctrineConfigType,
+ * }
+ * @phpstan-type DoctrineConfigType array{
+ *      cache: array{
+ *          array: array{
+ *              class: class-string<AdapterInterface>,
+ *          },
+ *          filesystem: array{
+ *              class: class-string<AdapterInterface>,
+ *              directory: non-empty-string,
+ *              namespace: non-empty-string,
+ *          },
+ *      },
+ *      configuration: array{
+ *          orm_default: array{
+ *              entity_listener_resolver: class-string<EntityListenerResolverInterface>,
+ *              result_cache: non-empty-string,
+ *              metadata_cache: non-empty-string,
+ *              query_cache: non-empty-string,
+ *              hydration_cache: non-empty-string,
+ *              typed_field_mapper: non-empty-string|null,
+ *              second_level_cache: array{
+ *                  enabled: bool,
+ *                  default_lifetime: int,
+ *                  default_lock_lifetime: int,
+ *                  file_lock_region_directory: string,
+ *                  regions: string[],
+ *               },
+ *          },
+ *      },
+ *      driver: array{
+ *          orm_default: array{
+ *              class: class-string<MappingDriver>,
+ *          },
+ *      },
+ *      migrations: array{
+ *          migrations_paths: array<non-empty-string, non-empty-string>,
+ *          all_or_nothing: bool,
+ *          check_database_platform: bool,
+ *      },
+ *      types: array<non-empty-string, class-string>,
+ * }
+ * @phpstan-type DependenciesType array{
+ *       factories: array<class-string|non-empty-string, class-string|non-empty-string>,
+ *       aliases: array<class-string|non-empty-string, class-string|non-empty-string>,
+ * }
+ **/
 class ConfigProvider
 {
     /**
-    @return array{
-     *     dependencies: array<mixed>,
-     *     templates: array<mixed>,
-     * }
+     * @return ConfigType
      */
     public function __invoke(): array
     {
@@ -37,10 +87,7 @@ public function __invoke(): array
     }
 
     /**
-     * @return array{
-     *     delegators: array<class-string, array<class-string>>,
-     *     factories: array<class-string, class-string>,
-     * }
+     * @return DependenciesType
      */
     public function getDependencies(): array
     {
@@ -84,6 +131,9 @@ public function getTemplates(): array
         ];
     }
 
+    /**
+     * @return DoctrineConfigType
+     */
     private function getDoctrineConfig(): array
     {
         return [

mkdocs.yml

@@ -5,9 +5,34 @@
 namespace Light\Book;
 
 use Doctrine\ORM\Mapping\Driver\AttributeDriver;
+use Doctrine\Persistence\Mapping\Driver\MappingDriver;
 
+/**
+ * @phpstan-type ConfigType array{
+ *      dependencies: DependenciesType,
+ *      doctrine: DoctrineConfigType,
+ * }
+ * @phpstan-type DoctrineConfigType array{
+ *      driver: array{
+ *          orm_default: array{
+ *              drivers: array<non-empty-string, non-empty-string>,
+ *          },
+ *          BookEntities: array{
+ *              class: class-string<MappingDriver>,
+ *              cache: non-empty-string,
+ *              paths: non-empty-string[],
+ *          },
+ *      },
+ * }
+ * @phpstan-type DependenciesType array{
+ *       factories: array<class-string, class-string>,
+ * }
+ */
 class ConfigProvider
 {
+    /**
+     * @return ConfigType
+     */
     public function __invoke(): array
     {
         return [
@@ -16,6 +41,9 @@ public function __invoke(): array
         ];
     }
 
+    /**
+     * @return DependenciesType
+     */
     private function getDependencies(): array
     {
         return [
@@ -24,6 +52,9 @@ private function getDependencies(): array
         ];
     }
 
+    /**
+     * @return DoctrineConfigType
+     */
     private function getDoctrineConfig(): array
     {
         return [

phpcs.xml

@@ -50,6 +50,12 @@ public function setAuthor(string $author): void
         $this->author = $author;
     }
 
+    /**
+     * @return array{
+     *     title:string|null,
+     *     author:string|null
+     * }
+     */
     public function getArrayCopy(): array
     {
         return [