Inheritance diagram for AbstractAdapter:

Public Member Functions
	open ($fileName)

	save ($destination=null, $newName=null)

	getImage ()

	resize ($width=null, $height=null)

	rotate ($angle)

	crop ($top=0, $left=0, $right=0, $bottom=0)

	watermark ($imagePath, $positionX=0, $positionY=0, $opacity=30, $tile=false)

	checkDependencies ()

	createPngFromString ($text, $font='')

	refreshImageDimensions ()

	getColorAt ($x, $y)

	__construct (\Magento\Framework\Filesystem $filesystem, \Psr\Log\LoggerInterface $logger, array $data=[])

	getMimeType ()

	getImageType ()

	getOriginalWidth ()

	getOriginalHeight ()

	setWatermarkPosition ($position)

	getWatermarkPosition ()

	setWatermarkImageOpacity ($imageOpacity)

	getWatermarkImageOpacity ()

	setWatermarkWidth ($width)

	getWatermarkWidth ()

	setWatermarkHeight ($height)

	getWatermarkHeight ()

	keepAspectRatio ($value=null)

	keepFrame ($value=null)

	keepTransparency ($value=null)

	constrainOnly ($value=null)

	quality ($value=null)

	backgroundColor ($value=null)

	getSupportedFormats ()

	validateUploadFile ($filePath)

Data Fields
	$imageBackgroundColor = 0

const	POSITION_TOP_LEFT = 'top-left'

const	POSITION_TOP_RIGHT = 'top-right'

const	POSITION_BOTTOM_LEFT = 'bottom-left'

const	POSITION_BOTTOM_RIGHT = 'bottom-right'

const	POSITION_STRETCH = 'stretch'

const	POSITION_TILE = 'tile'

const	POSITION_CENTER = 'center'

const	DEFAULT_FONT_SIZE = 15

Data Fields inherited from AdapterInterface
const	ADAPTER_GD2 = 'GD2'

const	ADAPTER_IM = 'IMAGEMAGICK'

Protected Member Functions
	_getFileAttributes ()

	_adaptResizeValues ($frameWidth, $frameHeight)

	_checkAspectRatio ($frameWidth, $frameHeight)

	_checkDimensions ($frameWidth, $frameHeight)

	_checkSrcDimensions ()

	_getImageOptions ($filePath)

	_prepareDestination ($destination=null, $newName=null)

	_canProcess ()

Protected Attributes
	$_fileType

	$_fileName

	$_fileMimeType

	$_fileSrcName

	$_fileSrcPath

	$_imageHandler

	$_imageSrcWidth

	$_imageSrcHeight

	$_requiredExtensions

	$_watermarkPosition

	$_watermarkWidth

	$_watermarkHeight

	$_watermarkImageOpacity

	$_quality

	$_fontSize = self::DEFAULT_FONT_SIZE

	$_keepAspectRatio

	$_keepFrame

	$_keepTransparency

	$_backgroundColor

	$_constrainOnly

	$_filesystem

	$directoryWrite

	$logger

Detailed Description

Definition at line 15 of file AbstractAdapter.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\Filesystem	$filesystem,
		\Psr\Log\LoggerInterface	$logger,
		array	$data = `[]`
	)

Initialize default values

Parameters

\Magento\Framework\Filesystem	$filesystem
\Psr\Log\LoggerInterface	$logger
array	$data	@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 269 of file AbstractAdapter.php.

       {
         $this->_filesystem = $filesystem;
         $this->logger = $logger;
         $this->directoryWrite = $this->_filesystem->getDirectoryWrite(DirectoryList::ROOT);
     }

Member Function Documentation

◆ _adaptResizeValues()

_adaptResizeValues	(	$frameWidth,
		$frameHeight
	)

protected

Adapt resize values based on image configuration

Parameters

int	$frameWidth
int	$frameHeight

Returns: array

Exceptions

