Skip to content

Commit

Permalink
[BUGFIX] Show content for columns with colPos set only
Browse files Browse the repository at this point in the history 
Setting up backend layouts with colPos not set will show the content of
column 0 because of an excplicit cast of the colPos. This patch checks
if colPos is set and if not skips the assignment of records.

Resolves: #91176
Releases: master, 10.4
Change-Id: I75d9818c4330bb8a4d9a7a60130a547167a83e58
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/64853
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Reviewed-by: Andreas Fernandez <a.fernandez@scripting-base.de>
  • Loading branch information
@gilbertsoft @andreaskienast
gilbertsoft authored and andreaskienast committed Jun 8, 2020
1 parent 46e53dc commit 234d24b
Show file tree
Hide file tree
Showing 3 changed files with 458 additions and 5 deletions.
12 changes: 7 additions & 5 deletions typo3/sysext/backend/Classes/View/Drawing/BackendLayoutRenderer.php
View file
Expand Up @@ -114,11 +114,13 @@ public function getGridForPageLayoutContext(PageLayoutContext $context): Grid
foreach ($row['columns.'] as $column) {
$columnObject = GeneralUtility::makeInstance(GridColumn::class, $context, $column);
$rowObject->addColumn($columnObject);
$records = $this->contentFetcher->getContentRecordsPerColumn((int)$column['colPos'], $languageId);
$recordRememberer->rememberRecords($records);
foreach ($records as $contentRecord) {
$columnItem = GeneralUtility::makeInstance(GridColumnItem::class, $context, $columnObject, $contentRecord);
$columnObject->addItem($columnItem);
if (isset($column['colPos'])) {
$records = $this->contentFetcher->getContentRecordsPerColumn((int)$column['colPos'], $languageId);
$recordRememberer->rememberRecords($records);
foreach ($records as $contentRecord) {
$columnItem = GeneralUtility::makeInstance(GridColumnItem::class, $context, $columnObject, $contentRecord);
$columnObject->addItem($columnItem);
}
}
}
$grid->addRow($rowObject);
Expand Down
334 changes: 334 additions & 0 deletions typo3/sysext/backend/Tests/Functional/View/Drawing/BackendLayoutRendererTest.php
View file
@@ -0,0 +1,334 @@
<?php

declare(strict_types=1);

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

namespace TYPO3\CMS\Backend\Tests\Functional\View\BackendLayout\Drawing;

use TYPO3\CMS\Backend\View\BackendLayout\BackendLayout;
use TYPO3\CMS\Backend\View\Drawing\BackendLayoutRenderer;
use TYPO3\CMS\Backend\View\PageLayoutContext;
use TYPO3\CMS\Core\Core\Bootstrap;
use TYPO3\CMS\Core\Tests\Functional\SiteHandling\SiteBasedTestTrait;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerFactory;
use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\Scenario\DataHandlerWriter;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;

/**
* Testing rendering of backend layouts.
*/
class BackendLayoutRendererTest extends FunctionalTestCase
{
use SiteBasedTestTrait;

/**
* @var string[]
*/
protected $coreExtensionsToLoad = ['workspaces'];

/**
* @var BackendUserAuthentication
*/
private $backendUser;

public static function setUpBeforeClass(): void
{
parent::setUpBeforeClass();
static::initializeDatabaseSnapshot();
}

public static function tearDownAfterClass(): void
{
static::destroyDatabaseSnapshot();
parent::tearDownAfterClass();
}

protected function setUp(): void
{
parent::setUp();

$this->backendUser = $this->setUpBackendUserFromFixture(1);

$this->withDatabaseSnapshot(function () {
$this->setUpDatabase();
});
}

protected function tearDown(): void
{
unset($this->backendUser);
parent::tearDown();
}

protected function setUpDatabase()
{
Bootstrap::initializeLanguageObject();

$scenarioFile = __DIR__ . '/../Fixtures/DefaultViewScenario.yaml';
$factory = DataHandlerFactory::fromYamlFile($scenarioFile);
$writer = DataHandlerWriter::withBackendUser($this->backendUser);
$writer->invokeFactory($factory);
static::failIfArrayIsNotEmpty(
$writer->getErrors()
);
}

/**
* @param int $pageId
* @param array $configuration BackendLayout configuration
* @return PageLayoutContext|\PHPUnit\Framework\MockObject\MockObject
*/
protected function getPageLayoutContext(int $pageId, array $configuration)
{
// Create a BackendLayout
$backendLayout = new BackendLayout('layout1', 'Layout 1', $configuration);

// Create a mock for the PageLayoutContext class
return $this->createConfiguredMock(
PageLayoutContext::class,
[
'getBackendLayout' => $backendLayout,
'getPageId' => $pageId,
]
);
}

/**
* @param PageLayoutContext|\PHPUnit\Framework\MockObject\MockObject $context
* @return BackendLayoutRenderer
*/
protected function getSubject(PageLayoutContext $context)
{
return GeneralUtility::makeInstance(BackendLayoutRenderer::class, $context);
}

/**
* @test
*/
public function emptyBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(0, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
}

/**
* @test
*/
public function oneRowBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(1, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(0, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
}

/**
* @test
*/
public function multipleRowsBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [],
],
1 => [
'columns.' => [],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(2, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(0, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
}

/**
* @test
*/
public function oneRowOneColBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [
0 => [
'colPos' => 0
],
],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(1, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(1, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
foreach ($subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns() as $column) {
self::assertCount(1, $column->getItems());
}
}

/**
* @test
*/
public function oneRowMultipleColsBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [
0 => [
'colPos' => 0
],
1 => [
'colPos' => 1
],
],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(1, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(2, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
foreach ($subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns() as $column) {
self::assertCount(1, $column->getItems());
}
}

/**
* @test
*/
public function multipleRowsOneColBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [
0 => [
'colPos' => 0
],
],
],
1 => [
'columns.' => [
0 => [
'colPos' => 1
],
],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(2, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(2, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
foreach ($subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns() as $column) {
self::assertCount(1, $column->getItems());
}
}

/**
* @test
*/
public function multipleRowsMultipleColsBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [
0 => [
'colPos' => 0
],
1 => [
'colPos' => 1
],
],
],
1 => [
'columns.' => [
0 => [
'colPos' => 2
],
1 => [
'colPos' => 3
],
],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(2, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(4, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
foreach ($subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns() as $column) {
self::assertCount(1, $column->getItems());
}
}

/**
* @test
*/
public function noColPosBackendLayoutIsRendered()
{
$configuration['__config']['backend_layout.'] = [
'rows.' => [
0 => [
'columns.' => [
0 => [
],
1 => [
],
],
],
],
];
$pageLayoutContext = $this->getPageLayoutContext(1100, $configuration);
$subject = $this->getSubject($pageLayoutContext);

// Test the subject
self::assertCount(1, $subject->getGridForPageLayoutContext($pageLayoutContext)->getRows());
self::assertCount(1, $subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns());
foreach ($subject->getGridForPageLayoutContext($pageLayoutContext)->getColumns() as $column) {
self::assertCount(0, $column->getItems());
}
}
}

0 comments on commit 234d24b

Please sign in to comment.