IconFactoryTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Functional\Imaging;
 
use Prophecy\PhpUnit\ProphecyTrait;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Imaging\IconProvider\FontawesomeIconProvider;
use ‪TYPO3\CMS\Core\Imaging\IconRegistry;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\ResourceStorage;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪IconFactoryTest extends FunctionalTestCase
{
    use ProphecyTrait;
 
    protected ‪IconFactory ‪$subject;
    protected string ‪$notRegisteredIconIdentifier = 'my-super-unregistered-identifier';
    protected string ‪$registeredIconIdentifier = 'actions-close';
    protected string ‪$registeredSpinningIconIdentifier = 'spinning-icon';
 
    protected array ‪$mockRecord = [
        'header' => 'dummy content header',
        'uid' => '1',
        'pid' => '1',
        'image' => '',
        'hidden' => '0',
        'starttime' => '0',
        'endtime' => '0',
        'fe_group' => '',
        'CType' => 'text',
        't3ver_state' => '0',
        't3ver_wsid' => '0',
        'sys_language_uid' => '0',
        'l18n_parent' => '0',
        'subheader' => '',
        'bodytext' => '',
    ];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->subject = GeneralUtility::getContainer()->get(IconFactory::class);
    }
 
    public function ‪differentSizesDataProvider(): array
    {
        return [
            ['size ' . ‪Icon::SIZE_SMALL => ['input' => ‪Icon::SIZE_SMALL, 'expected' => ‪Icon::SIZE_SMALL]],
            ['size ' . ‪Icon::SIZE_DEFAULT => ['input' => ‪Icon::SIZE_DEFAULT, 'expected' => ‪Icon::SIZE_DEFAULT]],
            ['size ' . ‪Icon::SIZE_LARGE => ['input' => ‪Icon::SIZE_LARGE, 'expected' => ‪Icon::SIZE_LARGE]],
        ];
    }
 
    public function ‪getIconReturnsIconWithCorrectMarkupWrapperIfRegisteredIconIdentifierIsUsed(): void
    {
        self::assertStringContainsString(
            '<span class="icon-markup">',
            $this->subject->getIcon($this->registeredIconIdentifier)->render()
        );
    }
 
    public function ‪getIconByIdentifierReturnsIconWithCorrectMarkupIfRegisteredIconIdentifierIsUsed(): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-actions-close" data-identifier="actions-close">',
            $this->subject->getIcon($this->registeredIconIdentifier)->render()
        );
    }
 
    public function ‪getIconByIdentifierAndSizeReturnsIconWithCorrectMarkupIfRegisteredIconIdentifierIsUsed($size): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-' . $size['expected'] . ' icon-state-default icon-actions-close" data-identifier="actions-close">',
            $this->subject->getIcon($this->registeredIconIdentifier, $size['input'])->render()
        );
    }
 
    public function ‪getIconByIdentifierAndSizeAndWithOverlayReturnsIconWithCorrectOverlayMarkupIfRegisteredIconIdentifierIsUsed($size): void
    {
        self::assertStringContainsString(
            '<span class="icon-overlay icon-overlay-readonly">',
            $this->subject->getIcon($this->registeredIconIdentifier, $size['input'], 'overlay-readonly')->render()
        );
    }
 
    public function ‪getIconReturnsNotFoundIconWithCorrectMarkupIfUnregisteredIdentifierIsUsed(): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-default-not-found" data-identifier="default-not-found">',
            $this->subject->getIcon($this->notRegisteredIconIdentifier)->render()
        );
    }
 
    public function ‪getIconByIdentifierAndSizeReturnsNotFoundIconWithCorrectMarkupIfUnregisteredIdentifierIsUsed(array $size): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-' . $size['expected'] . ' icon-state-default icon-default-not-found" data-identifier="default-not-found">',
            $this->subject->getIcon($this->notRegisteredIconIdentifier, $size['input'])->render()
        );
    }
 
    public function ‪getIconReturnsCorrectMarkupIfIconIsRegisteredAsSpinningIcon(): void
    {
        $iconRegistry = GeneralUtility::getContainer()->get(IconRegistry::class);
        $iconRegistry->registerIcon(
            $this->registeredSpinningIconIdentifier,
            FontawesomeIconProvider::class,
            [
                'name' => 'times',
                'spinning' => true,
            ]
        );
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-' . $this->registeredSpinningIconIdentifier . ' icon-spin" data-identifier="spinning-icon">',
            $this->subject->getIcon($this->registeredSpinningIconIdentifier)->render()
        );
    }
 
    public function ‪getIconByIdentifierAndSizeAndOverlayReturnsNotFoundIconWithCorrectMarkupIfUnregisteredIdentifierIsUsed(array $size): void
    {
        self::assertStringContainsString(
            '<span class="icon-overlay icon-overlay-readonly">',
            $this->subject->getIcon($this->notRegisteredIconIdentifier, $size['input'], 'overlay-readonly')->render()
        );
    }
 
    public function ‪getIconThrowsExceptionIfInvalidSizeIsGiven(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->subject->getIcon($this->registeredIconIdentifier, 'foo')->render();
    }
 
    //
    // Tests for getIconForFileExtension
    //
 
    public function ‪getIconForFileWithNoFileTypeReturnsDefaultFileIcon(): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-other-other" data-identifier="mimetypes-other-other">',
            $this->subject->getIconForFileExtension('')->render()
        );
    }
 
    public function ‪getIconForFileWithUnknownFileTypeReturnsDefaultFileIcon(): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-other-other" data-identifier="mimetypes-other-other">',
            $this->subject->getIconForFileExtension('foo')->render()
        );
    }
 
    public function ‪getIconForFileWithFileTypePdfReturnsPdfIcon(): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-pdf" data-identifier="mimetypes-pdf">',
            $this->subject->getIconForFileExtension('pdf')->render()
        );
    }
 
    public function ‪getIconForFileWithFileTypePngReturnsPngIcon(): void
    {
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-media-image" data-identifier="mimetypes-media-image">',
            $this->subject->getIconForFileExtension('png')->render()
        );
    }
 
    public function ‪getIconForResourceReturnsCorrectMarkupForFileResources(): void
    {
        $resourceProphecy = $this->prophesize(File::class);
        $resourceProphecy->isMissing()->willReturn(false);
        $resourceProphecy->getExtension()->willReturn('pdf');
        $resourceProphecy->getMimeType()->willReturn('');
 
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-pdf" data-identifier="mimetypes-pdf">',
            $this->subject->getIconForResource($resourceProphecy->reveal())->render()
        );
    }
 
    // Tests concerning getIconForResource
 
    public function ‪getIconForResourceWithFileWithoutExtensionTypeReturnsOtherIcon(): void
    {
        $fileObject = $this->‪getTestSubjectFileObject('');
        $result = $this->subject->getIconForResource($fileObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-other-other" data-identifier="mimetypes-other-other">', $result);
    }
 
    public function ‪getIconForResourceWithUnknownFileTypeReturnsOtherIcon(): void
    {
        $fileObject = $this->‪getTestSubjectFileObject('foo');
        $result = $this->subject->getIconForResource($fileObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-other-other" data-identifier="mimetypes-other-other">', $result);
    }
 
    public function ‪getIconForResourceWithPdfReturnsPdfIcon(): void
    {
        $fileObject = $this->‪getTestSubjectFileObject('pdf');
        $result = $this->subject->getIconForResource($fileObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-pdf" data-identifier="mimetypes-pdf">', $result);
    }
 
    public function ‪getIconForResourceWithMimeTypeApplicationPdfReturnsPdfIcon(): void
    {
        $fileObject = $this->‪getTestSubjectFileObject('pdf', 'application/pdf');
        $result = $this->subject->getIconForResource($fileObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-pdf" data-identifier="mimetypes-pdf">', $result);
    }
 
    public function ‪getIconForResourceWithCustomImageMimeTypeReturnsImageIcon(): void
    {
        $fileObject = $this->‪getTestSubjectFileObject('custom', 'image/my-custom-extension');
        $result = $this->subject->getIconForResource($fileObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-media-image" data-identifier="mimetypes-media-image">', $result);
    }
 
    public function ‪getIconForResourceWithPngFileReturnsIcon(): void
    {
        $fileObject = $this->‪getTestSubjectFileObject('png', 'image/png');
        $result = $this->subject->getIconForResource($fileObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-media-image" data-identifier="mimetypes-media-image">', $result);
    }
 
    public function ‪getIconForResourceWithFolderReturnsFolderIcon(): void
    {
        $folderObject = $this->‪getTestSubjectFolderObject('/test');
        $result = $this->subject->getIconForResource($folderObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-apps-filetree-folder-default" data-identifier="apps-filetree-folder-default">', $result);
    }
 
    public function ‪getIconForResourceWithOpenFolderReturnsOpenFolderIcon(): void
    {
        $folderObject = $this->‪getTestSubjectFolderObject('/test');
        $result = $this->subject->getIconForResource($folderObject, ‪Icon::SIZE_DEFAULT, null, ['folder-open' => true])->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-apps-filetree-folder-opened" data-identifier="apps-filetree-folder-opened">', $result);
    }
 
    public function ‪getIconForResourceWithRootFolderReturnsRootFolderIcon(): void
    {
        $folderObject = $this->‪getTestSubjectFolderObject('/');
        $result = $this->subject->getIconForResource($folderObject)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-apps-filetree-root" data-identifier="apps-filetree-root">', $result);
    }
 
    public function ‪getIconForResourceWithMountRootReturnsMountFolderIcon(): void
    {
        $folderObject = $this->‪getTestSubjectFolderObject('/mount');
        $result = $this->subject->getIconForResource($folderObject, ‪Icon::SIZE_DEFAULT, null, ['mount-root' => true])->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-apps-filetree-mount" data-identifier="apps-filetree-mount">', $result);
    }
 
    //
    // Test for getIconForRecord
    //
 
    public function ‪getIconForRecordWithNullTableReturnsMissingIcon(): void
    {
        ‪$GLOBALS['TCA']['']['ctrl'] = [];
        self::assertStringContainsString(
            '<span class="t3js-icon icon icon-size-default icon-state-default icon-default-not-found" data-identifier="default-not-found">',
            $this->subject->getIconForRecord('', [])->render()
        );
    }
 
    public function ‪getIconForRecordWithEmptyRecordReturnsNormalIcon(): void
    {
        ‪$GLOBALS['TCA'] = [
            'tt_content' => [
                'ctrl' => [
                    'typeicon_column' => 'CType',
                    'typeicon_classes' => [
                        'default' => 'mimetypes-x-content-text',
                    ],
                ],
            ],
        ];
        $result = $this->subject->getIconForRecord('tt_content', [])->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-x-content-text" data-identifier="mimetypes-x-content-text">', $result);
    }
 
    public function ‪getIconForRecordWithMockRecordReturnsNormalIcon(): void
    {
        ‪$GLOBALS['TCA'] = [
            'tt_content' => [
                'ctrl' => [
                    'typeicon_column' => 'CType',
                    'typeicon_classes' => [
                        'default' => '',
                        'text' => 'mimetypes-x-content-text',
                    ],
                ],
            ],
        ];
        $result = $this->subject->getIconForRecord('tt_content', $this->mockRecord)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-x-content-text" data-identifier="mimetypes-x-content-text">', $result);
    }
 
    public function ‪getIconForRecordWithMockRecordOfTypePluginReturnsDefaultPluginIcon(): void
    {
        ‪$GLOBALS['TCA'] = [
            'tt_content' => [
                'ctrl' => [
                    'typeicon_column' => 'CType',
                    'typeicon_classes' => [
                        'default' => '',
                        'list' => 'mimetypes-x-content-plugin',
                    ],
                ],
            ],
        ];
        ‪$mockRecord = ‪$this->mockRecord;
        ‪$mockRecord['CType'] = 'list';
        $result = $this->subject->getIconForRecord('tt_content', ‪$mockRecord)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-x-content-plugin" data-identifier="mimetypes-x-content-plugin">', $result);
    }
 
    public function ‪getIconForRecordWithMockRecordOfTypePluginReturnsConfiguredPluginIcon(): void
    {
        ‪$GLOBALS['TCA'] = [
            'tt_content' => [
                'ctrl' => [
                    'typeicon_column' => 'CType',
                    'typeicon_classes' => [
                        'default' => '',
                        'list' => 'mimetypes-x-content-plugin',
                    ],
                ],
                'columns' => [
                    'list_type' => [
                        'config' => [
                            'items' => [
                                [
                                    'Blog example plugin',
                                    'pi_blogexample',
                                    ‪$this->registeredIconIdentifier,
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ];
        ‪$mockRecord = ‪$this->mockRecord;
        ‪$mockRecord['CType'] = 'list';
        ‪$mockRecord['list_type'] = 'pi_blogexample';
        $result = $this->subject->getIconForRecord('tt_content', ‪$mockRecord)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-actions-close" data-identifier="actions-close">', $result);
    }
 
    public function ‪getIconForRecordWithMockRecordWithHiddenFlagReturnsNormalIconAndOverlay(): void
    {
        ‪$GLOBALS['TCA'] = [
            'tt_content' => [
                'ctrl' => [
                    'enablecolumns' => [
                        'disabled' => 'hidden',
                    ],
                    'typeicon_column' => 'CType',
                    'typeicon_classes' => [
                        'default' => '',
                        'text' => 'mimetypes-x-content-text',
                    ],
                ],
            ],
        ];
        ‪$mockRecord = ‪$this->mockRecord;
        ‪$mockRecord['hidden'] = '1';
        $result = $this->subject->getIconForRecord('tt_content', ‪$mockRecord)->render();
        self::assertStringContainsString('<span class="t3js-icon icon icon-size-default icon-state-default icon-mimetypes-x-content-text" data-identifier="mimetypes-x-content-text">', $result);
        self::assertStringContainsString('<span class="icon-overlay icon-overlay-hidden">', $result);
    }
 
    protected function ‪getTestSubjectFileObject(string $extension, string $mimeType = ''): File
    {
        $mockedStorage = $this->createMock(ResourceStorage::class);
        $mockedFile = $this->getMockBuilder(File::class)
            ->setConstructorArgs([['identifier' => '', 'name' => ''], $mockedStorage])
            ->getMock();
        $mockedFile->expects(self::atMost(1))->method('getExtension')->willReturn($extension);
        $mockedFile->expects(self::atLeastOnce())->method('getMimeType')->willReturn($mimeType);
        return $mockedFile;
    }
 
    protected function ‪getTestSubjectFolderObject(string $identifier): Folder
    {
        $mockedStorage = $this->createMock(ResourceStorage::class);
        $mockedStorage->method('getRootLevelFolder')->willReturn(
            new Folder($mockedStorage, '/', '/')
        );
        $mockedStorage->method('checkFolderActionPermission')->willReturn(true);
        $mockedStorage->method('isBrowsable')->willReturn(true);
        return new Folder($mockedStorage, $identifier, $identifier);
    }
}