9.5/_abstract_plugin_test_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Frontend\Tests\Unit\Plugin;


/*

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

 */

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

use ‪TYPO3\CMS\Frontend\ContentObject\TextContentObject;

use ‪TYPO3\CMS\Frontend\Plugin\AbstractPlugin;

use ‪TYPO3\CMS\Frontend\Tests\Unit\Fixtures\ResultBrowserPluginHook;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪AbstractPluginTest extends UnitTestCase

{

    protected ‪$abstractPlugin;


    protected ‪$defaultPiVars;


    protected ‪$resetSingletonInstances = true;


    protected function ‪setUp()

    {

        parent::setUp();


        // Allow objects until 100 levels deep when executing the stdWrap

        ‪$GLOBALS['TSFE'] = new \stdClass();

        ‪$GLOBALS['TSFE']->cObjectDepthCounter = 100;


        $this->abstractPlugin = new ‪AbstractPlugin();

        $contentObjectRenderer = new ‪ContentObjectRenderer();

        $contentObjectRenderer->setContentObjectClassMap([

            'TEXT' => TextContentObject::class,

        ]);

        $this->abstractPlugin->cObj = $contentObjectRenderer;

        $this->defaultPiVars = $this->abstractPlugin->piVars;

    }


    public function ‪piSetPiVarDefaultsStdWrapProvider()

    {

        return [

            'stdWrap on conf, non-recursive, stdWrap 1 level deep' => [

                [

                    'abc' => 'DEF',

                    'abc.' => [

                        'stdWrap.' => [

                            'wrap' => 'test | test'

                        ],

                    ],

                ],

                [

                    'abc' => 'testDEFtest',

                    'pointer' => '',

                    'mode' => '',

                    'sword' => '',

                    'sort' => '',

                ],

            ],

            'stdWrap on conf, non-recursive, stdWrap 2 levels deep' => [

                [

                    'xyz.' => [

                        'stdWrap.' => [

                            'cObject' => 'TEXT',

                            'cObject.' => [

                                'data' => 'date:U',

                                'strftime' => '%Y',

                            ],

                        ],

                    ],

                ],

                [

                    'xyz' => date('Y'),

                    'pointer' => '',

                    'mode' => '',

                    'sword' => '',

                    'sort' => '',

                ],

            ],

            'stdWrap on conf, recursive' => [

                [

                    'abc.' => [

                        'def' => 'DEF',

                        'def.' => [

                            'ghi' => '123',

                            'stdWrap.' => [

                                'wrap' => 'test | test'

                            ],

                        ],

                    ],

                ],

                [

                    'abc.' => [

                        'def' => 'testDEFtest',

                        'def.' => [

                            'ghi' => '123',

                        ],

                    ],

                    'pointer' => '',

                    'mode' => '',

                    'sword' => '',

                    'sort' => '',

                ],

            ],

        ];

    }


    public function ‪piSetPiVarDefaultsStdWrap($input, $expected)

    {

        $this->resetSingletonInstances = true;

        $this->abstractPlugin->piVars = ‪$this->defaultPiVars;


        $this->abstractPlugin->conf['_DEFAULT_PI_VARS.'] = $input;

        $this->abstractPlugin->pi_setPiVarDefaults();

        $this->assertEquals($expected, $this->abstractPlugin->piVars);

    }


    public function ‪registeredResultBrowserProvider()

    {

        return [

            'Result browser returning false' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => false,

                'expected' => ''

            ],

            'Result browser returning null' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => null,

                'expected' => ''

            ],

            'Result browser returning whitespace string' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => '   ',

                'expected' => ''

            ],

            'Result browser returning HTML' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => '<div><a href="index.php?id=1&pointer=1">1</a><a href="index.php?id=1&pointer=2">2</a><a href="index.php?id=1&pointer=3">3</a><a href="index.php?id=1&pointer=4">4</a></div>',

                'expected' => '<div><a href="index.php?id=1&pointer=1">1</a><a href="index.php?id=1&pointer=2">2</a><a href="index.php?id=1&pointer=3">3</a><a href="index.php?id=1&pointer=4">4</a></div>'

            ],

            'Result browser returning a truthy integer as string' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => '1',

                'expected' => '1'

            ],

            'Result browser returning a falsy integer' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => 0,

                'expected' => ''

            ],

            'Result browser returning a truthy integer' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => 1,

                'expected' => ''

            ],

            'Result browser returning a positive integer' => [

                'className' => $this->getUniqueId('tx_coretest'),

                'returnValue' => 42,

                'expected' => ''

            ]

        ];

    }


    public function ‪registeredResultBrowsersAreUsed($className, $returnValue, $expected)

    {

        $resultBrowserHook = $this->getMockBuilder(ResultBrowserPluginHook::class)

            ->setMockClassName($className)

            ->setMethods(['pi_list_browseresults'])

            ->disableOriginalConstructor()

            ->getMock();


        // Register hook mock object

        GeneralUtility::addInstance($className, $resultBrowserHook);

        ‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][AbstractPlugin::class]['pi_list_browseresults'] = [$className];


        $resultBrowserHook->expects($this->atLeastOnce())

            ->method('pi_list_browseresults')

            ->with(1, '', [], 'pointer', true, false, $this->abstractPlugin)

            ->will($this->returnValue($returnValue));


        $actualReturnValue = $this->abstractPlugin->pi_list_browseresults();


        $this->assertSame($expected, $actualReturnValue);


        unset(‪$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][AbstractPlugin::class]['pi_list_browseresults']);

    }

}