This library offers the ability to read HTML from URLs, file paths and strings and return any Markup (JSON-LD or Microdata) found within it in the JSON-LD format.
Install this library using composer:
composer install audriga/html2jsonld-php --prefer-dist --no-dev
This library requires PHP 8.1 or greater.
To use this library, import it in your PHP file using
use SML\Html2JsonLd\Util\MarkupUtil;and extract Markup data from an HTML source through one of the following methods.
These methods will return strings which contain a JSON representation of any markup found in the source. To turn it into an Object or Map, use PHP's json_decode() method.
Extracts any markup data from the given $html String. $url is needed to resolve relative file paths found in the markup. The implementation does not need to connect to this URL.
Example usage:
$html = "<!DOCTYPE html>\n<html> [...] </html>"
$result = MarkupUtil::getJsonLdFromHtmlString($html, "http://example.com")Extracts any markup data from the file located under $source. $url is needed to resolve relative file paths found in the markup. The implementation does not need to connect to this URL.
Example usage:
$result = MarkupUtil::getJsonLdFromFile("foo/bar.html", "http://example.com")Tries to retrieve HTML form $source using the built-in PHP cURL client and extract any markup data within it.
Example usage:
$result = MarkupUtil::getJsonLdFromUrl("http://example.com")Markup content may contain image data in the form of URLs, where these images are stored. By default, this library will call URLs found in this data and convert the content returned by them to Base64 images. You can modify this behaviour by passing in optional parameters while calling any of the above mentioned methods:
-
$downloadImages- Default istrue. If set tofalse, image URLs will no longer be accessed and processed. -
$downloadTimeout- Default is5. This setting will determine the duration in seconds, after which the retrieval will be aborted. -
$downloadSize- Default is500000. This will limit the size (in Bytes) of the content downloaded from the source.
After cloning this repository, run composer install to install dependencies (including dev-dependencies).
This project uses PHPUnit version 10 or greater.
To run every test: vendor/bin/phpunit tests/unit from within the project root.
To add a new test file, simply put it under tests/resources as <your-test-file>.html.
PHP version 8.1