ILIAS\Refinery\String\EstimatedReadingTime Class Reference

Inheritance diagram for ILIAS\Refinery\String\EstimatedReadingTime:

Collaboration diagram for ILIAS\Refinery\String\EstimatedReadingTime:

Public Member Functions
	__construct (bool $withImages)
	ReadingTime constructor. More...
	transform ($from)
	Perform the transformation.Please use this for transformations. It's more performant than calling invoke. Exceptions More...
Public Member Functions inherited from ILIAS\Refinery\Transformation
	applyTo (Result $data)
	Perform the transformation and reify possible failures. More...
	__invoke ($from)
	Transformations should be callable. More...

Private Member Functions
	calculateWordsForImages (int $numberOfImages)

Private Attributes
	$wordsPerMinute = 275
	$firstImageReadingTimeInSeconds = 12
	$withImages = false

Detailed Description

Definition at line 10 of file EstimatedReadingTime.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\EstimatedReadingTime::__construct

(

bool

$withImages

)

ReadingTime constructor.

Parameters

bool

$withImages

Definition at line 28 of file EstimatedReadingTime.php.

References ILIAS\Refinery\String\EstimatedReadingTime\$withImages.

    {
        $this->withImages = $withImages;
    }

Member Function Documentation

calculateWordsForImages()

ILIAS\Refinery\String\EstimatedReadingTime::calculateWordsForImages ( int  $numberOfImages )

private

See also

https://blog.medium.com/read-time-and-you-bc2048ab620c

Parameters

int

$numberOfImages

Returns

float The calculated reading time for the passed number of images translated to words

Definition at line 98 of file EstimatedReadingTime.php.

References $i.

Referenced by ILIAS\Refinery\String\EstimatedReadingTime\transform().

                                                                  : float
    {
        $time = 0.0;

        for ($i = 1; $i <= $numberOfImages; $i++) {
            if ($i >= 10) {
                $time += 3 * ((int) $this->wordsPerMinute / 60);
            } else {
                $time += (12 - ($i - 1)) * ((int) $this->wordsPerMinute / 60);
            }
        }

        return $time;
    }

Here is the caller graph for this function:

transform()

ILIAS\Refinery\String\EstimatedReadingTime::transform

(

$from

)

Perform the transformation.Please use this for transformations. It's more performant than calling invoke.

Exceptions

Implements ILIAS\Refinery\Transformation.

Definition at line 36 of file EstimatedReadingTime.php.

References ILIAS\Refinery\String\EstimatedReadingTime\calculateWordsForImages().

    {
        if (!is_string($from)) {
            throw new \InvalidArgumentException(__METHOD__ . " the argument is not a string.");
        }

        return $this->calculate($from);
    }

Here is the call graph for this function:

Field Documentation

$firstImageReadingTimeInSeconds

ILIAS\Refinery\String\EstimatedReadingTime::$firstImageReadingTimeInSeconds = 12

private

Definition at line 19 of file EstimatedReadingTime.php.

$withImages

ILIAS\Refinery\String\EstimatedReadingTime::$withImages = false

private

Definition at line 22 of file EstimatedReadingTime.php.

Referenced by ILIAS\Refinery\String\EstimatedReadingTime\__construct().

$wordsPerMinute

ILIAS\Refinery\String\EstimatedReadingTime::$wordsPerMinute = 275

private

Definition at line 16 of file EstimatedReadingTime.php.

---

The documentation for this class was generated from the following file:

• src/Refinery/String/EstimatedReadingTime.php