README

Подключение

Для добавления зависимости в проект на Laravel, используйте менеджер пакетов Composer:

composer require russsiq/laravel-dom-manipulator

Если в вашем приложении включен отказ от обнаружения пакетов в директиве dont-discover в разделе extra файла composer.json, то необходимо самостоятельно добавить следующее в файле config/app.php:

Провайдер услуг в раздел providers:

Russsiq\DomManipulator\ManipulatorServiceProvider::class,

Псевдоним класса (Facade) в раздел aliases:

'DOMManipulator' => Russsiq\DomManipulator\Facades\DOMManipulator::class,

Использование

Методы

Все публичные методы доступны через фасад DOMManipulator:

DOMManipulator::someMethod(example $someParam);

Список доступных публичных методов фасада DOMManipulator:

each
extractImages
remove
revisionPreTag
getContent

`each(string $name, callable $callback): self`

Выполнить замыкание над каждым узлом с заданным именем.

`extractImages(): array`

Извлечение массива путей изображений.

`getContent(): string`

Получить строковое представление содержимого текущего Документа.

`remove(string $name): self`

Удалить все теги, содержащие переданное имя.

`revisionPreTag(): self`

Скорректировать теги pre:

оставить единый класс для всех тегов;
преобразовать значения тегов в HTML-сущности.

Пример использования

Для инициализации класса-обертки Manipulator вы можете воспользоваться методом wrapAsDocument фасада DOMManipulator:

use Russsiq\DomManipulator\Facades\DOMManipulator;

// Предположим некое содержимое.
$content = '<h2>Velit rerum aut adipisci eius et est deserunt et et error</h2>'.PHP_EOL;
$content .= '<p>Dolore quidem <strong>dolorem</strong> ratione aut similique qui.</p>'.PHP_EOL;
$content .= '<pre>$manipulator = $this->createManipulator();</pre>'.PHP_EOL;
$content .= '<script>alert("Hello!");</script>'.PHP_EOL;

// Обернем содержимое как HTML-документ.
$result = DOMManipulator::wrapAsDocument($content)
    // Скорректируем теги `pre`.
    ->revisionPreTag()
    // Удалим нежелательные теги с их значениями.
    ->remove('script');

// Распечатаем результат.
print_r((string) $result);

// <h2>Velit rerum aut adipisci eius et est deserunt et et error</h2>
// <p>Dolore quidem <strong>dolorem</strong> ratione aut similique qui.</p>
// <pre class="ql-syntax" spellcheck="false">$manipulator = $this-&gt;createManipulator();</pre>

Тестирование

Для запуска тестов используйте команду:

composer run-script test

Для запуска тестов и формирования agile-документации, генерируемой в HTML-формате и записываемой в файл tests/testdox.html, используйте команду:

composer run-script testdox

Удаление пакета

Для удаления пакета из вашего проекта на Laravel используйте команду:

composer remove russsiq/laravel-dom-manipulator

Лицензия

laravel-dom-manipulator – программное обеспечение с открытым исходным кодом, распространяющееся по лицензии MIT.

russsiq / laravel-dom-manipulator

Maintainers

Details