Класс Engine

Граф наследования:Engine:

Открытые члены
	__construct ($file=null, array $options=[])
	setFile ($file)
	getInfo ($flashEnabled=false)
	getExifData ()
	load ()
	rotate ($angle, Color $bgColor)
	flipVertical ()
	flipHorizontal ()
	setOrientation ($orientation)
	resize (Rectangle $source, Rectangle $destination)
	blur (int $sigma)
	filter (Mask $mask)
	drawTextWatermark (TextWatermark $watermark)
	drawImageWatermark (ImageWatermark $watermark)
	save ($file, $quality=95, $format=null)
	getWidth ()
	getHeight ()
	getDimensions ()
	clear ()
	substituted ()
	exceedsMaxSize ()
	__destruct ()

Защищенные члены
	loadWatermark (ImageWatermark $watermark)
	getMaxSize ()

Защищенные данные
	$file
	$info
	$options
	$substituted = false

Подробное описание

Class Engine

См. определение в файле Engine.php строка 19

Конструктор(ы)

__construct()

__construct	(		$file = null,
		array	$options = [] )

Engine constructor.

Аргументы

string | null	$file
array	$options

См. определение в файле Engine.php строка 31

__destruct()

__destruct

(

)

См. определение в файле Engine.php строка 342

Методы

blur()

blur ( int $sigma )

abstract

Blur the image.

Аргументы

int

$sigma

Возвращает

bool

Переопределяется в Gd и Imagick.

clear()

clear ( )

abstract

Clears all resources associated to the image.

Переопределяется в Gd и Imagick.

drawImageWatermark()

drawImageWatermark ( ImageWatermark $watermark )

abstract

Draws an image watermark on the image.

Аргументы

Image\ImageWatermark

$watermark

Возвращает

bool

Переопределяется в Gd и Imagick.

drawTextWatermark()

drawTextWatermark ( TextWatermark $watermark )

abstract

Draws a text watermark on the image.

Аргументы

Image\TextWatermark

$watermark

Возвращает

bool

Переопределяется в Gd и Imagick.

exceedsMaxSize()

exceedsMaxSize

(

)

Returns true if the image exceeds maximum dimensions in options.

Возвращает

bool

См. определение в файле Engine.php строка 323

filter()

filter ( Mask $mask )

abstract

Applies a mask to the image (convolution).

Аргументы

Mask

$mask

Возвращает

bool

Переопределяется в Gd и Imagick.

flipHorizontal()

flipHorizontal ( )

abstract

Flops the image horizontally.

Возвращает

bool

Переопределяется в Gd и Imagick.

flipVertical()

flipVertical ( )

abstract

Flips the image vertically.

Возвращает

bool

Переопределяется в Gd и Imagick.

getDimensions()

getDimensions

(

)

Returns actual width and height in the Rectangle object.

Возвращает

Rectangle

См. определение в файле Engine.php строка 288

getExifData()

getExifData

(

)

Reads EXIF data from the image.

Возвращает

array

Переопределяется в Imagick.

См. определение в файле Engine.php строка 140

getHeight()

getHeight ( )

abstract

Returns actual height of the image.

Возвращает

int

Переопределяется в Gd и Imagick.

getInfo()

getInfo

(

$flashEnabled = false

)

Returns the image file info, including the image size.

Аргументы

bool

$flashEnabled

Возвращает

Image\Info|null

См. определение в файле Engine.php строка 57

getMaxSize()

getMaxSize ( )

protected

См. определение в файле Engine.php строка 308

getWidth()

getWidth ( )

abstract

Returns actual width of the image.

Возвращает

int

Переопределяется в Gd и Imagick.

load()

load ( )

abstract

Reads the image data from the file.

Возвращает

bool

Переопределяется в Gd и Imagick.

loadWatermark()

loadWatermark ( ImageWatermark $watermark )

protected

См. определение в файле Engine.php строка 231

resize()

resize ( Rectangle $source, Rectangle $destination )

abstract

Resizes the image.

Аргументы

Rectangle	$source
Rectangle	$destination

Возвращает

bool

Переопределяется в Gd и Imagick.

rotate()

rotate ( $angle, Color $bgColor )

abstract

Rotates the image clockwise.

Аргументы

float	$angle
Color	$bgColor

Возвращает

bool

Переопределяется в Gd и Imagick.

save()

save ( $file, $quality = 95, $format = null )

abstract

Saves the image to the specified file.

Аргументы

string	$file	Physical file.
int	$quality	Percents.
int | null	$format	One of the Image::FORMAT_* constants.

Возвращает

bool

Переопределяется в Gd и Imagick.

setFile()

setFile

(

$file

)

Аргументы

string

$file

Physical file name.

Возвращает

$this

См. определение в файле Engine.php строка 45

setOrientation()

setOrientation ( $orientation )

abstract

Sets the image orientation.

Аргументы

$orientation

Возвращает

bool

Переопределяется в Gd и Imagick.

substituted()

substituted

(

)

Returns true if the image is substituted with a stub.

Возвращает

bool

См. определение в файле Engine.php строка 303

Поля

$file

$file

protected

См. определение в файле Engine.php строка 21

$info

$info

protected

См. определение в файле Engine.php строка 22

$options

$options

protected

См. определение в файле Engine.php строка 23

$substituted

$substituted = false

protected

См. определение в файле Engine.php строка 24

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/File/Image/Engine.php