https://github.com/piradoiv/munchitos
Objectify HTML like a boss.
https://github.com/piradoiv/munchitos
Last synced: about 1 month ago
JSON representation
Objectify HTML like a boss.
- Host: GitHub
- URL: https://github.com/piradoiv/munchitos
- Owner: piradoiv
- License: mit
- Created: 2014-02-28T10:16:29.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-03-31T19:19:11.000Z (about 11 years ago)
- Last Synced: 2025-02-01T11:23:13.633Z (3 months ago)
- Language: PHP
- Size: 469 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Munchitos
[](https://travis-ci.org/piradoiv/munchitos)
This library aims to make developer's life easier
while trying to parse the HTML contents.
## Features
At the moment, Munchitos currently have these features:
- Returns the title of the page.
- Extract Links and Images from the contents.
- Detects meta description.
- Gives the canonical URL, if present.
- List every linked stylesheet.
- Detects the charset encoding.
In the future, Munchitos aims to support:
- Semantic microformat.
## How to install
Composer is the easier way, just add the library
to the dependancies:
```json
{
"require": {
"piradoiv/munchitos": "dev-master"
}
}
```
Remember to call **composer install** or **composer
update** after adding composer.json file. There are
loads of information about setting up
[Composer](http://getcomposer.org) on your project.
Munchitos goal isn't to download the HTML itself, so
I recommend to also install a cURL wrapper, like
[shuber/curl](https://packagist.org/packages/shuber/curl).
## How to use
```php
url("http://www.example.com/foo/bar.html");
// Fill it with the HTML
$html = '
Hello World!
';
$munchitos->html($html);
// And start calling any information you need.
echo $munchitos->title();
```
### $munchitos->title()
Returns the title of the page, trimming the spaces.
### $munchitos->description()
If there is any meta description tag, it returns its contents.
### $munchitos->canonical()
Some websites specifies a [canonical URL](https://support.google.com/webmasters/answer/139394?hl=en), there you go.
### $munchitos->stylesheets()
Returns a list (if any) of stylesheets urls used
on current HTML.
### $munchitos->charset()
Searchs for the charset tag and returns it content.
### $munchitos->links()
Returns an array of Link instances. Link class contains
these helpful methods:
- href()
- title()
- target()
- isNoFollow() / isFollow()
### $munchitos->images()
Returns an array of Image instances. Like with Link class,
it includes some methods:
- altText() or alt()
- src()
- isLinked()
## Acknowledges
I want to thank the Open Source community, specially
Composer guys, Symfony libraries and the PHP League
for their project template.
## Contribute
Simply send a pull request, but please ensure your
code doesn't breaks the tests and it's written
with the PSR-2 coding style.
## Contact
I'm [@PiradoIV](http://twitter.com/piradoiv/) on
Twitter, give me a shout if you need a hand with
this library.