DataHandlerSlugUpdateHook.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\Redirects\Hooks;
 
use ‪TYPO3\CMS\Core\DataHandling\DataHandler;
use ‪TYPO3\CMS\Core\Utility\MathUtility;
use ‪TYPO3\CMS\Redirects\RedirectUpdate\SlugRedirectChangeItem;
use ‪TYPO3\CMS\Redirects\RedirectUpdate\SlugRedirectChangeItemFactory;
use ‪TYPO3\CMS\Redirects\Service\SlugService;
 
class ‪DataHandlerSlugUpdateHook
{
    protected $persistedChangedItems;
 
    public function __construct(
        protected ‪SlugService $slugService,
        protected ‪SlugRedirectChangeItemFactory $slugRedirectChangeItemFactory,
    ) {}
 
    public function processDatamap_preProcessFieldArray(array $incomingFieldArray, string $table, $id, ‪DataHandler $dataHandler): void
    {
        if (
            $table !== 'pages'
            || empty($incomingFieldArray['slug'])
            || $this->‪isNestedHookInvocation($dataHandler)
            || !‪MathUtility::canBeInterpretedAsInteger($id)
            || !$dataHandler->‪checkRecordUpdateAccess($table, $id)
        ) {
            return;
        }
 
        $changeItem = $this->slugRedirectChangeItemFactory->create((int)$id);
        if ($changeItem === null) {
            return;
        }
        $this->‪persistedChangedItems[(int)$id] = $changeItem;
    }
 
    public function ‪processDatamap_afterDatabaseOperations(string $status, string $table, $id, array $fieldArray, DataHandler $dataHandler): void
    {
        $persistedChangedItem = $this->‪persistedChangedItems[(int)$id] ?? null;
 
        if (
            $persistedChangedItem === null
            || $table !== 'pages'
            || $status !== 'update'
            || empty($fieldArray['slug'])
            || $persistedChangedItem->getOriginal()['slug'] === $fieldArray['slug']
            || $this->‪isNestedHookInvocation($dataHandler)
        ) {
            return;
        }
        // We merge the fieldArray dataset into with the original record to spare a database query here.
        $persistedChangedItem = $persistedChangedItem->withChanged(array_merge($persistedChangedItem->getOriginal(), $fieldArray));
        $this->slugService->rebuildSlugsForSlugChange($id, $persistedChangedItem, $dataHandler->getCorrelationId());
    }
 
    protected function ‪isNestedHookInvocation(DataHandler $dataHandler): bool
    {
        $correlationId = $dataHandler->getCorrelationId();
        $correlationIdAspects = $correlationId ? $correlationId->getAspects() : [];
        return in_array(‪SlugService::CORRELATION_ID_IDENTIFIER, $correlationIdAspects, true);
    }
}