LayoutTest Class Reference

Inheritance diagram for LayoutTest:

Public Member Functions
	testDestructor ()
	testGetUpdate ()
	testGenerateGetAllBlocks ()
	testGetElementProperty ()
	testIsBlock ()
	testSetUnsetBlock ()
	testCreateBlock ($blockType, $blockName, array $blockData, $expectedName)
	createBlockDataProvider ()
	testCreateBlockNotExists ($name)
	blockNotExistsDataProvider ()
	testAddBlock ()
	testAddContainer ($htmlTag)
	addContainerDataProvider ()
	testAddContainerInvalidHtmlTag ()
	testGetChildBlock ()
	testSetChild ()
	testReorderChild (\Magento\Framework\View\LayoutInterface $layout)
	testGetChildBlocks ()
	testAddBlockInvalidType ()
	testIsContainer ()
	testIsManipulationAllowed ()
	testRenameElement ()
	testGetBlock ()
	testGetParentName ()
	testGetElementAlias ()
	testGetOutput ()
	testGetMessagesBlock ()
	testGetBlockSingleton ()
	testUpdateContainerAttributes ()
	testIsCacheable ()
	testIsNonCacheable ()

Protected Member Functions
	setUp ()

Protected Attributes
	$_layout
	$layoutFactory

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 19 of file LayoutTest.php.

Member Function Documentation

addContainerDataProvider()

addContainerDataProvider

(

)

Definition at line 253 of file LayoutTest.php.

    {
        return [
            ['dd'],
            ['div'],
            ['dl'],
            ['fieldset'],
            ['header'],
            ['ol'],
            ['p'],
            ['section'],
            ['table'],
            ['tfoot'],
            ['ul']
        ];
    }

blockNotExistsDataProvider()

blockNotExistsDataProvider

(

)

Definition at line 215 of file LayoutTest.php.

    {
        return [[''], ['block_not_exists']];
    }

createBlockDataProvider()

createBlockDataProvider

(

)

Definition at line 190 of file LayoutTest.php.

    {
        return [
            'named block' => [\Magento\Framework\View\Element\Template::class,
                'some_block_name_full_class',
                ['type' => \Magento\Framework\View\Element\Template::class, 'is_anonymous' => false],
                '/^some_block_name_full_class$/',
            ],
            'no name block' => [\Magento\Framework\View\Element\Text\ListText::class,
                '',
                ['type' => \Magento\Framework\View\Element\Text\ListText::class, 'key1' => 'value1'],
                '/text\\\\list/',
            ]
        ];
    }

setUp()

setUp ( )

protected

Definition at line 31 of file LayoutTest.php.

    {
        $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
        $this->layoutFactory = $objectManager->get(\Magento\Framework\View\LayoutFactory::class);
        $this->_layout = $this->layoutFactory->create();
        $objectManager->get(\Magento\Framework\App\Cache\Type\Layout::class)->clean();
    }

testAddBlock()

testAddBlock

(

)

Definition at line 220 of file LayoutTest.php.

    {
        $this->assertInstanceOf(
            \Magento\Framework\View\Element\Text::class,
            $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'block1')
        );
        $block2 = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
            \Magento\Framework\View\Element\Text::class
        );
        $block2->setNameInLayout('block2');
        $this->_layout->addBlock($block2, '', 'block1');

        $this->assertTrue($this->_layout->hasElement('block1'));
        $this->assertTrue($this->_layout->hasElement('block2'));
        $this->assertEquals('block1', $this->_layout->getParentName('block2'));
    }

testAddBlockInvalidType()

testAddBlockInvalidType

(

)

@expectedException \Magento\Framework\Exception\LocalizedException

Definition at line 366 of file LayoutTest.php.

    {
        $this->_layout->addBlock('invalid_name', 'child');
    }

testAddContainer()

testAddContainer

(

$htmlTag

)

@magentoAppIsolation enabled @dataProvider addContainerDataProvider()

