magento / dom
The modern DOM API for PHP 7 projects.
Requires
- php: >=7.1
- ext-dom: *
- ext-libxml: *
- ext-mbstring: *
- magento/cssxpath: *
- psr/http-message: 1.*
Requires (Dev)
- phpunit/phpunit: 7.*
Conflicts
- phpgt/dom: *
- dev-master
- 224.x-dev
- v2.1.7.x-dev
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v1.1.2
- v1.1.1
- v1.1.0
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- v0.4.0
- v0.3.2
- v0.3.1
- v0.3.0
- v0.2.1
- v0.2.0
- v0.1.2
- v0.1.1
- v0.1.0
- v0.0.3
- v0.0.2
- v0.0.1
- dev-240-innerhtml
- dev-dependabot/composer/phpunit/phpunit-8.5.2
- dev-github-actions
- dev-property-attribute
- dev-trait-constant
- dev-update-deps
- dev-circleci
- dev-protected-live-property
- dev-get-set-value
- dev-214-format-output
- dev-58-streaminterface
- dev-efficiency
This package is auto-updated.
Last update: 2024-10-25 06:41:30 UTC
README
Modern DOM API.
Built on top of PHP's native DOMDocument, this project provides access to modern DOM APIs, as you would expect working with client-side code in the browser.
Performing DOM manipulation in your server-side code enhances the way dynamic pages can be built. Utilising a standardised object-oriented interface means the page can be ready-processed, benefitting browsers, webservers and content delivery networks.
Example usage: Hello, you!
Important note: the example shown here is for illustrative purposes, but using the DOM to directly set data to elements' values tightly couples the logic to the view, which is considered bad practice. Please see the DomTemplate library for a more robust solution to binding data to the DOM.
Consider a page with a form, with an input element to enter your name. When the form is submitted, the page should greet you by your name.
This is a simple example of how source HTML files can be treated as templates. This can easily be applied to more advanced template pages to provide dynamic content, without requiring non-standard techniques such as {{curly braces}}
for placeholders, or echo '<div class='easy-mistake'>' . $content['opa'] . '</div>'
horrible HTML construction from within PHP.
Source HTML (name.html
)
<!doctype html> <h1> Hello, <span class="name-output">you</span> ! </h1> <form> <input name="name" placeholder="Your name, please" required /> <button>Submit</button> </form>
PHP used to inject your name (index.php
)
<?php require "vendor/autoload.php"; $html = file_get_contents("name.html"); $document = new \Gt\Dom\HTMLDocument($html); if(isset($_GET["name"])) { $document->querySelector(".name-output")->innerText = $_GET["name"]; } echo $document->saveHTML();
Features at a glance
- DOM level 4 classes:
HTMLDocument
Element
HTMLCollection
- and more extended DOM classes
- Standardised traits to add functionality in accordance with W3C
- Reference elements using CSS selectors via
querySelector
(All
) - Add/remove/toggle elements' classes using
ClassList
Element
Nodes within the document traversable with W3C properties:Element::remove()
to detach it from the document- Add elements around another using
Element::before()
andElement::after()
- Replace an element in place using
Element::replaceWith()
- Standard collection properties on the
HTMLDocument
:
Page template features
This repository is intended to be as accurate to the DOM specification as possible. An extension to the repository is available at https://php.gt/domtemplate which adds page templating through custom elements and template attributes, introducing serverside functionality similar to that of WebComponents.