divineomega/php-summary

PHP Summarization Library

v3.0.0 2020-06-24 22:16 UTC

Requires

• php: >=7.1

Requires (Dev)

• php-coveralls/php-coveralls: ^2.1
• phpunit/phpunit: ^7.0 || ^8.0

LGPL-3.0-only

• php
• library
• summary
• summarization
• summarizing
• summarization library

README

A PHP library to automatically summarise text using a naive summerisation algorithm.

This summerisation algorithm in use takes the key sentence from each paragraph. It then strings these resulting sentences together to form the summary.

For more details on this algorithm, see this blog post by Shlomi Babluki.

Installation

Require this package, with Composer, in the root directory of your project.

composer require divineomega/php-summary

Usage

To use PHP Summary, you should create a new SummaryTool object, passing it the text content of your article. You can then call its getSummary method to retrieve the shortened summary of the article.

Note: The article content must have its paragraphs seperated by two new line characters.

$summary = (new SummaryTool($content))->getSummary();