Definition at line 241 of file LayoutTest.php.

    {
        $this->assertFalse($this->_layout->hasElement('container'));
        $this->_layout->addContainer('container', 'Container', ['htmlTag' => $htmlTag]);
        $this->assertTrue($this->_layout->hasElement('container'));
        $this->assertTrue($this->_layout->isContainer('container'));
        $this->assertEquals($htmlTag, $this->_layout->getElementProperty('container', 'htmlTag'));

        $this->_layout->addContainer('container1', 'Container 1', [], 'container', 'c1');
        $this->assertEquals('container1', $this->_layout->getChildName('container', 'c1'));
    }

testAddContainerInvalidHtmlTag()

testAddContainerInvalidHtmlTag

(

)

@magentoAppIsolation enabled

Definition at line 273 of file LayoutTest.php.

    {
        $msg = 'Html tag "span" is forbidden for usage in containers. ' .
            'Consider to use one of the allowed: aside, dd, div, dl, fieldset, main, nav, ' .
            'header, footer, ol, p, section, table, tfoot, ul.';
        $this->expectException(\Magento\Framework\Exception\LocalizedException::class);
        $this->expectExceptionMessage($msg);
        $this->_layout->addContainer('container', 'Container', ['htmlTag' => 'span']);
    }

testCreateBlock()

testCreateBlock	(		$blockType,
			$blockName,
		array	$blockData,
			$expectedName
	)

@dataProvider createBlockDataProvider

Definition at line 180 of file LayoutTest.php.

    {
        $expectedData = $blockData + ['type' => $blockType];

        $block = $this->_layout->createBlock($blockType, $blockName, ['data' => $blockData]);

        $this->assertRegExp($expectedName, $block->getNameInLayout());
        $this->assertEquals($expectedData, $block->getData());
    }

testCreateBlockNotExists()

testCreateBlockNotExists

(

$name

)

@dataProvider blockNotExistsDataProvider @expectedException \Magento\Framework\Exception\LocalizedException

Definition at line 210 of file LayoutTest.php.

    {
        $this->_layout->createBlock($name);
    }

testDestructor()

testDestructor

(

)

@magentoAppIsolation enabled @magentoAppArea frontend

Definition at line 53 of file LayoutTest.php.

    {
        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'test');
        $this->assertNotEmpty($this->_layout->getAllBlocks());
        $this->_layout->__destruct();
        $this->assertEmpty($this->_layout->getAllBlocks());
    }

testGenerateGetAllBlocks()

testGenerateGetAllBlocks

(

)

A smoke test for generating elements

See sophisticated tests at \Magento\Framework\View\LayoutDirectivesTest

See also

\Magento\Framework\View\LayoutDirectivesTest @magentoAppIsolation enabled

Definition at line 101 of file LayoutTest.php.

    {
        $this->_layout->setXml(
            simplexml_load_string(
                '<layout>
                <block class="Magento\Framework\View\Element\Text" name="block1">
                    <block class="Magento\Framework\View\Element\Text"/>
                </block>
                <block class="Magento\Framework\View\Element\Text" template="test" ttl="360"/>
                <block class="Magento\Framework\View\Element\Text"/>
            </layout>',
                \Magento\Framework\View\Layout\Element::class
            )
        );
        $this->assertEquals([], $this->_layout->getAllBlocks());
        $this->_layout->generateElements();
        $expected = ['block1', 'block1_schedule_block0', 'schedule_block1', 'schedule_block2'];
        $this->assertSame($expected, array_keys($this->_layout->getAllBlocks()));
        $child = $this->_layout->getBlock('block1_schedule_block0');
        $this->assertSame($this->_layout->getBlock('block1'), $child->getParentBlock());
        $this->assertEquals('test', $this->_layout->getBlock('schedule_block1')->getData('template'));
        $this->assertEquals('360', $this->_layout->getBlock('schedule_block1')->getData('ttl'));
        $this->assertFalse($this->_layout->getBlock('nonexisting'));
    }

testGetBlock()

testGetBlock

(

)

