CropVariant
class \
Table of Contents
Properties
- $allowedAspectRatios : Ratio[]
- $coverAreas : Area[]|null
- $cropArea : Area
- $focusArea : Area|null
- $id : string
- $selectedRatio : string
- $title : string
Methods
- __construct() : mixed
- applyRatioRestrictionToSelectedCropArea() : CropVariant
- asArray() : array
- createFromConfiguration() : CropVariant
- getCropArea() : Area
- getFocusArea() : Area|null
- getId() : string
- addAllowedAspectRatio() : mixed
- addCoverArea() : mixed
- setAllowedAspectRatios() : mixed
- setCoverAreas() : mixed
Properties
$allowedAspectRatios
protected
Ratio[]
$allowedAspectRatios
$coverAreas
protected
Area[]|null
$coverAreas
$cropArea
protected
Area
$cropArea
$focusArea
protected
Area|null
$focusArea
$id
protected
string
$id
$selectedRatio
protected
string
$selectedRatio
$title
protected
string
$title
Methods
__construct()
public
__construct(string $id, string $title, Area $cropArea[, Ratio[] $allowedAspectRatios = null ][, string|null $selectedRatio = null ][, Area|null $focusArea = null ][, Area[]|null $coverAreas = null ]) : mixed
Parameters
- $id : string
- $title : string
- $cropArea : Area
- $allowedAspectRatios : Ratio[] = null
- $selectedRatio : string|null = null
- $focusArea : Area|null = null
- $coverAreas : Area[]|null = null
Tags
applyRatioRestrictionToSelectedCropArea()
public
applyRatioRestrictionToSelectedCropArea(FileInterface $file) : CropVariant
Parameters
- $file : FileInterface
Return values
CropVariantasArray()
public
asArray() : array
Internal
Return values
arraycreateFromConfiguration()
public
static createFromConfiguration(string $id, array $config) : CropVariant
Parameters
- $id : string
- $config : array
Tags
Return values
CropVariantgetCropArea()
public
getCropArea() : Area
Return values
AreagetFocusArea()
public
getFocusArea() : Area|null
Return values
Area|nullgetId()
public
getId() : string
Return values
stringaddAllowedAspectRatio()
protected
addAllowedAspectRatio(Ratio $ratio) : mixed
Parameters
- $ratio : Ratio
Tags
addCoverArea()
protected
addCoverArea(Area $area) : mixed
Parameters
- $area : Area
Tags
setAllowedAspectRatios()
protected
setAllowedAspectRatios(Ratio ...$ratios) : mixed
Parameters
- $ratios : Ratio
Tags
setCoverAreas()
protected
setCoverAreas(Area ...$areas) : mixed
Parameters
- $areas : Area