https://github.com/j0k3r/php-readability

A fork of https://bitbucket.org/fivefilters/php-readability
https://github.com/j0k3r/php-readability

content extract-website hacktoberfest php php-library readability text-rss tidy

Last synced: 8 days ago
JSON representation

A fork of https://bitbucket.org/fivefilters/php-readability

• Host: GitHub
• URL: https://github.com/j0k3r/php-readability
• Owner: j0k3r
• License: apache-2.0
• Created: 2014-12-12T09:27:16.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-10-11T06:56:35.000Z (6 months ago)
• Last Synced: 2024-10-12T13:44:14.590Z (6 months ago)
• Topics: content, extract-website, hacktoberfest, php, php-library, readability, text-rss, tidy
• Language: PHP
• Homepage:
• Size: 238 KB
• Stars: 168
• Watchers: 11
• Forks: 36
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Readability

![CI](https://github.com/j0k3r/php-readability/workflows/CI/badge.svg)

[![Coverage Status](https://coveralls.io/repos/j0k3r/php-readability/badge.svg?branch=master&service=github)](https://coveralls.io/github/j0k3r/php-readability/?branch=master)

[![Total Downloads](https://poser.pugx.org/j0k3r/php-readability/downloads)](https://packagist.org/packages/j0k3r/php-readability)

[![License](https://poser.pugx.org/j0k3r/php-readability/license)](https://packagist.org/packages/j0k3r/php-readability)

This is an extract of the Readability class from this [full-text-rss](https://github.com/Dither/full-text-rss) fork. It can be defined as a better version of the original [php-readability](https://bitbucket.org/fivefilters/php-readability).

## Differences

The default php-readability lib is really old and needs to be improved. I found a great fork of full-text-rss from [@Dither](https://github.com/Dither/full-text-rss) which improve the Readability class.

 - I've extracted the class from its fork to be able to use it out of the box

 - I've added some simple tests

 - and changed the CS, run `php-cs-fixer` and added a namespace

**But** the code is still really hard to understand / read ...

## Requirements

By default, this lib will use the [Tidy extension](https://github.com/htacg/tidy-html5) if it's available. Tidy is only used to cleanup the given HTML and avoid problems with bad HTML structure, etc .. It'll be suggested by Composer.

Also, if you got problem from parsing a content without Tidy installed, please install it and try again.

## Usage

```php

use Readability\Readability;

$url = 'http://www.medialens.org/index.php/alerts/alert-archive/alerts-2013/729-thatcher.html';

// you can use whatever you want to retrieve the html content (Guzzle, Buzz, cURL ...)

$html = file_get_contents($url);

$readability = new Readability($html, $url);

// or without Tidy

// $readability = new Readability($html, $url, 'libxml', false);

$result = $readability->init();

if ($result) {

    // display the title of the page

    echo $readability->getTitle()->textContent;

    // display the *readability* content

    echo $readability->getContent()->textContent;

} else {

    echo 'Looks like we couldn\'t find the content. :(';

}

```

If you want to debug it, or check what's going on, you can inject a logger (which must follow `Psr\Log\LoggerInterface`, Monolog for example):

```php

use Readability\Readability;

use Monolog\Logger;

use Monolog\Handler\StreamHandler;

$url = 'http://www.medialens.org/index.php/alerts/alert-archive/alerts-2013/729-thatcher.html';

$html = file_get_contents($url);

$logger = new Logger('readability');

$logger->pushHandler(new StreamHandler('path/to/your.log', Logger::DEBUG));

$readability = new Readability($html, $url);

$readability->setLogger($logger);

```