Definition at line 418 of file LayoutTest.php.

    {
        $this->assertFalse($this->_layout->getBlock('test'));
        $block = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
            \Magento\Framework\View\Layout::class
        )->createBlock(
            \Magento\Framework\View\Element\Text::class
        );
        $this->_layout->setBlock('test', $block);
        $this->assertSame($block, $this->_layout->getBlock('test'));
    }

testGetBlockSingleton()

testGetBlockSingleton

(

)

Definition at line 476 of file LayoutTest.php.

    {
        $block = $this->_layout->getBlockSingleton(\Magento\Framework\View\Element\Text::class);
        $this->assertInstanceOf(\Magento\Framework\View\Element\Text::class, $block);
        $this->assertSame($block, $this->_layout->getBlockSingleton(\Magento\Framework\View\Element\Text::class));
    }

testGetChildBlock()

testGetChildBlock

(

)

@magentoAppIsolation enabled

Definition at line 286 of file LayoutTest.php.

    {
        $this->_layout->addContainer('parent', 'Parent');
        $block = $this->_layout->addBlock(
            \Magento\Framework\View\Element\Text::class,
            'block',
            'parent',
            'block_alias'
        );
        $this->_layout->addContainer('container', 'Container', [], 'parent', 'container_alias');
        $this->assertSame($block, $this->_layout->getChildBlock('parent', 'block_alias'));
        $this->assertFalse($this->_layout->getChildBlock('parent', 'container_alias'));
    }

testGetChildBlocks()

testGetChildBlocks

(

)

@magentoAppIsolation enabled

Definition at line 354 of file LayoutTest.php.

    {
        $this->_layout->addContainer('parent', 'Parent');
        $block1 = $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'block1', 'parent');
        $this->_layout->addContainer('container', 'Container', [], 'parent');
        $block2 = $this->_layout->addBlock(\Magento\Framework\View\Element\Template::class, 'block2', 'parent');
        $this->assertSame(['block1' => $block1, 'block2' => $block2], $this->_layout->getChildBlocks('parent'));
    }

testGetElementAlias()

testGetElementAlias

(

)

Definition at line 441 of file LayoutTest.php.

    {
        $this->_layout->addContainer('one', 'One');
        $this->_layout->addContainer('two', 'One', [], 'one', '1');
        $this->assertFalse($this->_layout->getElementAlias('one'));
        $this->assertEquals('1', $this->_layout->getElementAlias('two'));
    }

testGetElementProperty()

testGetElementProperty

(

)

Definition at line 126 of file LayoutTest.php.

    {
        $name = 'test';
        $this->_layout->addContainer($name, 'Test', ['option1' => 1, 'option2' => 2]);
        $this->assertEquals(
            'Test',
            $this->_layout->getElementProperty($name, \Magento\Framework\View\Layout\Element::CONTAINER_OPT_LABEL)
        );
        $this->assertEquals(
            \Magento\Framework\View\Layout\Element::TYPE_CONTAINER,
            $this->_layout->getElementProperty($name, 'type')
        );
        $this->assertSame(2, $this->_layout->getElementProperty($name, 'option2'));

        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'text', $name);
        $this->assertEquals(
            \Magento\Framework\View\Layout\Element::TYPE_BLOCK,
            $this->_layout->getElementProperty('text', 'type')
        );
        $this->assertSame(
            ['text' => 'text'],
            $this->_layout->getElementProperty($name, \Magento\Framework\Data\Structure::CHILDREN)
        );
    }

testGetMessagesBlock()

testGetMessagesBlock

(

)

Definition at line 471 of file LayoutTest.php.

    {
        $this->assertInstanceOf(\Magento\Framework\View\Element\Messages::class, $this->_layout->getMessagesBlock());
    }

testGetOutput()

testGetOutput

(

)

@covers \Magento\Framework\View\Layout::addOutputElement @covers \Magento\Framework\View\Layout::getOutput @covers \Magento\Framework\View\Layout::removeOutputElement

