Image Class Reference

Public Member Functions
	__construct (\Magento\Framework\Image\Adapter\AdapterInterface $adapter, $fileName=null)
	open ()
	display ()
	save ($destination=null, $newFileName=null)
	rotate ($angle)
	crop ($top=0, $left=0, $right=0, $bottom=0)
	resize ($width, $height=null)
	keepAspectRatio ($value)
	keepFrame ($value)
	keepTransparency ($value)
	constrainOnly ($value)
	backgroundColor ($value)
	quality ($value)
	watermark ( $watermarkImage, $positionX=0, $positionY=0, $watermarkImageOpacity=30, $repeat=false)
	getMimeType ()
	getImageType ()
	process ()
	instruction ()
	setImageBackgroundColor ($color)
	setWatermarkPosition ($position)
	setWatermarkImageOpacity ($imageOpacity)
	setWatermarkWidth ($width)
	setWatermarkHeight ($height)
	getOriginalWidth ()
	getOriginalHeight ()
	createPngFromString ($text, $font='')

Protected Attributes
	$_adapter
	$_fileName

Detailed Description

Image handler library

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Definition at line 13 of file Image.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Image\Adapter\AdapterInterface	$adapter,
			$fileName = null
	)

Constructor

Parameters

Image\Adapter\AdapterInterface	$adapter
string | null	$fileName

Definition at line 31 of file Image.php.

    {
        $this->_adapter = $adapter;
        $this->_fileName = $fileName;
        if (isset($fileName)) {
            $this->open();
        }
    }

Member Function Documentation

backgroundColor()

backgroundColor

(

$value

)

Get/set backgroundColor

Parameters

null | array

$value

Returns

array|null

Definition at line 172 of file Image.php.

    {
        return $this->_adapter->backgroundColor($value);
    }

constrainOnly()

constrainOnly

(

$value

)

Get/set constrainOnly

Parameters

bool

$value

Returns

bool

Definition at line 161 of file Image.php.

    {
        return $this->_adapter->constrainOnly($value);
    }

createPngFromString()

createPngFromString	(		$text,
			$font = ''
	)

Create Image from string

Parameters

string	$text
string	$font	Path to font file

Returns

$this

Definition at line 343 of file Image.php.

    {
        $this->_adapter->createPngFromString($text, $font);
        return $this;
    }

crop()

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

Crop an image.

Parameters

int	$top	Default value is 0
int	$left	Default value is 0
int	$right	Default value is 0
int	$bottom	Default value is 0 @access public

Returns

void

Definition at line 104 of file Image.php.

    {
        $this->_adapter->crop($top, $left, $right, $bottom);
    }

display()

display

(

)

Display handled image in your browser

@access public

Returns

void

Definition at line 64 of file Image.php.

    {
        $this->_adapter->display();
    }

getImageType()

getImageType

(

)

Get image type of handled image

@access public

Returns

int

Definition at line 230 of file Image.php.

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

getMimeType()

getMimeType

(

)

Get mime type of handled image

@access public

Returns

string

Definition at line 219 of file Image.php.

    {
        return $this->_adapter->getMimeType();
    }

getOriginalHeight()

getOriginalHeight

(

)

Retrieve original image height

Returns

int|null

Definition at line 331 of file Image.php.

    {
        return $this->_adapter->getOriginalHeight();
    }

getOriginalWidth()

getOriginalWidth

(

)

Retrieve original image width

Returns

int|null

Definition at line 321 of file Image.php.

    {
        return $this->_adapter->getOriginalWidth();
    }

instruction()

instruction

(

)

Instruction

@access public

Returns

void

Definition at line 251 of file Image.php.

    {
    }

keepAspectRatio()

keepAspectRatio

(

$value

)

Get/set keepAspectRatio

Parameters

bool

$value

Returns

bool

Definition at line 128 of file Image.php.

    {
        return $this->_adapter->keepAspectRatio($value);
    }

keepFrame()

keepFrame

(

$value

)

Get/set keepFrame

Parameters

bool

$value

Returns

bool

