FileExtensionFilter

Utility methods for filtering filenames

Table of Contents

Properties

$allowedFileExtensions  : array<string|int, string>|null
Allowed file extensions. If NULL, all extensions are allowed.
$disallowedFileExtensions  : array<string|int, string>|null
Disallowed file extensions. If NULL, no extension is disallowed (i.e. all are allowed).

Methods

filter()  : array<string|int, mixed>
filterFileList()  : bool|int
Entry method for use as filelist filter.
filterInlineChildren()  : array<string|int, mixed>
Entry method for use as DataHandler "inline" field filter
getAllowedFileExtensions()  : array<string|int, mixed>|null
getDisallowedFileExtensions()  : array<string|int, mixed>|null
getFilteredFileExtensions()  : array<string|int, mixed>
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".
isAllowed()  : bool
Checks whether a file is allowed according to the criteria defined in the class variables ($this->allowedFileExtensions etc.)
setAllowedFileExtensions()  : void
Set allowed file extensions
setDisallowedFileExtensions()  : void
Set disallowed file extensions
convertToLowercaseArray()  : array<string|int, mixed>|null
Converts mixed (string or array) input arguments into an array, NULL if empty.

Properties

$allowedFileExtensions

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

protected array<string|int, string>|null $allowedFileExtensions = null

$disallowedFileExtensions

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

protected array<string|int, string>|null $disallowedFileExtensions = null

Methods

filter()

public filter(array<string|int, mixed> $references, string $allowedFileExtensions, string $disallowedFileExtensions, DataHandler|DatabaseRecordList $dataHandler) : array<string|int, mixed>
Parameters
$references : array<string|int, mixed>
$allowedFileExtensions : string
$disallowedFileExtensions : string
$dataHandler : DataHandler|DatabaseRecordList
Return values
array<string|int, mixed>

filterFileList()

Entry method for use as filelist filter.

public filterFileList(string $itemName, string $itemIdentifier, string $parentIdentifier, array<string|int, mixed> $additionalInformation, DriverInterface $driver) : bool|int

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
$itemName : string
$itemIdentifier : string
$parentIdentifier : string
$additionalInformation : array<string|int, mixed>

Additional information about the inspected item

$driver : DriverInterface
Return values
bool|int —

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

filterInlineChildren()

Entry method for use as DataHandler "inline" field filter

public filterInlineChildren(array<string|int, mixed> $parameters, DataHandler|DatabaseRecordList $dataHandler) : array<string|int, mixed>
Deprecated

Will be removed in TYPO3 v13. Use filterFileReferences() directly instead.

Parameters
$parameters : array<string|int, mixed>
$dataHandler : DataHandler|DatabaseRecordList
Return values
array<string|int, mixed>

getAllowedFileExtensions()

public getAllowedFileExtensions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getDisallowedFileExtensions()

public getDisallowedFileExtensions() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

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".

public getFilteredFileExtensions() : array<string|int, mixed>
Return values
array<string|int, mixed>

isAllowed()

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

public isAllowed(string $fileExtension) : bool
Parameters
$fileExtension : string
Internal

this is used internally for TYPO3 core only

Return values
bool

setAllowedFileExtensions()

Set allowed file extensions

public setAllowedFileExtensions(mixed $allowedFileExtensions) : void
Parameters
$allowedFileExtensions : mixed

Comma-separated list or array, of allowed file extensions

setDisallowedFileExtensions()

Set disallowed file extensions

public setDisallowedFileExtensions(mixed $disallowedFileExtensions) : void
Parameters
$disallowedFileExtensions : mixed

Comma-separated list or array, of allowed file extensions

convertToLowercaseArray()

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

protected convertToLowercaseArray(mixed $inputArgument) : array<string|int, mixed>|null

All array values will be converted to lower case.

Parameters
$inputArgument : mixed
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results