PHP: полный мануал с примерами, функциями и ООП

<?php
declare(strict_types=1);

$doc = tidy_parse_string(
                    '<!doctype html><html><head><title>Card</title></head><body><img src="card.png"></body></html>',
                    ['accessibility-check' => 2, 'tidy-mark' => false],
                    'utf8'
                );
                $doc->cleanRepair();
                $doc->diagnose();
                echo tidy_access_count($doc) > 0 ? "manual review
" : "no signal
";

manual review

Счётчик используется как маршрут проверки; решение о корректном alt принимает человек по смыслу изображения. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string(
                    '<html><head><title>X</title></head><body><img src="x.png"><a href="#">x</a></body></html>',
                    ['accessibility-check' => 2, 'tidy-mark' => false],
                    'utf8'
                );
                $doc->cleanRepair();
                $doc->diagnose();
                $count = tidy_access_count($doc);
                echo "accessibility signals: ", $count > 0 ? 'present' : 'none', "
";

accessibility signals: present

Не привязывайте бизнес-решение к точному числу: набор проверок меняется вместе с libTidy. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

set_error_handler(static fn() => true);
                $doc = tidy_parse_string('<p>Item</p>', 'bad-tidy.cfg', 'utf8');
                restore_error_handler();
                echo tidy_config_count($doc), " config errors
";

2 config errors

Файл содержит неизвестный ключ и неверное значение wrap. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Item</p>', 'tidy.cfg', 'utf8');
                echo tidy_config_count($doc) === 0 ? "config accepted
" : "config rejected
";

config accepted

Конфигурация хранится рядом с импортёром и версионируется как код. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string(
                    '<!doctype html><html><head><title>X</title></head><body><widget>42</widget></body></html>',
                    ['tidy-mark' => false],
                    'utf8'
                );
                $doc->cleanRepair();
                echo tidy_error_count($doc) > 0 ? "reject import
" : "accept import
";

reject import

Tidy не знает элемент и может удалить его; публикация без проверки потеряет данные. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo tidy_error_count($doc), " errors
";

0 errors

Нулевой счётчик относится к синтаксису Tidy, а не к ссылкам, бизнес-данным или безопасности. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p><b>Sale</p>', ['show-body-only' => true, 'wrap' => 0, 'tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                $html = tidy_get_output($doc);
                echo str_contains($html, '<b>Sale</b>') ? "ready to save
" : "not ready
";

ready to save

В базу можно записать $html, а исходник и диагностику оставить для аудита. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Preview</p>', ['show-body-only' => true, 'tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo tidy_get_output($doc) === (string) $doc ? "same markup
" : "different
";

same markup

Явная функция лучше показывает намерение в адаптере, строковое приведение короче в шаблоне. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p><b>Sale</p>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo tidy_warning_count($doc) > 0 ? "review repairs
" : "no repairs
";

review repairs

Пропущенные doctype/title и незакрытый тег дают предупреждения, даже если итог можно вывести. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo tidy_warning_count($doc), " warnings
";

0 warnings

Такой результат удобно использовать в тесте собственного шаблона. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                $doc->parseString('<p>Order</p>', ['show-body-only' => true, 'tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo str_contains((string) $doc, '<p>Order</p>') ? "loaded
" : "empty
";

loaded

Пошаговый объект нужен, когда после parse будут диагностика и обход дерева. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

try {
                    new tidy('missing-page.html');
                    echo "loaded
";
                } catch (Exception $error) {
                    echo "file not loaded
";
                }

file not loaded

В отличие от parseFile(), конструктор текущего PHP бросает Exception при невозможности загрузить файл. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $body = $doc->body();
                echo $body?->name ?? 'missing', "
";

body

Оператор ?-> безопасно возвращает null, если узла нет. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<main><h1>Guide</h1><p>Text</p></main>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                $body = tidy_get_body($doc);
                echo $body !== null && $body->hasChildren() ? $body->child[0]->name . "
" : "empty
";

main

Процедурный псевдоним возвращает тот же тип узла. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                $doc->parseString('<p><b>Sale</p>', ['show-body-only' => true, 'wrap' => 0, 'tidy-mark' => false], 'utf8');
                $ok = $doc->cleanRepair();
                echo $ok && str_contains((string) $doc, '<b>Sale</b>') ? "fixed
" : "failed
";

fixed

Первый результат видим: в строке появился закрывающий </b>. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<ul><li>One<li>Two</ul>', ['show-body-only' => true, 'wrap' => 0, 'tidy-mark' => false], 'utf8');
                $ok = tidy_clean_repair($doc);
                echo $ok && substr_count((string) $doc, '</li>') === 2 ? "two items closed
" : "unexpected
";

two items closed

Псевдоним полезен в старом процедурном коде; результат тот же. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p><b>Sale</p>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                $ok = $doc->diagnose();
                echo $ok && str_contains((string) $doc->errorBuffer, 'Tidy found') ? "summary added
" : "no summary
";

summary added

В production UI обычно показывают очищенный отчёт без абсолютных путей. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<img src="x.png">', ['accessibility-check' => 2, 'tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                tidy_diagnose($doc);
                echo tidy_access_count($doc) > 0 ? "access notes added
" : "none
";

access notes added

Эта проверка даёт сигналы, а не сертификат доступности. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['indent' => true, 'wrap' => 120, 'tidy-mark' => false], 'utf8');
                $config = $doc->getConfig();
                echo "indent=", $config['indent'], "; wrap=", $config['wrap'], "
";

indent=1; wrap=120

Число 1 — нормализованное enum/boolean значение текущей libTidy. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['tidy-mark' => false], 'utf8');
                $config = tidy_get_config($doc);
                echo count($config), " options