Definition at line 535 of file AbstractAdapter.php.

     {
         $this->_checkDimensions($frameWidth, $frameHeight);
 
         // calculate lacking dimension
         if (!$this->_keepFrame && $this->_checkSrcDimensions()) {
             if (null === $frameWidth) {
                 $frameWidth = round($frameHeight * ($this->_imageSrcWidth / $this->_imageSrcHeight));
             } elseif (null === $frameHeight) {
                 $frameHeight = round($frameWidth * ($this->_imageSrcHeight / $this->_imageSrcWidth));
             }
         } else {
             if (null === $frameWidth) {
                 $frameWidth = $frameHeight;
             } elseif (null === $frameHeight) {
                 $frameHeight = $frameWidth;
             }
         }
 
         // define coordinates of image inside new frame
         $srcX = 0;
         $srcY = 0;
         list($dstWidth, $dstHeight) = $this->_checkAspectRatio($frameWidth, $frameHeight);
 
         // define position in center
         // TODO: add positions option
         $dstY = round(($frameHeight - $dstHeight) / 2);
         $dstX = round(($frameWidth - $dstWidth) / 2);
 
         // get rid of frame (fallback to zero position coordinates)
         if (!$this->_keepFrame) {
             $frameWidth = $dstWidth;
             $frameHeight = $dstHeight;
             $dstY = 0;
             $dstX = 0;
         }
 
         return [
             'src' => ['x' => $srcX, 'y' => $srcY],
             'dst' => ['x' => $dstX, 'y' => $dstY, 'width' => $dstWidth, 'height' => $dstHeight],
             // size for new image
             'frame' => ['width' => $frameWidth, 'height' => $frameHeight]
         ];
     }

◆ _canProcess()

_canProcess ( )

protected

Checks is adapter can work with image

Returns: bool

Definition at line 702 of file AbstractAdapter.php.

     {
         return !empty($this->_fileName);
     }

◆ _checkAspectRatio()

_checkAspectRatio	(	$frameWidth,
		$frameHeight
	)

protected

Check aspect ratio

Parameters

int	$frameWidth
int	$frameHeight

Returns: int[]

Definition at line 587 of file AbstractAdapter.php.

     {
         $dstWidth = $frameWidth;
         $dstHeight = $frameHeight;
         if ($this->_keepAspectRatio && $this->_checkSrcDimensions()) {
             // do not make picture bigger, than it is, if required
             if ($this->_constrainOnly) {
                 if ($frameWidth >= $this->_imageSrcWidth && $frameHeight >= $this->_imageSrcHeight) {
                     $dstWidth = $this->_imageSrcWidth;
                     $dstHeight = $this->_imageSrcHeight;
                 }
             }
             // keep aspect ratio
             if ($this->_imageSrcWidth / $this->_imageSrcHeight >= $frameWidth / $frameHeight) {
                 $dstHeight = round($dstWidth / $this->_imageSrcWidth * $this->_imageSrcHeight);
             } else {
                 $dstWidth = round($dstHeight / $this->_imageSrcHeight * $this->_imageSrcWidth);
             }
         }
         return [$dstWidth, $dstHeight];
     }

◆ _checkDimensions()

_checkDimensions	(	$frameWidth,
		$frameHeight
	)

protected

Check Frame dimensions and throw exception if they are not valid

Parameters

int	$frameWidth
int	$frameHeight

Returns: void

Exceptions

Definition at line 617 of file AbstractAdapter.php.

     {
         if ($frameWidth !== null && $frameWidth <= 0 ||
             $frameHeight !== null && $frameHeight <= 0 ||
             empty($frameWidth) && empty($frameHeight)
         ) {
             throw new \Exception('Invalid image dimensions.');
         }
     }

◆ _checkSrcDimensions()

_checkSrcDimensions ( )

protected

Return false if source width or height is empty

Returns: bool

Definition at line 632 of file AbstractAdapter.php.

     {
         return !empty($this->_imageSrcWidth) && !empty($this->_imageSrcHeight);
     }

◆ _getFileAttributes()

_getFileAttributes ( )

protected

Assign file dirname and basename to object properties

Returns: void

Definition at line 519 of file AbstractAdapter.php.

     {
         $pathinfo = pathinfo($this->_fileName);
 
         $this->_fileSrcPath = $pathinfo['dirname'];
         $this->_fileSrcName = $pathinfo['basename'];
     }

