Ето как изглежда съвременният PHP

Заглавието е наистина претенциозно, нали? Да, това е. Въпреки че работя с PHP от години, как бих могъл да заявя кои са най-добрите практики и инструменти за работата? Не можах, но ще го направя.

Виждам истинска промяна в начина, по който разработчиците си вършат работата с PHP, не само, че езикът се променя драстично, за да стане по-зрял и стабилен с нови версии и подобрения, но и цялата екосистема около него се променя.

Създават се нови инструменти, библиотеки, рамки и статии, дефинират се модели, за да се направи кодът по-елегантен и лесен за разбиране. Няколко души обмислят начини да направят работата (и живота ви като разработчик) по-продуктивни, чисти и забавни.

Всъщност не съм ранен възприемач на нови тенденции, всъщност приемам нов инструмент само когато съм сигурен, че зад него стои общност и наистина мисля, че ще подобри работата ми. Това, което винаги правя, е да се опитам да напиша кода си, следвайки най-добрите практики.

Поради това ми отне време да започна да използвам неща като Composer и PHPUnit. Преди около година, горе-долу, отворих сърцето си за всички онези лъскави нови неща.

Първо се появи PSR, след това Composer, PHPUnit, Travis-ci и няколко други библиотеки и невероятни инструменти. Сега дори използвам IDE (Vim FTW, но PHPStorm с интеграция XDebug е задължително условие за нормален работен процес)!

Какво е модерно?

В мрежата има тонове статии за това колко ужасен е PHP, как животът ви би бил ужасен, ако трябва да работите с PHP код, как езикът е грозен и каквото друго можете да измислите!

Ако ще работите със стария код, може би животът ви няма да е толкова добър, но ако имате възможност да работите по нов проект и сте в състояние да използвате всички нови инструменти, ще видите този нов PHP Ще говоря за.

Имам няколко проблема с ежедневната работа с PHP, но човек не може да си затваря очите за промените, които се случват в езика, общността и екосистемата. Предстои дълъг път, но нещата стават зрели в страната на PHP.

Започнах да създавам SDK за вътрешен API във фирмата, за която работя, точно като проект за домашни любимци и реших да следвам най-добрите практики. Повечето от тях вече правех, но направих няколко промени в начина, по който правя някои неща. Тези промени и това, което научих през последната година, са предмет на тази статия и това, което аз наричам Modern PHP.

Нека започнем с работния процес

Както казах, аз съм новодошъл в това IDE нещо, но това беше любов от пръв поглед. PHPStorm е страхотно-страхотен софтуер. Това е първата ми и единствена IDE. Това беше първият ми опит и дори не се наложи да опитам друг.

Интеграцията с XDebug е перфектна, PHP разделителна способност на пространството от имена, композиционна интеграция, git интеграция, автоматично попълване, генериране на код, рефакторинг на код. Можех да продължавам да продължавам.

Не мисля, че трябва да използвате IDE, всъщност този момент е напълно личен. Трябва да използвате всичко, което отговаря на вашите нужди - Vim, Atom, Emacs, Bracket, NetBeans, PHPStorm, Eclipse, каквото и да е. Две важни точки тук са производителността и ергономичността. Вашият IDE / текстов редактор трябва да е там, за да ви помогне.

За мен обаче чудесен момент е интегрирането на дебъгер. За да напишете код за големи проекти (всъщност и за малки), трябва да използвате достоен дебъгер. Да забравим тези var_dumps и print_rs. Трябва да прокарате тези променливи по време на изпълнение, да анализирате следи от стека, да зададете точки на прекъсване. Тези неща са от съществено значение и улесняват развитието и рефакторинга.

Дори не знам дали тук има други опции, XDebug има всичко необходимо. Имате ли няколко минути? Ако все още не сте направили това, отделете малко време, за да настроите XDebug и да го интегрирате във вашия IDE или текстов редактор. Започнете да отстранявате грешки в кода си, като използвате правилните инструменти.

Другият инструмент, на който искам да ви обърна внимание, е GitHub. Може да се напише още една цяла статия за това колко добри са Git и GitHub и защо трябва да започнете да поддържате кода си под система за версии. Но искам да ви покажа друга причина.

Фокусът тук е върху интеграцията.

Има няколко инструмента, които се интегрират с GitHub и трябва да започнете да ги използвате. Тези инструменти могат да генерират показатели, да изпълняват тестове, да изпълняват задачи за вас по време на непрекъснат процес на интеграция и да правят всякакви неща във вашия работен процес. Интеграцията е добра причина да започнете да използвате GitHub, всички останали са обект за друг момент.

Управление на зависимостта

Друг момент в тази модерна PHP екосистема е управлението на зависимостите, а Composer е инструментът за работата.

Композиторът е на 5 години, но ми се струва, че масовото осиновяване се е случило преди няколко години. Може би защото не съм рано приет или може би защото разработчиците на PHP не са склонни да се променят.

Този инструмент осигурява преден край на Packagist, който е хранилище на PHP пакети, състоящо се от PHP библиотеки, проекти и инструменти, чийто изходен код се съхранява в Github (или на други места като BitBucket).

Всички библиотеки, за които говоря в тази статия, и може би един от онези ваши проекти за домашни любимци, могат да бъдат добавени към вашия проект с просто

$ composer require package_vendor/package_name

Ако не познавате доставчика на даден пакет, можете да searchго намерите и да инсталирате правилния.

$ composer search package_name

Композиторът би бил чудесен инструмент, ако просто е свършил тази работа, управлявал зависимости, но прави много повече. Отделете време, за да инсталирате Composer и прочетете документацията.

Интерфейсът на командния ред е направен правилно

Много обичам да пробвам идеи бързо, използвайки CLI интерфейси. За мен един от най-големите инструменти за REPL е IPython. Той ви помага за автоматично попълване на вашия код, позволява ви лесно да дефинирате функции, улеснявате достъпа до документацията и няколко други невероятни функции. Недостатъкът за нас е, че инструментът е за Python, а не за PHP.

В света на PHP имаме нещо, наречено „интерактивен режим“, до което може да се осъществи достъп чрез терминал, само с въвеждане

$ php -aInteractive mode enabled
php >

В този момент сте в интерактивен режим и можете да започнете да тествате нещо. Работи, но инструментът е твърде неинтуитивен. Опитах го няколко пъти, но тъй като знаех какво може да направи IPython, не можах да продължа да го използвам.

За наш късмет, на блока има страхотен нов CLI (интерфейс на командния ред) и името му е Psysh. Psysh е невероятен инструмент, пълен с интересни функции и може да бъде инсталиран глобално или за всеки проект с помощта на композитор.

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

Тази мантра си казвам всеки ден. Подобно на много хора, аз не тествам кода си толкова, колкото TDD предлага. Влизам в тестването сега и го правя през последната половин година и предстои дълъг път.

Реших да науча за тестовете, когато работя със сложен наследствен проект. Кодът беше толкова крехък и твърд, че всеки път, когато добавяхме някакъв код, той нарушаваше нещо. Нова функция? Приложете и счупете нещо! Отстраняване на грешка? Създайте още един.

Това беше голям проблем, който обсъдих в друга статия и ме накара да започна да давам шанс на тестовете.

Първият инструмент, който ми беше представен, беше PHPUnit. Както е посочено в официалния сайт

PHPUnit е ориентирана към програмист тестова рамка за PHP.

Това е екземпляр на архитектурата xUnit за модулни тестови рамки.

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.