FileCollectionRegistryTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Unit\Resource\Collection;

/*
 * 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!
 */

class FileCollectionRegistryTest extends \TYPO3\CMS\Core\Tests\Unit\Resource\BaseTestCase
{
    protected $testSubject;

    protected function setUp()
    {
        $this->initializeTestSubject();
    }

    protected function initializeTestSubject()
    {
        $this->testSubject = new \TYPO3\CMS\Core\Resource\Collection\FileCollectionRegistry();
    }

    public function registeredFileCollectionClassesCanBeRetrieved()
    {
        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $this->testSubject->registerFileCollectionClass($className, 'foobar');
        $returnedClassName = $this->testSubject->getFileCollectionClass('foobar');
        $this->assertEquals($className, $returnedClassName);
    }

    public function registerFileCollectionClassThrowsExceptionIfClassDoesNotExist()
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1391295613);

        $this->testSubject->registerFileCollectionClass($this->getUniqueId(), substr($this->getUniqueId(), 0, 30));
    }

    public function registerFileCollectionClassThrowsExceptionIfTypeIsTooLong()
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1391295611);

        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $type = str_pad('', 40);
        $this->testSubject->registerFileCollectionClass($className, $type);
    }

    public function registerFileCollectionClassThrowsExceptionIfTypeIsAlreadyRegistered()
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1391295643);

        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $className2 = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\StaticFileCollection::class));
        $this->testSubject->registerFileCollectionClass($className, 'foobar');
        $this->testSubject->registerFileCollectionClass($className2, 'foobar');
    }

    public function registerFileCollectionClassOverridesExistingRegisteredFileCollectionClass()
    {
        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $className2 = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\StaticFileCollection::class));
        $this->testSubject->registerFileCollectionClass($className, 'foobar');
        $this->testSubject->registerFileCollectionClass($className2, 'foobar', true);
    }

    public function getFileCollectionClassThrowsExceptionIfClassIsNotRegistered()
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1391295644);

        $this->testSubject->getFileCollectionClass($this->getUniqueId());
    }

    public function getFileCollectionClassAcceptsClassNameIfClassIsRegistered()
    {
        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $this->testSubject->registerFileCollectionClass($className, 'foobar');
        $this->assertEquals($className, $this->testSubject->getFileCollectionClass('foobar'));
    }

    public function fileCollectionRegistryIsInitializedWithPreconfiguredFileCollections()
    {
        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $type = substr($this->getUniqueId(), 0, 30);
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['fal']['registeredCollections'] = [
            $type => $className
        ];
        $this->initializeTestSubject();
        $this->assertEquals($className, $this->testSubject->getFileCollectionClass($type));
    }

    public function fileCollectionExistsReturnsTrueForAllExistingFileCollections()
    {
        $className = get_class($this->getMockForAbstractClass(\TYPO3\CMS\Core\Resource\Collection\AbstractFileCollection::class));
        $type = 'foo';
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['fal']['registeredCollections'] = [
            $type => $className
        ];
        $this->initializeTestSubject();
        $this->assertTrue($this->testSubject->fileCollectionTypeExists($type));
        $this->assertFalse($this->testSubject->fileCollectionTypeExists('bar'));
    }

    public function fileCollectionExistsReturnsFalseIfFileCollectionDoesNotExist()
    {
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['fal']['registeredFileCollections'] = [];
        $this->initializeTestSubject();
        $this->assertFalse($this->testSubject->fileCollectionTypeExists($this->getUniqueId()));
    }

    public function addNewTypeToTCA()
    {

        // Create a TCA fixture for sys_file_collection
        $GLOBALS['TCA']['sys_file_collection'] = [
            'types' => [
                'typeB' => ['showitem' => 'fieldA, fieldB, fieldC;labelC, --palette--;;paletteC, fieldD'],
            ],
            'columns' => [
                'type' => [
                    'config' => [
                        'items' => ['Type B', 'typeB']
                    ]
                ]
            ]
        ];

        $type = 'my_type';
        $label = 'The Label';

        $this->testSubject->addTypeToTCA($type, $label, 'something');

        // check type
        $this->assertEquals('sys_language_uid, l10n_parent, l10n_diffsource, title, --palette--;;1, type, something', $GLOBALS['TCA']['sys_file_collection']['types']['my_type']['showitem']);

        $indexOfNewType = count($GLOBALS['TCA']['sys_file_collection']['columns']['type']['config']['items']) - 1;

        // check if columns.type.item exist
        $this->assertEquals($type, $GLOBALS['TCA']['sys_file_collection']['columns']['type']['config']['items'][$indexOfNewType][1]);
        $this->assertEquals($label, $GLOBALS['TCA']['sys_file_collection']['columns']['type']['config']['items'][$indexOfNewType][0]);
    }
}