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)
	transform ($from)
Public Member Functions inherited from ILIAS\Refinery\Transformation
	applyTo (Result $result)
	Perform the transformation and reify possible failures. More...
	__invoke ($from)
	Transformations should be callable. More...

Private Member Functions
	calculateWordsForImages (int $numberOfImages)
	beginXmlLogging ()
	addErrors ()
	endXmlLogging ()
	xmlErrorsOccurred ()
	xmlErrorsToString ()

Private Attributes
int	$wordsPerMinute = 275
bool	$withImages
bool	$xmlErrorState = false
array	$xmlErrors = []

Detailed Description

Definition at line 34 of file EstimatedReadingTime.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Refinery\String\EstimatedReadingTime::__construct

(

bool

$withImages

)

Definition at line 45 of file EstimatedReadingTime.php.

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

    {
        $this->withImages = $withImages;
    }

Member Function Documentation

addErrors()

ILIAS\Refinery\String\EstimatedReadingTime::addErrors ( )

private

Definition at line 147 of file EstimatedReadingTime.php.

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

                                : void
    {
        $currentErrors = libxml_get_errors();
        libxml_clear_errors();

        $this->xmlErrors = $currentErrors;
    }

Here is the caller graph for this function:

beginXmlLogging()

ILIAS\Refinery\String\EstimatedReadingTime::beginXmlLogging ( )

private

Definition at line 141 of file EstimatedReadingTime.php.

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

                                      : void
    {
        $this->xmlErrorState = libxml_use_internal_errors(true);
        libxml_clear_errors();
    }

Here is the caller graph for this function:

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 126 of file EstimatedReadingTime.php.

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

                                                                 : float
    {
        $time = 0.0;

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

        return $time;
    }

Here is the caller graph for this function:

endXmlLogging()

ILIAS\Refinery\String\EstimatedReadingTime::endXmlLogging ( )

private

Definition at line 155 of file EstimatedReadingTime.php.

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

                                    : void
    {
        libxml_use_internal_errors($this->xmlErrorState);
    }

Here is the caller graph for this function:

transform()

ILIAS\Refinery\String\EstimatedReadingTime::transform

(

$from

)

Implements ILIAS\Refinery\Transformation.

Definition at line 53 of file EstimatedReadingTime.php.

References Vendor\Package\$e, $text, ILIAS\Refinery\String\EstimatedReadingTime\addErrors(), ILIAS\Refinery\String\EstimatedReadingTime\beginXmlLogging(), ILIAS\Refinery\String\EstimatedReadingTime\calculateWordsForImages(), and ILIAS\Refinery\String\EstimatedReadingTime\endXmlLogging().

                                    : int
    {
        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:

xmlErrorsOccurred()

ILIAS\Refinery\String\EstimatedReadingTime::xmlErrorsOccurred ( )

private

Definition at line 160 of file EstimatedReadingTime.php.

                                        : bool
    {
        return $this->xmlErrors !== [];
    }

xmlErrorsToString()

ILIAS\Refinery\String\EstimatedReadingTime::xmlErrorsToString ( )

private

Definition at line 165 of file EstimatedReadingTime.php.

References ILIAS\$error, and $text.

                                        : string
    {
        $text = '';
        foreach ($this->xmlErrors as $error) {
            $text .= implode(',', [
                'level=' . $error->level,
                'code=' . $error->code,
                'line=' . $error->line,
                'col=' . $error->column,
                'msg=' . trim($error->message)
            ]) . "\n";
        }

        return $text;
    }

Field Documentation

$withImages

bool ILIAS\Refinery\String\EstimatedReadingTime::$withImages

private

Definition at line 40 of file EstimatedReadingTime.php.

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

$wordsPerMinute

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

private

Definition at line 39 of file EstimatedReadingTime.php.

$xmlErrors

array ILIAS\Refinery\String\EstimatedReadingTime::$xmlErrors = []

private

Definition at line 43 of file EstimatedReadingTime.php.

$xmlErrorState

bool ILIAS\Refinery\String\EstimatedReadingTime::$xmlErrorState = false

private

Definition at line 41 of file EstimatedReadingTime.php.

---

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

• components/ILIAS/Refinery/src/String/EstimatedReadingTime.php