Ось так виглядає сучасний PHP

Заголовок справді претензійний, чи не так? Так, це так. Хоча я працюю з PHP роками, як я можу сказати, які найкращі практики та інструменти для роботи? Я не міг, але я збираюся це зробити.

Я бачу реальну зміну в тому, як розробники виконують свою роботу з PHP, не тільки мова різко змінюється, щоб стати більш зрілою та надійною з новими версіями та вдосконаленнями, але і вся екосистема навколо неї змінюється.

Створюються нові інструменти, бібліотеки, фреймворки та статті, визначаються шаблони, щоб зробити код більш елегантним та легким для розуміння. Кілька людей замислюються над способами, як зробити роботу (і ваше життя розробника) більш продуктивною, чистою та веселою.

Насправді я не рано застосовую нові тенденції, я приймаю новий інструмент лише тоді, коли впевнений, що за ним стоїть спільнота, і я справді думаю, що це покращить мою роботу. Завжди я намагаюся писати свій код, дотримуючись найкращих практик.

Через це мені знадобився час, щоб почати використовувати речі, такі як Composer та PHPUnit. Близько року тому, більш-менш, я відкрив своє серце для всіх цих блискучих нових речей.

Першим став PSR, потім Composer, PHPUnit, Travis-ci та кілька інших бібліотек та дивовижних інструментів. Зараз я навіть використовую IDE (Vim FTW, але PHPStorm з інтеграцією XDebug є обов’язковим для здорового робочого процесу)!

Що сучасного?

В Інтернеті є безліч статей про те, який жахливий PHP, як ваше життя було б жахливим, якби вам довелося працювати з PHP-кодом, як мова некрасива і що б ви ще не могли придумати!

Якщо ви збираєтеся працювати зі застарілим кодом, можливо, ваше життя буде не таким хорошим, але якщо у вас є можливість працювати над новим проектом і ви можете використовувати всі нові інструменти, ви побачите цей новий PHP Я буду говорити про.

У мене є кілька проблем із щоденною роботою з PHP, але не можна закривати очі на зміни, що відбуваються в мові, спільноті та екосистемі. Попереду довгий шлях, але в країні PHP все набуває зрілого значення.

Я почав створювати SDK для внутрішнього API у компанії, в якій я працюю, як проект для домашніх тварин, і вирішив дотримуватися найкращих практик. Більшість із них я вже робив, але я вніс незначні зміни в тому, як я роблю деякі речі. Ці зміни та те, що я дізнався за останній рік, є предметом цієї статті та того, що я називаю сучасним 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.