УРОК · Стандарты и поддерживаемый код

Единый стиль и имена

Опубликовано Автор: Соловьёва Мария Андреевна

После Patterns каталог работает, но поисковый блок в public/index.php выбивается из отступов, а $id в add-note.php мало говорит о результате.

Разберём по шагам

Отступы показывают, что поиск находится внутри try, а имя $newNoteId сообщает, что вернул insertNote. Поправим только оформление и имя, сохранив ответы формы. PSR-12 служит ориентиром для читаемого PHP, но в проекте пока нет настроенного форматтера: php -l проверяет синтаксис, git diff --check — пробелы, а смысл правки нужно проверить глазами и запросом.

Слова, которые пригодятся

Стиль кода
Согласованные правила записи: отступы, пробелы и размещение блоков. Здесь отступ показывает, что поиск находится внутри try.
Смысловое имя
Название переменной, объясняющее её роль. $newNoteId обозначает id результата вставки, а не любое число.
Проверка синтаксиса
Запуск php -l, который находит ошибки разбора PHP-файла без выполнения страницы. Он не проверяет HTTP-ответ или данные SQLite.

Согласованный стиль помогает увидеть границу try и внутреннего if до чтения каждой строки. Полный пример заменяет только существующий поисковый блок; $_GET, mb_stripos, listNotes и ответ при ошибке остаются теми же. Комментарий о будущем переносе HTML стал неверным после First Project3, поэтому его удаление убирает ложную подсказку.

$newNoteId точнее, чем $id: функция insertNote возвращает идентификатор только что добавленной строки. В реальном проекте переименование проверяют поиском всех употреблений, синтаксисом и запуском. php -l не доказывает одинаковое поведение, а git diff --check не навязывает PSR-12; HTTP и CLI-проверки дополняют их.

Рабочий пример

    $notes = listNotes($pdo);
    $rawQuery = $_GET['q'] ?? '';
    $query = is_string($rawQuery) ? trim($rawQuery) : '';
    $searchError = !is_string($rawQuery) || mb_strlen($query, 'UTF-8') > 100
        ? 'Поиск: введите текст не длиннее 100 символов'
        : '';
    if ($searchError === '' && $query !== '') {
        $notes = array_values(array_filter(
            $notes,
            static fn (array $note): bool => mb_stripos($note['title'], $query, 0, 'UTF-8') !== false
        ));
    }

Практика

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

  1. В Visual Studio Code откройте notes-php после Patterns через Файл → Открыть папку. В Терминал → Создать терминал выполните php -v; используется PHP из начального PHP-блока. Если команда не найдена, вернитесь к установке CLI из PHP1, откройте новый терминал и повторите php -v: без работающего PHP не переходите к проверкам. В public/index.php замените только блок от $notes = listNotes($pdo); до закрывающей } поиска перед catch примером. Две старые строки комментария после catch о переносе HTML из первого проекта удалите: этот перенос уже завершён. Сохраните Ctrl+S и выполните php -l public/index.php.
  2. В add-note.php замените имя $id на $newNoteId ровно в присваивании результата insertNote и в строке echo; другие id и файлы не трогайте. Сохраните Ctrl+S, выполните php -l add-note.php. Перед копированием запишите число строк обычной базы командой php -r '$p = require "src/db.php"; echo $p->query("SELECT COUNT(*) FROM notes")->fetchColumn(), PHP_EOL;'. Из корня сделайте Copy-Item -LiteralPath data/notes.sqlite -Destination data/style-test.sqlite, задайте $env:NOTES_DB_PATH = (Resolve-Path -LiteralPath data/style-test.sqlite).Path и выполните php add-note.php: ожидайте новый числовой id и список. Затем Remove-Item Env:NOTES_DB_PATH и повторите команду подсчёта: число в обычной базе должно совпасть с записанным до копирования.
  3. Запустите php -S localhost:8000 -t public из корня. Во втором терминале PowerShell выполните curl.exe -i -G --data-urlencode "q=нет-такого-названия" http://localhost:8000/: ожидайте 200 и «Ничего не найдено.». Выполните curl.exe -i --data "title=Style&body=Check" http://localhost:8000/: ожидайте 303 Location: /. Остановите сервер Ctrl+C, выполните git diff --check и git diff -- public/index.php add-note.php. Если изменения Patterns ещё не закоммичены, diff включает и их; сравните именно текущую редактуру по месту, не сбрасывайте прошлую работу.

Как проверить себя

Оба PHP-файла проходят php -l; CLI на тестовой SQLite выводит новый id, поиск по-прежнему даёт 200, успешный POST — 303. В текущей редактуре изменились отступы, устаревшие комментарии и одно имя.

Если не получилось
  • php не найден? В PHP1 описана установка CLI на Windows; после изменения PATH откройте новый терминал и повторите php -v.
  • Parse error после замены? Проверьте, что закрывающая } поиска осталась внутри try, а следующая строка начинается с } catch.
  • В обычной базе появилась учебная строка CLI? Перед php add-note.php проверьте NOTES_DB_PATH в том же терминале; опыт должен идти на data/style-test.sqlite.