Így néz ki a modern PHP

A cím valóban igényes, nem? Igen, ez az. Bár évek óta dolgozom a PHP-vel, hogyan állíthatnám, hogy melyek a legjobb gyakorlatok és eszközök a munkához? Nem tudtam, de meg fogom tenni.

Valódi változást látok abban, ahogy a fejlesztők a PHP-vel végzik munkájukat, nemcsak a nyelv drasztikusan változik, hogy érettebb és robusztusabb legyen az új verziókkal és fejlesztésekkel, hanem a körülötte lévő teljes ökoszisztéma is változik.

Új eszközök, könyvtárak, keretrendszerek és cikkek készülnek, a minták meghatározása annak érdekében, hogy a kód elegánsabb és könnyebben érthető legyen. Többen gondolkodnak azon, hogyan lehetne a munkát (és az ön fejlesztői életét) eredményesebbé, tisztábbá és szórakoztatóbbá tenni.

Nem vagyok az új trendek korai alkalmazója, valójában csak akkor fogadok el új eszközt, ha biztos vagyok benne, hogy van egy közösség mögötte, és úgy gondolom, hogy ez javítani fogja munkámat. Mindig azt teszem, hogy megpróbálom megírni a kódomat a legjobb gyakorlatok alapján.

Emiatt időbe telt, mire elkezdtem használni a Composert és a PHPUnit-t. Körülbelül egy évvel ezelőtt, többé-kevésbé, megnyitottam a szívem mindazon fényes új dolgok előtt.

Először a PSR következett, majd a Composer, a PHPUnit, a Travis-ci és számos más könyvtár és elképesztő eszközök. Most még egy IDE-t is használok (Vim FTW, de az észszerű munkafolyamathoz elengedhetetlen az XDebug integrációval rendelkező PHPStorm)!

Mi a modern?

Rengeteg cikk van az interneten arról, hogy milyen szörnyű a PHP, milyen szörnyű lenne az életed, ha PHP-kóddal kellene dolgoznod, mennyire csúnya a nyelv és bármi másra gondolhatsz!

Ha régi kóddal fogsz dolgozni, akkor az életed nem lesz olyan jó, de ha lehetőséged van egy új projekten dolgozni, és képes vagy használni az összes új eszközt, akkor meglátod ezt az új PHP-t Beszélni fogok róla.

Számos problémám van napi szinten dolgozni a PHP-vel, de nem lehet lehunyni a szemüket a nyelv, a közösség és az ökoszisztéma változásai előtt. Hosszú út áll előttünk, de a dolgok érlelődnek a PHP országában.

Elkezdtem létrehozni egy SDK-t egy belső API számára abban a vállalatban, amelyben dolgozom, csak kisállat-projektként, és úgy döntöttem, hogy követem a bevált gyakorlatokat. Legtöbbjüket már csináltam, de néhány dolgot kevés módon változtattam meg. Ezekkel a változásokkal és az elmúlt évben tanultakkal ez a cikk foglalkozik, és amit Modern PHP-nek hívok.

Kezdjük a munkafolyammal

Mint mondtam, újonc vagyok ebben az IDE-dologban, de ez első látásra szerelem volt. A PHPStorm egy nagyszerű szoftver. Ez az első és egyetlen IDE-m. Ököllel próbálkoztam, és nem is kellett mással próbálkoznom.

Az XDebug integrációja tökéletes, PHP névtér felbontás, zeneszerző integráció, git integráció, automatikus kiegészítés, kódgenerálás, kódjavítás. Folytathatnám tovább és tovább.

Nem hiszem, hogy IDE-t kell használnia, valójában ez a pont teljesen személyes. Bármit használjon, amely megfelel az Ön igényeinek - Vim, Atom, Emacs, Bracket, NetBeans, PHPStorm, Eclipse, bármi más. Két fontos szempont itt a termelékenység és az ergonómia. Az Ön IDE / szövegszerkesztőjének ott kell lennie, hogy segítsen.

Számomra azonban nagyszerű pont a hibakereső integráció. Kód írásához nagy projektekhez (valójában a kis projektekhez is) tisztességes hibakeresőt kell használnia. Felejtsük el azokat a var_dumps és print_rs fájlokat. Futtatás közben be kell állítania ezeket a változókat, elemeznie kell a verem nyomát, meg kell határoznia a töréspontokat. Ezek a dolgok elengedhetetlenek, és megkönnyítik a fejlesztést és az újrateremtést.

Nem is tudom, hogy vannak-e itt más lehetőségek, az XDebug mindent megtalál, amire szüksége van. Van néhány perced? Ha még nem tette meg, szánjon egy kis időt az XDebug beállítására, és integrálja azt az IDE-be vagy a szövegszerkesztőbe. Kezdje el hibakeresését a kód segítségével a megfelelő eszközökkel.

A másik eszköz, amelyre felhívom a figyelmét, a GitHub. Újabb teljes cikket lehetne írni arról, hogy a Git és a GitHub mennyire jó, és miért kell elkezdenie a kódját egy verziós rendszer alatt tartani. De szeretnék megmutatni egy másik okot.

