For years now, I'm using https://github.com/jakzal/phpqa to run a lot of static analysis tools on my PHP codebase.
The list of available tools is huge; see by yourself: Available tools.
In this blog post, we will see how we can take advantage of all these tools and increase the quality of our scripts.
It's only been ten days or so since I learned the trick, even though it was well documented: managing service startups and, above all, blocking one if the other isn't ready (official documentation).
Imagine a two services applications like Joomla (see my Create your Joomla website using Docker), WordPress, LimeSurvey, Laravel and many, many more use cases: you've an application and that application requires a database.
This article is the very short and straightforward version of PHP development in a devcontainer with preinstalled code quality tools. If you just want to follow a very few steps and get your PHP environment, this article is for you.
By following steps describe in this article, you'll obtain:
composer package manager installed,php-cs-fixer, phpcs, phpcbf, sonarlint and Rector installedJust follow the guide...
Please refers to my other articles about Docker to see how to Dockerize the application and be able to run the application using Apache and a database service like PostgreSQL.
When you're running a Docker container on a different network than the standard one (called bridge) and you wish to run a second container that needs to access the first container, you need to run the second container on the same network.
Let's say, you're running a MySQL database on a network called my_network and you wish to be able start a second container like phpMyAdmin and get access to the database, then you need to use the --network CLI option when running the second container using docker run.
Now, imagine the first container is a web application and the second container should be able to access his web page and, too, reusing the same alias?
When developing APIs from scratch, you can do it in the mode I get behind the PC and start programming or I learn about the standards first and then program in compliance with these standards.
And if we lose sight of these norms, we quickly come back to writing endpoints like /articles/insert that are semantically incorrect (and even stupid). In fact, we'll never GET here.
The purpose of the article below is to list best practices by way of examples.
Let's imagine one of the following situations:
You are working with several people on the same PHP project and you notice that one or other person does not comply with your quality criteria when it comes to the layout of the code. You like to use four spaces for indentation, you want the brace that marks the start of a function to be on the line, you don't want to see any more useless spaces at the end of the line, ... and damned! you notice that some people don't care about this.
You are working alone on a project and don't want to lose time to configure your VSCode experience. You wish to start very quickly with a lot of tools already installed in VSCode so you can put your focus to the code, not the editor.
The ultimate solution: using a devcontainer in VSCode.
By using a devcontainer, you (and your team colleague) will use a preinstalled environment and everyone will have exactly the same. You'll save yourself a lot of time by not having to configure your system, and you'll be able to start coding straight away, supported by a range of quality analysis tools.
This article continues where Running Docusaurus with Docker left off. Make sure to read it first and to create required files first.
So you've created your own blog using Docker and Docusaurus. By following steps explained in the Running Docusaurus with Docker article, now, you've a blog with the list of articles stored on your machine; in a blog folder.
Let's go further.
As you know, this blog is powered by Docusaurus.
I'm writing blog posts in Markdown files (one post = one .md file) and Docusaurus will convert them into HTML pages.
In this first article, we're going to learn how to install Docusaurus... ouch, sorry, not install Docusaurus as we're going to use Docker to simplify our lives.
LimeSurvey is an open-source survey tool that allows users to create and conduct surveys online. It is a powerful and intuitive tool that can be used by everyone.
Once again, it's easy to play with it and create a sandbox site to take a look on all his features; thanks to Docker.
To do this, we'll use the https://github.com/martialblog/docker-limesurvey Docker image.
Last year I had a large application developed in Laravel that required a MySQL database. When I was migrating to PostgreSQL I discovered PostgREST, which allowed me to completely remove queries from my code.
Don't get me wrong: my Laravel/PHP code was launching dozens of queries to the database and, after migration, none at all.
My tables, my models, my SQL queries, I was able to remove everything from my code. My PHP code has been greatly lightened and simplified.