| Servicio | Version | Puertos |
|---|---|---|
| PHP 8.2 + Apache | 8.2 | 8000:80 |
| PHP 8.1 + Apache | 8.1 | 8001:80 |
| Composer | 2 | - |
| Mysql | Latest | 3307:3306 |
| PhpMyAdmin | Latest | 8002:80 |
Para poder ejecutar este repositorio y poder empezar a desarrollar en PHP deberás ejecutar el siguiente comando en el directorio raíz.
docker compose up -d- docker compose up : Inicia los contenedores alojados en el archivo docker-compose.yml
- -d : Ejecuta los contenedores en segundo plano.
Con este comando se empezarán a crear los contenedores antes mencionados (si pones el comando con los contenedores ya creados lo único que hace es iniciarlos cogiendo los cambios). Luego de esta primera ejecución podrás encender los contendores de manera normal en el Docker Desktop
Para detener los contenedores puedes hacerlo directamente en la aplicación Docker Desktop en el botón de detener.
Hay otras dos maneras, pero son mediante terminal:
- Abre una terminal en el directorio raíz del proyecto (a la altura del docker-compose.yml y del Dockerfile), pones el comando
docker compose down. Esto eliminará todos los contenedores que estén asociados a ese docker-compose.yml. - Abre una terminal y escribes
docker down (nombre_contenedor o id_contenedor)
Para empezar tu aplicación y poder programar deberás trabajar en la carpeta app.
Ya que esta es la carpeta que los dos servicios de PHP (PHP 8.2 y PHP 7.4) sirven la web.
Básicamente montamos la carpeta app en /var/www/html la carpeta por defecto de Apache para servir las webs.
En Docker podemos cambiar los puertos que exponemos para conectarnos, por ejemplo, en este repositorio en PHP 8.2 tenemos esta configuración
ports:
- "8000:80"Usamos las redes para prevenir conexiones exteriores a nuestro servidor de base de datos.
- dwcsLan (Para red interna, Base de datos, PHP8.2, PHP7.4, Composer, PHPMyAdmin)
- dwcs (Para red puente externa)
Lo que quiere decir que de manera interna el PHP 8.2 funciona con el puerto 80 (él por defecto para Apache) pero para conectarnos de manera externa a la web deberemos usar el 8000, por ejemplo http://localhost:8000.
En nuestra aplicación usaremos de manera frecuente conexiones a nuestra base de datos MySql, así que es importante explicar como manejar estas conexiones en nuestro entorno Docker.
Debe conincidir el nombre del contenedor de MySql, con el conector que usaremos en php, aloja en el ./config/config.ini.
Imagen del contenedor de MySql
A diferencia de Xamp, en Docker no nos podemos conectar a la base de datos con PHP mediante el hostname localhost, ya que Docker tiene un servidor DNS interno distinto. Lo recomendable es usar el conector interno de Docker, usando el hostname de nuestra base de datos: dwcs-mysql.
Archivo config.ini
[database]
hostname = "dwcs-mysql"
puerto = "3306"
usuario = "root"
contrasena = "root"
base_de_datos = "dwcs"Pero de manera externa, sí podremos conectarnos mediante localhost por ejemplo, para usar algún gestor de base de datos, como MySQL Workbench o DataGrip.
DataGrip -> Descargar
MySQL Workbench -> Descargar
En resumen, para conexiones internas entre los contenedores usar el puerto interno y el hostname de la base de datos dwcs-mysql, para conexiones externas usar el puerto que expone docker y el hostname localhost.
En el repositorio tenemos creados varios volúmenes importantes.
- MySql Volumen: ./data:/var/lib/mysql | Este volumen es el encargado de guardar los datos de la base de datos, para evitar perder la información cada vez que apagamos el contenedor.
- PHP 8.2 y 7.2:
- ./app:/var/www/html | Volumen que monta la web para servirla mediante el servidor Apache
- ./config/php.ini:/usr/local/etc/php/php.ini | Montar el archivo de configuración php.ini en el servidor para poder editarlo mas facil
- Composer: ./app:/var/www/html | Donde se monta la instalación del composer. (Carpeta ./vendor, composer.json, composer.lock)
A lo largo del desarrollo en este entorno es posible que al reconstruir nuestros proyectos (docker compose up --force-recreate --build -d) tantas veces ocurran algunos errores, o sean por otros motivos, dejo aquí unas soluciones a algunos errores que me han ido saliendo.
- SQLState could not find driver
Este error se da porque en nuestro contenedor no se instaló bien el pdo_mysql.
- Error al cargar alguno de los servicios en la web
La solucion suele ser eliminar los contenedores y volver a construirlos.
Para solucionarlo debemos instalarlo de manera manual, primero debemos ejecutar la consola de nuestro contenedor con docker exec -it "nombreContenedor" /bin/bash
Ya con la consola abierta podemos ejecutar el comando para instalarlo docker-php-ext-install mysqli pdo_mysql ,
ya con esto se instala y ahora solo queda habilitarlo docker-php-ext-enable mysqli pdo_mysql. Ahora solo queda reiniciar el contenedor.
Composer es una herramienta para administrar las dependencias en proyectos de PHP. En términos simples, ayuda a gestionar las bibliotecas y paquetes de código que tu proyecto PHP pueda necesitar para funcionar.
Para poder usar composer e instalar la librerías que necesitemos lo haremos desde el Docker llamado mycomposer.
A modo de ejemplo, mostraré como instalar Krumo (Una herramienta para visualizar mejor los vardump() ) -> https://packagist.org/packages/mmucklo/krumo
- Entraremos dentro del contenedor mycomposer con el siguiente comando.
docker exec -it mycomposer /bin/bash
Se nos abrirá una consola nueva, esta es la consola interna del contenedor mycomposer.
- Ponemos el comando para instalar el paquete que queramos, en nuestro caso es Krumo el paquete.
composer require mmucklo/krumo
Con esto comenzará la instalación de nuestro paquete.
- Con nuestro paquete instalado es muy recomendable ejecutar el siguiente comando para refrescar el script encargado de cargar la librerías (dentro de la consola de mycomposer).
composer dump-autoload
- Ya con nuestro paquete instalado solo queda probarlo, dejo aquí un código simple para probarlo.
include('./vendor/autoload.php');
$variable = array('a' => 'apple', 'b' => 'banana', 'c' => 'cherry');
krumo($variable);- Solucion de errores de bibliotecas copiadas
Se soluciona eliminando la biblioteca y haciendo
composer dump-autoload
De una manera simple, Composer usa un archivo llamado autoload.php, el cual se encarga de cargar todas las librerías y que puedas usarlas en tus scripts.
Para usar las librerías deberás escribir obligatoriamente en el fichero la siguiente línea:
include('./vendor/autoload.php');Así de esta manera se cargarán todas las librerías y las podrás usar. Una buena práctica es que cada vez que descarguemos una librería ejecutemos el comando del paso 3, del anterior apartado anterior para actualizar el script que autocarga las librerías.
PhpMyAdmin es una herramienta de administración de bases de datos MySQL a través de una interfaz web. Permite realizar tareas como la creación de bases de datos, tablas, modificación de datos, copias de seguridad, entre otras.
Para poder usar PhpMyAdmin junto a una base de datos (en nuestro caso una MySql) se debe de configurar bien nuestro docker-compose.yml, debemos fijarnos en estos apartados.
PMA_HOST: dwcs-mysql
PMA_PORT: 3306Estos parametros corresponden al host y puerto al que va acceder PhpMyAdmin, debemos comprobra que son
iguales a el container_name: 'dwcs-mysql' y el ports: - "3306:3306"
Segun el tipo de arquitectura del sistema y de dispositivo hay que tener una especial preocupacion sobre que version de PhpMyAdmin, en el repositorio usamos la base de amd64 la basica para Windows. Asi que deberias verificar el tipo de arquitectura de tu equipo y cambiar el docker-compose.yml.
| Sistema Operativo | Tipo de Arquitectura |
|---|---|
| Windows | amd64 |
| Linux | arm32v5 |
| Linux | arm32v6 |
| Linux | arm32v7 |
| Linux | arm64v8 |
| Windows | i386 |
| Linux | mips64le |
| Linux | ppc64le |
| Linux | s390x |
| macOS | amd64 |
Para acceder al PhpMyAdmin lo hacemos mediante el puerto que tenemos abierto, localhost:8002.
Nos abrira la pagina para el Login y debemos acceder con las credenciales creadas en el docker-compose.yml, en este caso usuario root y contraseña root (recuerda que si has cambiado las credenciales hay que reflejar el cambio a la hora de iniciar sesion).
Xdebug es una extensión de PHP que proporciona capacidades de depuración de código y errores.
Para poder usar el xdebug en el VSCode es necesario configurar los parámetros de lanzamiento de la sesión de Debugging.
Estos parámetros se encuentran en la carpeta oculta ./.vscode en el archivo launch.json. Los parámetros más importantes son los siguientes:
- Puerto del XDebug
"port": 9003, este es el puerto por defecto que se usa para la sesión del XDebug - Ruta de Mapeo del proyecto
"pathMappings": { "/var/www/html/": "${workspaceRoot}/app/" }, esta configuración define la ruta para el servidor de depuración. Si se cambia el nombre de la carpeta del proyecto es importante volver a cambiarlo aquí. - Directorio de trabajo
cwd": "${workspaceFolder}/app/", aquí se establece el directorio donde está alojado el proyecto.
Por suerte en este repositorio ya viene configurado el launch.json, pero recuerda que si realizas alguna modificación es relevante volver a reflejarlas en el launch.json
Aparte de esto es relevante descargar la siguiente extensión.
- PHP Debug -> https://marketplace.visualstudio.com/items?itemName=xdebug.php-debug (Nos permite colocar los puntos de interrupción en nuestro código PHP)
Para empezar a realizar una sesión de depuración con XDebug deberás seguir estos pasos.
- Poner el Breakpoint
- Entrar en el apartado de Run and Debug (Ctrl+Shift+D) y hacer click en XDebug
Tras hacer click nos saldrá abajo que el XDebug está escuchando en puerto 9003
- Ya con el XDebug escuchando solo queda abrir nuestra web y ya podremos ver la sesión de depuración funcionando, si la web ya esta en ejecucion solo es recargar la página.
Para configurar nuestro entorno en Netbeans es algo más complicado que en Vscode.
Primero debemos cargar nuestro proyecto en NetBeans.
Aquí es importante poner como carpeta del proyecto la misma que montamos en nuestro docker, en este caso la carpeta app
Por último no olvidarse de poner bien nuestra URL del proyecto, cuidando especificar el puerto, como en nuestro caso tenemos un PHP 8.2 en el puerto 8000 debemos cambiar el puerto http://localhost:8000
Con esto ya tenemos el nuestro proyecto configurado en Netbeans, con la configuración por defecto del Netbeans debería de funcionar sin problemas la depuración.
En el caso de que no funcione, explico aquí como solucionarlo:
- El principal problema para que NetBeans no detecte bien nuestro XDebug es porque la xdebug.idekey este mal configurado.
La xdebug.idekey es una opción utilizada por XDebug para especificar la clave del entorno de desarrollo integrado (IDE, por sus siglas en inglés) que está siendo utilizada. Esta se especifica en el php.ini que en el caso de este repositorio está alojada en la carpeta ./composer/config
xdebug.client_port=9003
xdebug.idekey="netbeans-xdebug"Aquí la especificamos como "netbeans-xdebug", que es la idekey por defecto de NetBeans.
Así que lo que tenemos que hacer es comprobar que esta coincida tanto en NetBeans como en el php.ini, para verlo en el NetBeans tienes que acceder a Tools>Options. Se abrira la siguiente pestaña e iremos a PHP y Debugging.
Aquí comprobamos la Session ID, y también el puerto (es el 9003).
El fichero navigator.php es un buscador de archivos, el cual nos permite visualizar todo tipo de ficheros y poder ejecutar nuestros scripts de PHP, este fichero es completamente prescindible, es solo una utilidad que pense que podria interesar al usuario. Dejo aqui el repositorio del chico creador de este script.