‪TYPO3CMS  10.4
TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter Class Reference

Public Member Functions

array filterInlineChildren (array $parameters, DataHandler $dataHandler)
 
bool int filterFileList ($itemName, $itemIdentifier, $parentIdentifier, array $additionalInformation, DriverInterface $driver)
 
 setAllowedFileExtensions ($allowedFileExtensions)
 
 setDisallowedFileExtensions ($disallowedFileExtensions)
 

Protected Member Functions

bool isAllowed ($fileExt)
 
array convertToLowercaseArray ($inputArgument)
 

Protected Attributes

array $allowedFileExtensions
 
array $disallowedFileExtensions
 

Detailed Description

Utility methods for filtering filenames

Definition at line 27 of file FileExtensionFilter.php.

Member Function Documentation

◆ convertToLowercaseArray()

array TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::convertToLowercaseArray (   $inputArgument)
protected

Converts mixed (string or array) input arguments into an array, NULL if empty.

All array values will be converted to lower case.

Parameters
mixed$inputArgument‪Comma-separated list or array.
Returns
‪array

Definition at line 165 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\setAllowedFileExtensions(), and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\setDisallowedFileExtensions().

◆ filterFileList()

bool int TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::filterFileList (   $itemName,
  $itemIdentifier,
  $parentIdentifier,
array  $additionalInformation,
DriverInterface  $driver 
)

Entry method for use as filelist filter.

We have to use -1 as the „don't include“ return value, as call_user_func() will return FALSE if calling the method failed and thus we can't use that as a return value.

Parameters
string$itemName
string$itemIdentifier
string$parentIdentifier
array$additionalInformation‪Additional information about the inspected item
DriverInterface$driver
Returns
‪bool|int -1 if the file should not be included in a listing

Definition at line 95 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Driver\DriverInterface\fileExists(), TYPO3\CMS\Core\Resource\Driver\DriverInterface\getFileInfoByIdentifier(), and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\isAllowed().

◆ filterInlineChildren()

array TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::filterInlineChildren ( array  $parameters,
DataHandler  $dataHandler 
)

◆ isAllowed()

bool TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::isAllowed (   $fileExt)
protected

Checks whether a file is allowed according to the criteria defined in the class variables ($this->allowedFileExtensions etc.)

Parameters
string$fileExt
Returns
‪bool

Definition at line 122 of file FileExtensionFilter.php.

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filterFileList(), and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filterInlineChildren().

◆ setAllowedFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::setAllowedFileExtensions (   $allowedFileExtensions)

Set allowed file extensions

Parameters
mixed$allowedFileExtensions‪Comma-separated list or array, of allowed file extensions

Definition at line 142 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\convertToLowercaseArray().

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filterInlineChildren().

◆ setDisallowedFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::setDisallowedFileExtensions (   $disallowedFileExtensions)

Set disallowed file extensions

Parameters
mixed$disallowedFileExtensions‪Comma-separated list or array, of allowed file extensions

Definition at line 152 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\convertToLowercaseArray().

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filterInlineChildren().

Member Data Documentation

◆ $allowedFileExtensions

array TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::$allowedFileExtensions
protected

Allowed file extensions. If NULL, all extensions are allowed.

Definition at line 33 of file FileExtensionFilter.php.

◆ $disallowedFileExtensions

array TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::$disallowedFileExtensions
protected

Disallowed file extensions. If NULL, no extension is disallowed (i.e. all are allowed).

Definition at line 39 of file FileExtensionFilter.php.