Laravel Readability

This package is a Laravel wrapper for readability.php. It provides a simple way to extract the main content from a webpage.

Installation

You can install the package via composer:

composer require the-3labs-team/laravel-readability

Since it uses the readability.php package, you will need the following PHP extensions:

$ sudo apt-get install php7.4-xml php7.4-mbstring

Please change the version according to your PHP version.

Usage

use The3LabsTeam\LaravelReadability\Facades\Readability;

$html = '<html>...</html>';
$parsed = Readability::parse($html);
$title = $parsed->getTitle();

You can use the same methods as the original package. Please refer to the readability.php documentation.

$html = '<html>...</html>';
$parsed = Readability::parse($html);

$title = $parsed->getTitle();
$content = $parsed->getContent();
$excerpt = $parsed->getExcerpt();
$author = $parsed->getAuthor();
$direction = $parsed->getDirection();
$image = $parsed->getImage();
$images = $parsed->getImages();

Get the source list

use The3LabsTeam\LaravelReadability\Readability as ReadabilityClass;

$html = '<html>...</html>';
$parse = (new ReadabilityClass($html))
->getSourceList(
    domainWhitelist: ['example.com', 'another-example.com/some-path'],
    tagsToExtract: ['a', 'iframe', 'text'] // Optional, default is ['a', 'iframe']
)
->parse();
$content = $parsed->getContent();

´$content´ will contain the list of sources in the article.

...
<p>Source list: https://example.com/source1, https://example.com/source2</p>

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Stefano Novelli
• All Contributors

License

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

Sponsor