A hangsúly itt az integráció.

Számos eszköz integrálódik a GitHub-ba, és el kell kezdenie használni őket. Ezek az eszközök képesek metrikákat generálni, teszteket futtatni, feladatokat futtatni az Ön számára a folyamatos integrációs folyamat során, és mindenféle dolgot elvégezhetnek a munkafolyamatban. Az integráció jó ok arra, hogy elkezdje használni a GitHub-ot, az összes többi egy pillanatra alá van vetve.

Függőségkezelés

A modern PHP-ökoszisztéma másik pontja a függőségkezelés, a Composer pedig a munka eszköze.

A zeneszerző 5 éves, de nekem úgy tűnik, hogy pár évvel ezelőtt hatalmas örökbefogadás történt. Talán azért, mert nem vagyok korai alkalmazó, vagy talán azért, mert a PHP fejlesztői nem szívesen változnak.

This tool provides a front end to Packagist, which is a PHP package repository consisting of PHP libraries, projects and tools, whose source code is stored in Github (or other places like BitBucket).

All the libraries I’m talking about in this article, and maybe one of those pet projects of yours, can be added to your project with a simple

$ composer require package_vendor/package_name

If you don’t know the vendor of a package, you can search for a package to find and install the right one.

$ composer search package_name

Composer would be a great tool if it just did this work, manage dependencies, but it does a lot more. Take a time to install Composer and read the documentation.

Command line interface done right

I really like to try ideas quickly using CLI interfaces. For me, one of the greatest REPL tools is the IPython. It helps you autocomplete your code, let you easily define functions, ease the access to the documentation and several other amazing features. The downside for us, the tool is for Python, not PHP.

In the PHP world we have something called “interactive mode” which can be accessed by terminal, just typing

$ php -aInteractive mode enabled
php >

At this point, you are in the interactive mode and can start testing something. It works, but the tool is just too unintuitive. I’ve tried it several times but, since I knew what IPython was able to do, I could not keep using it.

To our luck, there is a cool new CLI (command line interface) on the block and its name is Psysh. Psysh is an amazing tool, full of interesting features and can be installed globally or per project using composer.

The nicest Psysh feature for me is inline documentation. Accessing the doc for a PHP function without heading over to Php.net is great. The downside is that you need to do few things before it is fully functional.

After installing it, type the following commands (I’m using Debian here, this may not work for everyone) in order to get it working properly

$ apt-get install php7.1-sqlite3$ mkdir /usr/local/share/psysh$ wget //psysh.org/manual/en/php_manual.sqlite -o /usr/local/share/psysh/php_manual.sqlite

The first command is not mandatory and if you have the Sqlite already installed you can skip this step. The second command creates the directory to store the documentation and the third line downloads and save the doc into the previously created directory. Remember, all these commands must run as root.

Now you have this

Head to Psysh and learn more about this awesome tool.

You should start testing

Ezt a mantrát mondom magamnak minden nap. Mint sok ember, én sem tesztelem annyira a kódomat, mint a TDD sugallja. Most kezdek bele a tesztelésbe és az elmúlt fél évben is ezt tettem, és hosszú út áll előttünk.

Úgy döntöttem, hogy megismerem a teszteket, amikor egy komplex örökölt projekttel dolgozom. A kód annyira törékeny és merev volt, hogy bármikor hozzáadtunk valamilyen kódot, az eltört valamit. Új funkció? Végezzen el és törjön meg valamit! Javít egy hibát? Hozzon létre még egyet.

Ez nagy probléma volt, amelyet egy másik cikkben tárgyaltam, és arra késztetett, hogy elkezdjek esélyt adni a teszteknek.

Az első eszköz, amelyet bemutattak, a PHPUnit volt. Amint azt a hivatalos oldalon is közöltük

A PHPUnit egy programozó-orientált tesztelési keretrendszer a PHP számára.

Ez az xUnit architektúra példánya az egység tesztelési kereteihez.

So, PHPUnit is a framework for helping you create tests for your projects, unitary tests. It gives you several functions to test the outcome of your code and generate a nice output with the result from those tests.

Since I started thinking about tests, reading and talking to people about it, I’ve discovered another great tool, which complements the work you’ve put in those unitary tests, it is calle Behat, which is a BDD framework for PHP.

BDD (Behavior-Driven Development) is a development process which came from TDD (Test-Driven Development). Those acronyms are not important now, what is important is that you can specify your tests using a more natural language, a language that non-technical folks can understand.

This language is called Gherkin and is used to describe the expected behavior being tested. A test description, using Gherkin, looks like this

Behind those lines there is PHP code that is called whenever there is a match between a line and a regex pattern specified in the PhpDoc of the method. This code implements those steps and what a real user would do, using your SDK, application or web system.

The workflow with Behat is so smooth. After everything properly configured, you start writing all possible scenarios for testing a feature. The first time you run Behat, it gives you all the method templates you should add to your PHP Context class in order to implement each step in a scenario.

