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

Public Member Functions
	__construct (float $x, float $y, float $width, float $height)
	getWidth ()
	getHeight ()
	getOffsetLeft ()
	getOffsetTop ()
array	asArray ()
Area	makeAbsoluteBasedOnFile (FileInterface $file)
Area	makeRelativeBasedOnFile (FileInterface $file)
Area	applyRatioRestriction (Ratio $ratio)
bool	isEmpty ()
string	__toString ()

Static Public Member Functions
static Area	createFromConfiguration (array $config)
static Area[]	createMultipleFromConfiguration (array $config)
static Area	createEmpty ()

Protected Attributes
float	$x
float	$y
float	$width
float	$height

Detailed Description

Definition at line 22 of file Area.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Imaging\ImageManipulation\Area::__construct	(	float	$x,
		float	$y,
		float	$width,
		float	$height
	)

Parameters

float	$x
float	$y
float	$width
float	$height

Definition at line 46 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$height, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$width, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$x, and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$y.

Member Function Documentation

__toString()

string TYPO3\CMS\Core\Imaging\ImageManipulation\Area::__toString

(

)

Returns

‪string

Definition at line 196 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\asArray(), and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\isEmpty().

applyRatioRestriction()

Area TYPO3\CMS\Core\Imaging\ImageManipulation\Area::applyRatioRestriction

(

Ratio

$ratio

)

Parameters

Ratio

$ratio

Returns

‪Area

Definition at line 168 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Ratio\getRatioValue(), and TYPO3\CMS\Core\Imaging\ImageManipulation\Ratio\isFree().

asArray()

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

(

)

Returns

‪array

Definition at line 119 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$height, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$width, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$x, and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$y.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\Area\__toString(), and TYPO3\CMS\Backend\Form\Element\ImageManipulationElement\populateConfiguration().

createEmpty()

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

static

Returns

‪Area

Definition at line 90 of file Area.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\getCropArea(), TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariantCollection\getFocusArea(), TYPO3\CMS\Core\Imaging\ImageManipulation\Area\makeRelativeBasedOnFile(), and TYPO3\CMS\Backend\Form\Element\ImageManipulationElement\populateConfiguration().

createFromConfiguration()

static Area TYPO3\CMS\Core\Imaging\ImageManipulation\Area::createFromConfiguration ( array  $config )

static

Parameters

array

$config

Returns

‪Area

Exceptions

InvalidConfigurationException

Definition at line 59 of file Area.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\CropVariant\createFromConfiguration(), and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\createMultipleFromConfiguration().

createMultipleFromConfiguration()

static Area [] TYPO3\CMS\Core\Imaging\ImageManipulation\Area::createMultipleFromConfiguration ( array  $config )

static

Parameters

array

$config

Returns

‪Area[]

Exceptions

InvalidConfigurationException

Definition at line 78 of file Area.php.

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

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

getHeight()

TYPO3\CMS\Core\Imaging\ImageManipulation\Area::getHeight

(

)

Definition at line 100 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$height.

getOffsetLeft()

TYPO3\CMS\Core\Imaging\ImageManipulation\Area::getOffsetLeft

(

)

Definition at line 105 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$x.

getOffsetTop()

TYPO3\CMS\Core\Imaging\ImageManipulation\Area::getOffsetTop

(

)

Definition at line 110 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$y.

getWidth()

TYPO3\CMS\Core\Imaging\ImageManipulation\Area::getWidth

(

)

Definition at line 95 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$width.

isEmpty()

bool TYPO3\CMS\Core\Imaging\ImageManipulation\Area::isEmpty

(

)

Returns

‪bool

Definition at line 188 of file Area.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\Area\__toString().

makeAbsoluteBasedOnFile()

Area TYPO3\CMS\Core\Imaging\ImageManipulation\Area::makeAbsoluteBasedOnFile

(

FileInterface

$file

)

Parameters

FileInterface

$file

Returns

‪Area

Definition at line 133 of file Area.php.

References TYPO3\CMS\Core\Resource\FileInterface\getProperty().

makeRelativeBasedOnFile()

Area TYPO3\CMS\Core\Imaging\ImageManipulation\Area::makeRelativeBasedOnFile

(

FileInterface

$file

)

Parameters

FileInterface

$file

Returns

‪Area

Definition at line 147 of file Area.php.

References TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$height, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\$width, TYPO3\CMS\Core\Imaging\ImageManipulation\Area\createEmpty(), and TYPO3\CMS\Core\Resource\FileInterface\getProperty().

Member Data Documentation

$height

float TYPO3\CMS\Core\Imaging\ImageManipulation\Area::$height

protected

Definition at line 38 of file Area.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\Area\__construct(), TYPO3\CMS\Core\Imaging\ImageManipulation\Area\asArray(), TYPO3\CMS\Core\Imaging\ImageManipulation\Area\getHeight(), and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\makeRelativeBasedOnFile().

$width

float TYPO3\CMS\Core\Imaging\ImageManipulation\Area::$width

protected

Definition at line 34 of file Area.php.

Referenced by TYPO3\CMS\Core\Imaging\ImageManipulation\Area\__construct(), TYPO3\CMS\Core\Imaging\ImageManipulation\Area\asArray(), TYPO3\CMS\Core\Imaging\ImageManipulation\Area\getWidth(), and TYPO3\CMS\Core\Imaging\ImageManipulation\Area\makeRelativeBasedOnFile().

$x

float TYPO3\CMS\Core\Imaging\ImageManipulation\Area::$x

protected

Definition at line 26 of file Area.php.

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

$y

float TYPO3\CMS\Core\Imaging\ImageManipulation\Area::$y

protected

Definition at line 30 of file Area.php.

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