RatingInputTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once(__DIR__ . "/../../../../../../../vendor/composer/vendor/autoload.php");
require_once(__DIR__ . "/../../../Base.php");
require_once(__DIR__ . "/CommonFieldRendering.php");

use ILIAS\UI\Implementation\Component as I;
use ILIAS\UI\Implementation\Component\SignalGenerator;
use ILIAS\UI\Component\Input\Field;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Data\FiveStarRatingScale;

class RatingInputTest extends ILIAS_UI_TestBase
{
    use CommonFieldRendering;

    protected DefNamesource $name_source;

    public function setUp(): void
    {
        $this->name_source = new DefNamesource();
    }

    protected function buildRating(): \ILIAS\UI\Component\Input\Container\Form\FormInput
    {
        $f = $this->getFieldFactory();
        $label = "label";
        $byline = "byline";
        return $f
            ->rating($label, $byline)
            ->withNameFrom($this->name_source);
    }

    public function testRatingImplementsFactoryInterface(): void
    {
        $f = $this->getFieldFactory();
        $rating = $f->rating("label", "byline");
        $this->assertInstanceOf(\ILIAS\UI\Component\Input\Container\Form\FormInput::class, $rating);
        $this->assertInstanceOf(Field\Rating::class, $rating);
    }

    public function testRatingRenderBasic(): void
    {
        $rating = $this->buildRating();
        $expected = $this->getFormWrappedHtml(
            'rating-field-input',
            'label',
            '
            <fieldset class="input-group il-input-rating">
                <legend class="il-input-rating__text" id="id_1_desc"></legend>
                <div class="il-input-rating__stars" role="radiogroup">
                    <div class="il-input-rating__options">
                        <input aria-describedby="id_1_desc" type="radio" id="id_1-5" name="name_0" value="5" class="il-input-rating-scaleoption" />
                        <label class="glyphicon-star il-input-rating-star" for="id_1-5" aria-label="5stars"></label>

                        <input aria-describedby="id_1_desc" type="radio" id="id_1-4" name="name_0" value="4" class="il-input-rating-scaleoption" />
                        <label class="glyphicon-star il-input-rating-star" for="id_1-4" aria-label="4stars"></label>

                        <input aria-describedby="id_1_desc" type="radio" id="id_1-3" name="name_0" value="3" class="il-input-rating-scaleoption" />
                        <label class="glyphicon-star il-input-rating-star" for="id_1-3" aria-label="3stars"></label>

                        <input aria-describedby="id_1_desc" type="radio" id="id_1-2" name="name_0" value="2" class="il-input-rating-scaleoption" />
                        <label class="glyphicon-star il-input-rating-star" for="id_1-2" aria-label="2stars"></label>

                        <input aria-describedby="id_1_desc" type="radio" id="id_1-1" name="name_0" value="1" class="il-input-rating-scaleoption" />
                        <label class="glyphicon-star il-input-rating-star" for="id_1-1" aria-label="1stars"></label>
                    </div>
                    <div class="il-input-rating__none">
                        <label for="id_1-0" aria-label="reset_stars">reset_stars</label>
                        <input aria-describedby="id_1_desc" type="radio" id="id_1-0" name="name_0" value="0" checked="checked"/>
                    </div>
                </div>
            </fieldset>
            ',
            'byline',
            null
        );
        $this->assertEquals($expected, $this->render($rating));
    }

    public function testRatingRenderFull(): void
    {
        $rating = $this->buildRating()
            ->withAdditionalText('question text')
            ->withDisabled(true)
            ->withValue(FiveStarRatingScale::GOOD)
            ->withCurrentAverage(3);

        $expected = $this->brutallyTrimHTML(
            '<fieldset class="c-input" data-il-ui-component="rating-field-input" data-il-ui-input-name="name_0" disabled="disabled" tabindex="0">
            <label>label</label>
            <div class="c-input__field">

                <fieldset class="input-group il-input-rating disabled">
                    <legend class="il-input-rating__text" id="id_1_desc">question text</legend>

                    <div class="il-input-rating__stars" role="radiogroup">

                        <div class="il-input-rating__options" title="rating_average">

                            <div class="il-input-rating__average">
                                <div class="il-input-rating__average_value" style="width:60%;"></div>
                            </div>

                            <input aria-describedby="id_1_desc" type="radio" id="id_1-5" name="name_0" value="5" class="il-input-rating-scaleoption" disabled="disabled"/>
                            <label class="glyphicon-star il-input-rating-star" for="id_1-5" aria-label="5stars"></label>

                            <input aria-describedby="id_1_desc" type="radio" id="id_1-4" name="name_0" value="4" class="il-input-rating-scaleoption" disabled="disabled" checked="checked"/>
                            <label class="glyphicon-star il-input-rating-star" for="id_1-4" aria-label="4stars"></label>

                            <input aria-describedby="id_1_desc" type="radio" id="id_1-3" name="name_0" value="3" class="il-input-rating-scaleoption" disabled="disabled"/>
                            <label class="glyphicon-star il-input-rating-star" for="id_1-3" aria-label="3stars"></label>

                            <input aria-describedby="id_1_desc" type="radio" id="id_1-2" name="name_0" value="2" class="il-input-rating-scaleoption" disabled="disabled"/>
                            <label class="glyphicon-star il-input-rating-star" for="id_1-2" aria-label="2stars"></label>

                            <input aria-describedby="id_1_desc" type="radio" id="id_1-1" name="name_0" value="1" class="il-input-rating-scaleoption" disabled="disabled"/>
                            <label class="glyphicon-star il-input-rating-star" for="id_1-1" aria-label="1stars"></label>
                        </div>
                    
                        <div class="il-input-rating__none">
                            <label for="id_1-0" aria-label="reset_stars">reset_stars</label>
                            <input aria-describedby="id_1_desc" type="radio" id="id_1-0" name="name_0" value="0" />
                        </div>
                    
                    </div>
                </fieldset>

            </div>
            <div class="c-input__help-byline">byline</div>
        </fieldset>'
        );

        $this->assertEquals($expected, $this->render($rating));
    }

    public function testCommonRendering(): void
    {
        $f = $this->getFieldFactory();
        $rating = $f->rating("label", null)->withNameFrom($this->name_source);

        $this->testWithError($rating);
        $this->testWithNoByline($rating);
        $this->testWithRequired($rating);
        $this->testWithDisabled($rating);
        $this->testWithAdditionalOnloadCodeRendersId($rating);
    }

    public function testRatingAverage(): void
    {
        $rating = $this->buildRating();
        $this->assertNull($rating->getCurrentAverage());
        $this->assertEquals(2.1, $rating->withCurrentAverage(2.1)->getCurrentAverage());
    }

    public function testRatingAverageException(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $rating = $this->buildRating()->withCurrentAverage(7);
    }


}