Изменяемая конфигурация — PHP: Объектно-ориентированный дизайн

• Создание нового объекта
• Сеттеры
• Новые опции на время запроса

Как мы выяснили в предыдущем уроке, многие объекты в ООП не являются абстракцией данных, а используются как способ сохранить конфигурацию для выполнения повторяющихся действий, таких как генерация HTML из Markdown или определение города по IP. Конфигурация осуществляется через передачу опций в конструктор объекта, а сами опции хранятся внутри и используются для всех последующих вызовов.

<?php

// timeout устанавливает ограничение в одну секунду на длительность запроса
$ipgeo = new IpGeo(['timeout' => 1000]);
// Возвращает гео-информацию на основе ip-адреса
$ipgeo->resolve('123.4.3.2');

Но что если для конкретного запроса, нужно временно установить опции, отличные от тех, что были переданы в конструктор? Для выхода из этой ситуации есть три возможных решения.

Создание нового объекта

Самое простое решение сводится к созданию нового объекта в том месте где нам нужно. Это решение хоть и простое, но обладает рядом недостатков. Главный недостаток связан с невозможностью подмены реализации (тот самый полиморфизм, о котором мы будем говорить в будущем), так как объект создается не на этапе конфигурирования системы, а в том месте, где происходит вызов. Это, в свою очередь, ведёт к тому, что придётся дублировать общие опции, а тестирование станет затруднительным (если не невозможным).

<?php

$ipgeo = new IpGeo(['timeout' => 10]);
$ipgeo->resolve('123.4.3.2');

Сеттеры

Самый страшный вариант связан с использованием сеттеров.

<?php

$ipgeo = new IpGeo(['timeout' => 1000]);

// В одной части программы
$ipgeo->resolve('123.4.3.2');

// В другой части программы
$ipgeo->setOption('timeout', 10);
$ipgeo->resolve('123.4.3.2');

Изменяемое состояние — самое сложное, что есть в программировании. Его наличие приводит практически ко всем проблемам, с которыми мы встречаемся, и создает трудноотловимые и опасные баги. Догадайтесь, что пойдёт не так после выполнения последних двух строк? Наш объект $ipgeo используется совместно всеми частями системы, из этого следует, что его изменение в одном месте, повлияет на все последующие вызовы. В случае работы с Markdown всё может быть ещё опаснее, так как неправильный вывод порождает дыры в безопасности, а конкретно — возможность провести XSS:

<?php

$md = new Markdown(['sanitize' => true]);

// В одной части программы
$md->render($markdown)

// В другой части программы отключаем санитайз
$md->setOption('sanitize', false);
$md->render($markdown2)

sanitize — флаг, отвечающий за включение безопасного рендеринга. Если его выключить, то теги script вставленные в Markdown отобразятся как есть. Такое иногда нужно и допустимо для своего собственного текста (например, на Хекслете это уроки), но недопустимо для текста, который вводят пользователи. Изменение объекта md создает дыру в безопасности. Избежать её можно не забыв вернуть опцию обратно:

<?php

$md = new Markdown(['sanitize' => true]);

// В одной части программы
$md->render($markdown);

// В другой части программы отключаем санитайз
$md->setOption('sanitize', false);
$md->render($markdown2);
$md->setOption('sanitize', true);

В силу человеческого фактора, программист обязательно забудет это сделать. Такой код, в котором сначала что-то меняется в одну сторону, а потом восстанавливается обратно, почти всегда говорит о проблемах архитектуры и его можно написать безопасно.

Новые опции на время запроса

Правильный способ решает все проблемы указанные выше. Его использование основано на передаче дополнительного параметра в метод. Этот параметр содержит временные опции, которые применяются только для данного запроса.

<?php

$md = new Markdown(['sanitize' => true]);

// В одной части программы
$md->render($markdown);

// В другой части программы отключаем санитайз на время выполнения запроса
$md->render($markdown2, ['sanitize' => false]);
$md->render($markdown3); // sanitize по прежнему равен true

Теперь все в порядке. Sanitize включён глобально, но в конкретном запросе он был переопределён $md->render($markdown, ['sanitize' => false]) и это никак не отражается на последующих вызовах метода render.

---

Остались вопросы? Задайте их в разделе «Обсуждение»

Вам ответят команда поддержки Хекслета или другие студенты