Definition at line 454 of file LayoutTest.php.

    {
        $blockName = 'block_' . __METHOD__;
        $expectedText = "some_text_for_{$blockName}";

        $block = $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, $blockName);
        $block->setText($expectedText);

        $this->_layout->addOutputElement($blockName);
        // add the same element twice should not produce output duplicate
        $this->_layout->addOutputElement($blockName);
        $this->assertEquals($expectedText, $this->_layout->getOutput());

        $this->_layout->removeOutputElement($blockName);
        $this->assertEmpty($this->_layout->getOutput());
    }

testGetParentName()

testGetParentName

(

)

@magentoAppIsolation enabled

Definition at line 433 of file LayoutTest.php.

    {
        $this->_layout->addContainer('one', 'One');
        $this->_layout->addContainer('two', 'Two', [], 'one');
        $this->assertFalse($this->_layout->getParentName('one'));
        $this->assertEquals('one', $this->_layout->getParentName('two'));
    }

testGetUpdate()

testGetUpdate

(

)

Definition at line 61 of file LayoutTest.php.

    {
        $this->assertInstanceOf(\Magento\Framework\View\Layout\ProcessorInterface::class, $this->_layout->getUpdate());
    }

testIsBlock()

testIsBlock

(

)

@magentoAppIsolation enabled

Definition at line 154 of file LayoutTest.php.

    {
        $this->assertFalse($this->_layout->isBlock('container'));
        $this->assertFalse($this->_layout->isBlock('block'));
        $this->_layout->addContainer('container', 'Container');
        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'block');
        $this->assertFalse($this->_layout->isBlock('container'));
        $this->assertTrue($this->_layout->isBlock('block'));
    }

testIsCacheable()

testIsCacheable

(

)

Definition at line 498 of file LayoutTest.php.

    {
        $this->_layout->setXml(
            simplexml_load_file(
                __DIR__ . '/_files/layout/cacheable.xml',
                \Magento\Framework\View\Layout\Element::class
            )
        );
        $this->_layout->generateElements();
        $this->assertTrue($this->_layout->isCacheable());
    }

testIsContainer()

testIsContainer

(

)

@magentoAppIsolation enabled

Definition at line 374 of file LayoutTest.php.

    {
        $block = 'block';
        $container = 'container';
        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, $block);
        $this->_layout->addContainer($container, 'Container');
        $this->assertFalse($this->_layout->isContainer($block));
        $this->assertTrue($this->_layout->isContainer($container));
        $this->assertFalse($this->_layout->isContainer('invalid_name'));
    }

testIsManipulationAllowed()

testIsManipulationAllowed

(

)

Definition at line 385 of file LayoutTest.php.

    {
        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'block1');
        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'block2', 'block1');
        $this->assertFalse($this->_layout->isManipulationAllowed('block1'));
        $this->assertFalse($this->_layout->isManipulationAllowed('block2'));

        $this->_layout->addContainer('container1', 'Container 1');
        $this->_layout->addBlock(\Magento\Framework\View\Element\Text::class, 'block3', 'container1');
        $this->_layout->addContainer('container2', 'Container 2', [], 'container1');
        $this->assertFalse($this->_layout->isManipulationAllowed('container1'));
        $this->assertTrue($this->_layout->isManipulationAllowed('block3'));
        $this->assertTrue($this->_layout->isManipulationAllowed('container2'));
    }

testIsNonCacheable()

testIsNonCacheable

(

)

Definition at line 510 of file LayoutTest.php.

    {
        $this->_layout->setXml(
            simplexml_load_file(
                __DIR__ . '/_files/layout/non_cacheable.xml',
                \Magento\Framework\View\Layout\Element::class
            )
        );
        $this->_layout->generateElements();
        $this->assertFalse($this->_layout->isCacheable());
    }

testRenameElement()

testRenameElement

(

)

Definition at line 400 of file LayoutTest.php.

    {
        $blockName = 'block';
        $expBlockName = 'block_renamed';
        $containerName = 'container';
        $expContainerName = 'container_renamed';
        $block = $this->_layout->createBlock(\Magento\Framework\View\Element\Text::class, $blockName);
        $this->_layout->addContainer($containerName, 'Container');

        $this->assertEquals($block, $this->_layout->getBlock($blockName));
        $this->_layout->renameElement($blockName, $expBlockName);
        $this->assertEquals($block, $this->_layout->getBlock($expBlockName));

        $this->_layout->hasElement($containerName);
        $this->_layout->renameElement($containerName, $expContainerName);
        $this->_layout->hasElement($expContainerName);
    }

