CKFinder 3 – PHP Connector Documentation
DownloadedFile Class Reference
Inheritance diagram for DownloadedFile:
ExistingFile File

Public Member Functions

 __construct ($fileName, CKFinder $app)
 
 getWorkingFolder ()
 
 isValid ()
 
 hasAllowedExtension ()
 
 isHidden ()
 
 exists ()
 
- Public Member Functions inherited from ExistingFile
 __construct ($fileName, $folder, ResourceType $resourceType, CKFinder $app)
 
 getPath ()
 
 getFilePath ()
 
 hasValidPath ()
 
 getResourceType ()
 
 hasAllowedExtension ()
 
 isHidden ()
 
 hasHiddenPath ()
 
 exists ()
 
 getContentsStream ()
 
 getContents ()
 
 save ($contents, $filePath=null)
 
 addError (int $number)
 
 getErrors ()
 
 deleteThumbnails ()
 
 deleteResizedImages ()
 
 getTimestamp ()
 
 getMimeType ()
 
 getSize ()
 
- Public Member Functions inherited from File
 __construct ($fileName, CKFinder $app)
 
 hasValidFilename ()
 
 getFilename ()
 
 getExtension ()
 
 getExtensions ($newFileName=null)
 
 autorename (Backend $backend=null, $path='')
 
 isImage ()
 
 getCache ()
 

Protected Attributes

 $workingFolder
 
- Protected Attributes inherited from ExistingFile
 $resourceType
 
 $folder
 
 $errors = []
 
 $metadata
 
 $backend
 
- Protected Attributes inherited from File
 $fileName
 
 $config
 
 $app
 

Additional Inherited Members

- Static Public Member Functions inherited from File
static isValidName ($fileName, $disallowUnsafeCharacters=true)
 
static secureName ($fileName, $disallowUnsafeCharacters=true, $forceAscii=false)
 
static convertToAscii ($str)
 
- Public Attributes inherited from File
const NO_EXTENSION = 'NO_EXT'
 

Detailed Description

The DownloadedFile class.

Represents downloaded file

Constructor & Destructor Documentation

◆ __construct()

__construct (   $fileName,
CKFinder  $app 
)

Constructor.

Parameters
string$fileName

Reimplemented from File.

Member Function Documentation

◆ exists()

exists ( )

Checks if the file exists.

Returns
bool true if the file exists

Reimplemented from ExistingFile.

◆ getWorkingFolder()

getWorkingFolder ( )

Returns the folder of the downloaded file.

Returns
WorkingFolder

◆ hasAllowedExtension()

hasAllowedExtension ( )

Checks if the file extension is allowed.

Returns
bool true if an extension is allowed

Reimplemented from ExistingFile.

◆ isHidden()

isHidden ( )

Checks if the file is hidden.

Returns
bool true if the file is hidden

Reimplemented from ExistingFile.

◆ isValid()

isValid ( )

Validates the downloaded file.

Returns
bool true if the file passed validation
Exceptions

Exception


The documentation for this class was generated from the following file: