Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manychois/simdom
A simple-to-use PHP library for processing DOM documents.
https://github.com/manychois/simdom
dom html html5 parser php
Last synced: 3 months ago
JSON representation
A simple-to-use PHP library for processing DOM documents.
- Host: GitHub
- URL: https://github.com/manychois/simdom
- Owner: manychois
- License: mit
- Created: 2022-12-31T12:34:08.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T08:07:40.000Z (3 months ago)
- Last Synced: 2024-11-12T09:19:41.435Z (3 months ago)
- Topics: dom, html, html5, parser, php
- Language: PHP
- Homepage:
- Size: 408 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Simdom
[](https://packagist.org/packages/manychois/simdom)
[](https://github.com/manychois/simdom/blob/main/LICENSE)
[](https://codecov.io/github/manychois/simdom)
[](https://github.com/manychois/simdom/commits/main)
[](https://packagist.org/packages/manychois/simdom)
Simdom is a lightweight PHP library designed to make parsing and manipulating DOM documents as straightforward as possible.
This library requires no external dependencies or extensions - such as `libxml` or `dom`.
Though not a full DOM implementation, for most use cases Simdom proves to be more than sufficient.
Regular expressions are used extensively in the parsing logic. It is OK if you don't like this approach, we can't please everyone.
Feel free to try its parsing ability at [the demo site](https://simdom.manychois.site/).
## Features
- Depends on no extensions or external libraries.
- Conversion to and from PHP's native DOM objects for integration with existing code.
- Pretty print HTML5 document.
- Type hinting is placed everywhere.
- Remove meaningless properties (e.g. `childNodes`) and methods (e.g. `appendChild()`) from `Comment`, `DocumentType`, and `Text` for cleaner interface.
- Extra convenient methods are added to `Document`, `DocumentFragment` and `Element`, e.g. `dfs()` for depth-first search on desendant nodes.
- Throw exceptions with richer context when insertion or replacement of nodes will result in invalid HTML document.
## Getting Started
### Installation
To use this library in your project, run:
```bash
composer require manychois/simdom
```
## Major differences from DOM standard
- You do not need to use `Document::importNode()` to import nodes from other documents.
Simdom has no concept of [node document](https://dom.spec.whatwg.org/#concept-node-document).
- XML document will still be parsed as if it is HTML5.
- Handling of deprecated tags `frame`, `frameset`, and `plaintext` is not implemented.
When encountered, they are treated as ordinary tags like `div`.
- `Attr` does not inherit from `Node`, so will never participate in the DOM tree hierarchy.
- Parsing `` will not create a `DocumentFragment` inside the `template` element.
Its content will be treated as raw text.
- The DOM standard has a complicated logic of handling misaligned end tags.
In Simdom we try to find any matching start tag up to 3 levels, and discard the end tag if not found.
- Fixing of incorrect tag hierarchy e.g. `
## Usage
### Parsing HTML
```php
$parser = \Manychois\Simdom\Dom::createParser();
$doc = $parser->parseFromString('
Hello, world!
');// $doc is an instance of \Manychois\Simdom\Document
```
### Traversing and manipulating the DOM tree
```php
// Standard DOM methods for traversal and manipulation are available
$html = $doc->documentElement();
$body = $html->children()->item($html->children()->length() - 1);
$body->append(\Manychois\Simdom\Dom::createElement('div'));
// Simdom also provides extra convenient methods like dfs (Depth First Search)
foreach ($doc->dfs() as $node) {
if ($node instanceof \Manychois\Simdom\Comment) {
echo $node->data() . "\n";
}
}
```
### Outputting HTML
```php
$option = new \Manychois\Simdom\PrettyPrintOption();
$option->indent ="\t";
echo \Manychois\Simdom\Dom::print($doc, $option);
```
### Convertion to and from PHP's native DOM objects
```php
$converter = new \Manychois\Simdom\DomNodeConverter();
$domDoc = new \DOMDocument();
// Convert DOMElement to Element and you can start playing with Simdom
$element = $converter->convertToElement($domDoc->createElement('html'));
// Convert Element back to DOMElement and you can import it to DOMDocument
$domElement = $converter->importElement($element, $domDoc);
```