◆ _getImageOptions()

_getImageOptions ( $filePath )

protected

Return information about image using getimagesize function

Parameters

string $filePath

Returns: array

Definition at line 643 of file AbstractAdapter.php.

     {
         return getimagesize($filePath);
     }

◆ _prepareDestination()

_prepareDestination	(	$destination = `null`,
		$newName = `null`
	)

protected

Create destination folder if not exists and return full file path

Parameters

string	$destination
string	$newName

Returns: string

Exceptions

Definition at line 666 of file AbstractAdapter.php.

     {
         if (empty($destination)) {
             $destination = $this->_fileSrcPath;
         } else {
             if (empty($newName)) {
                 $info = pathinfo($destination);
                 $newName = $info['basename'];
                 $destination = $info['dirname'];
             }
         }
 
         if (empty($newName)) {
             $newFileName = $this->_fileSrcName;
         } else {
             $newFileName = $newName;
         }
         $fileName = $destination . '/' . $newFileName;
 
         if (!is_writable($destination)) {
             try {
                 $this->directoryWrite->create($this->directoryWrite->getRelativePath($destination));
             } catch (\Magento\Framework\Exception\FileSystemException $e) {
                 $this->logger->critical($e);
                 throw new \Exception('Unable to write file into directory ' . $destination . '. Access forbidden.');
             }
         }
 
         return $fileName;
     }

◆ backgroundColor()

backgroundColor ( $value = null )

Get/set keepBackgroundColor

Parameters

null | array $value

Returns: array|void

Definition at line 498 of file AbstractAdapter.php.

     {
         if (null !== $value) {
             if (!is_array($value) || 3 !== count($value)) {
                 return;
             }
             foreach ($value as $color) {
                 if (!is_integer($color) || $color < 0 || $color > 255) {
                     return;
                 }
             }
         }
         $this->_backgroundColor = $value;
         return $this->_backgroundColor;
     }

◆ checkDependencies()

checkDependencies ( )

abstract

Checks required dependencies

Returns: void

Exceptions

Implements AdapterInterface.

◆ constrainOnly()

constrainOnly ( $value = null )

Get/set constrainOnly

Parameters

bool $value

Returns: bool

Definition at line 470 of file AbstractAdapter.php.

     {
         if (null !== $value) {
             $this->_constrainOnly = (bool)$value;
         }
         return $this->_constrainOnly;
     }

◆ createPngFromString()

createPngFromString	(	$text,
		$font = `''`
	)

abstract

Create Image from string

Parameters

string	$text
string	$font	Path to font file

Returns: AbstractAdapter

Implements AdapterInterface.

◆ crop()

crop	(	$top = `0`,
		$left = `0`,
		$right = `0`,
		$bottom = `0`
	)

abstract

Crop image

Parameters

int	$top
int	$left
int	$right
int	$bottom

Returns: bool

Implements AdapterInterface.

◆ getColorAt()

getColorAt	(	$x,
		$y
	)

abstract

Returns rgba array of the specified pixel

Parameters

int	$x
int	$y

Returns: array

Implements AdapterInterface.

◆ getImage()

getImage ( )

abstract

Render image and return its binary contents

Returns: string

Implements AdapterInterface.

◆ getImageType()

getImageType ( )

Assign image width, height, fileType to object properties using getimagesize function

Returns: int|null

Definition at line 299 of file AbstractAdapter.php.

     {
         if ($this->_fileType) {
             return $this->_fileType;
         } else {
             if ($this->_canProcess()) {
                 list($this->_imageSrcWidth, $this->_imageSrcHeight, $this->_fileType) = getimagesize($this->_fileName);
                 return $this->_fileType;
             }
         }
         return null;
     }

◆ getMimeType()

getMimeType ( )

Assign image width, height, fileMimeType to object properties

Returns: string|null

Definition at line 284 of file AbstractAdapter.php.

     {
         if ($this->_fileMimeType) {
             return $this->_fileMimeType;
         } else {
             $this->_fileMimeType = image_type_to_mime_type($this->getImageType());
             return $this->_fileMimeType;
         }
     }

