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

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

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

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

Static Protected Member Functions
static CropVariantCollection	createEmpty ()

Protected Attributes
CropVariant[]	$cropVariants

Detailed Description

Definition at line 22 of file CropVariantCollection.php.

Constructor & Destructor Documentation

__construct()

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

(

array

$cropVariants

)

Parameters

CropVariant[]

$cropVariants

Exceptions

Definition at line 32 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 110 of file CropVariantCollection.php.

addCropVariant()

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

protected

Parameters

CropVariant

$cropVariant

Exceptions

InvalidConfigurationException

Definition at line 173 of file CropVariantCollection.php.

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

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

applyRatioRestrictionToSelectedCropArea()

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

(

FileInterface

$file

)

Parameters

FileInterface

$file

Returns

‪CropVariantCollection

Definition at line 101 of file CropVariantCollection.php.

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

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

asArray()

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

(

)

Returns

‪array

Definition at line 88 of file CropVariantCollection.php.

create()

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

static

Parameters

string	$jsonString
array	$tcaConfig

Returns

‪CropVariantCollection

Definition at line 42 of file CropVariantCollection.php.

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

Referenced by TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantCollectionTest\createEmptyWorks(), TYPO3\CMS\Core\Tests\Unit\Imaging\ImageManipulation\CropVariantCollectionTest\createFromJsonWorks(), TYPO3\CMS\Core\Controller\FileDumpController\dumpAction(), TYPO3\CMS\Seo\MetaTag\MetaTagGenerator\generateSocialImages(), TYPO3\CMS\Frontend\DataProcessing\GalleryProcessor\getCroppedDimensionalProperty(), TYPO3\CMS\Backend\Form\Element\ImageManipulationElement\processConfiguration(), TYPO3\CMS\Backend\Form\FieldWizard\OtherLanguageThumbnails\render(), TYPO3\CMS\Backend\ViewHelpers\ThumbnailViewHelper\render(), TYPO3\CMS\Fluid\ViewHelpers\ImageViewHelper\render(), TYPO3\CMS\Backend\Form\Container\InlineRecordContainer\renderForeignRecordHeader(), TYPO3\CMS\Fluid\ViewHelpers\MediaViewHelper\renderImage(), TYPO3\CMS\Fluid\ViewHelpers\Uri\ImageViewHelper\renderStatic(), and TYPO3\CMS\Backend\Utility\BackendUtility\thumbCode().

createEmpty()

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

staticprotected

Returns

‪CropVariantCollection

Definition at line 152 of file CropVariantCollection.php.

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

getCropArea()

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

(

string

$id = 'default'

)

Parameters

string

$id

Returns

‪Area

Definition at line 129 of file CropVariantCollection.php.

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

Referenced by TYPO3\CMS\Core\Controller\FileDumpController\dumpAction().

getFocusArea()

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

(

string

$id = 'default'

)

Parameters

string

$id

Returns

‪Area

Definition at line 141 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 161 of file CropVariantCollection.php.

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

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

Member Data Documentation

$cropVariants

CropVariant [] TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection::$cropVariants

protected

Definition at line 26 of file CropVariantCollection.php.

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