";

103 options

Число относится к проверенной libTidy 5.8.0; приложение не должно жёстко зависеть от него. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo $doc->getHtmlVer() === 500 ? "HTML5
" : "other
";

HTML5

Проверка полезна для миграции старых шаблонов. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo "detected code: ", tidy_get_html_ver($doc), "
";

detected code: 500

Для человекочитаемого отчёта приложение само сопоставляет код с названием. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['wrap' => 120, 'tidy-mark' => false], 'utf8');
                echo "wrap=", $doc->getOpt('wrap'), "
";

wrap=120

Для машинной проверки значение сохраняется без преобразования в текст yes/no. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['tidy-mark' => false], 'utf8');
                try {
                    tidy_getopt($doc, 'not-real');
                    echo "found
";
                } catch (ValueError $error) {
                    echo "unknown option
";
                }

unknown option

PHP 8 выбрасывает ValueError; тихий fallback скрыл бы ошибку конфигурации. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['tidy-mark' => false], 'utf8');
                $help = $doc->getOptDoc('wrap');
                echo is_string($help) && str_contains($help, 'right margin') ? "wrap help found
" : "missing
";

wrap help found

Текст англоязычный и может содержать HTML; в JSON API его лучше преобразовать в plain text. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['tidy-mark' => false], 'utf8');
                try {
                    $doc->getOptDoc('not-real');
                    echo "found
";
                } catch (ValueError $error) {
                    echo "unknown option
";
                }

unknown option

Пример отражает фактическое поведение PHP 8.5, более строгое, чем старое описание false. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                echo $doc->getRelease(), "
";

2021/07/10

В проверенном окружении ext/tidy использует libTidy 5.8.0. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

echo "PHP ", PHP_MAJOR_VERSION, '.', PHP_MINOR_VERSION, "; Tidy ", tidy_get_release(), "
";

PHP 8.5; Tidy 2021/07/10

Такая строка полезнее сообщения «у меня работает»: она фиксирует обе версии. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo $doc->getStatus(), "
";

0

Ноль подходит для теста собственного шаблона. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><title>X</title><widget>42</widget>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo tidy_get_status($doc) === 2 ? "errors
" : "other
";

errors

При status 2 импортёр сохраняет исходник и не публикует изменённый документ автоматически. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $head = $doc->head();
                echo $head?->child[1]->name ?? 'missing', "
";

title

В этом точном fixture первым ребёнком является meta, вторым — title; в общем коде ищут по имени. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Fragment</p>', ['tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo tidy_get_head($doc)?->name ?? 'missing', "
";

head

Tidy может добавить отсутствующую ветку; это важно отличать от исходного документа. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                echo $doc->html()?->name ?? 'missing', "
";

html

Это элемент html, а не служебный root-документ. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $html = tidy_get_html($doc);
                echo implode(',', array_map(static fn(tidyNode $node): string => $node->name, $html?->child ?? [])), "
";

head,body

Преобразование узлов в имена делает путь дерева видимым. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<?xml version="1.0"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>X</title></head><body><p>Y</p></body></html>', ['tidy-mark' => false], 'utf8');
                echo $doc->isXhtml() ? "xhtml
" : "not xhtml
";

xhtml

Пример содержит и XML declaration, и XHTML doctype/namespace. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                echo tidy_is_xhtml($doc) ? "xhtml
" : "html
";

html