◆ getOriginalHeight()

getOriginalHeight ( )

Retrieve Original Image Height

Returns: int|null

Definition at line 328 of file AbstractAdapter.php.

     {
         $this->getImageType();
         return $this->_imageSrcHeight;
     }

◆ getOriginalWidth()

getOriginalWidth ( )

Retrieve Original Image Width

Returns: int|null

Definition at line 317 of file AbstractAdapter.php.

     {
         $this->getImageType();
         return $this->_imageSrcWidth;
     }

◆ getSupportedFormats()

getSupportedFormats ( )

Return supported image formats

Returns: string[]

Definition at line 653 of file AbstractAdapter.php.

     {
         return ['gif', 'jpeg', 'jpg', 'png'];
     }

◆ getWatermarkHeight()

getWatermarkHeight ( )

Return watermark height

Returns: int

Definition at line 417 of file AbstractAdapter.php.

     {
         return $this->_watermarkHeight;
     }

◆ getWatermarkImageOpacity()

getWatermarkImageOpacity ( )

Get watermark opacity

Returns: int

Definition at line 373 of file AbstractAdapter.php.

     {
         return $this->_watermarkImageOpacity;
     }

◆ getWatermarkPosition()

getWatermarkPosition ( )

Get watermark position

Returns: string

Definition at line 351 of file AbstractAdapter.php.

     {
         return $this->_watermarkPosition;
     }

◆ getWatermarkWidth()

getWatermarkWidth ( )

Get watermark width

Returns: int

Definition at line 395 of file AbstractAdapter.php.

     {
         return $this->_watermarkWidth;
     }

◆ keepAspectRatio()

keepAspectRatio ( $value = null )

Get/set keepAspectRatio

Parameters

bool $value

Returns: bool|\Magento\Framework\Image\Adapter\AbstractAdapter

Definition at line 428 of file AbstractAdapter.php.

     {
         if (null !== $value) {
             $this->_keepAspectRatio = (bool)$value;
         }
         return $this->_keepAspectRatio;
     }

◆ keepFrame()

keepFrame ( $value = null )

Get/set keepFrame

Parameters

bool $value

Returns: bool

Definition at line 442 of file AbstractAdapter.php.

     {
         if (null !== $value) {
             $this->_keepFrame = (bool)$value;
         }
         return $this->_keepFrame;
     }

◆ keepTransparency()

keepTransparency ( $value = null )

Get/set keepTransparency

Parameters

bool $value

Returns: bool

Definition at line 456 of file AbstractAdapter.php.

     {
         if (null !== $value) {
             $this->_keepTransparency = (bool)$value;
         }
         return $this->_keepTransparency;
     }

◆ open()

open ( $fileName )

abstract

Open image for processing

Parameters

string $fileName

Returns: void

Implements AdapterInterface.

◆ quality()

quality ( $value = null )

Get/set quality, values in percentage from 0 to 100

Parameters

int $value

Returns: int

Definition at line 484 of file AbstractAdapter.php.

     {
         if (null !== $value) {
             $this->_quality = (int)$value;
         }
         return $this->_quality;
     }

◆ refreshImageDimensions()

refreshImageDimensions ( )

abstract

Reassign image dimensions

Returns: void

Implements AdapterInterface.

◆ resize()

resize	(	$width = `null`,
		$height = `null`
	)

abstract

Change the image size

Parameters

null \| int	$width
null \| int	$height

Returns: void

Implements AdapterInterface.

◆ rotate()

rotate ( $angle )

abstract

Rotate image on specific angle

Parameters

int $angle

Returns: void

Implements AdapterInterface.

◆ save()

save	(	$destination = `null`,
		$newName = `null`
	)

abstract

Save image to specific path. If some folders of path does not exist they will be created

Parameters

null \| string	$destination
null \| string	$newName

Returns: void

Exceptions

Implements AdapterInterface.

◆ setWatermarkHeight()

setWatermarkHeight ( $height )

Set watermark height

Parameters

int $height

Returns: $this

