MarkSchema.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test\Scoring\Marks;

use ILIAS\Test\Logging\AdditionalInformationGenerator;

class MarkSchema
{
    private array $mark_steps;
    private int $nr_of_passed_marks;
    private int $nr_of_zero_percentage_marks;

    public function __construct(
        private int $test_id
    ) {
        $this->mark_steps = [];
    }

    public function withTestId(int $test_id): self
    {
        $clone = clone $this;
        $clone->test_id = $test_id;
        return $clone;
    }

    public function getTestId(): int
    {
        return $this->test_id;
    }

    public function hasSinglePassedMark(): bool
    {
        return $this->nr_of_passed_marks === 1;
    }

    public function hasSingleZeroPercentageMark(): bool
    {
        return $this->nr_of_zero_percentage_marks === 1;
    }

    public function createSimpleSchema(
        string $txt_failed_short = 'failed',
        string $txt_failed_official = 'failed',
        float $percentage_failed = 0,
        bool $failed_passed = false,
        string $txt_passed_short = 'passed',
        string $txt_passed_official = 'passed',
        float $percentage_passed = 50,
        bool $passed_passed = true
    ): self {
        return $this->withMarkSteps([
            new Mark($txt_failed_short, $txt_failed_official, $percentage_failed, $failed_passed),
            new Mark($txt_passed_short, $txt_passed_official, $percentage_passed, $passed_passed)
        ]);
    }

    public function getMatchingMark(
        float $percentage
    ): ?Mark {
        $reached = round($percentage, 2);
        foreach (array_reverse($this->mark_steps) as $step) {
            $level = round($step->getMinimumLevel(), 2);
            if ($reached >= $level) {
                return $step;
            }
        }
        return null;
    }

    public function checkForMissingZeroPercentage(): bool
    {
        return $this->nr_of_zero_percentage_marks === 0;
    }

    public function checkForMissingPassed(): bool
    {
        return $this->nr_of_passed_marks === 0;
    }

    public function checkForFailedAfterPassed(): bool
    {
        $has_to_be_passed = false;
        foreach ($this->mark_steps as $step) {
            if ($has_to_be_passed && !$step->getPassed()) {
                return true;
            }
            if ($step->getPassed() === true) {
                $has_to_be_passed = true;
            }
        }
        return false;
    }

    public function getMarkSteps(): array
    {
        return $this->mark_steps;
    }

    public function withMarkSteps(array $mark_steps): self
    {
        $clone = clone $this;
        $clone->mark_steps = $this->sort($mark_steps);
        [$clone->nr_of_passed_marks, $clone->nr_of_zero_percentage_marks] = array_reduce(
            $mark_steps,
            function (array $c, Mark $v): array {
                if ($v->getPassed()) {
                    $c[0]++;
                }
                if ($v->getMinimumLevel() === 0.0) {
                    $c[1]++;
                }
                return $c;
            },
            [0, 0]
        );
        return $clone;
    }

    private function sort(array $mark_steps): array
    {
        usort(
            $mark_steps,
            function ($a, $b): int {
                if ($a->getMinimumLevel() === $b->getMinimumLevel()) {
                    $res = strcmp($a->getShortName(), $b->getShortName());
                    if ($res === 0) {
                        return strcmp($a->getOfficialName(), $b->getOfficialName());
                    } else {
                        return $res;
                    }
                }
                return ($a->getMinimumLevel() < $b->getMinimumLevel()) ? -1 : 1;
            }
        );
        return $mark_steps;
    }


    public function toLog(AdditionalInformationGenerator $additional_info): array
    {
        $log_array = [];
        foreach ($this->getMarkSteps() as $mark) {
            $log_array[$mark->getShortName()] = [
                AdditionalInformationGenerator::KEY_MARK_SHORT_NAME => $mark->getShortName(),
                AdditionalInformationGenerator::KEY_MARK_OFFICIAL_NAME => $mark->getOfficialName(),
                AdditionalInformationGenerator::KEY_MARK_MINIMUM_LEVEL => $mark->getMinimumLevel(),
                AdditionalInformationGenerator::KEY_MARK_IS_PASSING => $additional_info
                    ->getTrueFalseTagForBool($mark->getPassed())
            ];
        }
        return $log_array;
    }
}