TYPO3\CMS\Extbase\Service\ImageService Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Service\ImageService:

Public Member Functions
	__construct (ResourceFactory $resourceFactory)
	applyProcessingInstructions ($image, array $processingInstructions)
	getImageUri (FileInterface $image, bool $absolute=false)
	getImage (string $src, $image, bool $treatIdAsReference)

Protected Member Functions
	getImageFromSourceString (string $src, bool $treatIdAsReference)
	setCompatibilityValues (ProcessedFile $processedImage)

Protected Attributes
ResourceFactory	$resourceFactory

Detailed Description

Service for processing images

Definition at line 37 of file ImageService.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Service\ImageService::__construct

(

ResourceFactory

$resourceFactory

)

ImageService constructor.

Definition at line 46 of file ImageService.php.

References TYPO3\CMS\Extbase\Service\ImageService\$resourceFactory.

Member Function Documentation

applyProcessingInstructions()

TYPO3\CMS\Extbase\Service\ImageService::applyProcessingInstructions	(		$image,
		array	$processingInstructions
	)

Create a processed file

Parameters

FileInterface | FileReference

$image

Definition at line 56 of file ImageService.php.

References TYPO3\CMS\Core\Resource\ProcessedFile\CONTEXT_IMAGECROPSCALEMASK, TYPO3\CMS\Core\Resource\ProcessedFile\getOriginalFile(), and TYPO3\CMS\Extbase\Service\ImageService\setCompatibilityValues().

getImage()

TYPO3\CMS\Extbase\Service\ImageService::getImage	(	string	$src,
			$image,
		bool	$treatIdAsReference
	)

Get File or FileReference object

This method is a factory and compatibility method that does not belong to this service, but is put here for pragmatic reasons for the time being. It should be removed once we do not support string sources for images anymore.

Parameters

string	$src
FileInterface | \TYPO3\CMS\Extbase\Domain\Model\FileReference | null	$image
bool	$treatIdAsReference

Exceptions

Definition at line 102 of file ImageService.php.

References TYPO3\CMS\Extbase\Service\ImageService\getImageFromSourceString().

getImageFromSourceString()

TYPO3\CMS\Extbase\Service\ImageService::getImageFromSourceString ( string  $src, bool  $treatIdAsReference  )

protected

Get File or FileReference object by src

Definition at line 148 of file ImageService.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\MathUtility\canBeInterpretedAsInteger(), and TYPO3\CMS\Core\Http\fromRequest.

Referenced by TYPO3\CMS\Extbase\Service\ImageService\getImage().

getImageUri()

TYPO3\CMS\Extbase\Service\ImageService::getImageUri	(	FileInterface	$image,
		bool	$absolute = false
	)

Get public url of image depending on the environment

Parameters

bool | false

$absolute

‪Force absolute URL

Definition at line 79 of file ImageService.php.

setCompatibilityValues()

TYPO3\CMS\Extbase\Service\ImageService::setCompatibilityValues ( ProcessedFile  $processedImage )

protected

Set compatibility values to frontend controller object in case we are in frontend environment.

Definition at line 180 of file ImageService.php.

Referenced by TYPO3\CMS\Extbase\Service\ImageService\applyProcessingInstructions().

Member Data Documentation

$resourceFactory

ResourceFactory TYPO3\CMS\Extbase\Service\ImageService::$resourceFactory

protected

Definition at line 41 of file ImageService.php.

Referenced by TYPO3\CMS\Extbase\Service\ImageService\__construct().