Class AbstractFileStorage
Class AbstractFileStorage
Methods summary
public
|
|
public
array
|
#
getFileList( WritableDirectory $directory, array $extensions = [] )
Returns a file list for a directory.
Returns a file list for a directory.
Parameters
- $directory
- Directory to scan.
- $extensions
- File extensions (optional).
Returns
array
|
public
string
|
#
importFile( ExistingFile $sourceFile, FilenameStringType $preferredFilename )
Import File
Saves an image to a writable directory.
Parameters
- $sourceFile
- The source file to import.
- $preferredFilename
- The preferred name of the file to be saved.
Returns
string The created filename
Throws
InvalidArgumentException
|
public
AbstractFileStorage
|
#
renameFile( FilenameStringType $oldName, FilenameStringType $newName )
Rename File
Renames an existing image file.
Parameters
- $oldName
- The old name of the file.
- $newName
- The new name of the file.
Returns
Throws
InvalidArgumentException If the file that should be renamed does not exists.
InvalidArgumentException If a file with the preferred name already exists.
|
public
boolean
|
#
fileExists( FilenameStringType $filename )
File Exists
Checks if the provided file exists.
Parameters
- $filename
- The filename of the file to be checked.
Returns
boolean
|
public
AbstractFileStorage
|
|
abstract protected
AbstractFileStorage
|
#
_validateFile( ExistingFile $sourceFile )
Validates the provided file.
Validates the provided file.
Parameters
- $sourceFile
- The file to validate.
Returns
Throws
InvalidArgumentException
|
abstract protected
AbstractFileStorage
|
#
_validateFilename( FilenameStringType $filename )
Validates the provided filename.
Validates the provided filename.
Parameters
- $filename
- The filename to validate.
Returns
Throws
InvalidArgumentException
|
protected
string
|
#
_createAndReturnNewFilename( FilenameStringType $existingFilename )
Create and Return the New Filename
Create and Return the New Filename
Checks whether the provided preferred filename already exists and generates one,
with appending the next available number, which does not already exist.
Parameters
- $existingFilename
- The existing filename to change.
Returns
string The created filename
Throws
InvalidArgumentException
|