FolderLinkHandler.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\Core\LinkHandling;
 
use ‪TYPO3\CMS\Core\Resource\Exception\FolderDoesNotExistException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFolderAccessPermissionsException;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪FolderLinkHandler implements ‪LinkHandlingInterface
{
    protected ‪$baseUrn = 't3://folder';
 
    protected ‪$resourceFactory;
 
    public function ‪asString(array $parameters): string
    {
        if (!($parameters['folder'] ?? null) instanceof ‪Folder) {
            return '';
        }
        // the magic with prepending slash if it is missing will not work on windows
        return $this->baseUrn . '?storage=' . $parameters['folder']->getStorage()->getUid() .
        '&identifier=' . urlencode('/' . ltrim($parameters['folder']->getIdentifier(), '/'));
    }
 
    public function ‪resolveHandlerData(array $data): array
    {
        $combinedIdentifier = ($data['storage'] ?? '0') . ':' . $data['identifier'];
        try {
            $folder = $this->‪getResourceFactory()->getFolderObjectFromCombinedIdentifier($combinedIdentifier);
        } catch (‪FolderDoesNotExistException|‪InsufficientFolderAccessPermissionsException $e) {
            $folder = null;
        }
        return ['folder' => $folder];
    }
 
    protected function ‪getResourceFactory(): ‪ResourceFactory
    {
        if (!$this->resourceFactory) {
            $this->resourceFactory = GeneralUtility::makeInstance(ResourceFactory::class);
        }
        return ‪$this->resourceFactory;
    }
}