PagesRecyclerDoktypeMigration.php

Go to the documentation of this file.

<?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\Install\Updates;
 
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\QueryBuilder;
use ‪TYPO3\CMS\Core\Domain\Repository\PageRepository;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Install\Attribute\UpgradeWizard;
 
#[UpgradeWizard('pagesRecyclerDoktypeMigration')]
class ‪PagesRecyclerDoktypeMigration implements ‪UpgradeWizardInterface
{
    protected const ‪TABLE_NAME = 'pages';
 
    public function ‪getTitle(): string
    {
        return 'Migrate pages of doktype 255 ("Recycler") to a Backend User Section doktype.';
    }
 
    public function ‪getDescription(): string
    {
        return 'The Recycler doktype of the "pages" table is removed from TYPO3. This update migrates records of this type to a Backend User Section.';
    }
 
    public function ‪getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class,
        ];
    }
 
    public function ‪updateNecessary(): bool
    {
        return $this->‪hasRecordsToUpdate();
    }
 
    public function ‪executeUpdate(): bool
    {
        $connection = $this->‪getConnectionPool()->getConnectionForTable(self::TABLE_NAME);
 
        foreach ($this->‪getRecordsToUpdate() as ‪$record) {
            $connection->update(
                self::TABLE_NAME,
                [
                    'title' => '[RECYCLER] ' . ‪$record['title'],
                    'doktype' => ‪PageRepository::DOKTYPE_BE_USER_SECTION,
                ],
                ['uid' => (int)‪$record['uid']]
            );
        }
 
        return true;
    }
 
    protected function ‪hasRecordsToUpdate(): bool
    {
        return (bool)$this->‪getPreparedQueryBuilder()->count('uid')->executeQuery()->fetchOne();
    }
 
    protected function ‪getRecordsToUpdate(): array
    {
        return $this->‪getPreparedQueryBuilder()->select('uid', 'title', 'doktype')->executeQuery()->fetchAllAssociative();
    }
 
    protected function ‪getPreparedQueryBuilder(): QueryBuilder
    {
        $queryBuilder = $this->‪getConnectionPool()->getQueryBuilderForTable(self::TABLE_NAME);
        $queryBuilder->getRestrictions()->removeAll();
        $queryBuilder
            ->from(self::TABLE_NAME)
            ->where(
                $queryBuilder->expr()->eq('doktype', $queryBuilder->createNamedParameter(255, ‪Connection::PARAM_INT))
            );
 
        return $queryBuilder;
    }
 
    protected function ‪getConnectionPool(): ‪ConnectionPool
    {
        return GeneralUtility::makeInstance(ConnectionPool::class);
    }
}