mmk2410/mmk2410.org
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity Actions

🐛 Fix article reading time calculation
All checks were successful
Deploy / deploy (push) Successful in 3s
Details

Browse source
This commit is contained in:
Marcel Kapfer 2025-06-03 19:33:49 +02:00
parent fe6737a797
commit 8136b14c95
Signed by: mmk2410
GPG key ID: CADE6F0C09F21B09
1 changed files with 20 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

23
site/models/article.php
View file

@ -12,6 +12,8 @@ class ArticlePage extends Page
{ {
private const READING_TIME_FORMAT = '%d words, ~%d min reading time'; private const READING_TIME_FORMAT = '%d words, ~%d min reading time';
private const WORDS_PER_MINUTE = 150;
/** /**
* @param array|string|null $options * @param array|string|null $options
*/ */
@ -21,13 +23,28 @@ class ArticlePage extends Page
return '/' . $date .'/' . $this->slug(); return '/' . $date .'/' . $this->slug();
} }
/**
* Simple function for estimating the reading time of the article.
*
* The algorithm counts all words in p-Elements and divides them by
* words-per-minute amount defined in WORDS_PER_MINUTES. It outputs the
* text defined in READING_TIME_FORMAT containing the estimated word count
* and estimated reading time.
*
* @return string Text with estimated reading time.
*/
public function readingTime(): string public function readingTime(): string
{ {
// After requiring PHP 8.4 or higher, replace DOMDocument with
// DOM/HTMLDocument and remove the LIBXML_NOERROR option. This option
// is only needed because DOMDocument only supports HTML4 and
// therefore throws warnings for HTML5 tags.
$doc = new DOMDocument(); $doc = new DOMDocument();
$doc->loadHTML( $doc->loadHTML(
'<html><head><meta charset="UTF-8"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>' '<html><head><meta charset="UTF-8"><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>'
. $this->text()->kirbytext() . $this->text()->kirbytext()
. '</body></html>' . '</body></html>',
LIBXML_NOERROR
); );
$pElems = $doc->getElementsByTagName('p'); $pElems = $doc->getElementsByTagName('p');
@ -37,7 +54,7 @@ class ArticlePage extends Page
} }
$wordCount = count(explode(' ', $text)); $wordCount = count(explode(' ', $text));
$readingTime = (int)ceil($wordCount / 150); $readingTime = (int)ceil($wordCount / self::WORDS_PER_MINUTE);
return sprintf(self::READING_TIME_FORMAT, $wordCount, $readingTime); return sprintf(self::READING_TIME_FORMAT, $wordCount, $readingTime);
} }