yusufkandemir / microdata-parser

Parse microdata from HTML documents with ease. PHP Implementation of W3C Microdata to JSON Specification.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

microdata-parser

Latest Version on Packagist PHP Version Support Software License Tests Quality Checks Total Downloads

This package aims to implement W3C Microdata to JSON Specification.

microdata-parser extracts microdata from documents.

Installation

Via Composer

$ composer require yusufkandemir/microdata-parser

Usage

PHP
use YusufKandemir\MicrodataParser\Microdata;

$microdata = Microdata::fromHTMLFile('source.html')->toJSON();
/* Other sources:
     fromHTML()        // from HTML string
     fromDOMDocument() // from DOMDocument object
   Other output methods:
     toArray()  // to Associtive PHP Array
     toObject() // to PHP Object (stdClass)
*/
Source as HTML
<!-- source.html -->
<div itemscope itemtype="http://schema.org/Product">
  <img itemprop="image" src="http://shop.example.com/test_product.jpg" />
  <a itemprop="url" href="http://shop.example.com/test_product">
    <span itemprop="name">Test Product</span>
  </a>
</div>
Result as JSON
{
  "items": [
    {
      "type": [ "http://schema.org/Product" ],
      "properties": {
        "image": [ "http://shop.example.com/test_product.jpg" ],
        "url": [ "http://shop.example.com/test_product" ],
        "name": [ "Test Product" ]
      }
    }
  ]
}

Testing

$ composer test

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

Parse microdata from HTML documents with ease. PHP Implementation of W3C Microdata to JSON Specification.

License:MIT License


Languages

Language:PHP 82.1%Language:HTML 17.9%