Хуки свойств легко показать и легко испортить. В ревью я вижу пять одних и тех же ошибок, поэтому показываю командам пять правил, каждое с кодом, который объясняет, зачем оно нужно. Примеры из микрофреймворка с 728 тестами, и в любом другом проекте они ведут себя так же.
Код: ATOM, лицензия GPL-3.0.
Правило 1: хуки свойств в PHP выполняются на каждое чтение
Хук выглядит как свойство, а стоит как метод, и цена метода к нему применяется целиком. Вот хук, который делает арифметику и потому хорош:
public string $method {
get => strtoupper($this->raw['REQUEST_METHOD'] ?? 'GET');
}
А вот хук, который плох, и дело не в стиле:
public array $headers {
get => $this->parseHeaders($this->raw);
}
Каждое чтение заново разбирает строку заголовков. Цикл по двенадцати заголовкам вызовет его двенадцать раз, и в вызывающем коде об этом ничего не говорит. Перед тем как писать хук, посчитайте чтения. Если хук делает настоящую работу, запоминайте результат внутри, чтобы свойство вело себя как поле, которое он заменил.
Правило 2: нормализация в сеттере, один раз
Валидация и чистка, размазанные по местам вызова, это способ получить один и тот же email в трёх видах в одной таблице. Правило ставится там, где значение входит в объект:
public string $email {
set (string $value) {
$this->email = strtolower(trim($value));
}
}
Теперь нормализуется каждое присваивание, включая то, которое написал разработчик, ни разу не открывавший модель. В этом и преимущество типизированного свойства перед договорённостью: правило едет вместе с типом.
Правило 3: выберите один путь доступа
Смесь $user->name и $user->getName() в одном классе учит следующего разработчика угадывать. Если свойство публичное и с хуком, геттеру работы не осталось, удаляйте. Если геттер нужен интерфейсу или контракту фреймворка, оставляйте геттер и не добавляйте хук, который его дублирует.
Одно правило, одна дверь. Две двери к одному значению это половина сделанного рефакторинга, которая осталась в коде.
Правило 4: никаких побочных эффектов в хуке
Геттер-хук, который пишет строку в лог, увеличивает счётчик или лениво грузит связь, превращает чтение в событие. Дальше рендер страницы отправляет письмо, а трейс начинается в шаблоне.
Чтения должны быть дешёвыми и повторяемыми. Запись живёт в методе, имя которого говорит, что он пишет. Компилятор это не проверит, и именно поэтому проверяет ревью.
Правило 5: хуки не заменяют валидацию на границе
Сеттер-хук срабатывает на присваивание, и это не то же самое, что проверка недоверенного ввода. DTO, собранный из $_POST, всё равно требует валидации с сообщением, которое человек прочитает, а колонка в базе всё равно требует ограничения.
Хуки выражают инварианты объекта, который уже держит осмысленные данные. Проверку между формой и таблицей они не заменяют, и сеттер-хук с исключением внутри это тяжёлый способ узнать правило.
Где хукам не место
Сущности, отображённые на широкую таблицу. Хуки на двадцати колонках добавляют шум и прячут поведение самой ORM.
Всё, что ходит в сеть или на диск, всё, где важен порядок чтений, и всё, что отладчик не покажет. Наберите три имени свойств в отладчике и посмотрите, какие сработали: это и есть проверка.
Как вводить их в существующий код
Начните с класса, у которого уже есть четыре однострочных геттера над одним полем. Замените это поле, прогоните тесты, остановитесь. Хуки распространяются примером, а код, где половина свойств с хуками, читается хуже любого из двух однородных вариантов.
Тот же инстинкт работает и за пределами свойств: держите один механизм и делайте его читаемым. Поэтому роутер в том же фреймворке компилирует таблицу маршрутов в один шаблон PCRE вместо перебора списка, и поэтому же правила именования у меня достаточно строгие, чтобы имя класса отвечало на первый вопрос ревью.
Если нужно обоснование таких решений, шесть архитектурных паттернов разбирают компромиссы, а заметка про правильные имена в коде про то, что ревьюер замечает первым.
Что почитать: заметки о выпуске PHP 8.5 и ATOM на GitHub, лицензия GPL-3.0.