PHP Read Time: Estimate the time for a person to read an article

Recommend this page to a friend!
  Info   View files Documentation   View files View files (6)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog (1)    
Last Updated Ratings Unique User Downloads Download Rankings
2021-08-06 (1 month ago) RSS 2.0 feedNot yet rated by the usersTotal: 81 All time: 9,725 This week: 174Up
Version License PHP version Categories
read-time 1.0.1GNU General Publi...7PHP 5, Statistics, Text processing, B...
Description Author

This class can estimate the time for a person to read an article.

It takes the text of an article as a parameter and returns the length of time that it would take a person to read that text. It supports processing text in different languages and text that people should read from right to left.

The class can return the read time as an array with the count of the minutes and seconds or a string that expresses the read time in English.

It can also return the read time in other languages if the class gets the translations of the text messages used to format the read time string.

Innovation Award
PHP Programming Innovation award nominee
July 2021
Number 5
Many users like to read blogs about interesting topics, but often they do not have much time to read long articles.

This class can estimate the time that an article could take to be read by an average user.

This way, sites can show the estimated read time to help users decide if they have the time to read the article when they look at it for the first time or leave it later.

Manuel Lemos
Picture of Waqar Ahmed
Name: Waqar Ahmed is available for providing paid consulting. Contact Waqar Ahmed .
Classes: 3 packages by
Country: United Kingdom
Age: ???
All time rank: 2754126 in United Kingdom
Week rank: 579 Up20 in United Kingdom Up
Innovation award
Innovation award
Nominee: 1x

Details

Read Time

Calculates the read time of an article.

Output string

e.g: x min read or 5 minutes read.

Features

  • Multilingual translations support.
  • Static to get simple abbreviated output string in English.
  • Static method to get the integer value of the number of minutes required to read the given text.
  • Multilingual and right-to-left language support.
  • Support for Array output
  • Support for JSON output

Installation

Installation using composer

composer require waqarahmed/read-time

Usage

Static Methods

There are two static methods minRead(string $text) andtime(sting $text).

minRead()

Use this method for a simple x min read message. It returns a rounded minutes number with a min read message.

$text = str_repeat('ad bc ', 251); //502 words in $text
echo ReadTime::minRead($text);

The output:

2 min read

time()

time() method returns an array of the number of minutes and seconds required to read the given $text.

$text = str_repeat('ad bc ', 251); //502 words in $text
ReadTime::time($text);

The output:

['minutes' => 2, 'seconds' => 12]

Class Methods

Create an instance of the class to use - translation - right-to-left language support - JSON output - array output

constructor()

The Constructor takes and sets these parameters:

public function __construct(
  string $text, 
  array $translation = null, 
  bool $abbreviate = true, 
  bool $rtl = false, 
  string $language = null,
  int $wordsPerMinute = 228
  )

#### Class defaults - $wordsPerMinute default value is 200 - $rtl language direction right-to-left is false by default - $translation default is null class outputs the English language by default - $abbreviate Abbreviate the word 'minute/minutes' to 'min' is true by default

getTime()

After initiating a new class object, call the getTime() method to get the result. Example: 4 minutes read or 1 minute read or abbreviated 4 min read.

setTextLanguge()

Reading time of different languages vary significantly (S. Klosinski, K. Dietz). Class method setTextLanguage() has estimated reading times of 17 languages taken from this study.

Reference: "Standardized Assessment of Reading Performance: The New International Reading Speed Texts IReST"

Language (iso-code) Words-per-minutes

Arabic (ar) 138, Chinese (zh) 158, Dutch (nl) 202, English (en) 228, Finnish (fi) 161, French (fr) 195, German (el) 179, Hebrew (he) 187, Italian (it) 188, Japanese (jp) 193, Polish (pl) 166, Portoguese (pt) 181, Russian (ru) 184, Slovenian (sl) 180, Spanish (es) 218, Swedish (sv) 199, Turkish (tr) 166.

English is the default language. Set different languages by passing two letters (ISO 639-1) language codes to the setTextLanguag() method.

An example: Setting Turkish as the input language.

 $text = str_repeat('ad bc ', 251); //502 words in $text
 $result = new ReadTime($this->generateText(), ['minute' => 'dakika', 'minutes' => 'dakika', 'read' => 'okuman'], false, false, 'tr');
 echo $result->getTime();

Translation

Pass translation array to the class to set the translations of the words: minute, minutes, min and read. A passed array must be an associative array with any number of translation strings.

Default property of $translation

$translation = [
        'min'     => 'min',
        'minute'  => 'minute',
        'minutes' => 'minutes',
        'read'    => 'read',
    ];

Example translation input

$text = str_repeat('ad bc ', 251); //502 words in $text
$result = new ReadTime($this->generateText(), ['minute' => 'minuto', 'minutes' => 'minutos', 'read' => 'leer'], false);
echo $result->getTime();

The Spanish translated output: 2 minutos leer.

Right-to-Left Language Translation

Set $rtl property to true and pass $translation of languages written right-to-left.

$text = str_repeat('ad bc ', 251);
$result = new ReadTime($this->generateText(), ['minute' => '?????', 'minutes' => '?????', 'read' => '??????'], false, true);
echo $result->getTime();

Persian translated output: '?????? ????? 2'

getJSON()

Method to get JSON output of claculated read time and class properties.

A class instance with default properties outputs:

$text = str_repeat('hello world ', 251);
$result = new ReadTime($text);
echo $result->getJSON();

outputs:

{
    "minutes": 2,
    "time": {
        "minutes": 2,
        "seconds": 12
    },
    "wordCount": 502,
    "translation": {
        "min": "min",
        "minute": "minute",
        "minutes": "minutes",
        "read": "read"
    },
    "abbreviate": true,
    "wordsPerMinute": 228
}

getArray()

Method to get array output of calculated read time and instance properties. A class instance with default properties:

$text = str_repeat('hello world ', 251);
$result = new ReadTime($text);
echo $result->getArray();

Outputs:

array(6) {
  ["minutes"]=>
  int(2)
  ["time"]=>
  array(2) {
    ["minutes"]=>
    int(2)
    ["seconds"]=>
    int(12)
  }
  ["wordCount"]=>
  int(502)
  ["translation"]=>
  array(4) {
    ["min"]=>
    string(3) "min"
    ["minute"]=>
    string(6) "minute"
    ["minutes"]=>
    string(7) "minutes"
    ["read"]=>
    string(4) "read"
  }
  ["abbreviate"]=>
  bool(true)
  ["wordsPerMinute"]=>
  int(228)
}

  Files folder image Files  
File Role Description
Files folder imagesrc (1 file)
Files folder imagetests (1 file)
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
  Plain text file readTime.php Class Class source

  Files folder image Files  /  tests  
File Role Description
  Plain text file readTimeTest.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:81
This week:0
All time:9,725
This week:174Up
For more information send a message to info at phpclasses dot org.