ilTermsOfServiceUserHasLanguageCriterionTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Legacy\Legacy;
use PHPUnit\Framework\MockObject\MockObject;

class ilTermsOfServiceUserHasLanguageCriterionTest extends ilTermsOfServiceCriterionBaseTest
{
    protected ilLanguage $lng;
    protected string $expectedInitialValue = 'en';
    protected string $expectedAfterFormSubmitValue = 'de';
    protected string $englishLanguageTranslation = 'English';
    protected string $germanLanguageTranslation = 'German';

    protected function setUp(): void
    {
        parent::setUp();

        $this->lng = $this->getLanguageMock();

        $this->lng
            ->method('txt')
            ->willReturn('dummy');

        $this->lng
            ->method('getInstalledLanguages')
            ->willReturn([$this->expectedAfterFormSubmitValue, $this->expectedInitialValue]);
    }

    protected function getInstance(): ilTermsOfServiceUserHasLanguageCriterion
    {
        return new ilTermsOfServiceUserHasLanguageCriterion();
    }

    public function testInstanceCanBeCreated(): ilTermsOfServiceUserHasLanguageCriterion
    {
        $criterion = $this->getInstance();

        $this->assertSame('usr_language', $criterion->getTypeIdent());
        $this->assertTrue($criterion->hasUniqueNature());

        return $criterion;
    }

    protected function buildForm(
        ilTermsOfServiceCriterionTypeGUI $gui,
        string $httpCriterionSelectionBodyParameter
    ): ilPropertyFormGUI {
        $form = $this->getFormMock();

        $radioGroup = $this->getRadioGroupMock();

        $radioGroup
            ->method('getPostVar')
            ->willReturn($httpCriterionSelectionBodyParameter);

        $form->addItem($radioGroup);

        $gui->appendOption($radioGroup, $this->getCriterionConfig(['lng' => $this->expectedInitialValue]));

        return $form;
    }

    public function testFormUserInterfaceElementsAreProperlyBuilt(
        ilTermsOfServiceUserHasLanguageCriterion $criterion
    ): ilTermsOfServiceUserHasLanguageCriterion {
        $httpCriterionSelectionBodyParameter = 'criterion';
        $httpCriterionConfigBodyParameter = $criterion->getTypeIdent() . '_lng';

        $gui = $criterion->ui($this->lng);

        $this->assertInstanceOf(ilTermsOfServiceUserHasLanguageCriterionGUI::class, $gui);

        $form = $this->buildForm($gui, $httpCriterionSelectionBodyParameter);

        $languageSelection = $form->getItemByPostVar($httpCriterionConfigBodyParameter);
        $this->assertInstanceOf(ilSelectInputGUI::class, $languageSelection);
        $this->assertSame($languageSelection->getValue(), $this->expectedInitialValue);

        return $criterion;
    }

    public function testValuesFromFormUserInterfaceElementsCanBeRetrieved(
        ilTermsOfServiceUserHasLanguageCriterion $criterion
    ): void {
        $httpCriterionSelectionBodyParameter = 'criterion';
        $httpCriterionConfigBodyParameter = $criterion->getTypeIdent() . '_lng';

        $gui = $criterion->ui($this->lng);

        $form = $this->buildForm($gui, $httpCriterionSelectionBodyParameter);

        $form
            ->expects($this->once())
            ->method('getInput')
            ->with($httpCriterionConfigBodyParameter)
            ->willReturnCallback(function () {
                return $this->expectedAfterFormSubmitValue;
            });

        $value = $gui->getConfigByForm($form);

        $this->assertInstanceOf(ilTermsOfServiceCriterionConfig::class, $value);
        $this->assertSame($this->expectedAfterFormSubmitValue, $value['lng']);
        $this->assertEquals($this->getCriterionConfig(['lng' => $this->expectedAfterFormSubmitValue]), $value);
    }

    public function testTypeIdentPresentationIsANonEmptyString(
        ilTermsOfServiceUserHasLanguageCriterion $criterion
    ): void {
        $gui = $criterion->ui($this->lng);

        $actual = $gui->getIdentPresentation();

        $this->assertIsString($actual);
        $this->assertNotEmpty($actual);
    }

    public function languageProvider(): array
    {
        return [
            'English Language' => [$this->expectedInitialValue, $this->englishLanguageTranslation],
            'German Language' => [$this->expectedAfterFormSubmitValue, $this->germanLanguageTranslation],
            'Invalid Languages' => ['invalid_lng', ''],
        ];
    }

    public function testValuePresentationMatchesExpectation(string $lng, string $translation): void
    {
        $language = $this->getLanguageMock();

        $language
            ->method('txt')
            ->with('meta_l_' . $lng, '')
            ->willReturn($translation);

        $criterion = new ilTermsOfServiceUserHasLanguageCriterion();
        $gui = $criterion->ui($language);

        $actual = $gui->getValuePresentation(
            $this->getCriterionConfig(['lng' => $lng]),
            $this->getUiFactoryMock()
        );

        $this->assertInstanceOf(Component::class, $actual);
        $this->assertInstanceOf(Legacy::class, $actual);
        $this->assertSame($translation, $actual->getContent());
    }

    public function failingConfigProvider(): array
    {
        $criterion = $this->getInstance();

        return [
            'English Language where German is Expected' => [$criterion, $this->getCriterionConfig(['lng' => 'en'])],
            'Array' => [$criterion, $this->getCriterionConfig(['lng' => []])],
            'Object' => [$criterion, $this->getCriterionConfig(['lng' => new stdClass()])],
            'Double' => [$criterion, $this->getCriterionConfig(['lng' => 1.0])],
            'Integer' => [$criterion, $this->getCriterionConfig(['lng' => 1])],
            'Wrong Key Provided for Extracting Language' => [
                $criterion,
                $this->getCriterionConfig(['another_config_key' => true])
            ],
            'Empty Configuration' => [$criterion, $this->getCriterionConfig()],
        ];
    }

    public function succeedingConfigProvider(): array
    {
        $criterion = $this->getInstance();

        return [
            'German Language' => [$criterion, $this->getCriterionConfig(['lng' => 'de'])],
            'German Language Uppercase' => [$criterion, $this->getCriterionConfig(['lng' => 'DE'])],
        ];
    }

    public function testEvaluationFailsIfUserLanguageDoesNotMatchDefinedLanguage(
        ilTermsOfServiceUserHasLanguageCriterion $criterion,
        ilTermsOfServiceCriterionConfig $config
    ): void {
        $user = $this->getUserMock();

        $user
            ->method('getLanguage')
            ->willReturn('de');

        $this->assertFalse($criterion->evaluate($user, $config));
    }

    public function testEvaluationSucceedsIfUserLanguageDoesMatchDefinedLanguage(
        ilTermsOfServiceUserHasLanguageCriterion $criterion,
        ilTermsOfServiceCriterionConfig $config
    ): void {
        $user = $this->getUserMock();

        $user
            ->method('getLanguage')
            ->willReturn('de');

        $this->assertTrue($criterion->evaluate($user, $config));
    }
}