Обычный HTML5 направляется в HTML pipeline. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<?xml version="1.0"?><catalog><item>one</item></catalog>', ['input-xml' => true, 'output-xml' => true, 'tidy-mark' => false], 'utf8');
                echo $doc->isXml() ? "xml
" : "not xml
";

xml

Ключ input-xml запрещает HTML-эвристике выбрасывать пользовательские элементы. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                echo tidy_is_xml($doc) ? "xml
" : "html
";

html

Развилка происходит до DOM/XPath этапа. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                $ok = $doc->parseFile('template.html', ['show-body-only' => true, 'tidy-mark' => false], 'utf8');
                $doc->cleanRepair();
                echo $ok && str_contains((string) $doc, '<p>Imported</p>') ? "parsed
" : "failed
";

parsed

Fixture имитирует файл из export/import pipeline. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                set_error_handler(static fn() => true);
                $ok = $doc->parseFile('missing.html');
                restore_error_handler();
                echo $ok ? "parsed
" : "not found
";

not found

В production сначала делают is_file() и проверяют, что путь остаётся внутри import-каталога. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                $ok = $doc->parseString('<p>Hello</p>', ['show-body-only' => true, 'tidy-mark' => false], 'utf8');
                echo $ok ? "parsed
" : "failed
";

parsed

На этом этапе объект уже содержит дерево; repair можно запускать отдельно. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = new tidy();
                try {
                    $doc->parseString('<p>Hello</p>', ['not-real' => true], 'utf8');
                    echo "parsed
";
                } catch (ValueError $error) {
                    echo "bad config
";
                }

bad config

Опечатка не замалчивается; config исправляют до импорта. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<p>Text</p>', ['tidy-mark' => false], 'utf8');
                $buffer = $doc->errorBuffer;
                echo is_string($buffer) && str_contains($buffer, 'missing <!DOCTYPE>') ? "doctype warning
" : "none
";

doctype warning

В UI можно вывести очищенные строки, а полный буфер сохранить в техническом логе. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><title>X</title><widget>42</widget>', ['tidy-mark' => false], 'utf8');
                $buffer = tidy_get_error_buffer($doc);
                echo is_string($buffer) && str_contains($buffer, '<widget> is not recognized') ? "unknown widget
" : "none
";

unknown widget

Сообщение объясняет, почему итоговая строка могла потерять элемент. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$html = tidy::repairFile('card.html', ['show-body-only' => true, 'wrap' => 0, 'tidy-mark' => false], 'utf8');
                echo is_string($html) && str_contains($html, '<b>Sale</b>') ? "card repaired
" : "failed
";

card repaired

Исходный fixture остаётся неизменным; приложение решает, куда записать результат. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$html = tidy_repair_file('missing.html', ['show-body-only' => true], 'utf8');
                echo $html === false ? "no output
" : "unexpected
";

no output

Проверка === false отличает отказ от допустимой пустой строки. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$html = tidy::repairString('<p><b>Sale</p>', ['show-body-only' => true, 'wrap' => 0, 'tidy-mark' => false], 'utf8');
                echo trim((string) $html), "
";

<p><b>Sale</b></p>

Видимый результат: Tidy добавил </b> и </p>. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$html = tidy_repair_string('<p>Short note</p>', ['show-body-only' => true, 'wrap' => 0, 'tidy-mark' => false], 'utf8');
                echo str_contains((string) $html, '<html>') ? "document
" : "fragment
";

fragment

show-body-only решает частую проблему редакторов: не добавлять html/head/body вокруг поля. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $root = $doc->root();
                echo $root?->type === TIDY_NODETYPE_ROOT ? "root
" : "missing
";

root

Константа делает проверку понятнее магического числа 0. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><meta charset="utf-8"><title>Shop</title></head><body><p>Ready</p></body></html>', ['tidy-mark' => false], 'utf8');
                $root = tidy_get_root($doc);
                echo count($root?->child ?? []), " root children
";

2 root children

В fixture это doctype и html element. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

try {
                    new tidyNode();
                    echo "created
";
                } catch (Error $error) {
                    echo "private constructor
";
                }

private constructor

Это защищает дерево от узла без родителя, позиции и libTidy document. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$node = $doc->body();
echo get_class($node), ':', $node->name, "\n";

tidyNode:body

Объект создаёт расширение, а приложение начинает с body() или root(). Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$list = $doc->body()->child[0]->child[5];
$first = $list->child[0];
$next = $first->getNextSibling();
echo trim($next?->value ?? 'missing'), "\n";

<li>Two</li>

Видимый результат — соседний пункт списка. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$list = $doc->body()->child[0]->child[5];
$last = $list->child[1];
echo $last->getNextSibling() === null ? "end\n" : "more\n";

