the-3labs-team/laravel-readability

Laravel Readability is a supercharged PHP client that makes it easy to extract and manipulate the main content of a web page.

v1.0.3 2024-05-07 10:33 UTC

This package is auto-updated.

Last update: 2024-11-04 15:35:26 UTC


README

Logo Laravel Readability

Laravel Readability

Latest Version on Packagist GitHub Tests Action Status Github PHPStan GitHub Code Style Action Status Maintainability Test Coverage License Mit Total Downloads

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

$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();

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

License

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