ProductsContentFileStorage
extends AbstractFileStorage
in package
Class AbstractFileStorage
Table of Contents
- $storageDirectory : WritableDirectory
- Storage Directory.
- __construct() : mixed
- ProductsContentFileStorage constructor.
- deleteFile() : AbstractFileStorage
- Delete File
- fileExists() : bool
- File Exists
- getFileList() : array<string|int, mixed>
- Returns a file list for a directory.
- importFile() : string
- Import File
- renameFile() : AbstractFileStorage
- Rename File
- _createAndReturnNewFilename() : string
- Create and Return the New Filename
- _validateFile() : AbstractFileStorage
- Validates the provided file.
- _validateFilename() : AbstractFileStorage
- Validates the provided filename.
Properties
$storageDirectory
Storage Directory.
protected
WritableDirectory
$storageDirectory
Methods
__construct()
ProductsContentFileStorage constructor.
public
__construct() : mixed
Overridden parent constructor, no arguments required.
Return values
mixed —deleteFile()
Delete File
public
deleteFile(FilenameStringType $filename) : AbstractFileStorage
Deletes an existing file.
Parameters
- $filename : FilenameStringType
-
The file to delete.
Return values
AbstractFileStorage —Same instance for chained method calls.
fileExists()
File Exists
public
fileExists(FilenameStringType $filename) : bool
Checks if the provided file exists.
Parameters
- $filename : FilenameStringType
-
The filename of the file to be checked.
Return values
bool —getFileList()
Returns a file list for a directory.
public
getFileList(WritableDirectory $directory[, array<string|int, mixed> $extensions = [] ]) : array<string|int, mixed>
Parameters
- $directory : WritableDirectory
-
Directory to scan.
- $extensions : array<string|int, mixed> = []
-
File extensions (optional).
Return values
array<string|int, mixed> —importFile()
Import File
public
importFile(ExistingFile $sourceFile, FilenameStringType $preferredFilename) : string
Saves an image to a writable directory.
Parameters
- $sourceFile : ExistingFile
-
The source file to import.
- $preferredFilename : FilenameStringType
-
The preferred name of the file to be saved.
Tags
Return values
string —The created filename
renameFile()
Rename File
public
renameFile(FilenameStringType $oldName, FilenameStringType $newName) : AbstractFileStorage
Renames an existing image file.
Parameters
- $oldName : FilenameStringType
-
The old name of the file.
- $newName : FilenameStringType
-
The new name of the file.
Tags
Return values
AbstractFileStorage —Same instance for chained method calls.
_createAndReturnNewFilename()
Create and Return the New Filename
protected
_createAndReturnNewFilename(FilenameStringType $existingFilename) : string
Checks whether the provided preferred filename already exists and generates one, with appending the next available number, which does not already exist.
Parameters
- $existingFilename : FilenameStringType
-
The existing filename to change.
Tags
Return values
string —The created filename
_validateFile()
Validates the provided file.
protected
_validateFile(ExistingFile $sourceFile) : AbstractFileStorage
Parameters
- $sourceFile : ExistingFile
-
The file to validate.
Tags
Return values
AbstractFileStorage —Same instance for chained method calls.
_validateFilename()
Validates the provided filename.
protected
_validateFilename(FilenameStringType $filename) : AbstractFileStorage
Parameters
- $filename : FilenameStringType
-
The filename to validate.
Tags
Return values
AbstractFileStorage —Same instance for chained method calls.