Definition at line 406 of file AbstractAdapter.php.

     {
         $this->_watermarkHeight = $height;
         return $this;
     }

◆ setWatermarkImageOpacity()

setWatermarkImageOpacity ( $imageOpacity )

Set watermark opacity

Parameters

int $imageOpacity

Returns: $this

Definition at line 362 of file AbstractAdapter.php.

     {
         $this->_watermarkImageOpacity = $imageOpacity;
         return $this;
     }

◆ setWatermarkPosition()

setWatermarkPosition ( $position )

Set watermark position

Parameters

string $position

Returns: $this

Definition at line 340 of file AbstractAdapter.php.

     {
         $this->_watermarkPosition = $position;
         return $this;
     }

◆ setWatermarkWidth()

setWatermarkWidth ( $width )

Set watermark width

Parameters

int $width

Returns: $this

Definition at line 384 of file AbstractAdapter.php.

     {
         $this->_watermarkWidth = $width;
         return $this;
     }

◆ validateUploadFile()

validateUploadFile ( $filePath )

Check - is this file an image

Parameters

string $filePath

Returns: bool

Exceptions

Definition at line 714 of file AbstractAdapter.php.

     {
         if (!file_exists($filePath)) {
             throw new \InvalidArgumentException("File '{$filePath}' does not exists.");
         }
         if (!getimagesize($filePath)) {
             throw new \InvalidArgumentException('Disallowed file type.');
         }
         $this->checkDependencies();
         $this->open($filePath);
 
         return $this->getImageType() !== null;
     }

◆ watermark()

watermark	(	$imagePath,
		$positionX = `0`,
		$positionY = `0`,
		$opacity = `30`,
		$tile = `false`
	)

abstract

Add watermark to image

Parameters

string	$imagePath
int	$positionX
int	$positionY
int	$opacity
bool	$tile

Returns: void

Implements AdapterInterface.

Field Documentation

◆ $_backgroundColor

$_backgroundColor

protected

Definition at line 138 of file AbstractAdapter.php.

◆ $_constrainOnly

$_constrainOnly

protected

Definition at line 143 of file AbstractAdapter.php.

◆ $_fileMimeType

$_fileMimeType

protected

Definition at line 58 of file AbstractAdapter.php.

◆ $_fileName

$_fileName

protected

Definition at line 53 of file AbstractAdapter.php.

◆ $_fileSrcName

$_fileSrcName

protected

Definition at line 63 of file AbstractAdapter.php.

◆ $_fileSrcPath

$_fileSrcPath

protected

Definition at line 68 of file AbstractAdapter.php.

◆ $_filesystem

$_filesystem

protected

Definition at line 150 of file AbstractAdapter.php.

◆ $_fileType

$_fileType

protected

Definition at line 48 of file AbstractAdapter.php.

◆ $_fontSize

$_fontSize = self::DEFAULT_FONT_SIZE

protected

Definition at line 118 of file AbstractAdapter.php.

◆ $_imageHandler

$_imageHandler

protected

Definition at line 73 of file AbstractAdapter.php.

◆ $_imageSrcHeight

$_imageSrcHeight

protected

Definition at line 83 of file AbstractAdapter.php.

◆ $_imageSrcWidth

$_imageSrcWidth

protected

Definition at line 78 of file AbstractAdapter.php.

◆ $_keepAspectRatio

$_keepAspectRatio

protected

Definition at line 123 of file AbstractAdapter.php.

◆ $_keepFrame

$_keepFrame

protected

Definition at line 128 of file AbstractAdapter.php.

◆ $_keepTransparency

$_keepTransparency

protected

Definition at line 133 of file AbstractAdapter.php.

◆ $_quality

$_quality

protected

Definition at line 113 of file AbstractAdapter.php.

◆ $_requiredExtensions

$_requiredExtensions

protected

Definition at line 88 of file AbstractAdapter.php.

◆ $_watermarkHeight

$_watermarkHeight

protected

Definition at line 103 of file AbstractAdapter.php.

◆ $_watermarkImageOpacity

$_watermarkImageOpacity

protected

Definition at line 108 of file AbstractAdapter.php.

