Skip to content

Commit 4bc50b1

Browse files
authored
Merge pull request #147 from dotkernel/install-edits
updated pages
2 parents 3f38a0c + 7063e0a commit 4bc50b1

File tree

4 files changed

+38
-33
lines changed

4 files changed

+38
-33
lines changed

docs/book/v7/installation/configuration-files.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Configuration Files
22

3+
> The installation script should have already created the files mentioned on this page.
4+
> We mention them explicitly because you will need to visit them to fully configure your development environment.
5+
36
## Prepare config files
47

58
* duplicate `config/autoload/cors.local.php.dist` as `config/autoload/cors.local.php`

docs/book/v7/installation/doctrine-orm.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,8 @@ More details on how fixtures work can be found on [dot-data-fixtures documentati
114114

115115
### Prefixing table names
116116

117-
Note in the database configuration array the key called `table_prefix`.
118-
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.
117+
The database configuration array contains the key called `table_prefix`.
118+
By default, it is an empty string, which means that all the tables will use the names specified in their respective entities.
119119

120120
```text
121121
├─ admin
@@ -139,7 +139,7 @@ By default, it is an empty string, which means that all the tables will be named
139139
└─ user_roles
140140
```
141141

142-
Adding a prefix, for example `dot_`, all the table will be composed of the prefix and the original table name.
142+
By adding a prefix, for example `dot_`, all the table names will have the prefix appended to the table names specified in the entities.
143143

144144
```text
145145
├─ dot_admin
@@ -165,4 +165,4 @@ Adding a prefix, for example `dot_`, all the table will be composed of the prefi
165165

166166
> The configured prefix is prepended as is, no intermediary character will be added.
167167
168-
> `doctrine_migration_versions` is an exception, being a special table handled by Doctrine Migrations.
168+
> `doctrine_migration_versions` is an exception and will remain unchanged, since it's a special table handled only by Doctrine Migrations.

docs/book/v7/installation/test-the-installation.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Test the installation
22

3+
> 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/)
4+
35
Sending a GET request to the [home page](http://0.0.0.0:8080/) should output the following message:
46

57
```json
Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# Packages
22

3-
* `doctrine/dbal`:`^4.2` - Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management.
4-
* `doctrine/orm`:`^3.4` - Object-Relational-Mapper for PHP
5-
* `dotkernel/dot-cache`:`^4.3` - Cache component extending symfony-cache
6-
* `dotkernel/dot-cli`:`^3.9` - Component for creating console applications based on laminas-cli
7-
* `dotkernel/dot-data-fixtures`:`^1.4` - Provides a CLI interface for listing & executing doctrine data fixtures
8-
* `dotkernel/dot-dependency-injection`:`^1.2` - Dependency injection component using class attributes.
3+
* `doctrine/dbal`:`^4.4` - Powerful PHP database abstraction layer (DBAL) with many features for database schema introspection and management.
4+
* `doctrine/orm`:`^3.6` - Object-Relational-Mapper for PHP
5+
* `dotkernel/dot-cache`:`^4.4` - Cache component extending symfony-cache
6+
* `dotkernel/dot-cli`:`^3.10` - Component for creating console applications based on laminas-cli
7+
* `dotkernel/dot-data-fixtures`:`^1.5` - Provides a CLI interface for listing & executing doctrine data fixtures
8+
* `dotkernel/dot-dependency-injection`:`^1.3` - Dependency injection component using class attributes.
99
* `dotkernel/dot-errorhandler`:`^4.0` - Logging Error Handler for Middleware Applications
10-
* `dotkernel/dot-mail`:`^5.3` - Mail component based on Symfony Mailer
11-
* `dotkernel/dot-response-header`:`^3.5` - Middleware for setting custom response headers.
12-
* `dotkernel/dot-router`:`^1.0` - Dotkernel component to build complex routes, based on `mezzio/mezzio-fastroute`
13-
* `laminas/laminas-authentication`:`^2.18` - API for authentication and includes concrete authentication adapters for common use case scenarios
14-
* `laminas/laminas-component-installer`:`^3.5` - Composer plugin for injecting modules and configuration providers into application configuration
15-
* `laminas/laminas-config-aggregator`:`^1.18` - Lightweight library for collecting and merging configuration from different sources
16-
* `laminas/laminas-hydrator`:`^4.16` - Serialize objects to arrays, and vice versa
17-
* `laminas/laminas-inputfilter`:`^2.31` - Normalize and validate input sets from the web, APIs, the CLI, and more, including files
18-
* `laminas/laminas-servicemanager`:`^3.23` - Factory-Driven Dependency Injection Container
19-
* `laminas/laminas-stdlib`:`^3.20` - SPL extensions, array utilities, error handlers, and more
20-
* `mezzio/mezzio`:`^3.20` - PSR-15 Middleware Microframework
21-
* `mezzio/mezzio-authentication-oauth2`:`^2.11` - OAuth2 (server) authentication middleware for Mezzio and PSR-15 applications
22-
* `mezzio/mezzio-authorization-acl`:`^1.11` - laminas-permissions-acl adapter for mezzio-authorization
23-
* `mezzio/mezzio-authorization-rbac`:`^1.8` - mezzio authorization rbac adapter for laminas/laminas-permissions-rbac
24-
* `mezzio/mezzio-cors`:`^1.13` - CORS component for Mezzio and other PSR-15 middleware runners
25-
* `mezzio/mezzio-fastroute`:`^3.12` - FastRoute integration for Mezzio
26-
* `mezzio/mezzio-hal`:`^2.10` - Hypertext Application Language implementation for PHP and PSR-15
27-
* `mezzio/mezzio-helpers`:`^5.18` - Helper/Utility classes for Mezzio
28-
* `mezzio/mezzio-problem-details`:`^1.15` - Problem Details for PSR-15 HTTP APIs addressing the RFC 7807 standard
29-
* `ramsey/uuid`:`^4.5` - A PHP library for generating and working with universally unique identifiers (UUIDs).
10+
* `dotkernel/dot-mail`:`^5.4` - Mail component based on Symfony Mailer
11+
* `dotkernel/dot-response-header`:`^3.6` - Middleware for setting custom response headers.
12+
* `dotkernel/dot-router`:`^1.1` - Dotkernel component to build complex routes, based on `mezzio/mezzio-fastroute`
13+
* `laminas/laminas-authentication`:`^2.19` - API for authentication and includes concrete authentication adapters for common use case scenarios
14+
* `laminas/laminas-component-installer`:`^3.7` - Composer plugin for injecting modules and configuration providers into application configuration
15+
* `laminas/laminas-config-aggregator`:`^1.19` - Lightweight library for collecting and merging configuration from different sources
16+
* `laminas/laminas-hydrator`:`^4.18` - Serialize objects to arrays, and vice versa
17+
* `laminas/laminas-inputfilter`:`^2.35` - Normalize and validate input sets from the web, APIs, the CLI, and more, including files
18+
* `laminas/laminas-servicemanager`:`^3.24` - Factory-Driven Dependency Injection Container
19+
* `laminas/laminas-stdlib`:`^3.21` - SPL extensions, array utilities, error handlers, and more
20+
* `mezzio/mezzio`:`^3.27` - PSR-15 Middleware Microframework
21+
* `mezzio/mezzio-authentication-oauth2`:`^2.14` - OAuth2 (server) authentication middleware for Mezzio and PSR-15 applications
22+
* `mezzio/mezzio-authorization-acl`:`^1.13` - laminas-permissions-acl adapter for mezzio-authorization
23+
* `mezzio/mezzio-authorization-rbac`:`^1.10` - mezzio authorization rbac adapter for laminas/laminas-permissions-rbac
24+
* `mezzio/mezzio-cors`:`^1.16` - CORS component for Mezzio and other PSR-15 middleware runners
25+
* `mezzio/mezzio-fastroute`:`^3.14` - FastRoute integration for Mezzio
26+
* `mezzio/mezzio-hal`:`^2.13` - Hypertext Application Language implementation for PHP and PSR-15
27+
* `mezzio/mezzio-helpers`:`^5.20` - Helper/Utility classes for Mezzio
28+
* `mezzio/mezzio-problem-details`:`^1.19` - Problem Details for PSR-15 HTTP APIs addressing the RFC 7807 standard
29+
* `ramsey/uuid`:`^4.9` - A PHP library for generating and working with universally unique identifiers (UUIDs).
3030
* `ramsey/uuid-doctrine`:`^2.1` - Use ramsey/uuid as a Doctrine field type
31-
* `roave/psr-container-doctrine`:`^5.2` || `^6.0` - Doctrine Factories for PSR-11 Containers
32-
* `symfony/filesystem`:`^7.2` - Provides basic utilities for the filesystem
33-
* `zircote/swagger-php`:`^5.0` - Generate interactive documentation for your RESTful API using PHP attributes (preferred) or PHPDoc annotations
31+
* `roave/psr-container-doctrine`:`^5.2` || `^6.1` - Doctrine Factories for PSR-11 Containers
32+
* `symfony/filesystem`:`^7.4` - Provides basic utilities for the filesystem
33+
* `zircote/swagger-php`:`^5.8` - Generate interactive documentation for your RESTful API using PHP attributes (preferred) or PHPDoc annotations

0 commit comments

Comments
 (0)