end

Null — условие остановки цикла по siblings. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$strong = $doc->body()->child[0]->child[0]->child[1];
$parent = $strong->getParent();
echo $parent?->name ?? 'missing', "\n";

p

Так диагностический UI может показать путь body > main > p > strong. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$root = $doc->root();
echo $root->getParent() === null ? "no parent\n" : "has parent\n";

no parent

Null задаёт естественную остановку подъёма. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$list = $doc->body()->child[0]->child[5];
$second = $list->child[1];
$previous = $second->getPreviousSibling();
echo trim($previous?->value ?? 'missing'), "\n";

<li>One</li>

Метод не пересобирает список и сохраняет исходный порядок tree. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$list = $doc->body()->child[0]->child[5];
$first = $list->child[0];
echo $first->getPreviousSibling() === null ? "start\n" : "before\n";

start

Null — штатная граница обхода назад. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$main = $doc->body()->child[0];
echo $main->hasChildren() ? "children\n" : "leaf\n";

children

После true безопасно дополнительно проверить/перебрать $main->child ?? []. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$comment = $doc->body()->child[0]->child[1];
echo $comment->hasChildren() ? "children\n" : "leaf\n";

leaf

Лист можно классифицировать через isComment() без рекурсии. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$list = $doc->body()->child[0]->child[5];
$first = $list->child[0];
echo $first->hasSiblings() ? "siblings\n" : "alone\n";

siblings

Дальше можно вызвать getNextSibling(). Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>One</title></head><body></body></html>', ['tidy-mark' => false], 'utf8');
                $title = $doc->head()->child[0];
                echo $title->hasSiblings() ? "siblings
" : "alone
";

alone

В точном fixture внутри head только title. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$asp = $doc->body()->child[0]->child[3];
echo $asp->isAsp() ? "asp\n" : "other\n";

asp

Мигратор может сформировать отдельный список устаревших вставок. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$php = $doc->body()->child[0]->child[2];
echo $php->isAsp() ? "asp\n" : "not asp\n";

not asp

Каждый предикат отвечает только за свой node type. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$comment = $doc->body()->child[0]->child[1];
echo $comment->isComment() ? trim($comment->value) . "\n" : "other\n";

<!--todo-->

Значение показывает точный комментарий. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$paragraph = $doc->body()->child[0]->child[0];
echo $paragraph->isComment() ? "comment\n" : "element\n";

element

HTML element проверяется отдельно через isHtml(). Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$paragraph = $doc->body()->child[0]->child[0];
echo $paragraph->isHtml() ? $paragraph->name . "\n" : "not element\n";

p

После true свойства name/id/attribute имеют HTML-смысл. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$text = $doc->body()->child[0]->child[0]->child[0];
echo $text->isHtml() ? "element\n" : "not element\n";

not element

Текст читают через value и isText(). Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$jste = $doc->body()->child[0]->child[4];
echo $jste->isJste() ? "jste\n" : "other\n";

jste

Код не выполняет содержимое, только обнаруживает. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$asp = $doc->body()->child[0]->child[3];
echo $asp->isJste() ? "jste\n" : "not jste\n";

not jste

Предикаты позволяют составить точный отчёт по legacy instructions. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$php = $doc->body()->child[0]->child[2];
echo $php->isPhp() ? "php instruction\n" : "other\n";

php instruction

Это обнаружение, а не выполнение кода. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$text = $doc->body()->child[0]->child[0]->child[0];
echo $text->isPhp() ? "php\n" : "text\n";

text

Обычный контент остаётся отдельным типом. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$text = $doc->body()->child[0]->child[0]->child[0];
echo $text->isText() ? trim($text->value) . "\n" : "not text\n";

Hello

Первый child p — текст до элемента strong. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.

<?php
declare(strict_types=1);

$doc = tidy_parse_string('<!doctype html><html><head><title>Shop</title></head><body><main><p id="lead">Hello <strong>world</strong></p><!--todo--><?php echo "x"; ?><% asp %><# jste #><ul><li>One</li><li>Two</li></ul></main></body></html>', ['tidy-mark' => false, 'wrap' => 0], 'utf8');
$strong = $doc->body()->child[0]->child[0]->child[1];
echo $strong->isText() ? "text\n" : "element\n";

element

Чтобы получить world, нужно спуститься к child strong. Пример выполнен один раз на изолированном PHP 8.5.11 NTS x64 с ext/tidy 8.5.11 и libTidy 5.8.0; внешняя сеть, пользовательские файлы и рабочий сайт не затрагиваются.