AbstractGenerator.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\Styleguide\TcaDataGenerator;
 
use TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Configuration\SiteWriter;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Database\Connection;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Database\Query\Restriction\DeletedRestriction;
use ‪TYPO3\CMS\Core\DataHandling\DataHandler;
use ‪TYPO3\CMS\Core\Resource\Enum\DuplicationBehavior;
use ‪TYPO3\CMS\Core\Resource\Exception\ExistingTargetFolderException;
use ‪TYPO3\CMS\Core\Resource\StorageRepository;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
 
abstract class ‪AbstractGenerator
{
    protected function ‪createSiteConfiguration(int $topPageUid, string $base = 'http://localhost/', string $title = 'styleguide demo'): void
    {
        $recordFinder = GeneralUtility::makeInstance(RecordFinder::class);
        // When the DataHandler created the page tree, a default site configuration has been added. Fetch,  rename, update.
        $site = GeneralUtility::makeInstance(SiteFinder::class)->getSiteByRootPageId($topPageUid);
        $siteWriter = GeneralUtility::makeInstance(SiteWriter::class);
        ‪$siteIdentifier = 'styleguide-demo-' . $topPageUid;
        $siteWriter->rename($site->getIdentifier(), ‪$siteIdentifier);
        $highestLanguageId = $recordFinder->findHighestLanguageId();
        $configuration = [
            'base' => $base . 'styleguide-demo-' . $topPageUid,
            'rootPageId' => $topPageUid,
            'routes' => [],
            'websiteTitle' => $title . ' ' . $topPageUid,
            'baseVariants' => [],
            'errorHandling' => [],
            'languages' => [
                [
                    'title' => 'English',
                    'enabled' => true,
                    'languageId' => 0,
                    'base' => '/',
                    'typo3Language' => 'default',
                    'locale' => 'en_US.UTF-8',
                    'iso-639-1' => 'en',
                    'navigationTitle' => 'English',
                    'hreflang' => 'en-us',
                    'direction' => 'ltr',
                    'flag' => 'us',
                    'websiteTitle' => '',
                ],
                [
                    'title' => 'styleguide demo language danish',
                    'enabled' => true,
                    'base' => '/da/',
                    'typo3Language' => 'da',
                    'locale' => 'da_DK.UTF-8',
                    'iso-639-1' => 'da',
                    'websiteTitle' => '',
                    'navigationTitle' => '',
                    'hreflang' => 'da-dk',
                    'direction' => '',
                    'fallbackType' => 'strict',
                    'fallbacks' => '',
                    'flag' => 'dk',
                    'languageId' => $highestLanguageId + 1,
                ],
                [
                    'title' => 'styleguide demo language german',
                    'enabled' => true,
                    'base' => '/de/',
                    'typo3Language' => 'de',
                    'locale' => 'de_DE.UTF-8',
                    'iso-639-1' => 'de',
                    'websiteTitle' => '',
                    'navigationTitle' => '',
                    'hreflang' => 'de-de',
                    'direction' => '',
                    'fallbackType' => 'strict',
                    'fallbacks' => '',
                    'flag' => 'de',
                    'languageId' => $highestLanguageId + 2,
                ],
                [
                    'title' => 'styleguide demo language french',
                    'enabled' => true,
                    'base' => '/fr/',
                    'typo3Language' => 'fr',
                    'locale' => 'fr_FR.UTF-8',
                    'iso-639-1' => 'fr',
                    'websiteTitle' => '',
                    'navigationTitle' => '',
                    'hreflang' => 'fr-fr',
                    'direction' => '',
                    'fallbackType' => 'strict',
                    'fallbacks' => '',
                    'flag' => 'fr',
                    'languageId' => $highestLanguageId + 3,
                ],
                [
                    'title' => 'styleguide demo language spanish',
                    'enabled' => true,
                    'base' => '/es/',
                    'typo3Language' => 'es',
                    'locale' => 'es_ES.UTF-8',
                    'iso-639-1' => 'es',
                    'websiteTitle' => '',
                    'navigationTitle' => '',
                    'hreflang' => 'es-es',
                    'direction' => '',
                    'fallbackType' => 'strict',
                    'fallbacks' => '',
                    'flag' => 'es',
                    'languageId' => $highestLanguageId + 4,
                ],
            ],
        ];
        $siteWriter->write(‪$siteIdentifier, $configuration);
    }
 
    protected function ‪getUidOfLastTopLevelPage(): int
    {
        $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('pages');
        $queryBuilder->getRestrictions()->removeAll()->add(GeneralUtility::makeInstance(DeletedRestriction::class));
        $lastPage = $queryBuilder->select('uid')
            ->from('pages')
            ->where($queryBuilder->expr()->eq('pid', $queryBuilder->createNamedParameter(0, ‪Connection::PARAM_INT)))
            ->orderBy('sorting', 'DESC')
            ->executeQuery()
            ->fetchOne();
        ‪$uid = 0;
        if (‪MathUtility::canBeInterpretedAsInteger($lastPage) && $lastPage > 0) {
            ‪$uid = (int)$lastPage;
        }
        return ‪$uid;
    }
 
    protected function ‪addToFal(array $files, string $from, string $to): void
    {
        $storageRepository = GeneralUtility::makeInstance(StorageRepository::class);
        $storage = $storageRepository->findByUid(1);
        $folder = $storage->getRootLevelFolder();
 
        try {
            $folder->createFolder($to);
            $folder = $folder->getSubfolder($to);
            foreach ($files as $fileName) {
                $sourceLocation = GeneralUtility::getFileAbsFileName($from . $fileName);
                $storage->addFile($sourceLocation, $folder, $fileName, DuplicationBehavior::RENAME, false);
            }
        } catch (‪ExistingTargetFolderException $e) {
            // No op if folder exists. This code assumes file exist, too.
        }
    }
 
    protected function ‪deleteFalFolder(string $path): void
    {
        $storageRepository = GeneralUtility::makeInstance(StorageRepository::class);
        $storage = $storageRepository->findByUid(1);
        $folder = $storage->getRootLevelFolder();
        try {
            $folder = $folder->getSubfolder($path);
            $folder->delete(true);
        } catch (\InvalidArgumentException $e) {
            // No op if folder does not exist
        }
    }
 
    protected function ‪executeDataHandler(array $data = [], array $commands = []): void
    {
        if (!empty($data) || !empty($commands)) {
            $dataHandler = GeneralUtility::makeInstance(DataHandler::class);
            $dataHandler->enableLogging = false;
            $dataHandler->bypassAccessCheckForRecords = true;
            $dataHandler->bypassWorkspaceRestrictions = true;
            $dataHandler->start($data, $commands);
            if (‪Environment::isCli()) {
                $dataHandler->clear_cacheCmd('all');
            }
 
            empty($data) ?: $dataHandler->process_datamap();
            empty($commands) ?: $dataHandler->process_cmdmap();
 
            // Update signal only if not running in cli mode
            if (!‪Environment::isCli()) {
                BackendUtility::setUpdateSignal('updatePageTree');
            }
        }
    }
}