README

This package allows you to easily create HTML elements from PHP. It's inspired by David Walsh's blogpost but further improved.

use Vdhicts\HtmlElement\HtmlElement;

// Create new html element with attribute name
$selectElement = new HtmlElement('select');
$selectElement->setAttribute('name', 'something');
$selectElement->generate();

// Create new html element with text and attribute
$paragraphElement = new HtmlElement('p', 'text', ['class' => 'center']);

Requirements

This package requires PHP 7.4 or higher.

Installation

You can install the package via composer:

composer require vdhicts/html-element

Usage

A new html element can be created with:

use Vdhicts\HtmlElement\HtmlElement;

$containerElement = new HtmlElement('div');
$containerElement->setAttribute('class', 'container');

The element could contain text:

$containerElement->setText('Hello World');

The element could have one or more attributes:

// One attribute
$containerElement->setAttribute('class', 'container');

// Multiple attributes
$containerElement->setAttributes(['class' => 'container', 'role' => 'container']);

Or the element could contain another html element:

$colElement = new HtmlElement('div', '', ['class' => 'col-md-6']);
$rowElement = new HtmlElement('div', '', ['class' => 'row']);

$rowElement->inject($colElement);
$containerElement->inject($rowElement);

The text and attributes can also be added, which merges with existing text or attributes.

Methods

getTag or setTag to request or change the tag.
getAttributes or getAttribute(attribute) to retrieve all attributes with their values or one attributes with its value
setAttributes or setAttribute(attribute, value) to manipulate all attributes or just one.
addAttributeValue adds a value to an attributes.
removeAttributes or removeAttribute(attribute) to remove all attributes or just one.
removeAttributeValue(attribute, value) to remove one value from a attribute.
getText, addText or setText to retrieve, add or set the inner text.
inject to inject a Element into the current Element.
generate generates the Element and returns its string representation.
output echos the result of generate.

Tests

Unit tests are available in the tests folder. Run with:

composer test

When you want a code coverage report which will be generated in the build/report folder. Run with:

composer test-coverage

Contribution

Any contribution is welcome, but it should meet the PSR-12 standard and please create one pull request per feature/bug. In exchange, you will be credited as contributor on this page.

Security

If you discover any security related issues in this or other packages of Vdhicts, please email security@vdhicts.nl instead of using the issue tracker.

Support

If you encounter a problem with this parser or has a question about it, feel free to open an issue on GitHub.

License

This package is open-sourced software licensed under the MIT license.

About Vdhicts

Vdhicts is the name of my personal company for which I work as freelancer. Vdhicts develops and implements IT solutions for businesses and educational institutions.

vdhicts / html-element

Maintainers

Details