testReorderChild()

testReorderChild

(

\Magento\Framework\View\LayoutInterface

$layout

)

Parameters

\Magento\Framework\View\LayoutInterface

$layout

@depends testSetChild

Definition at line 318 of file LayoutTest.php.

    {
        $layout->addContainer('four', 'Four', [], 'one');

        // offset +1
        $layout->reorderChild('one', 'four', 1);
        $this->assertSame(['two', 'four', 'three'], $layout->getChildNames('one'));

        // offset -2
        $layout->reorderChild('one', 'three', 2, false);
        $this->assertSame(['two', 'three', 'four'], $layout->getChildNames('one'));

        // after sibling
        $layout->reorderChild('one', 'two', 'three');
        $this->assertSame(['three', 'two', 'four'], $layout->getChildNames('one'));

        // after everyone
        $layout->reorderChild('one', 'three', '-');
        $this->assertSame(['two', 'four', 'three'], $layout->getChildNames('one'));

        // before sibling
        $layout->reorderChild('one', 'four', 'two', false);
        $this->assertSame(['four', 'two', 'three'], $layout->getChildNames('one'));

        // before everyone
        $layout->reorderChild('one', 'two', '-', false);
        $this->assertSame(['two', 'four', 'three'], $layout->getChildNames('one'));

        //reorder by sibling alias
        $layout->reorderChild('one', 'two', 'three_alias', true);
        $this->assertSame(['four', 'three', 'two'], $layout->getChildNames('one'));
    }

testSetChild()

testSetChild

(

)

Returns

\Magento\Framework\View\Layout

Definition at line 303 of file LayoutTest.php.

    {
        $this->_layout->addContainer('one', 'One');
        $this->_layout->addContainer('two', 'Two');
        $this->_layout->addContainer('three', 'Three');
        $this->assertSame($this->_layout, $this->_layout->setChild('one', 'two', ''));
        $this->_layout->setChild('one', 'three', 'three_alias');
        $this->assertSame(['two', 'three'], $this->_layout->getChildNames('one'));
        return $this->_layout;
    }

testSetUnsetBlock()

testSetUnsetBlock

(

)

Definition at line 164 of file LayoutTest.php.

    {
        $expectedBlockName = 'block_' . __METHOD__;
        $expectedBlock = $this->_layout->createBlock(\Magento\Framework\View\Element\Text::class);

        $this->_layout->setBlock($expectedBlockName, $expectedBlock);
        $this->assertSame($expectedBlock, $this->_layout->getBlock($expectedBlockName));

        $this->_layout->unsetElement($expectedBlockName);
        $this->assertFalse($this->_layout->getBlock($expectedBlockName));
        $this->assertFalse($this->_layout->hasElement($expectedBlockName));
    }

testUpdateContainerAttributes()

testUpdateContainerAttributes

(

)

Definition at line 483 of file LayoutTest.php.

    {
        $this->_layout->setXml(
            simplexml_load_file(
                __DIR__ . '/_files/layout/container_attributes.xml',
                \Magento\Framework\View\Layout\Element::class
            )
        );
        $this->_layout->generateElements();
        $result = $this->_layout->renderElement('container1', false);
        $this->assertEquals('<div id="container1-2" class="class12">Test11Test12</div>', $result);
        $result = $this->_layout->renderElement('container2', false);
        $this->assertEquals('<div id="container2-2" class="class22">Test21Test22</div>', $result);
    }

Field Documentation

$_layout

$_layout

protected

Definition at line 24 of file LayoutTest.php.

$layoutFactory

$layoutFactory

protected

Definition at line 29 of file LayoutTest.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/magento2-base/dev/tests/integration/testsuite/Magento/Framework/View/LayoutTest.php