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

Public Member Functions
	filterInlineChildren (array $parameters, \TYPO3\CMS\Core\DataHandling\DataHandler $tceMain)
	filterFileList ($itemName, $itemIdentifier, $parentIdentifier, array $additionalInformation, \TYPO3\CMS\Core\Resource\Driver\DriverInterface $driver)
	setAllowedFileExtensions ($allowedFileExtensions)
	setDisallowedFileExtensions ($disallowedFileExtensions)

Protected Member Functions
	isAllowed ($fileName)
	convertToLowercaseArray ($inputArgument)

Protected Attributes
	$allowedFileExtensions = NULL
	$disallowedFileExtensions = NULL

Detailed Description

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! Utility methods for filtering filenames

Author

Ingmar Schlecht ingma.nosp@m.r.sc.nosp@m.hlech.nosp@m.t@ty.nosp@m.po3.o.nosp@m.rg

Definition at line 21 of file FileExtensionFilter.php.

Member Function Documentation

convertToLowercaseArray()

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 147 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()

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

Entry method for use as file list 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
\TYPO3\CMS\Core\Resource\Driver\DriverInterface	$driver

Returns

boolean|integer -1 if the file should not be included in a listing

Definition at line 86 of file FileExtensionFilter.php.

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

filterInlineChildren()

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

Entry method for use as TCEMain "inline" field filter

Parameters

array	$parameters
\TYPO3\CMS\Core\DataHandling\DataHandler	$tceMain

Returns

array

Definition at line 44 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\ResourceFactory\getInstance(), 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().

isAllowed()

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::isAllowed (   $fileName )

protected

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

Parameters

\TYPO3\CMS\Core\Resource\FileInterface

$file

Returns

boolean

Definition at line 107 of file FileExtensionFilter.php.

References $result.

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 126 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$allowedFileExtensions, and 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 135 of file FileExtensionFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\$disallowedFileExtensions, and TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter\convertToLowercaseArray().

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

Member Data Documentation

$allowedFileExtensions

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::$allowedFileExtensions = NULL

protected

Definition at line 28 of file FileExtensionFilter.php.

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

$disallowedFileExtensions

TYPO3\CMS\Core\Resource\Filter\FileExtensionFilter::$disallowedFileExtensions = NULL

protected

Definition at line 35 of file FileExtensionFilter.php.

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