SelectViewHelperTest.php

Go to the documentation of this file.

<?php

/*                                                                        *
 * This script belongs to the FLOW3 package "Fluid".                      *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License as published by the *
 * Free Software Foundation, either version 3 of the License, or (at your *
 * option) any later version.                                             *
 *                                                                        *
 * This script is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
 * General Public License for more details.                               *
 *                                                                        *
 * You should have received a copy of the GNU Lesser General Public       *
 * License along with the script.                                         *
 * If not, see http://www.gnu.org/licenses/lgpl.html                      *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */

require_once(dirname(__FILE__) . '/Fixtures/EmptySyntaxTreeNode.php');
require_once(dirname(__FILE__) . '/Fixtures/Fixture_UserDomainClass.php');
require_once(dirname(__FILE__) . '/../ViewHelperBaseTestcase.php');

/**
 * Test for the "Select" Form view helper
 *
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 */
class Tx_Fluid_Tests_Unit_ViewHelpers_Form_SelectViewHelperTest extends Tx_Fluid_ViewHelpers_ViewHelperBaseTestcase {

    /**
     * var Tx_Fluid_ViewHelpers_Form_SelectViewHelper
     */
    protected $viewHelper;

    public function setUp() {
        parent::setUp();
        $this->viewHelper = $this->getAccessibleMock('Tx_Fluid_ViewHelpers_Form_SelectViewHelper', array('setErrorClassAttribute', 'registerFieldNameForFormTokenGeneration'));
        $this->injectDependenciesIntoViewHelper($this->viewHelper);
        $this->viewHelper->initializeArguments();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function selectCorrectlySetsTagName() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('setTagName'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('setTagName')->with('select');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array()
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function selectCreatesExpectedOptions() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="value1">label1</option>' . chr(10) . '<option value="value2" selected="selected">label2</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                'value1' => 'label1',
                'value2' => 'label2'
            ),
            'value' => 'value2',
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

        /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function anEmptyOptionTagIsRenderedIfOptionsArrayIsEmptyToAssureXhtmlCompatibility() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value=""></option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(),
            'value' => 'value2',
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function OrderOfOptionsIsNotAlteredByDefault() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="value3">label3</option>' . chr(10) . '<option value="value1">label1</option>' . chr(10) . '<option value="value2" selected="selected">label2</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                'value3' => 'label3',
                'value1' => 'label1',
                'value2' => 'label2'
            ),
            'value' => 'value2',
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function optionsAreSortedByLabelIfSortByOptionLabelIsSet() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="value1">label1</option>' . chr(10) . '<option value="value2" selected="selected">label2</option>' . chr(10) . '<option value="value3">label3</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                'value3' => 'label3',
                'value1' => 'label1',
                'value2' => 'label2'
            ),
            'value' => 'value2',
            'name' => 'myName',
            'sortByOptionLabel' => TRUE
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function multipleSelectCreatesExpectedOptions() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->at(0))->method('addAttribute')->with('multiple', 'multiple');
        $mockTagBuilder->expects($this->at(1))->method('addAttribute')->with('name', 'myName[]');
        $this->viewHelper->expects($this->exactly(3))->method('registerFieldNameForFormTokenGeneration')->with('myName[]');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="value1" selected="selected">label1</option>' . chr(10) . '<option value="value2">label2</option>' . chr(10) . '<option value="value3" selected="selected">label3</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                'value1' => 'label1',
                'value2' => 'label2',
                'value3' => 'label3'
            ),
            'value' => array('value3', 'value1'),
            'name' => 'myName',
            'multiple' => 'multiple',
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Sebastian Kurfürst <sebastian@typo3.org>
     * @author Bastian Waidelich <bastian@typo3.org>
     * @author Robert Lemke <robert@typo3.org>
     */
    public function selectOnDomainObjectsCreatesExpectedOptions() {
        $mockPersistenceBackend = $this->getMock('Tx_Extbase_Persistence_BackendInterface');
        $mockPersistenceBackend->expects($this->any())->method('getIdentifierByObject')->will($this->returnValue(NULL));

        $mockPersistenceManager = $this->getMock('Tx_Extbase_Persistence_ManagerInterface');
        $mockPersistenceManager->expects($this->any())->method('getBackend')->will($this->returnValue($mockPersistenceBackend));
        $this->viewHelper->injectPersistenceManager($mockPersistenceManager);

        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="1">Ingmar</option>' . chr(10) . '<option value="2" selected="selected">Sebastian</option>' . chr(10) . '<option value="3">Robert</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $user_is = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(1, 'Ingmar', 'Schlecht');
        $user_sk = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(2, 'Sebastian', 'Kurfuerst');
        $user_rl = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(3, 'Robert', 'Lemke');

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                $user_is,
                $user_sk,
                $user_rl
            ),
            'value' => $user_sk,
            'optionValueField' => 'id',
            'optionLabelField' => 'firstName',
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function multipleSelectOnDomainObjectsCreatesExpectedOptions() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->at(0))->method('addAttribute')->with('multiple', 'multiple');
        $mockTagBuilder->expects($this->at(1))->method('addAttribute')->with('name', 'myName[]');
        $this->viewHelper->expects($this->exactly(3))->method('registerFieldNameForFormTokenGeneration')->with('myName[]');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="1" selected="selected">Schlecht</option>' . chr(10) . '<option value="2">Kurfuerst</option>' . chr(10) . '<option value="3" selected="selected">Lemke</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $user_is = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(1, 'Ingmar', 'Schlecht');
        $user_sk = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(2, 'Sebastian', 'Kurfuerst');
        $user_rl = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(3, 'Robert', 'Lemke');

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                $user_is,
                $user_sk,
                $user_rl
            ),
            'value' => array($user_rl, $user_is),
            'optionValueField' => 'id',
            'optionLabelField' => 'lastName',
            'name' => 'myName',
            'multiple' => 'multiple'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function selectWithoutFurtherConfigurationOnDomainObjectsUsesUuidForValueAndLabel() { $this->markTestIncomplete("This does not work right now due to a renaming in FLOW3.");
        $mockPersistenceManager = $this->getMock('Tx_Extbase_Persistence_ManagerInterface');
        $mockPersistenceManager->expects($this->any())->method('getIdentifierByObject')->will($this->returnValue('fakeUID'));
        $this->viewHelper->injectPersistenceManager($mockPersistenceManager);

        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="fakeUID">fakeUID</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $user = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(1, 'Ingmar', 'Schlecht');

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                $user
            ),
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function selectWithoutFurtherConfigurationOnDomainObjectsUsesToStringForLabelIfAvailable() { $this->markTestIncomplete("This does not work right now due to a renaming in FLOW3.");
        $mockPersistenceManager = $this->getMock('Tx_Extbase_Persistence_ManagerInterface');
        $mockPersistenceManager->expects($this->any())->method('getIdentifierByObject')->will($this->returnValue('fakeUID'));
        $this->viewHelper->injectPersistenceManager($mockPersistenceManager);

        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('addAttribute')->with('name', 'myName');
        $this->viewHelper->expects($this->once())->method('registerFieldNameForFormTokenGeneration')->with('myName');
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="fakeUID">toStringResult</option>' . chr(10));
        $mockTagBuilder->expects($this->once())->method('render');
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $user = $this->getMock('Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass', array('__toString'), array(1, 'Ingmar', 'Schlecht'));
        $user->expects($this->atLeastOnce())->method('__toString')->will($this->returnValue('toStringResult'));

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                $user
            ),
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Karsten Dambekalns <karsten@typo3.org>
     * @expectedException Tx_Fluid_Core_ViewHelper_Exception
     */
    public function selectOnDomainObjectsThrowsExceptionIfNoValueCanBeFound() {
        $mockPersistenceBackend = $this->getMock('Tx_Extbase_Persistence_BackendInterface');
        $mockPersistenceBackend->expects($this->any())->method('getIdentifierByObject')->will($this->returnValue(NULL));

        $mockPersistenceManager = $this->getMock('Tx_Extbase_Persistence_ManagerInterface');
        $mockPersistenceManager->expects($this->any())->method('getBackend')->will($this->returnValue($mockPersistenceBackend));
        $this->viewHelper->injectPersistenceManager($mockPersistenceManager);

        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $user = new Tx_Fluid_ViewHelpers_Fixtures_UserDomainClass(1, 'Ingmar', 'Schlecht');

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                $user
            ),
            'name' => 'myName'
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function renderCallsSetErrorClassAttribute() {
        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array()
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->expects($this->once())->method('setErrorClassAttribute');
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function allOptionsAreSelectedIfSelectAllIsTrue() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="value1" selected="selected">label1</option>' . chr(10) . '<option value="value2" selected="selected">label2</option>' . chr(10) . '<option value="value3" selected="selected">label3</option>' . chr(10));
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                'value1' => 'label1',
                'value2' => 'label2',
                'value3' => 'label3'
            ),
            'name' => 'myName',
            'multiple' => 'multiple',
            'selectAllByDefault' => TRUE
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }

    /**
     * @test
     * @author Bastian Waidelich <bastian@typo3.org>
     */
    public function selectAllHasNoEffectIfValueIsSet() {
        $mockTagBuilder = $this->getMock('Tx_Fluid_Core_ViewHelper_TagBuilder', array('addAttribute', 'setContent', 'render'), array(), '', FALSE);
        $mockTagBuilder->expects($this->once())->method('setContent')->with('<option value="value1" selected="selected">label1</option>' . chr(10) . '<option value="value2" selected="selected">label2</option>' . chr(10) . '<option value="value3">label3</option>' . chr(10));
        $this->viewHelper->_set('tag', $mockTagBuilder);

        $arguments = new Tx_Fluid_Core_ViewHelper_Arguments(array(
            'options' => array(
                'value1' => 'label1',
                'value2' => 'label2',
                'value3' => 'label3'
            ),
            'value' => array('value2', 'value1'),
            'name' => 'myName',
            'multiple' => 'multiple',
            'selectAllByDefault' => TRUE
        ));
        $this->viewHelper->setArguments($arguments);

        $this->viewHelper->initialize();
        $this->viewHelper->render();
    }
}

?>