CropVariant

Table of Contents

Properties

$allowedAspectRatios  : array<string|int, Ratio>
$coverAreas  : array<string|int, Area>|null
$cropArea  : Area
$focusArea  : Area|null
$id  : string
$selectedRatio  : string
$title  : string

Methods

__construct()  : mixed
applyRatioRestrictionToSelectedCropArea()  : CropVariant
asArray()  : array<string|int, mixed>
createFromConfiguration()  : CropVariant
getCropArea()  : Area
getFocusArea()  : Area|null
getId()  : string
addAllowedAspectRatio()  : mixed
addCoverArea()  : mixed
setAllowedAspectRatios()  : mixed
setCoverAreas()  : mixed

Properties

$allowedAspectRatios

protected array<string|int, Ratio> $allowedAspectRatios

$selectedRatio

protected string $selectedRatio

Methods

__construct()

public __construct(string $id, string $title, Area $cropArea[, array<string|int, Ratio$allowedAspectRatios = null ][, string|null $selectedRatio = null ][, Area|null $focusArea = null ][, array<string|int, Area>|null $coverAreas = null ]) : mixed
Parameters
$id : string
$title : string
$cropArea : Area
$allowedAspectRatios : array<string|int, Ratio> = null
$selectedRatio : string|null = null
$focusArea : Area|null = null
$coverAreas : array<string|int, Area>|null = null
Tags
throws
InvalidConfigurationException

asArray()

public asArray() : array<string|int, mixed>
Internal
Return values
array<string|int, mixed>

getId()

public getId() : string
Return values
string

        
On this page

Search results