App\Helpers\TextHelpers

Complexity

Total Complexity

7

Size/Duplication

Total Lines	46
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
B	estimateReadingTime()	0	31	7

<?php

namespace App\Helpers;

class TextHelpers
{

    /**
     * Return the estimated reading time for a given piece of $content in minutes.
     *
     * Average reading speed is between 230-280 words per minute,
     * so he using 200 here is keeping some limit to provide pessimistic reading time.
     * Most of people should read it faster.
     *
     * @param string $content Content to calculate read time for.
     * @param int $wpm Estimated words per minute of reader.
     *
     * @return string estimated read time eg. 1 minute, 30 seconds
     */
    public static function estimateReadingTime(
        string $content = '',
        int $wpm = 200,
        string $format = null
    ): string {

        $word_count = str_word_count(strip_tags($content));

        $minutes = floor($word_count / $wpm);
        $seconds = floor($word_count % $wpm / ($wpm / 60));

        $str_minutes = ($minutes == 1) ? "minute" : "minutes";
        $str_seconds = ($seconds == 1) ? "second" : "seconds";

        if ($format == 'minutes') {
            if ($minutes == 0) {
                return 'Less then one minute';
            } else {
                return "{$minutes}";
            }
        }

        if ($format == 'minutesAndSeconds') {
            if ($minutes == 0) {
                return "{$seconds} {$str_seconds}";
            } else {
                return "{$minutes} {$str_minutes}, {$seconds} {$str_seconds}";
            }
        }

        return "Please specify the time format";
    }
}