microdata-parser/README.md

101 lines
3.0 KiB
Markdown
Raw Normal View History

# microdata-parser
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
2018-12-17 17:46:07 +00:00
This package aims to implement [W3C Microdata to JSON Specification](https://www.w3.org/TR/microdata/#json).
**microdata-parser** extracts microdata from documents.
## Installation
Via Composer
``` bash
$ composer require yusufkandemir/microdata-parser
```
## Usage
2018-11-12 17:30:19 +00:00
##### PHP
```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
```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
```json
{
"items": [
{
"type": [ "http://schema.org/Product" ],
"properties": {
"image": [ "http://shop.example.com/test_product.jpg" ],
2018-11-14 20:15:59 +00:00
"url": [ "http://shop.example.com/test_product" ],
2018-11-12 17:30:19 +00:00
"name": [ "Test Product" ]
}
}
]
}
```
## Change log
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Testing
``` bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Credits
- [Yusuf Kandemir][link-author]
- [All Contributors][link-contributors]
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[ico-version]: https://img.shields.io/packagist/v/yusufkandemir/microdata-parser.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/yusufkandemir/microdata-parser/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/yusufkandemir/microdata-parser.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/yusufkandemir/microdata-parser.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/yusufkandemir/microdata-parser.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/yusufkandemir/microdata-parser
[link-travis]: https://travis-ci.org/yusufkandemir/microdata-parser
[link-scrutinizer]: https://scrutinizer-ci.com/g/yusufkandemir/microdata-parser/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/yusufkandemir/microdata-parser
[link-downloads]: https://packagist.org/packages/yusufkandemir/microdata-parser
[link-author]: https://github.com/yusufkandemir
[link-contributors]: ../../contributors