├── .coveralls.yml ├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── composer.json ├── phpunit.xml ├── src ├── SentenceTokenizer.php └── SummaryTool.php └── tests └── Unit ├── SentenceTokenizerTest.php └── SummaryToolTest.php /.coveralls.yml: -------------------------------------------------------------------------------- 1 | coverage_clover: tests/Logs/clover.xml 2 | json_path: tests/Logs/coveralls-upload.json 3 | service_name: travis-ci 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | vendor/ 2 | composer.lock 3 | *.cache 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | php: 3 | - '7.1' 4 | - '7.2' 5 | - '7.3' 6 | - '7.4' 7 | - nightly 8 | matrix: 9 | allow_failures: 10 | - php: nightly 11 | install: 12 | - composer install 13 | script: 14 | - ./vendor/bin/phpunit --coverage-clover ./tests/Logs/clover.xml 15 | after_script: 16 | - php vendor/bin/php-coveralls -v 17 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PHP Summary 2 | 3 | [![Build Status](https://travis-ci.org/DivineOmega/php-summary.svg?branch=master)](https://travis-ci.org/DivineOmega/php-summary) 4 | [![Coverage Status](https://coveralls.io/repos/github/DivineOmega/php-summary/badge.svg?branch=master)](https://coveralls.io/github/DivineOmega/php-summary?branch=master) 5 | [![StyleCI](https://styleci.io/repos/47579407/shield?branch=master)](https://styleci.io/repos/47579407) 6 | ![Packagist](https://img.shields.io/packagist/dt/DivineOmega/php-summary.svg) 7 | 8 | A PHP library to automatically summarise text using a naive summerisation algorithm. 9 | 10 | This summerisation algorithm in use takes the key sentence from each paragraph. It then strings these resulting sentences together to form the summary. 11 | 12 | For more details on this algorithm, see this [blog post by Shlomi Babluki](http://thetokenizer.com/2013/04/28/build-your-own-summary-tool/). 13 | 14 | ## Installation 15 | 16 | Require this package, with [Composer](https://getcomposer.org/), in the root directory of your project. 17 | 18 | ```bash 19 | composer require divineomega/php-summary 20 | ``` 21 | 22 | ## Usage 23 | 24 | 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. 25 | 26 | Note: The article content must have its paragraphs seperated by two new line characters. 27 | 28 | ```php 29 | $summary = (new SummaryTool($content))->getSummary(); 30 | ``` 31 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "divineomega/php-summary", 3 | "type": "library", 4 | "description": "PHP Summarization Library", 5 | "keywords": ["summarizing", "summary", "summarization", "summarization library", "library", "php"], 6 | "homepage": "https://github.com/DivineOmega/php-summary", 7 | "license": "LGPL-3.0-only", 8 | "require": { 9 | "php": ">=7.1" 10 | }, 11 | "require-dev": { 12 | "phpunit/phpunit": "^7.0 || ^8.0", 13 | "php-coveralls/php-coveralls": "^2.1" 14 | }, 15 | "autoload": { 16 | "psr-4": { 17 | "DivineOmega\\PHPSummary\\": "src/" 18 | } 19 | }, 20 | "autoload-dev": { 21 | "psr-4": { 22 | "DivineOmega\\PHPSummary\\Tests\\": "tests/Unit/" 23 | } 24 | }, 25 | "extra": { 26 | "branch-alias": { 27 | "dev-master": "1.0-dev" 28 | } 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 11 | 12 | 13 | ./tests/Unit 14 | 15 | 16 | 17 | 18 | src 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /src/SentenceTokenizer.php: -------------------------------------------------------------------------------- 1 | content = $content; 12 | } 13 | 14 | public function getSentences(): array 15 | { 16 | if (!trim($this->content)) { 17 | return []; 18 | } 19 | 20 | $contentParts = preg_split("/([\.\!\?])+/", $this->content, -1, PREG_SPLIT_DELIM_CAPTURE); 21 | 22 | $sentences = []; 23 | 24 | for ($i = 0; $i < count($contentParts); $i += 2) { 25 | if (!isset($contentParts[$i + 1])) { 26 | break; 27 | } 28 | 29 | $sentence = $contentParts[$i].$contentParts[$i + 1]; 30 | $sentence = trim($sentence); 31 | $sentences[] = $sentence; 32 | } 33 | 34 | return $sentences; 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/SummaryTool.php: -------------------------------------------------------------------------------- 1 | content = $content; 12 | } 13 | 14 | private function getParagraphs(string $content): array 15 | { 16 | return explode(PHP_EOL.PHP_EOL, $content); 17 | } 18 | 19 | private function getSentences(string $content): array 20 | { 21 | $sentenceTokenizer = new SentenceTokenizer(); 22 | $sentenceTokenizer->setContent($content); 23 | 24 | return $sentenceTokenizer->getSentences(); 25 | } 26 | 27 | /** 28 | * @return bool|int 29 | */ 30 | private function sentencesIntersection(string $sent1, string $sent2) 31 | { 32 | $s1 = explode(' ', $sent1); 33 | $s2 = explode(' ', $sent2); 34 | 35 | if (count($s1) + count($s2) === 0) { 36 | return true; 37 | } 38 | 39 | $intersect = array_intersect($s1, $s2); 40 | $splicePoint = ((count($s1) + count($s2)) / 2); 41 | 42 | $splicedIntersect = array_splice($intersect, 0, $splicePoint); 43 | 44 | return count($splicedIntersect); 45 | } 46 | 47 | private function getSentencesRanks(string $content): array 48 | { 49 | $sentences = $this->getSentences($content); 50 | $n = count($sentences); 51 | 52 | $values = []; 53 | 54 | // Assign each score to each sentence 55 | for ($i = 0; $i < $n; $i++) { 56 | for ($j = 0; $j < $n; $j++) { 57 | $intersection = $this->sentencesIntersection($sentences[$i], $sentences[$j]); 58 | $values[$i][$j] = $intersection; 59 | } 60 | } 61 | 62 | // Build sentences object array 63 | $sentenceRankings = []; 64 | 65 | for ($i = 0; $i < $n; $i++) { 66 | $score = 0; 67 | for ($j = 0; $j < $n; $j++) { 68 | if ($i == $j) { 69 | continue; 70 | } 71 | 72 | $score += $values[$i][$j]; 73 | } 74 | 75 | $sentenceRanking = new \stdClass(); 76 | $sentenceRanking->sentence = $sentences[$i]; 77 | $sentenceRanking->score = $score; 78 | 79 | $sentenceRankings[] = $sentenceRanking; 80 | } 81 | 82 | return $sentenceRankings; 83 | } 84 | 85 | private function getBestSentence(string $paragraph, array $sentenceRankings): ?string 86 | { 87 | $sentences = $this->getSentences($paragraph); 88 | 89 | if (count($sentences) < 2) { 90 | return null; 91 | } 92 | 93 | $highestScore = 0; 94 | $bestSentence = null; 95 | 96 | foreach ($sentences as $sentence) { 97 | foreach ($sentenceRankings as $sentenceRanking) { 98 | if ($sentenceRanking->sentence == $sentence && $sentenceRanking->score > $highestScore) { 99 | $highestScore = $sentenceRanking->score; 100 | $bestSentence = $sentenceRanking->sentence; 101 | } 102 | } 103 | } 104 | 105 | return $bestSentence; 106 | } 107 | 108 | public function getSummarySentences(): array 109 | { 110 | $sentenceRankings = $this->getSentencesRanks($this->content); 111 | 112 | $paragraphs = $this->getParagraphs($this->content); 113 | 114 | $sentences = []; 115 | 116 | foreach ($paragraphs as $paragraph) { 117 | $bestSentence = $this->getBestSentence($paragraph, $sentenceRankings); 118 | 119 | if ($bestSentence) { 120 | $sentences[] = $bestSentence; 121 | } 122 | } 123 | 124 | return $sentences; 125 | } 126 | 127 | public function getSummary(): string 128 | { 129 | $sentences = $this->getSummarySentences(); 130 | 131 | $summary = ''; 132 | 133 | foreach ($sentences as $sentence) { 134 | $summary .= $sentence; 135 | $summary .= ' '; 136 | } 137 | 138 | return trim($summary); 139 | } 140 | } 141 | -------------------------------------------------------------------------------- /tests/Unit/SentenceTokenizerTest.php: -------------------------------------------------------------------------------- 1 | setContent($content); 48 | 49 | $this->assertSame($expected, $sentenceTokenizer->getSentences()); 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /tests/Unit/SummaryToolTest.php: -------------------------------------------------------------------------------- 1 | assertSame($expected, $summaryTool->getSummary()); 36 | } 37 | 38 | public function summarySentencesDataProvider() 39 | { 40 | return [ 41 | [ 42 | 'Cake (also known as gateau or gâteau, from French) is a form of sweet dessert that is typically baked. In its oldest forms, cakes were modifications of breads, but cakes now cover a wide range of preparations that can be simple or elaborate, and that share features with other desserts such as pastries, meringues, custards, and pies. 43 | 44 | Typical cake ingredients are flour, sugar, eggs, butter or oil or margarine, a liquid, and leavening agents, such as baking soda or baking powder. Common additional ingredients and flavourings include dried, candied, or fresh fruit, nuts, cocoa, and extracts such as vanilla, with numerous substitutions for the primary ingredients. Cakes can also be filled with fruit preserves,nuts or dessert sauces (like pastry cream), iced with buttercream or other icings, and decorated with marzipan, piped borders, or candied fruit. 45 | 46 | Cake is often served as a celebratory dish on ceremonial occasions, such as weddings, anniversaries, and birthdays. There are countless cake recipes; some are bread-like, some are rich and elaborate, and many are centuries old. Cake making is no longer a complicated procedure; while at one time considerable labor went into cake making (particularly the whisking of egg foams), baking equipment and directions have been simplified so that even the most amateur cook may bake a cake.', 47 | [ 48 | 'In its oldest forms, cakes were modifications of breads, but cakes now cover a wide range of preparations that can be simple or elaborate, and that share features with other desserts such as pastries, meringues, custards, and pies.', 49 | 'Typical cake ingredients are flour, sugar, eggs, butter or oil or margarine, a liquid, and leavening agents, such as baking soda or baking powder.', 50 | 'Cake making is no longer a complicated procedure; while at one time considerable labor went into cake making (particularly the whisking of egg foams), baking equipment and directions have been simplified so that even the most amateur cook may bake a cake.', 51 | ], 52 | ], 53 | [ 54 | '', 55 | [], 56 | ], 57 | ]; 58 | } 59 | 60 | /** 61 | * @dataProvider summarySentencesDataProvider 62 | */ 63 | public function testGetSummarySentences($content, $expected) 64 | { 65 | $summaryTool = new SummaryTool($content); 66 | 67 | $this->assertSame($expected, $summaryTool->getSummarySentences()); 68 | } 69 | } 70 | --------------------------------------------------------------------------------