phpDocumentor

ProductImageFileStorage extends ImageFileStorage
in package

Class ProductImageFileStorage

Tags
category

System

subpackage

Storages

Table of Contents

$originalDir  : WritableDirectory
Original Dir (The original_images folder).
$processing  : ProductImageProcessingInterface
Processing
$productImageInUseService  : ProductImageInUseServiceInterface
$settings  : EnvProductImageFileStorageSettings
Settings
$storageDirectory  : WritableDirectory
Storage Directory.
__construct()  : mixed
deleteFile()  : ProductImageFileStorage
Delete File
fileExists()  : bool
File Exists
getFileList()  : array<string|int, mixed>
Returns a file list for a directory.
importFile()  : string
Import File
processImage()  : ProductImageFileStorage
Processes an image for the front end.
productImageInUseService()  : ProductImageInUseServiceInterface
renameFile()  : ProductImageFileStorage
Rename File
_createAndReturnNewFilename()  : string
Create and Return the New Filename
_validateFile()  : AbstractFileStorage
Validates the provided file.
_validateFilename()  : AbstractFileStorage
Validates the provided filename.
addInfoMessageToStack()  : mixed

Properties

Methods

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
throws
InvalidArgumentException

If the provided source file of the preferred filename is not valid.

Return values
string —

Preferred filename

renameFile()

Rename File

public renameFile(FilenameStringType $oldName, FilenameStringType $newName) : ProductImageFileStorage

Renames an existing image file.

Parameters
$oldName : FilenameStringType

The old name of the file.

$newName : FilenameStringType

The new name of the file.

Tags
throws
InvalidArgumentException

If a file with the preferred name already exists.

throws
FileNotFoundException

If processed product image does not exists.

throws
InvalidArgumentException

If the file that should be renamed does not exists.

Return values
ProductImageFileStorage —

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
throws
InvalidArgumentException
Return values
string —

The created filename

Search results