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

Static Public Member Functions
static bool int	filterHiddenFilesAndFolders ($itemName, $itemIdentifier, $parentIdentifier, array $additionalInformation, DriverInterface $driverInstance)
static bool	getShowHiddenFilesAndFolders ()
static bool	setShowHiddenFilesAndFolders ($showHiddenFilesAndFolders)

Static Protected Attributes
static bool	$showHiddenFilesAndFolders = false

Detailed Description

Utility methods for filtering filenames

Definition at line 23 of file FileNameFilter.php.

Member Function Documentation

filterHiddenFilesAndFolders()

static bool int TYPO3\CMS\Core\Resource\Filter\FileNameFilter::filterHiddenFilesAndFolders (   $itemName,   $itemIdentifier,   $parentIdentifier, array  $additionalInformation, DriverInterface  $driverInstance  )

static

Filter method that checks if a file/folder name starts with a dot (e.g. .htaccess)

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 (driver dependent) about the inspected item
DriverInterface	$driverInstance

Returns

‪bool|int -1 if the file should not be included in a listing

Definition at line 44 of file FileNameFilter.php.

Referenced by TYPO3\CMS\Core\Tests\Unit\Resource\Filter\FileNameFilterTest\filterHiddenFilesAndFoldersAllowsHiddenFilesAndFolders(), and TYPO3\CMS\Core\Tests\Unit\Resource\Filter\FileNameFilterTest\filterHiddenFilesAndFoldersFiltersHiddenFilesAndFolders().

getShowHiddenFilesAndFolders()

static bool TYPO3\CMS\Core\Resource\Filter\FileNameFilter::getShowHiddenFilesAndFolders ( )

static

Gets the info whether the hidden files are also displayed currently

Returns

‪bool

Definition at line 59 of file FileNameFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileNameFilter\$showHiddenFilesAndFolders.

setShowHiddenFilesAndFolders()

static bool TYPO3\CMS\Core\Resource\Filter\FileNameFilter::setShowHiddenFilesAndFolders (   $showHiddenFilesAndFolders )

static

set the flag to show (or hide) the hidden files

Parameters

bool

$showHiddenFilesAndFolders

Returns

‪bool

Definition at line 71 of file FileNameFilter.php.

References TYPO3\CMS\Core\Resource\Filter\FileNameFilter\$showHiddenFilesAndFolders.

Referenced by TYPO3\CMS\Core\Authentication\BackendUserAuthentication\evaluateUserSpecificFileFilterSettings(), TYPO3\CMS\Core\Tests\Unit\Resource\Filter\FileNameFilterTest\filterHiddenFilesAndFoldersAllowsHiddenFilesAndFolders(), and TYPO3\CMS\Core\Tests\Unit\Resource\Filter\FileNameFilterTest\filterHiddenFilesAndFoldersFiltersHiddenFilesAndFolders().

Member Data Documentation

$showHiddenFilesAndFolders

bool TYPO3\CMS\Core\Resource\Filter\FileNameFilter::$showHiddenFilesAndFolders = false

staticprotected

whether to also show the hidden files (don't show them by default)

Definition at line 29 of file FileNameFilter.php.

Referenced by TYPO3\CMS\Core\Resource\Filter\FileNameFilter\getShowHiddenFilesAndFolders(), and TYPO3\CMS\Core\Resource\Filter\FileNameFilter\setShowHiddenFilesAndFolders().