TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter Class Reference

Public Member Functions
	filter (array $references, string $allowedFileExtensions, string $disallowedFileExtensions, DataHandler|DatabaseRecordList $dataHandler)
bool int	filterFileList ($itemName, $itemIdentifier, $parentIdentifier, array $additionalInformation, DriverInterface $driver)
	isAllowed (string $fileExtension)
	setAllowedFileExtensions (mixed $allowedFileExtensions)
	getAllowedFileExtensions ()
	setDisallowedFileExtensions (mixed $disallowedFileExtensions)
	getDisallowedFileExtensions ()
	getFilteredFileExtensions ()

Protected Member Functions
	convertToLowercaseArray (mixed $inputArgument)

Protected Attributes
array	$allowedFileExtensions = null
array	$disallowedFileExtensions = null

Detailed Description

Utility methods for filtering filenames

Definition at line 30 of file FileExtensionFilter.php.

Member Function Documentation

convertToLowercaseArray()

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

protected

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

All array values will be converted to lower case.

Definition at line 192 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().

filter()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::filter	(	array	$references,
		string	$allowedFileExtensions,
		string	$disallowedFileExtensions,
		DataHandler|DatabaseRecordList	$dataHandler
	)

Definition at line 46 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$allowedFileExtensions, TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$disallowedFileExtensions, TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\isAllowed(), TYPO3\CMS\Core\Utility\GeneralUtility\revExplode(), 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 use -1 as the "don't include“ return value, for historic reasons, as call_user_func() used to return FALSE if calling the method failed.

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\Filter\FileExtensionFilter\isAllowed().

getAllowedFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::getAllowedFileExtensions

(

)

Definition at line 146 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$allowedFileExtensions.

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getFileSelectors().

getDisallowedFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::getDisallowedFileExtensions

(

)

Definition at line 161 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$disallowedFileExtensions.

Referenced by TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getFileSelectors().

getFilteredFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::getFilteredFileExtensions

(

)

Compared the current allowed and disallowed lists and returns a filtered list either as allow or as disallow list. The "mode" is indicated by the array key, which is either "allowedFileExtensions" or "disallowedFileExtensions".

Definition at line 172 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$disallowedFileExtensions.

isAllowed()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::isAllowed

(

string

$fileExtension

)

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

this is used internally for TYPO3 core only

Definition at line 121 of file FileExtensionFilter.php.

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filter(), TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filterFileList(), and TYPO3\CMS\Backend\Form\Container\FilesControlContainer\getFileSelectors().

setAllowedFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::setAllowedFileExtensions

(

mixed

$allowedFileExtensions

)

Set allowed file extensions

Parameters

mixed

$allowedFileExtensions

‪Comma-separated list or array, of allowed file extensions

Definition at line 141 of file FileExtensionFilter.php.

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

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

setDisallowedFileExtensions()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::setDisallowedFileExtensions

(

mixed

$disallowedFileExtensions

)

Set disallowed file extensions

Parameters

mixed

$disallowedFileExtensions

‪Comma-separated list or array, of allowed file extensions

Definition at line 156 of file FileExtensionFilter.php.

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

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

Member Data Documentation

$allowedFileExtensions

array TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::$allowedFileExtensions = null

protected

Definition at line 37 of file FileExtensionFilter.php.

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filter(), and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\getAllowedFileExtensions().

$disallowedFileExtensions

array TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::$disallowedFileExtensions = null

protected

Definition at line 44 of file FileExtensionFilter.php.

Referenced by TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\filter(), TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\getDisallowedFileExtensions(), and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\getFilteredFileExtensions().