https://github.com/oscarotero/html
PHP library to generate HTML code
https://github.com/oscarotero/html
html html-templating
Last synced: 11 months ago
JSON representation
PHP library to generate HTML code
- Host: GitHub
- URL: https://github.com/oscarotero/html
- Owner: oscarotero
- License: mit
- Created: 2019-04-27T11:18:40.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-12-05T18:06:24.000Z (over 6 years ago)
- Last Synced: 2025-03-18T16:04:04.492Z (over 1 year ago)
- Topics: html, html-templating
- Language: PHP
- Size: 32.2 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# html
PHP library to generate HTML code
## Install
Note, PHP ~7.2 is required
```sh
composer require oscarotero/html
```
## Usage
```php
namespace Html;
//Create a div
$div = div();
//Render the div
echo $div;
//
//Create a div with text content
echo div('Hello world');
//
Hello world
//Create a div with more text content
echo div('Hello', ' world');
//
Hello world
//HTML entities are escaped
echo div('Hello', ' ');
//
Hello <world>
//Use the function raw() to do not escape html entities
echo div('Hello', raw(' '));
//
Hello
//Create a div with html content
echo div('Hello ', strong('world'));
//
Hello world
//A div with many content
echo div(
h1('Hello world'),
p('This is a paragraph'),
ul(
li('And this is a list item'),
li('Other list item')
)
);
```
## Attributes
There are two ways to add attributes to the html tags: using an array as the first argument or using magic methods.
```php
//Add attributes using an array
echo div(['id' => 'foo'], 'Hello world');
//Or add attributes with magic methods
echo div('Hello world')->id('foo');
//Both examples outputs:
Hello world
```
All attributes with `null` as value are omitted:
```php
//Add attributes using an array
echo div(['id' => null], 'Hello world');
//Or add attributes with magic methods
echo div('Hello world')->id(null);
//Both examples outputs:
Hello world
```
### Flags
In HTML, flags (or boolean attributes) are attributes that does not need a value. Use `boolean` values to add flags.
Example using array syntax:
```php
//Positive flag
echo div(['hidden' => true]);
//
//Negative flag
echo div(['hidden' => false]);
//
//A short method to add positive flags:
echo div(['hidden']);
//
//Mixing attributes and flags
echo div(['hidden', 'class' => 'foo']);
//
```
Example using magic methods:
```php
//Positive flag
echo div()->hidden(true);
//
//Negative flag
echo div()->hidden(false);
//
//A short method to add positive flags (true is not needed):
echo div()->hidden();
//
```
### Classes
Some attributes can contain several space-separated values, for example `class`. You can use an array to add classes:
```php
//Using an array
echo div(['class' => ['foo', 'bar']]);
//Using the magic method:
echo div()->class(['foo', 'bar']);
//Both examples return:
```
Use the `key => value` syntax to add classes under some conditions. Only if the value is evaluated as true, the class will be added:
```php
//Using an array
echo div([
'class' => [
'foo',
'bar',
'theme-blue' => true,
'error' => !empty($error)
]
]);
//Using the magic method:
echo div()->class([
'foo',
'bar',
'theme-blue' => true,
'error' => !empty($error)
]);
//Both examples output:
```
### data-* attributes
Any `data-*` attribute containing a non-scalable value, will be converted to json. Unlike flags, boolean values are included too:
```php
//Using an array
echo div([
'data-enabled' => true,
'data-other' => false,
'data-omitted' => null, //Null values are ommitted
'data-options' => ['foo', 'bar']
]);
//Using the special method `data()`
echo div()
->data('enabled', true),
->data('other', false),
->data('omitted', null),
->data('options', ['foo', 'bar']);
//Both examples output:
```
## Import/Export
Elements implements `JsonSerializable` and `Serializable` interfaces, so you can export them:
```php
$article = article(
header(
h1('Hello world')
),
div(['class' => 'content'],
p('This is an article')
)
);
//Export to JSON
$json = json_encode($article);
//Use the function array2Html to recreate the html from json:
$article = array2Html(json_decode($json, true));
//Serialize and unserialize
$ser = serialize($article);
$article = unserialize($ser);
```
## Other interfaces implemented
All elements that can contain children (not self-closing elements like `
` or `![]()
`) implement the following standard PHP interfaces:
### ArrayAccess
To access to the children elements using the array API.
```php
$div = div('First child', strong('Second child'), 'Third child');
echo $div[2]; //Third child
```
### IteratorAggregate
To iterate with the element:
```php
$div = div('First child', strong('Second child'), 'Third child');
foreach ($div as $child) {
echo $child;
}
```
### Countable
To use `count()`:
```php
$div = div('First child', strong('Second child'), 'Third child');
echo count($div); //3
```
Note that `NULL` children are discarded
```php
$div = div('First child', null, 'Third child');
echo count($div); //2
```