ilSystemStyleIconFolderTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once('libs/composer/vendor/autoload.php');

class ilSystemStyleIconFolderTest extends ilSystemStyleBaseFSTest
{
    protected string $icon_name = 'test_image_1.svg';
    protected string $icon_type = 'svg';

    public function testConstruct(): void
    {
        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        $this->assertEquals($this->container->getImagesSkinPath($this->style->getId()), $folder->getPath());
    }

    public function testSetPath(): void
    {
        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));
        $folder->setPath('pathnew');

        $this->assertEquals('pathnew', $folder->getPath());
    }

    public function testReadRecursiveCount(): void
    {
        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));
        $this->assertCount(5, $folder->getIcons());
    }

    public function testFolderDoesNotExist(): void
    {
        try {
            new ilSystemStyleIconFolder('Does not exist');
            $this->fail();
        } catch (ilSystemStyleIconException $e) {
            $this->assertEquals(ilSystemStyleIconException::IMAGES_FOLDER_DOES_NOT_EXIST, $e->getCode());
        }
    }

    public function testFolderGetIconByName(): void
    {
        $style_path = $this->container->getImagesSkinPath($this->style->getId());

        $path1 = $style_path . '/test_image_1.svg';
        $icon1 = new ilSystemStyleIcon('test_image_1.svg', $path1, 'svg');
        $folder = new ilSystemStyleIconFolder($style_path);
        $this->assertEquals($icon1, $folder->getIconByName('test_image_1.svg'));
    }

    public function testFolderGetIconByPath(): void
    {
        $style_path = $this->container->getImagesSkinPath($this->style->getId());

        $path1 = $style_path . '/test_image_1.svg';
        $icon1 = new ilSystemStyleIcon('test_image_1.svg', $path1, 'svg');
        $folder = new ilSystemStyleIconFolder($style_path);
        $this->assertEquals($icon1, $folder->getIconByPath($path1));
    }

    public function testIconDoesNotExist(): void
    {
        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        try {
            $folder->getIconByName('doesNotExist.svg');
            $this->fail();
        } catch (ilSystemStyleIconException $e) {
            $this->assertEquals(ilSystemStyleIconException::ICON_DOES_NOT_EXIST, $e->getCode());
        }
    }

    public function testReadRecursiveAndSortByName(): void
    {
        $style_path = $this->container->getImagesSkinPath($this->style->getId());

        $path1 = $style_path . '/test_image_1.svg';
        $icon1 = new ilSystemStyleIcon('test_image_1.svg', $path1, 'svg');

        $path2 = $style_path . '/image_subfolder/sub_test_image_1.svg';
        $icon2 = new ilSystemStyleIcon('sub_test_image_1.svg', $path2, 'svg');

        $path3 = $style_path . '/image_subfolder/sub_test_image_2.svg';
        $icon3 = new ilSystemStyleIcon('sub_test_image_2.svg', $path3, 'svg');

        $path4 = $style_path . '/nonsvg.png';
        $icon4 = new ilSystemStyleIcon('nonsvg.png', $path4, 'png');

        $path5 = $style_path . '/icon_accs.svg';
        $icon5 = new ilSystemStyleIcon('icon_accs.svg', $path5, 'svg');

        $expected_icons = [$icon5, $icon2, $icon3, $icon1, $icon4];

        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));
        $this->assertEquals($expected_icons, $folder->getIcons());
    }

    public function testReadRecursiveAndSortByFolder(): void
    {
        $style_path = $this->container->getImagesSkinPath($this->style->getId());

        $path1 = $style_path . '/test_image_1.svg';
        $icon1 = new ilSystemStyleIcon('test_image_1.svg', $path1, 'svg');

        $path2 = $style_path . '/image_subfolder/sub_test_image_1.svg';
        $icon2 = new ilSystemStyleIcon('sub_test_image_1.svg', $path2, 'svg');

        $path3 = $style_path . '/image_subfolder/sub_test_image_2.svg';
        $icon3 = new ilSystemStyleIcon('sub_test_image_2.svg', $path3, 'svg');

        $path4 = $style_path . '/nonsvg.png';
        $icon4 = new ilSystemStyleIcon('nonsvg.png', $path4, 'png');

        $path5 = $style_path . '/icon_accs.svg';
        $icon5 = new ilSystemStyleIcon('icon_accs.svg', $path5, 'svg');

        $expected_icons = [
            $style_path => [$icon5, $icon1, $icon4],
            $style_path . '/image_subfolder' => [$icon2, $icon3],
        ];

        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));
        $this->assertEquals($expected_icons, $folder->getIconsSortedByFolder());
    }

    public function testExtractColorset(): void
    {
        $folder = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        $expected_color_set = new ilSystemStyleIconColorSet();
        $color1 = new ilSystemStyleIconColor('id_505050', '505050', '505050', '505050');
        $color2 = new ilSystemStyleIconColor('id_6B6B6B', '6B6B6B', '6B6B6B', '6B6B6B');
        $color3 = new ilSystemStyleIconColor('id_838383', '838383', '838383', '838383');
        $color4 = new ilSystemStyleIconColor('id_8C8C8C', '8C8C8C', '8C8C8C', '8C8C8C');
        $color5 = new ilSystemStyleIconColor('id_303030', '303030', '303030', '303030');
        $color6 = new ilSystemStyleIconColor('id_404040', '404040', '404040', '404040');
        $color7 = new ilSystemStyleIconColor('id_000', '000', '000', '000');

        $expected_color_set->addColor($color1);
        $expected_color_set->addColor($color2);
        $expected_color_set->addColor($color3);
        $expected_color_set->addColor($color4);
        $expected_color_set->addColor($color5);
        $expected_color_set->addColor($color6);
        $expected_color_set->addColor($color7);

        $this->assertEquals($expected_color_set, $folder->getColorSet());
    }

    public function testExtractChangeColors(): void
    {
        $folder1 = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));
        $folder1->changeIconColors(['505050' => '555555']);

        $folder2 = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        $expected_color_set = new ilSystemStyleIconColorSet();
        $color1 = new ilSystemStyleIconColor('id_555555', '555555', '555555', '555555');
        $color2 = new ilSystemStyleIconColor('id_6B6B6B', '6B6B6B', '6B6B6B', '6B6B6B');
        $color3 = new ilSystemStyleIconColor('id_838383', '838383', '838383', '838383');
        $color4 = new ilSystemStyleIconColor('id_8C8C8C', '8C8C8C', '8C8C8C', '8C8C8C');
        $color5 = new ilSystemStyleIconColor('id_303030', '303030', '303030', '303030');
        $color6 = new ilSystemStyleIconColor('id_404040', '404040', '404040', '404040');
        $color7 = new ilSystemStyleIconColor('id_000', '000', '000', '000');

        $expected_color_set->addColor($color2);
        $expected_color_set->addColor($color3);
        $expected_color_set->addColor($color4);
        $expected_color_set->addColor($color5);
        $expected_color_set->addColor($color6);
        $expected_color_set->addColor($color1);
        $expected_color_set->addColor($color7);

        $this->assertEquals($expected_color_set, $folder2->getColorSet());
    }

    public function testGetUsages(): void
    {
        $style_path = $this->container->getImagesSkinPath($this->style->getId());

        $folder1 = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        $path1 = $style_path . '/test_image_1.svg';
        $icon1 = new ilSystemStyleIcon('test_image_1.svg', $path1, 'svg');
        $icon1->getColorSet();

        $path2 = $style_path . '/image_subfolder/sub_test_image_1.svg';
        $icon2 = new ilSystemStyleIcon('sub_test_image_1.svg', $path2, 'svg');
        $icon2->getColorSet();

        $path3 = $style_path . '/image_subfolder/sub_test_image_2.svg';
        $icon3 = new ilSystemStyleIcon('sub_test_image_2.svg', $path3, 'svg');
        $icon3->getColorSet();

        $expected_icons_usages = [$icon2, $icon3, $icon1];

        $this->assertEquals($expected_icons_usages, $folder1->getUsagesOfColor('id_6B6B6B'));
    }

    public function testGetUsagesAfterChangeColor(): void
    {
        $style_path = $this->container->getImagesSkinPath($this->style->getId());

        $folder1 = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));
        $folder1->changeIconColors(['6B6B6B' => '7B6B6B']);

        $folder2 = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        $path1 = $style_path . '/test_image_1.svg';
        $icon1 = new ilSystemStyleIcon('test_image_1.svg', $path1, 'svg');
        $icon1->getColorSet();

        $path2 = $style_path . '/image_subfolder/sub_test_image_1.svg';
        $icon2 = new ilSystemStyleIcon('sub_test_image_1.svg', $path2, 'svg');
        $icon2->getColorSet();

        $path3 = $style_path . '/image_subfolder/sub_test_image_2.svg';
        $icon3 = new ilSystemStyleIcon('sub_test_image_2.svg', $path3, 'svg');
        $icon3->getColorSet();

        $expected_icons_usages = [$icon2, $icon3, $icon1];

        $this->assertEquals($expected_icons_usages, $folder2->getUsagesOfColor('id_7B6B6B'));
        $this->assertEquals([], $folder2->getUsagesOfColor('id_6B6B6B'));
    }

    public function testGetUsagesAsString(): void
    {
        $folder1 = new ilSystemStyleIconFolder($this->container->getImagesSkinPath($this->style->getId()));

        $this->assertEquals(
            'sub_test_image_1; sub_test_image_2; test_image_1; ',
            $folder1->getUsagesOfColorAsString('id_6B6B6B')
        );
    }
}