◆ $_watermarkPosition

$_watermarkPosition

protected

Definition at line 93 of file AbstractAdapter.php.

◆ $_watermarkWidth

$_watermarkWidth

protected

Definition at line 98 of file AbstractAdapter.php.

◆ $directoryWrite

$directoryWrite

protected

Definition at line 155 of file AbstractAdapter.php.

◆ $imageBackgroundColor

$imageBackgroundColor = 0

Definition at line 21 of file AbstractAdapter.php.

◆ $logger

$logger

protected

Definition at line 160 of file AbstractAdapter.php.

◆ DEFAULT_FONT_SIZE

const DEFAULT_FONT_SIZE = 15

Default font size

Definition at line 43 of file AbstractAdapter.php.

◆ POSITION_BOTTOM_LEFT

const POSITION_BOTTOM_LEFT = 'bottom-left'

Definition at line 30 of file AbstractAdapter.php.

◆ POSITION_BOTTOM_RIGHT

const POSITION_BOTTOM_RIGHT = 'bottom-right'

Definition at line 32 of file AbstractAdapter.php.

◆ POSITION_CENTER

const POSITION_CENTER = 'center'

Definition at line 38 of file AbstractAdapter.php.

◆ POSITION_STRETCH

const POSITION_STRETCH = 'stretch'

Definition at line 34 of file AbstractAdapter.php.

◆ POSITION_TILE

const POSITION_TILE = 'tile'

Definition at line 36 of file AbstractAdapter.php.

◆ POSITION_TOP_LEFT

const POSITION_TOP_LEFT = 'top-left'

Position constants

Definition at line 26 of file AbstractAdapter.php.

◆ POSITION_TOP_RIGHT

const POSITION_TOP_RIGHT = 'top-right'

Definition at line 28 of file AbstractAdapter.php.

The documentation for this class was generated from the following file:

vendor/magento/framework/Image/Adapter/AbstractAdapter.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _adaptResizeValues()

◆ _canProcess()

◆ _checkAspectRatio()

◆ _checkDimensions()

◆ _checkSrcDimensions()

◆ _getFileAttributes()

◆ _getImageOptions()

◆ _prepareDestination()

◆ backgroundColor()

◆ checkDependencies()

◆ constrainOnly()

◆ createPngFromString()

◆ crop()

◆ getColorAt()

◆ getImage()

◆ getImageType()

◆ getMimeType()

◆ getOriginalHeight()

◆ getOriginalWidth()

◆ getSupportedFormats()

◆ getWatermarkHeight()

◆ getWatermarkImageOpacity()

◆ getWatermarkPosition()

◆ getWatermarkWidth()

◆ keepAspectRatio()

◆ keepFrame()

◆ keepTransparency()

◆ open()

◆ quality()

◆ refreshImageDimensions()

◆ resize()

◆ rotate()

◆ save()

◆ setWatermarkHeight()

◆ setWatermarkImageOpacity()

◆ setWatermarkPosition()

◆ setWatermarkWidth()

◆ validateUploadFile()

◆ watermark()

Field Documentation

◆ $_backgroundColor

◆ $_constrainOnly

◆ $_fileMimeType

◆ $_fileName

◆ $_fileSrcName

◆ $_fileSrcPath

◆ $_filesystem

◆ $_fileType

◆ $_fontSize

◆ $_imageHandler

◆ $_imageSrcHeight

◆ $_imageSrcWidth

◆ $_keepAspectRatio

◆ $_keepFrame

◆ $_keepTransparency

◆ $_quality

◆ $_requiredExtensions

◆ $_watermarkHeight

◆ $_watermarkImageOpacity

◆ $_watermarkPosition

◆ $_watermarkWidth

◆ $directoryWrite

◆ $imageBackgroundColor

◆ $logger

◆ DEFAULT_FONT_SIZE

◆ POSITION_BOTTOM_LEFT

◆ POSITION_BOTTOM_RIGHT

◆ POSITION_CENTER

◆ POSITION_STRETCH

◆ POSITION_TILE

◆ POSITION_TOP_LEFT

◆ POSITION_TOP_RIGHT