Compile PHP Classes for HTML Elements

INFO

Please note that code generation is not necessary, if you haven't made any changes to the HTML5 specification or the *.tpl.php files.

This repository uses the HTML5 specifications to auto-generate PHP Classes for HTML Elements and Attributes. You can modify the file HTML specifications to your needs src/Resources/definitions/html5.yaml and then re-build the HTML Element classes. You can also modify the class generation templates in the folder src/Resources/templates to change the class signature.

Requirements

• PHP 8.4+ installed

Basic use

To (re)generate all classes and enums from the HTML5 specification, run the following command.

php vendor/bin/ext-html

Sub commands

There are more parameters available for code generation.

Details

php vendor/bin/ext-html make:enums # only generates enums as specified in the HTML5 schema
php vendor/bin/ext-html make:classes a # only generates the Html\Element\Anchor class, no enums
php vendor/bin/ext-html make:classes # generates all classes, no enums
php vendor/bin/ext-html make:all # generates both enums and classes
php vendor/bin/ext-html generate:all twig,storybook templates # generates all twig templates and storybook stories, and saved them into templates folder
php vendor/bin/ext-html generate:composed twig,storybook templates # generates composed templates based on content model (eg <table> with <tr>, <td>, etc), and saves them into templates folder
php vendor/bin/ext-html merge:specs custom/schema.yaml destination/path.yaml # merges a custom regex or element-based specification into the html5.yaml file
php vendor/bin/ext-html watch source/path dest/path # component builder. watches for component yaml changes, and generates templates on the fly

Custom HTML Specification File

WARNING

Parameter isn't implemented yet.

INFO

@todo allow parameter or config file (for when in symfony/laravel/other frameworks)...

If you want to use your own HTML5 specification file, you can use the --specification option.

php vendor/bin/ext-html make:all --specification path/to/my-custom-html5-specification.yaml

This especially interesting if you:

• want to merge your own CSS framework specifications into the PHP classes.
• have different requirements (eg. want to compile the ARIA roles and properties) or the WCAG specifications directly into the HTML element classes.
• simply want to enrich the PHP classes with your own attributes, such as instructions for faker, or other meta information.
• just modified or added your own tpl.php files and want to re-generate the classes.

Custom Templates for class generation

WARNING

Not implemented yet.

This library can be extended with custom templates for class generation.

INFO

@todo Add a config file where one can specify paths.