‪TYPO3CMS  11.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider Class Reference
Inheritance diagram for TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider:
TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider TYPO3\CMS\Backend\ContextMenu\ItemProviders\ProviderInterface TYPO3\CMS\Form\Hooks\FormFileProvider

Public Member Functions

bool canHandle ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider
 __construct (string $table, string $identifier, string $context='')
 
int getPriority ()
 
array addItems (array $items)
 

Protected Member Functions

 initialize ()
 
bool canRender (string $itemName, string $type)
 
bool canBeEdited ()
 
bool canEditMetadata ()
 
bool canBeRenamed ()
 
bool canBeDeleted ()
 
bool canShowInfo ()
 
bool canCreateNew ()
 
bool canCreateNewFilemount ()
 
bool canBeCopied ()
 
bool canBeCut ()
 
bool canBePastedInto ()
 
 canBeDownloaded ()
 
bool isFoldersAreInTheSameRoot ($fileOrFolderInClipBoard)
 
bool isRecordInClipboard (string $mode='')
 
bool isStorageRoot ()
 
bool isFile ()
 
bool isFolder ()
 
array getAdditionalAttributes (string $itemName)
 
string getIdentifier ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider
 initClipboard ()
 
 initDisabledItems ()
 
array prepareItems (array $itemsConfiguration)
 

Protected Attributes

File Folder null $record
 
array $itemsConfiguration
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider
LanguageService $languageService
 
BackendUserAuthentication $backendUser
 
TYPO3 CMS Backend Clipboard Clipboard $clipboard
 
array $itemsConfiguration = array( )
 
array $disabledItems = array( )
 
string $table = ''
 
string $identifier = ''
 
string $context = ''
 

Detailed Description

Provides click menu items for files and folders

Definition at line 34 of file FileProvider.php.

Member Function Documentation

◆ canBeCopied()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBeCopied ( )
protected
Returns
‪bool

Definition at line 283 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isRecordInClipboard().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canBeCut()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBeCut ( )
protected
Returns
‪bool

Definition at line 291 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isRecordInClipboard().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canBeDeleted()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBeDeleted ( )
protected
Returns
‪bool

Definition at line 249 of file FileProvider.php.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canBeDownloaded()

TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBeDownloaded ( )
protected

Definition at line 317 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFolder(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canBeEdited()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBeEdited ( )
protected
Returns
‪bool

Reimplemented in TYPO3\CMS\Form\Hooks\FormFileProvider.

Definition at line 219 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFile().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canBePastedInto()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBePastedInto ( )
protected
Returns
‪bool

Definition at line 299 of file FileProvider.php.

References TYPO3\CMS\Core\Resource\Folder\getStorage(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFolder(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFoldersAreInTheSameRoot(), and TYPO3\CMS\Core\Resource\ResourceStorage\isWithinFolder().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canBeRenamed()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canBeRenamed ( )
protected
Returns
‪bool

Reimplemented in TYPO3\CMS\Form\Hooks\FormFileProvider.

Definition at line 241 of file FileProvider.php.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canCreateNew()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canCreateNew ( )
protected
Returns
‪bool

Definition at line 265 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFolder().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canCreateNewFilemount()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canCreateNewFilemount ( )
protected

New filemounts can only be created for readable folders by admins

Returns
‪bool

Definition at line 275 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFolder().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canEditMetadata()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canEditMetadata ( )
protected
Returns
‪bool

Definition at line 229 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFile().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ canHandle()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canHandle ( )
Returns
‪bool

Reimplemented from TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider.

Reimplemented in TYPO3\CMS\Form\Hooks\FormFileProvider.

Definition at line 129 of file FileProvider.php.

◆ canRender()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canRender ( string  $itemName,
string  $type 
)
protected

Checks whether certain item can be rendered (e.g. check for disabled items or permissions)

Parameters
string$itemName
string$type
Returns
‪bool

Reimplemented from TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider.

Definition at line 154 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeCopied(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeCut(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeDeleted(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeDownloaded(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeEdited(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBePastedInto(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeRenamed(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canCreateNew(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canCreateNewFilemount(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canEditMetadata(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canShowInfo(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFile(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFolder(), and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isRecordInClipboard().

Referenced by TYPO3\CMS\Form\Hooks\FormFileProvider\purgeItems().

◆ canShowInfo()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::canShowInfo ( )
protected
Returns
‪bool

Definition at line 257 of file FileProvider.php.

References TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFile().

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ getAdditionalAttributes()

array TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::getAdditionalAttributes ( string  $itemName)
protected
Parameters
string$itemName
Returns
‪array

Reimplemented from TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider.

Definition at line 411 of file FileProvider.php.

References TYPO3\CMS\Core\Type\Bitmask\JsConfirmation\COPY_MOVE_PASTE, TYPO3\CMS\Core\Type\Bitmask\JsConfirmation\DELETE, and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\isFolder().

◆ getIdentifier()

string TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::getIdentifier ( )
protected
Returns
‪string

Reimplemented from TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider.

Definition at line 507 of file FileProvider.php.

◆ initialize()

TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::initialize ( )
protected

Initialize file object

Reimplemented from TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider.

Definition at line 137 of file FileProvider.php.

Referenced by TYPO3\CMS\Form\Hooks\FormFileProvider\addItems().

◆ isFile()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::isFile ( )
protected
Returns
‪bool

Definition at line 394 of file FileProvider.php.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeEdited(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canEditMetadata(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender(), and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canShowInfo().

◆ isFolder()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::isFolder ( )
protected
Returns
‪bool

Definition at line 402 of file FileProvider.php.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeDownloaded(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBePastedInto(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canCreateNew(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canCreateNewFilemount(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender(), and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\getAdditionalAttributes().

◆ isFoldersAreInTheSameRoot()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::isFoldersAreInTheSameRoot (   $fileOrFolderInClipBoard)
protected

Checks if folder and record are in the same filemount Cannot copy folders between filemounts

Parameters
File | Folder | null$fileOrFolderInClipBoard
Returns
‪bool

Definition at line 353 of file FileProvider.php.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBePastedInto().

◆ isRecordInClipboard()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::isRecordInClipboard ( string  $mode = '')
protected

Checks if a file record is in the "normal" pad of the clipboard

Parameters
string$mode‪"copy", "cut" or '' for any mode
Returns
‪bool

Definition at line 368 of file FileProvider.php.

References TYPO3\CMS\Backend\ContextMenu\ItemProviders\AbstractProvider\$table.

Referenced by TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeCopied(), TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canBeCut(), and TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider\canRender().

◆ isStorageRoot()

bool TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::isStorageRoot ( )
protected
Returns
‪bool

Definition at line 386 of file FileProvider.php.

Member Data Documentation

◆ $itemsConfiguration

array TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::$itemsConfiguration
protected

Definition at line 42 of file FileProvider.php.

◆ $record

File Folder null TYPO3\CMS\Filelist\ContextMenu\ItemProviders\FileProvider::$record
protected

Definition at line 38 of file FileProvider.php.