Skip to content

Latest commit

 

History

History
138 lines (93 loc) · 4.25 KB

README.md

File metadata and controls

138 lines (93 loc) · 4.25 KB
Raw

Content Parser - Laravel 5 package for automatically detecting a content on custom web pages.

With this package, you can easily detect main content on different web pages and grab the content from it. This package provides following features:

  • Expandable architecture. You can easily add support for new APIs
  • Code cleaning. The package can automatically clean CSS and style attributes. Thus you always will receive clean and good HTML content.

The package uses automatic algorithms for grabbing data from web pages. You'll receive the title and the content from needle web page.

Requirements

The package requires follow solutions:

Installation

You can install the package via Composer. Just run:

php composer require deepslam/content-parser

Further, you have to add service provider in your config/app.php:

...
Deepslam\ContentParser\ContentParserServiceProvider::class,
...

At next step you need to create alias in your config/app.php:

'ContentParser' => Deepslam\ContentParser\ContentParser::class,

After it you need to publish configs:

php artisan vendor:publish --provider="Deepslam\ContentParser\ContentParserServiceProvider"

Do not forget to run config:cache command:

php artisan config:cache

That's all!

Settings

There are two different parsers:

  • Standalone parser - graby which uses by default.
  • MarcuryContentParser which uses Mercury API

Thus you have 3 configs:

  • /config/deepslam/parser.php - This is the common config for all parsers. Here you can configure such options as necessary of cleaning code, stripping tags, set allow tags list etc.
  • /config/deepslam/mercury-tools.php - There is only one settings - API key for Mercury API service
  • /config/deepslam/graby.php - This is the copy of original settings of graby parser. You can read about it on developer's page.

Usage

You can easily use ContentParser:

$parser = ContentParser::create();

There will be ContentParser object created.

This configuration will use "Graby" parser. If you need to use another one, you can specify it as a parameter:

$parser = ContentParser::create('mercury');

As result, you will receive ContentParser object.

For parse data, you must use parse method which return true\false result (true if data has been received, false if not)

$parser->parse($url)

For getting a result of parsing there is one method:

  • getResult - Returns needle ParsingResult object

There are a few methods in this object:

  • setTitle - Set new title
  • setContent - Set new content
  • setImage - Set main image for the content
  • setOriginal - Save original response
  • getTitle - The title of result
  • getContent - The content of result. It can be already cleaned if you specify it in configs.
  • getImage - Returns URL to the OG Image or empty string
  • getOriginal - Just returns service\script original response
  • isEmpty - Is it empty object (without data) or not?
  • stripContent - Manually strip content from tags
  • cleanContent - Manually clean content from strange classes, ID's and style blocks in the parsed HTML

Extending

If you want to add a new parser you must create a new class and inherit it from \Deepslam\ContentParser\ContentParser class. You must realise the only one method - parse which must return bool as result and changes internal result object.

After it, you must specific your new class in the /config/deepslam/parser.php parsers array.

To use you parser specify it when you call ContentParser as shows below:

$parser = ContentParser::create('<your alias of parser>');

Full example

        $parser = ContentParser::create('<parser which you need>');
        $parser->parse('<url to grab>');
        $result = $parser->getResult();
        <your_model>->name = $result->getTitle();
        <your_model>->description = $result->getContent();

Support

If you find bug or have question\suggestion you can send e-mail to me: [[email protected]][email protected]