Definition at line 139 of file Image.php.

    {
        return $this->_adapter->keepFrame($value);
    }

keepTransparency()

keepTransparency

(

$value

)

Get/set keepTransparency

Parameters

bool

$value

Returns

bool

Definition at line 150 of file Image.php.

    {
        return $this->_adapter->keepTransparency($value);
    }

open()

open

(

)

Opens an image and creates image handle

@access public

Returns

void

Exceptions

Definition at line 47 of file Image.php.

    {
        $this->_adapter->checkDependencies();

        if (!file_exists($this->_fileName)) {
            throw new \Exception("File '{$this->_fileName}' does not exist.");
        }

        $this->_adapter->open($this->_fileName);
    }

process()

process

(

)

Process

@access public

Returns

void

Definition at line 241 of file Image.php.

    {
    }

quality()

quality

(

$value

)

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

Parameters

int

$value

Returns

int

Definition at line 183 of file Image.php.

    {
        return $this->_adapter->quality($value);
    }

resize()

resize	(		$width,
			$height = null
	)

Resize an image

Parameters

int	$width
int	$height	@access public

Returns

void

Definition at line 117 of file Image.php.

    {
        $this->_adapter->resize($width, $height);
    }

rotate()

rotate

(

$angle

)

Rotate an image.

Parameters

int

$angle

@access public

Returns

void

Definition at line 89 of file Image.php.

    {
        $this->_adapter->rotate($angle);
    }

save()

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

Save handled image into file

Parameters

null | string	$destination	Default value is NULL
null | string	$newFileName	Default value is NULL @access public

Returns

void

Definition at line 77 of file Image.php.

    {
        $this->_adapter->save($destination, $newFileName);
    }

setImageBackgroundColor()

setImageBackgroundColor

(

$color

)

Set image background color

Parameters

int

$color

@access public

Returns

void

@noinspection PhpUndefinedFieldInspection

Definition at line 262 of file Image.php.

    {
        $this->_adapter->imageBackgroundColor = intval($color);
    }

setWatermarkHeight()

setWatermarkHeight

(

$height

)

Set watermark height

Parameters

int

$height

Returns

$this

Definition at line 310 of file Image.php.

    {
        $this->_adapter->setWatermarkHeight($height);
        return $this;
    }

setWatermarkImageOpacity()

setWatermarkImageOpacity

(

$imageOpacity

)

Set watermark image opacity

Parameters

int

$imageOpacity

Returns

$this

Definition at line 286 of file Image.php.

    {
        $this->_adapter->setWatermarkImageOpacity($imageOpacity);
        return $this;
    }

setWatermarkPosition()

setWatermarkPosition

(

$position

)

Set watermark position

Parameters

string

$position

Returns

$this

Definition at line 274 of file Image.php.

    {
        $this->_adapter->setWatermarkPosition($position);
        return $this;
    }

setWatermarkWidth()

setWatermarkWidth

(

$width

)

Set watermark width

Parameters

int

$width

Returns

$this

Definition at line 298 of file Image.php.

    {
        $this->_adapter->setWatermarkWidth($width);
        return $this;
    }

watermark()

watermark	(		$watermarkImage,
			$positionX = 0,
			$positionY = 0,
			$watermarkImageOpacity = 30,
			$repeat = false
	)

Adds watermark to our image.

Parameters

string	$watermarkImage	Absolute path to watermark image.
int	$positionX	Watermark X position.
int	$positionY	Watermark Y position.
int	$watermarkImageOpacity	Watermark image opacity.
bool	$repeat	Enable or disable watermark brick. @access public

Exceptions

Definition at line 200 of file Image.php.

      {
        if (!file_exists($watermarkImage)) {
            throw new \Exception("Required file '{$watermarkImage}' does not exists.");
        }
        $this->_adapter->watermark($watermarkImage, $positionX, $positionY, $watermarkImageOpacity, $repeat);
    }

Field Documentation

$_adapter

$_adapter

protected

Definition at line 18 of file Image.php.

$_fileName

$_fileName

protected

Definition at line 23 of file Image.php.

---

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

• vendor/magento/framework/Image.php