phpgt/dom

The modern DOM API for PHP projects.

Maintainers

Details

github.com/PhpGt/Dom

Source

Issues

Fund package maintenance!
PhpGt

Installs: 1 007 673

Dependents: 23

Suggesters: 0

Security: 0

Stars: 78

Watchers: 6

Forks: 19

Open Issues: 9


README

The modern DOM API for PHP 7 projects

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.

Build status Code quality Code coverage Current version PHP.Gt/Dom documentation

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>' error-prone 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
use Gt\Dom\HTMLDocument;
use Gt\Dom\HTMLElement\HTMLSpanElement;
require "vendor/autoload.php";

$html = file_get_contents("name.html");
$document = new HTMLDocument($html);

if(isset($_GET["name"])) {
	/** @var HTMLSpanElement $span */
	$span = $document->querySelector(".name-output");
	$span->innerText = $_GET["name"];
}

echo $document;

Features at a glance

Known limitations / W3C spec compliance

This repository aims to be as accurate as possible to the DOM specification at https://dom.spec.whatwg.org/ - as of v3.0.0 there are no known inconsistencies.

The DOM specification does however define functionality that is only possible to implement on the client-side. For example, HTMLInputElement::files returns a FileList that enumerates all files that are selected by the user through the browser's interface. This kind of functionality is impossible to implement server-side, but has been stubbed out for consistency with the specification. Attempting to use client-side functionality within this library throws a ClientSideOnlyFunctionalityException.

The following classes extend the ClientSideOnly base class:

  • AudioTrackList
  • CSSStyleDeclaration
  • FileList
  • MediaController
  • MediaError
  • MediaStream
  • StyleSheet
  • TextTrack
  • TextTrackList
  • TimeRanges
  • ValidityState
  • VideoTrackList
  • WindowProxy

Data binding and 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 and data binding through custom elements and template attributes, introducing serverside functionality similar to that of WebComponents.