\Pop\Pdf\Document\PageImage

Pdf page image class

Summary

Methods
Properties
Constants
__construct()
setImage()
resizeToWidth()
resizeToHeight()
resize()
scale()
getImage()
getResizeDimensions()
isPreserveResolution()
No public properties found
No constants found
No protected methods found
$image
$width
$height
$resize
$preserveResolution
N/A
No private methods found
No private properties found
N/A

Properties

$image

$image : string

Image file name

Type

string

$width

$width : integer

Image width

Type

integer

$height

$height : integer

Image height

Type

integer

$resize

$resize : array

Image resize value

Type

array

$preserveResolution

$preserveResolution : boolean

Flag to preserve image resolution

Type

boolean

Methods

__construct()

__construct(string  $image) : \Pop\Pdf\Document\Page\Image

Constructor

Instantiate a PDF image object.

Parameters

string $image

Returns

\Pop\Pdf\Document\Page\Image

setImage()

setImage(string  $image) : \Pop\Pdf\Document\Page\Image

Set the image file name

Parameters

string $image

Throws

\Pop\Pdf\Document\Page\Exception

Returns

\Pop\Pdf\Document\Page\Image

resizeToWidth()

resizeToWidth(integer  $width, boolean  $preserveResolution = false) : \Pop\Pdf\Document\Page\Image

Resize image to width

Parameters

integer $width
boolean $preserveResolution

Returns

\Pop\Pdf\Document\Page\Image

resizeToHeight()

resizeToHeight(integer  $height, boolean  $preserveResolution = false) : \Pop\Pdf\Document\Page\Image

Resize image to height

Parameters

integer $height
boolean $preserveResolution

Returns

\Pop\Pdf\Document\Page\Image

resize()

resize(integer  $pixel, boolean  $preserveResolution = false) : \Pop\Pdf\Document\Page\Image

Resize image on whichever dimension is the greatest

Parameters

integer $pixel
boolean $preserveResolution

Returns

\Pop\Pdf\Document\Page\Image

scale()

scale(float  $scale, boolean  $preserveResolution = false) : \Pop\Pdf\Document\Page\Image

Scale image

Parameters

float $scale
boolean $preserveResolution

Returns

\Pop\Pdf\Document\Page\Image

getImage()

getImage() : string

Get the image file name

Returns

string

getResizeDimensions()

getResizeDimensions() : array

Get the image resize dimensions

Returns

array

isPreserveResolution()

isPreserveResolution() : boolean

Get the image preserve resolution flag

Returns

boolean