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

Public Member Functions
	__construct (array $cropVariants)
	asArray ()
	applyRatioRestrictionToSelectedCropArea (FileInterface $file)
	__toString ()
	getCropArea (string $id='default')
	getFocusArea (string $id='default')

Static Public Member Functions
static	create (string $jsonString, array $tcaConfig=[])

Protected Member Functions
	setCropVariants (CropVariant ... $cropVariants)
	addCropVariant (CropVariant $cropVariant)

Static Protected Member Functions
static	createEmpty ()

Protected Attributes
	$cropVariants

Detailed Description

Definition at line 20 of file CropVariantCollection.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::__construct

(

array

$cropVariants

)

Parameters

CropVariant[]

cropVariants

Exceptions

Definition at line 31 of file CropVariantCollection.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\setCropVariants().

Member Function Documentation

__toString()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::__toString

(

)

Definition at line 109 of file CropVariantCollection.php.

addCropVariant()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::addCropVariant ( CropVariant  $cropVariant )

protected

Parameters

CropVariant

$cropVariant

Exceptions

InvalidConfigurationException

Definition at line 172 of file CropVariantCollection.php.

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

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

applyRatioRestrictionToSelectedCropArea()

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

(

FileInterface

$file

)

Parameters

FileInterface

$file

Returns

CropVariantCollection

Definition at line 100 of file CropVariantCollection.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\applyRatioRestrictionToSelectedCropArea().

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

asArray()

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

(

)

Returns

array

Definition at line 87 of file CropVariantCollection.php.

create()

static TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::create ( string  $jsonString, array  $tcaConfig = []  )

static

Parameters

string	$jsonString
array	$tcaConfig

Returns

CropVariantCollection

Definition at line 41 of file CropVariantCollection.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\$cropVariants, and TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\createFromConfiguration().

Referenced by TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer\createCropAreaFromJsonString(), TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantCollectionTest\createEmptyWorks(), TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantCollectionTest\createFromJsonWorks(), TYPO3\CMS\Frontend\DataProcessing\GalleryProcessor\getCroppedDimensionalProperty(), TYPO3\CMS\Backend\Form\Element\ImageManipulationElement\processConfiguration(), TYPO3\CMS\Fluid\ViewHelpers\ImageViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper\renderImage(), TYPO3\CMS\Fluid\ViewHelpers\Uri\ImageViewHelper\renderStatic(), and TYPO3\CMS\Backend\Utility\BackendUtility\titleAltAttrib().

createEmpty()

static TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::createEmpty ( )

staticprotected

Returns

CropVariantCollection

Definition at line 151 of file CropVariantCollection.php.

getCropArea()

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

(

string

$id = 'default'

)

Parameters

string

$id

Returns

Area

Definition at line 128 of file CropVariantCollection.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\createEmpty().

getFocusArea()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::getFocusArea

(

string

$id = 'default'

)

Parameters

string

$id

Returns

Area

Definition at line 140 of file CropVariantCollection.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\createEmpty().

setCropVariants()

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::setCropVariants ( CropVariant ...  $cropVariants )

protected

Parameters

CropVariant[]

...$cropVariants

Exceptions

Definition at line 160 of file CropVariantCollection.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\addCropVariant().

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

Member Data Documentation

$cropVariants

TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::$cropVariants

protected

Definition at line 25 of file CropVariantCollection.php.

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