| Current Path : /var/www/surf/TYPO3/vendor/typo3/cms-form/Classes/Hooks/ |
| Current File : /var/www/surf/TYPO3/vendor/typo3/cms-form/Classes/Hooks/FormFileProvider.php |
<?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\Form\Hooks;
use TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider;
use TYPO3\CMS\Form\Mvc\Persistence\FormPersistenceManager;
/**
* Purges previously added form files from items for context menus.
* @internal
*/
class FormFileProvider extends FileProvider
{
/**
* @var array
*/
protected $itemsConfiguration = [];
/**
* Lowest priority, thus gets executed last.
*/
public function getPriority(): int
{
return 0;
}
public function canHandle(): bool
{
return parent::canHandle()
&& str_ends_with($this->identifier, FormPersistenceManager::FORM_DEFINITION_FILE_EXTENSION);
}
public function addItems(array $items): array
{
$this->initialize();
return $this->purgeItems($items);
}
/**
* Purges items that are not allowed for according command.
* According canBeEdited, canBeRenamed, ... commands will always return
* false in order to remove those form file items.
*
* Using the canRender() approach avoid adding hardcoded index name
* lookup. Thus, it's streamlined with the rest of the provides, but
* actually purges items instead of adding them.
*
* @param array $items
*/
protected function purgeItems(array $items): array
{
foreach ($items as $name => $item) {
$type = $item['type'];
if ($type === 'submenu' && !empty($item['childItems'])) {
$item['childItems'] = $this->purgeItems($item['childItems']);
} elseif (!$this->canRender($name, $type)) {
unset($items[$name]);
}
}
return $items;
}
protected function canBeEdited(): bool
{
return false;
}
protected function canBeRenamed(): bool
{
return false;
}
}