ParameterSigner
FinalYes
Table of Contents
Constants
- SALT_ARCHIVE = 'disk.archive'
- SALT_ENTITY_ARCHIVE = 'disk.entity.archive'
- SALT_IMAGE_SIZE = 'disk.image.size'
Methods
- getArchiveSignature() : string
- Returns signature for archive by ids of files which will be archived.
- getEntityArchiveSignature() : string
- Returns signature for archive which are created by entity.
- getImageSignature() : string
- Returns signature for image by width and height.
- validateArchiveSignature() : bool
- Validates signature for archive.
- validateEntityArchiveSignature() : bool
- Validates signature for archive which are created by entity.
- validateImageSignature() : bool
- Validates signature for image.
Constants
SALT_ARCHIVE
public
mixed
SALT_ARCHIVE
= 'disk.archive'
SALT_ENTITY_ARCHIVE
public
mixed
SALT_ENTITY_ARCHIVE
= 'disk.entity.archive'
SALT_IMAGE_SIZE
public
mixed
SALT_IMAGE_SIZE
= 'disk.image.size'
Methods
getArchiveSignature()
Returns signature for archive by ids of files which will be archived.
public
static getArchiveSignature(array<string|int, mixed> $ids) : string
It is used to prevent unnecessary requests to make archive.
Parameters
- $ids : array<string|int, mixed>
-
List of id.
Tags
Return values
stringgetEntityArchiveSignature()
Returns signature for archive which are created by entity.
public
static getEntityArchiveSignature(string $entity, string|int $entityId, string $fieldName) : string
It is used to prevent unnecessary requests to make archive.
Parameters
- $entity : string
-
Entity name.
- $entityId : string|int
-
Entity id.
- $fieldName : string
-
Field name.
Return values
stringgetImageSignature()
Returns signature for image by width and height.
public
static getImageSignature(string $id, int $width, int $height) : string
It is used to prevent unnecessary requests to resize image.
Parameters
- $id : string
-
Id of image.
- $width : int
-
Width (px).
- $height : int
-
Height (px).
Tags
Return values
stringvalidateArchiveSignature()
Validates signature for archive.
public
static validateArchiveSignature(string $signature, array<string|int, mixed> $ids) : bool
Parameters
- $signature : string
-
Signature to check.
- $ids : array<string|int, mixed>
-
List of id.
Tags
Return values
boolvalidateEntityArchiveSignature()
Validates signature for archive which are created by entity.
public
static validateEntityArchiveSignature(string $signature, string $entity, string|int $entityId, string $fieldName) : bool
Parameters
- $signature : string
-
Signature to check.
- $entity : string
-
Entity name.
- $entityId : string|int
-
Entity id.
- $fieldName : string
-
Field name.
Tags
Return values
boolvalidateImageSignature()
Validates signature for image.
public
static validateImageSignature(string $signature, string $id, int $width, int $height) : bool
Parameters
- $signature : string
-
Signature to check.
- $id : string
-
Id of image.
- $width : int
-
Width (px).
- $height : int
-
Height (px).