After that, you start writing the actual code for each step and keep repeating this cycle.

  • Implement PHP code for a step
  • Run tests
  • If everything is fine, write PHP code for another step
  • If something is broken, fix it

After half an hour of configuring and reading documentation, you are prepared to use Behat, you’ll see that in the end it is all PHP code and you already know how to program with it.

Continuous Integration

Continuous integration (CI) is a process - a way to do something, and this thing, for us software engineers, is creating software.

In plain English, it is the act of incorporating small chunks of code constantly (maybe several times a day) into your code base. Code which has been tested and did not break anything. CI helps you automate the building, testing and deployment of your applications.

With a few clicks you can integrate your GitHub project with Travis CI and every push to your repository will run those tests you created with PHPUnit and Behat, telling you whether the the last feature you’ve implemented is ready, or not, to be merged. Besides that, you can use Travis CI to deploy your code to production and staging.

Having a nice pipeline of work with a well defined process is great and Travis CI can help you with this job. Follow this nice Getting started and discover how interesting it is to think about the process of software development, not just the code itself.

Adhere to PSR-1 and PSR-2

If you don’t know what PSR is, you should. Actually, PSR stands for PHP Standard Recommendations and is proposed by PHP-FIG (PHP Framework Interop Group), a consortium formed by members from the biggest PHP projects, frameworks and CMSs, which are thinking about the future of the language, ecosystem and discussing standards to be followed.

For a long time, PHP had no coding style. I’m not that old, but every time I looked into someone’s project or library, it was following a different style. Sometimes the bracket was left in one position, sometimes it was put in the next line, different approaches were used to deal with long lines and every other combination of style and preference you could think of. It was a mess.

PHP-FIG does many other jobs, but by proposing a single unity of code, they are saying “Let’s stop worrying about code style, let’s everyone follow a standard and start thinking about creating great software”. Now, whenever you take a look at someone’s code you just worry about understanding how it works, not blaming the format, the structure.

There are, until the end of this article, 9 accepted PSRs proposing common solutions for common problems. But if you don’t know anything about those standards, start with the PSR-1 and PSR-2.

These standards propose the modern PHP coding style. Make sure you read them before start using them. Don’t think you’ll remember all of them when coding, it is a process, but to make you sure, there are tools to help you with it.

PHP CodeSniffer is a tool you can find on Packagist that you can install with Composer. I don’t think the repository name was the best choice, because it ships two different tools, phpcs and phpcbf.

Phpcs is the code sniffer, it will scan your entire code, looking for parts that are not following the configured coding standard.

You can use several coding standards with phpcs and you can even create your own. At the end of the code scan, phpcs shows you a list of the pieces of code not following the standard. It is great.

Now, how to change everything which is wrong? You could open every file, change the code, run phpcs again, see the error not being shown, and repeat the process. It’ll be extra boring.

To solve this problem, PHP CodeSniffer came with another tool, called phpcbf, or PHP Code Beautifier. You run phpcbf, following the same rule set and, voilá, it fixes everything for you, or it tries to do its best without breaking your code.

Try to create the habit of running phpcs and phpcbf before pushing any changes in your code to the repository, this will ensure that all of your code adhere to the standards and if someone likes your tool/project and wants to contribute, they will have no problem reading it.

Frameworks

I’m not going to dedicate too much time discussing frameworks. There are several good ones out there, each one with its ups and downs. Personally, I prefer not to use those big frameworks, with everything inside. I like the idea that you must use just what you need.

If you need a HTTP client, use Guzzle. If you need a template engine, use Twig. If you need a router, find a good component which suits your needs and use it. Glue these components together and create your application.

Symfony is doing a great job towards this concept. You can use the entire framework for a project, or you can just take whatever you want and use it. Simple as that.

However, whenever I need a framework to write an application, I chose one of the so called microframeworks. They are really small, offer just the basics and are easy to customize and easier to make them follow your project structure.

My microframework of choice is Slimframework and I think you should read about it. It is simple for doing small projects, but it gets a bit more complex for bigger ones.

By the way, and this is for those who are starting with programming, I really think that before adopting a framework and dying for it, you should try to create your own. This will give you the understanding of the whole mechanism and ease the adoption of a big one.

The Modern PHP Toolset

Let’s finish this article with a list of links. To me, these components, tools and libraries represent a great deal of what Modern PHP is:

  • Slimframework: a nice and cool microframework
  • Symfony: a bigger framework which is filled with great and reusable components
  • Guzzle: a simple and easy to use HTTP client
  • PHPUnit: a framework for unitary testing
  • Behat: a framework for Behavior-Driven Development
  • PHPCS/CBF: code sniffer and code beautifier
  • Faker: fake data generator
  • Psysh: a runtime developer console (CLI) full of amazing features
  • Composer: dependency management and other useful features
  • Packagist: package repository
  • Twig: template engine

The title was really pretentious, I know. What I really wanted to show here is that PHP is evolving and the ecosystem is evolving at the same (maybe faster) pace.