Merge branch 'docker'

Author: pifou25

README.md

@@ -184,3 +184,47 @@ You can add your own methods to entities and change getter/setter functions, the
 ## Configuration
 
 see src/Generator/Config.php
+
+# Docker integration
+
+## Entity Generator image
+
+![Docker Pulls](https://img.shields.io/docker/pulls/pifou25/entity-generator)
+ https://hub.docker.com/r/pifou25/entity-generator
+
+## Generation from existing database
+The database should be accessible from the docker network, the hostname is either
+the name of the Mysql running container, or `localhost` if db is running on host.
+The below command will generate entities into `./entities` directory.
+
+```
+docker run --rm -v $PWD/entities:/app/entities --network some-network \
+   -e MYSQL_HOSTNAME=some-mariadb \
+   -e MYSQL_DATABASE=exmple-database \
+   -e MYSQL_USERNAME=example-user \
+   -e MYSQL_PASSWORD=my_cool_secret \
+    pifou25/entity-generator
+```
+
+## namespace and extends example
+The base class must exist into /entities to be declared
+```
+docker run --rm -v $PWD/include/entities:/app/entities --network scripts_default \
+   -e MYSQL_HOSTNAME=myhost \
+   -e MYSQL_DATABASE=mydb \
+   -e MYSQL_USERNAME=myuser \
+   -e MYSQL_PASSWORD=mypwd \
+   -e ENTITY_NAMESPACE=Example\\Pdo\\Entities \
+   -e BASECLASS=Example\\Pdo\\Entities\Entity \
+    entity-generator
+```
+
+## Generation from flat plain SQL file
+
+The `docker compose` file create a new database and initialize it with SQL data,
+you have to put SQL init file into `./examples` directory. When db is ready, 
+ the entity-generator start on it to generate PHP entities.
+
+It is as simple as running this command from the `docker` directory :
+`docker compose up`
+

docker/docker-compose.yaml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 networks:
   default:
     name: default_network
@@ -16,7 +14,7 @@ services:
       - MYSQL_PASSWORD=my-password
     volumes:
       # directory for init sql and scripts
-      - ./init:/docker-entrypoint-initdb.d
+      - ../examples:/docker-entrypoint-initdb.d
     healthcheck:
       test: ["CMD", "healthcheck.sh", "--su-mysql", "--connect", "--innodb_initialized"]
       interval: 1m30s

docker/index.php

@@ -10,7 +10,7 @@
 $params['baseclass'] = getenv('BASECLASS');
 $params['namespace'] = getenv('ENTITY_NAMESPACE');
 
-// vérifier que les paramètres requis pour mysql sont présents
+// check all required mysql parameters
 if(!isset($params['hostname']) || !isset($params['database']) || !isset($params['username']) || !isset($params['password'])) {
     var_dump($params);
     die('Missing or bad command line parameters.');