diff --git a/docs/book/v7/installation/configuration-files.md b/docs/book/v7/installation/configuration-files.md index f3d5e7d..91f9249 100644 --- a/docs/book/v7/installation/configuration-files.md +++ b/docs/book/v7/installation/configuration-files.md @@ -1,5 +1,8 @@ # Configuration Files +> The installation script should have already created the files mentioned on this page. +> We mention them explicitly because you will need to visit them to fully configure your development environment. + ## Prepare config files * duplicate `config/autoload/cors.local.php.dist` as `config/autoload/cors.local.php` diff --git a/docs/book/v7/installation/doctrine-orm.md b/docs/book/v7/installation/doctrine-orm.md index 3042587..0352602 100644 --- a/docs/book/v7/installation/doctrine-orm.md +++ b/docs/book/v7/installation/doctrine-orm.md @@ -114,8 +114,8 @@ More details on how fixtures work can be found on [dot-data-fixtures documentati ### Prefixing table names -Note in the database configuration array the key called `table_prefix`. -By default, it is an empty string, which means that all the tables will be named exactly the way they are configured in the entities. +The database configuration array contains the key called `table_prefix`. +By default, it is an empty string, which means that all the tables will use the names specified in their respective entities. ```text ├─ admin @@ -139,7 +139,7 @@ By default, it is an empty string, which means that all the tables will be named └─ user_roles ``` -Adding a prefix, for example `dot_`, all the table will be composed of the prefix and the original table name. +By adding a prefix, for example `dot_`, all the table names will have the prefix appended to the table names specified in the entities. ```text ├─ dot_admin @@ -165,4 +165,4 @@ Adding a prefix, for example `dot_`, all the table will be composed of the prefi > The configured prefix is prepended as is, no intermediary character will be added. -> `doctrine_migration_versions` is an exception, being a special table handled by Doctrine Migrations. +> `doctrine_migration_versions` is an exception and will remain unchanged, since it's a special table handled only by Doctrine Migrations. diff --git a/docs/book/v7/installation/test-the-installation.md b/docs/book/v7/installation/test-the-installation.md index f49732c..a665c61 100644 --- a/docs/book/v7/installation/test-the-installation.md +++ b/docs/book/v7/installation/test-the-installation.md @@ -1,5 +1,7 @@ # Test the installation +> If you are getting server error 500, make sure to check the folder permissions covered in the [FAQ page](https://docs.dotkernel.org/api-documentation/v7/installation/faq/) + Sending a GET request to the [home page](http://0.0.0.0:8080/) should output the following message: ```json diff --git a/docs/book/v7/introduction/packages.md b/docs/book/v7/introduction/packages.md index 07a5098..3022710 100644 --- a/docs/book/v7/introduction/packages.md +++ b/docs/book/v7/introduction/packages.md @@ -1,33 +1,33 @@ # Packages -* `doctrine/dbal`:`^4.2` - Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management. -* `doctrine/orm`:`^3.4` - Object-Relational-Mapper for PHP -* `dotkernel/dot-cache`:`^4.3` - Cache component extending symfony-cache -* `dotkernel/dot-cli`:`^3.9` - Component for creating console applications based on laminas-cli -* `dotkernel/dot-data-fixtures`:`^1.4` - Provides a CLI interface for listing & executing doctrine data fixtures -* `dotkernel/dot-dependency-injection`:`^1.2` - Dependency injection component using class attributes. +* `doctrine/dbal`:`^4.4` - Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management. +* `doctrine/orm`:`^3.6` - Object-Relational-Mapper for PHP +* `dotkernel/dot-cache`:`^4.4` - Cache component extending symfony-cache +* `dotkernel/dot-cli`:`^3.10` - Component for creating console applications based on laminas-cli +* `dotkernel/dot-data-fixtures`:`^1.5` - Provides a CLI interface for listing & executing doctrine data fixtures +* `dotkernel/dot-dependency-injection`:`^1.3` - Dependency injection component using class attributes. * `dotkernel/dot-errorhandler`:`^4.0` - Logging Error Handler for Middleware Applications -* `dotkernel/dot-mail`:`^5.3` - Mail component based on Symfony Mailer -* `dotkernel/dot-response-header`:`^3.5` - Middleware for setting custom response headers. -* `dotkernel/dot-router`:`^1.0` - Dotkernel component to build complex routes, based on `mezzio/mezzio-fastroute` -* `laminas/laminas-authentication`:`^2.18` - API for authentication and includes concrete authentication adapters for common use case scenarios -* `laminas/laminas-component-installer`:`^3.5` - Composer plugin for injecting modules and configuration providers into application configuration -* `laminas/laminas-config-aggregator`:`^1.18` - Lightweight library for collecting and merging configuration from different sources -* `laminas/laminas-hydrator`:`^4.16` - Serialize objects to arrays, and vice versa -* `laminas/laminas-inputfilter`:`^2.31` - Normalize and validate input sets from the web, APIs, the CLI, and more, including files -* `laminas/laminas-servicemanager`:`^3.23` - Factory-Driven Dependency Injection Container -* `laminas/laminas-stdlib`:`^3.20` - SPL extensions, array utilities, error handlers, and more -* `mezzio/mezzio`:`^3.20` - PSR-15 Middleware Microframework -* `mezzio/mezzio-authentication-oauth2`:`^2.11` - OAuth2 (server) authentication middleware for Mezzio and PSR-15 applications -* `mezzio/mezzio-authorization-acl`:`^1.11` - laminas-permissions-acl adapter for mezzio-authorization -* `mezzio/mezzio-authorization-rbac`:`^1.8` - mezzio authorization rbac adapter for laminas/laminas-permissions-rbac -* `mezzio/mezzio-cors`:`^1.13` - CORS component for Mezzio and other PSR-15 middleware runners -* `mezzio/mezzio-fastroute`:`^3.12` - FastRoute integration for Mezzio -* `mezzio/mezzio-hal`:`^2.10` - Hypertext Application Language implementation for PHP and PSR-15 -* `mezzio/mezzio-helpers`:`^5.18` - Helper/Utility classes for Mezzio -* `mezzio/mezzio-problem-details`:`^1.15` - Problem Details for PSR-15 HTTP APIs addressing the RFC 7807 standard -* `ramsey/uuid`:`^4.5` - A PHP library for generating and working with universally unique identifiers (UUIDs). +* `dotkernel/dot-mail`:`^5.4` - Mail component based on Symfony Mailer +* `dotkernel/dot-response-header`:`^3.6` - Middleware for setting custom response headers. +* `dotkernel/dot-router`:`^1.1` - Dotkernel component to build complex routes, based on `mezzio/mezzio-fastroute` +* `laminas/laminas-authentication`:`^2.19` - API for authentication and includes concrete authentication adapters for common use case scenarios +* `laminas/laminas-component-installer`:`^3.7` - Composer plugin for injecting modules and configuration providers into application configuration +* `laminas/laminas-config-aggregator`:`^1.19` - Lightweight library for collecting and merging configuration from different sources +* `laminas/laminas-hydrator`:`^4.18` - Serialize objects to arrays, and vice versa +* `laminas/laminas-inputfilter`:`^2.35` - Normalize and validate input sets from the web, APIs, the CLI, and more, including files +* `laminas/laminas-servicemanager`:`^3.24` - Factory-Driven Dependency Injection Container +* `laminas/laminas-stdlib`:`^3.21` - SPL extensions, array utilities, error handlers, and more +* `mezzio/mezzio`:`^3.27` - PSR-15 Middleware Microframework +* `mezzio/mezzio-authentication-oauth2`:`^2.14` - OAuth2 (server) authentication middleware for Mezzio and PSR-15 applications +* `mezzio/mezzio-authorization-acl`:`^1.13` - laminas-permissions-acl adapter for mezzio-authorization +* `mezzio/mezzio-authorization-rbac`:`^1.10` - mezzio authorization rbac adapter for laminas/laminas-permissions-rbac +* `mezzio/mezzio-cors`:`^1.16` - CORS component for Mezzio and other PSR-15 middleware runners +* `mezzio/mezzio-fastroute`:`^3.14` - FastRoute integration for Mezzio +* `mezzio/mezzio-hal`:`^2.13` - Hypertext Application Language implementation for PHP and PSR-15 +* `mezzio/mezzio-helpers`:`^5.20` - Helper/Utility classes for Mezzio +* `mezzio/mezzio-problem-details`:`^1.19` - Problem Details for PSR-15 HTTP APIs addressing the RFC 7807 standard +* `ramsey/uuid`:`^4.9` - A PHP library for generating and working with universally unique identifiers (UUIDs). * `ramsey/uuid-doctrine`:`^2.1` - Use ramsey/uuid as a Doctrine field type -* `roave/psr-container-doctrine`:`^5.2` || `^6.0` - Doctrine Factories for PSR-11 Containers -* `symfony/filesystem`:`^7.2` - Provides basic utilities for the filesystem -* `zircote/swagger-php`:`^5.0` - Generate interactive documentation for your RESTful API using PHP attributes (preferred) or PHPDoc annotations +* `roave/psr-container-doctrine`:`^5.2` || `^6.1` - Doctrine Factories for PSR-11 Containers +* `symfony/filesystem`:`^7.4` - Provides basic utilities for the filesystem +* `zircote/swagger-php`:`^5.8` - Generate interactive documentation for your RESTful API using PHP attributes (preferred) or PHPDoc annotations