TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant Class Reference

Public Member Functions
	__construct (string $id, string $title, Area $cropArea, array $allowedAspectRatios=null, string $selectedRatio=null, Area $focusArea=null, array $coverAreas=null)
	asArray ()
	getId ()
	getCropArea ()
Area null	getFocusArea ()
	applyRatioRestrictionToSelectedCropArea (FileInterface $file)

Static Public Member Functions
static	createFromConfiguration (string $id, array $config)

Protected Member Functions
	setAllowedAspectRatios (Ratio ... $ratios)
	addAllowedAspectRatio (Ratio $ratio)
	setCoverAreas (Area ... $areas)
	addCoverArea (Area $area)

Protected Attributes
string	$id
string	$title
Area	$cropArea
Ratio[]	$allowedAspectRatios
string	$selectedRatio
Area null	$focusArea
Area[] null	$coverAreas

Detailed Description

Definition at line 22 of file CropVariant.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::__construct	(	string	$id,
		string	$title,
		Area	$cropArea,
		array	$allowedAspectRatios = null,
		string	$selectedRatio = null,
		Area	$focusArea = null,
		array	$coverAreas = null
	)

Parameters

Ratio[]	$allowedAspectRatios
string | null	$selectedRatio
Area | null	$focusArea
Area[] | null	$coverAreas

Exceptions

InvalidConfigurationException

Definition at line 59 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$allowedAspectRatios, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$coverAreas, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$cropArea, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$focusArea, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$id, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$selectedRatio, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$title, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\setAllowedAspectRatios(), and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\setCoverAreas().

Member Function Documentation

addAllowedAspectRatio()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::addAllowedAspectRatio ( Ratio  $ratio )

protected

Exceptions

InvalidConfigurationException

Definition at line 176 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\setAllowedAspectRatios().

addCoverArea()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::addCoverArea ( Area  $area )

protected

Exceptions

InvalidConfigurationException

Definition at line 198 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\setCoverAreas().

applyRatioRestrictionToSelectedCropArea()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::applyRatioRestrictionToSelectedCropArea

(

FileInterface

$file

)

Definition at line 150 of file CropVariant.php.

asArray()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::asArray

(

)

Definition at line 108 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$id, TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$selectedRatio, and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$title.

createFromConfiguration()

static TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::createFromConfiguration ( string  $id, array  $config  )

static

Exceptions

InvalidConfigurationException

Definition at line 88 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$id, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\createFromConfiguration(), and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\createMultipleFromConfiguration().

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\create(), TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantTest\createFromTcaWorks(), TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantTest\selectedRatioCanBeNull(), and TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantTest\throwsExceptionOnTypeMismatchInRatio().

getCropArea()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::getCropArea

(

)

Definition at line 137 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$cropArea.

getFocusArea()

Area null TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::getFocusArea

(

)

Returns

‪Area|null

Definition at line 145 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$focusArea.

getId()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::getId

(

)

Definition at line 132 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\$id.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\addCropVariant().

setAllowedAspectRatios()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::setAllowedAspectRatios ( Ratio ...  $ratios )

protected

Exceptions

InvalidConfigurationException

Definition at line 165 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\addAllowedAspectRatio().

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct().

setCoverAreas()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::setCoverAreas ( Area ...  $areas )

protected

Exceptions

InvalidConfigurationException

Definition at line 187 of file CropVariant.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\addCoverArea().

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct().

Member Data Documentation

$allowedAspectRatios

Ratio [] TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$allowedAspectRatios

protected

Definition at line 38 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct().

$coverAreas

Area [] null TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$coverAreas

protected

Definition at line 50 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct().

$cropArea

Area TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$cropArea

protected

Definition at line 34 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct(), and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\getCropArea().

$focusArea

Area null TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$focusArea

protected

Definition at line 46 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct(), and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\getFocusArea().

$id

string TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$id

protected

Definition at line 26 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct(), TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\asArray(), TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\createFromConfiguration(), and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\getId().

$selectedRatio

string TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$selectedRatio

protected

Definition at line 42 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct(), and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\asArray().

$title

string TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant::$title

protected

Definition at line 30 of file CropVariant.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\__construct(), and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\asArray().