Merge pull request #97 from iazaran/xdebug

Xdebug

Author: iazaran

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for Xdebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9003,
+            "pathMappings": {
+                "/var/www/": "${workspaceFolder}"
+            }
+        }
+    ]
+}

README.md

@@ -1,6 +1,6 @@
 ### Dockerized Pure PHP Composer based MVC Framework
 
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9b13bf034af64123821121d191acfaff)](https://app.codacy.com/manual/eazaran/php-mvc?utm_source=github.com&utm_medium=referral&utm_content=iazaran/php-mvc&utm_campaign=Badge_Grade_Dashboard)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8d638fe590dd4e68b9ce4ac9a7517e3d)](https://app.codacy.com/gh/iazaran/php-mvc/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 
 > This project tries to cover some PHP features in a simple MVC structure with minimum installed composer packages. Then developers can use packages for specific requirements. Please add your ideas in Discussions, ask features or report bugs in issues.
 
@@ -86,6 +86,9 @@ Export a specific table from DB to a CSV file
 #### Use Ajax to send forms' data:
 Consider a route for your form like `/blog/create`; now use `blog-create` as an ID for form, and `blog-create-submit` for submit button ID. All form's buttons need to have constant `form-button` class.
 
+#### Use Xdebug:
+Xdebug installed via Docker, so it is ready to use, just need to start debug in your IDE or start listen to the Xdebug.
+
 #### RESTful API sample
 
 ```php

composer.json

@@ -21,7 +21,7 @@
     },
     "config": {
         "platform": {
-            "php": "8.1"
+            "php": "8.3"
         }
     },
     "require": {

composer.lock

@@ -43,10 +43,14 @@ services:
         command: php-fpm
         volumes:
             - ./:/var/www
-            - ./docker/php/local.ini:/usr/local/etc/php/conf.d/local.in
+            - ./docker/php/local.ini:/usr/local/etc/php/conf.d/local.ini
+            - ./docker/php/xdebug.ini:/usr/local/etc/php/conf.d/xdebug.ini
+            - ./docker/php/error_reporting.ini:/usr/local/etc/php/conf.d/error_reporting.ini
         working_dir: /var/www
         networks:
             - php-mvc-network
+        extra_hosts:
+            - "host.docker.internal:host-gateway"
 
     php-mvc-cron:
         build:

docker-compose.yml

@@ -1,7 +1,7 @@
 FROM php:8.3-fpm
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
-    apt-utils build-essential curl zip zlib1g-dev unzip \
+    apt-utils build-essential curl zip zlib1g-dev libssl-dev unzip \
     memcached libmemcached-dev \
     libpng-dev libjpeg62-turbo-dev libfreetype6-dev \
     jpegoptim optipng pngquant gifsicle \
@@ -18,6 +18,8 @@ RUN pecl install grpc \
     && docker-php-ext-enable grpc
 RUN pecl install protobuf \
     && docker-php-ext-enable protobuf
+RUN pecl install xdebug-3.3.0alpha3 \
+    && docker-php-ext-enable xdebug
 
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 

docker/Dockerfile

@@ -0,0 +1 @@
+error_reporting=E_ALL

docker/php/error_reporting.ini

@@ -0,0 +1,9 @@
+zend_extension=xdebug.so
+
+[xdebug]
+xdebug.mode=develop,coverage,debug,profile
+xdebug.client_host=host.docker.internal
+xdebug.client_port=9003
+xdebug.start_with_request=yes
+xdebug.log=/tmp/xdebug.log
+xdebug.idekey=docker