9.5/_open_document_service_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Opendocs\Service;


/*

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

 */


use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;


class ‪OpenDocumentService

{

    protected ‪$backendUser;


    public function ‪__construct(‪BackendUserAuthentication ‪$backendUser = null)

    {

        $this->backendUser = ‪$backendUser ?: ‪$GLOBALS['BE_USER'];

    }


    public function ‪getOpenDocuments(): array

    {

        $openDocuments = [];

        $sessionOpenDocuments = $this->backendUser->getModuleData('FormEngine', 'ses');


        if ($sessionOpenDocuments !== null) {

            $openDocuments = $sessionOpenDocuments[0];

        }


        return $openDocuments;

    }


    public function ‪getRecentDocuments(): array

    {

        return $this->backendUser->getModuleData('opendocs::recent') ?: [];

    }


    public function ‪closeDocument(string $identifier): void

    {

        $openDocuments = $this->‪getOpenDocuments();


        if (!isset($openDocuments[$identifier])) {

            return;

        }


        $document = $openDocuments[$identifier];

        unset($openDocuments[$identifier]);


        $this->‪storeOpenDocuments($openDocuments);

        $this->‪addToRecentDocuments($identifier, $document);

    }


    protected function ‪storeOpenDocuments(array $openDocuments): void

    {

        list(, $lastOpenDocumentIdentifier) = $this->backendUser->getModuleData('FormEngine', 'ses');

        $this->backendUser->pushModuleData('FormEngine', [$openDocuments, $lastOpenDocumentIdentifier]);

    }


    protected function ‪addToRecentDocuments(string $identifier, array $document): void

    {

        $recentDocuments = $this->‪getRecentDocuments();

        $recentDocuments = array_merge(

            [$identifier => $document],

            $recentDocuments

        );


        // Allow a maximum of 8 recent documents

        if (count($recentDocuments) > 8) {

            $recentDocuments = array_slice($recentDocuments, 0, 8);

        }


        $this->backendUser->pushModuleData('opendocs::recent', $recentDocuments);

    }

}