LayoutTest Class Reference

Inheritance diagram for LayoutTest:

Public Member Functions
	testPageTypesDeclaration ()
	testOverrideBaseFiles ()
	testOverrideThemeFiles ()
	overrideBaseFilesDataProvider ()
	overrideThemeFilesDataProvider ()

Static Public Member Functions
static	setUpBeforeClass ()
static	tearDownAfterClass ()

Protected Member Functions
	_collectHierarchyErrors ($node, $xml, &$errors)

Static Protected Member Functions
static	_getCachedFiles ( $cacheKey, $sourceClass, \Magento\Framework\View\Design\ThemeInterface $theme)

Static Protected Attributes
static	$_cachedFiles = []

Detailed Description

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 14 of file LayoutTest.php.

Member Function Documentation

_collectHierarchyErrors()

_collectHierarchyErrors (   $node,   $xml, &  $errors  )

protected

Validate node's declared position in hierarchy and add errors to the specified array if found

Parameters

\SimpleXMLElement	$node
\Magento\Framework\View\Layout\Element	$xml
array	&$errors

Definition at line 58 of file LayoutTest.php.

    {
        $name = $node->getName();
        $refName = $node->getAttribute('type') == $node->getAttribute('parent');
        if ($refName) {
            $refNode = $xml->xpath("/layouts/{$refName}");
            if (!$refNode) {
                $errors[$name][] = "Node '{$refName}', referenced in hierarchy, does not exist";
            }
        }
    }

_getCachedFiles()

static _getCachedFiles (   $cacheKey,   $sourceClass, \Magento\Framework\View\Design\ThemeInterface  $theme  )

staticprotected

Retrieve list of cached source files

Parameters

string	$cacheKey
string	$sourceClass
\Magento\Framework\View\Design\ThemeInterface	$theme

Returns

\Magento\Framework\View\File[]

Definition at line 269 of file LayoutTest.php.

      {
        if (!isset(self::$_cachedFiles[$cacheKey])) {
            /* @var $fileList \Magento\Framework\View\File[] */
            $fileList = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
                ->create($sourceClass, ['subDir' => 'layout'])->getFiles($theme, '*.xml');
            $files = [];
            foreach ($fileList as $file) {
                $files[$file->getModule() . '/' . $file->getName()] = true;
            }
            self::$_cachedFiles[$cacheKey] = $files;
        }
        return self::$_cachedFiles[$cacheKey];
    }

overrideBaseFilesDataProvider()

overrideBaseFilesDataProvider

(

)

Returns

array

Definition at line 290 of file LayoutTest.php.

    {
        return $this->_retrieveFilesForEveryTheme(
            \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
                ->create(
                    \Magento\Framework\View\File\Collector\Override\Base::class,
                    ['subDir' => 'layout/override/base']
                )
        );
    }

overrideThemeFilesDataProvider()

overrideThemeFilesDataProvider

(

)

Returns

array

Definition at line 304 of file LayoutTest.php.

    {
        return $this->_retrieveFilesForEveryTheme(
            \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
                ->create(
                    \Magento\Framework\View\File\Collector\Override\ThemeModular::class,
                    ['subDir' => 'layout/override/theme']
                )
        );
    }

setUpBeforeClass()

static setUpBeforeClass ( )

static

Definition at line 23 of file LayoutTest.php.

    {
        \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->configure(
            ['preferences' => [\Magento\Theme\Model\Theme::class => \Magento\Theme\Model\Theme\Data::class]]
        );
    }

tearDownAfterClass()

static tearDownAfterClass ( )

static

Definition at line 30 of file LayoutTest.php.

    {
        self::$_cachedFiles = []; // Free memory
    }

testOverrideBaseFiles()

testOverrideBaseFiles

(

)

Check, that for an overriding file ($themeFile) in a theme ($theme), there is a corresponding base file

Parameters

\Magento\Framework\View\File	$themeFile
\Magento\Framework\View\Design\ThemeInterface	$theme

Definition at line 184 of file LayoutTest.php.

    {
        $invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
        $invoker(
            function ($themeFile, $theme) {
                $baseFiles = self::_getCachedFiles(
                    $theme->getArea(),
                    \Magento\Framework\View\File\Collector\Base::class,
                    $theme
                );
                $fileKey = $themeFile->getModule() . '/' . $themeFile->getName();
                $this->assertArrayHasKey(
                    $fileKey,
                    $baseFiles,
                    sprintf("Could not find base file, overridden by theme file '%s'.", $themeFile->getFilename())
                );
            },
            $this->overrideBaseFilesDataProvider()
        );
    }

testOverrideThemeFiles()

testOverrideThemeFiles

(

)

Check, that for an ancestor-overriding file ($themeFile) in a theme ($theme), there is a corresponding file in that ancestor theme

Parameters

\Magento\Framework\View\File	$themeFile
\Magento\Framework\View\Design\ThemeInterface	$theme

Definition at line 211 of file LayoutTest.php.

    {
        $invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
        $invoker(
            function ($themeFile, $theme) {
                // Find an ancestor theme, where a file is to be overridden
                $ancestorTheme = $theme;
                while ($ancestorTheme = $ancestorTheme->getParentTheme()) {
                    if ($ancestorTheme == $themeFile->getTheme()) {
                        break;
                    }
                }
                $this->assertNotNull(
                    $ancestorTheme,
                    sprintf(
                        'Could not find ancestor theme "%s", ' .
                        'its layout file is supposed to be overridden by file "%s".',
                        $themeFile->getTheme()->getCode(),
                        $themeFile->getFilename()
                    )
                );

                // Search for the overridden file in the ancestor theme
                $ancestorFiles = self::_getCachedFiles(
                    $ancestorTheme->getFullPath(),
                    \Magento\Framework\View\File\Collector\ThemeModular::class,
                    $ancestorTheme
                );
                $fileKey = $themeFile->getModule() . '/' . $themeFile->getName();
                $this->assertArrayHasKey(
                    $fileKey,
                    $ancestorFiles,
                    sprintf(
                        "Could not find original file in '%s' theme, overridden by file '%s'.",
                        $themeFile->getTheme()->getCode(),
                        $themeFile->getFilename()
                    )
                );
            },
            $this->overrideThemeFilesDataProvider()
        );
    }

testPageTypesDeclaration()

testPageTypesDeclaration

(

)

Check whether page types are declared only in layout update files allowed for it - base ones

Definition at line 132 of file LayoutTest.php.

    {
        $invoker = new \Magento\Framework\App\Utility\AggregateInvoker($this);
        $invoker(
            function (\Magento\Framework\View\File $layout) {
                $content = simplexml_load_file($layout->getFilename());
                $this->assertEmpty(
                    $content->xpath(\Magento\Framework\View\Model\Layout\Merge::XPATH_HANDLE_DECLARATION),
                    "Theme layout update '" . $layout->getFilename() . "' contains page type declaration(s)"
                );
            },
            $this->pageTypesDeclarationDataProvider()
        );
    }

Field Documentation

$_cachedFiles

$_cachedFiles = []

staticprotected

Definition at line 21 of file LayoutTest.php.

---

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

• vendor/magento/magento2-base/dev/tests/integration/testsuite/Magento/Test/Integrity/LayoutTest.php