Com\Tecnick\Pdf\Image\Output
Tags
Table of Contents
- $cache : array<string|int, mixed>
- Images cache.
- $compress : int
- Enable stream compression.
- $enc : Encrypt
- Encrypt object.
- $image : array<string|int, mixed>
- Image structure.
- $kunit : float
- Unit of measure conversion ratio.
- $pdfa : bool
- True if we are in PDF/A mode.
- $pon : int
- Current PDF object number.
- $xobjdict : array<string|int, mixed>
- Store image object IDs for the XObject Dictionary.
- __construct() : mixed
- Initialize images data.
- getObjectNumber() : int
- Returns current PDF object number.
- getOutImagesBlock() : string
- Get the PDF output string for Images.
- getSetImage() : string
- Get the PDF output string to print the specified image ID.
- getXobjectDict() : string
- Return XObjects Dictionary portion for the images.
- getOutAltImages() : string
- Get the PDF output string for Alternate images object.
- getOutColorInfo() : string
- Get the PDF output string for color and mask information.
- getOutIcc() : string
- Get the PDF output string for ICC object.
- getOutImage() : string
- Get the PDF output string for Image object.
- getOutPalette() : string
- Get the PDF output string for Indexed palette object.
- getOutTransparency() : string
- Get the PDF output string for color and mask information.
Properties
$cache
Images cache.
protected array<string|int,
mixed> $cache = []$compress
Enable stream compression.
protected int $compress = true$enc
Encrypt object.
protected Encrypt
$enc$image
Image structure.
protected array<string|int,
mixed> $image = []$kunit
Unit of measure conversion ratio.
protected float $kunit = 1.0$pdfa
True if we are in PDF/A mode.
protected bool $pdfa = false$pon
Current PDF object number.
protected int $pon$xobjdict
Store image object IDs for the XObject Dictionary.
protected array<string|int,
mixed> $xobjdict = array()Methods
__construct()
Initialize images data.
public __construct(float $kunit,
Encrypt $enc[,
bool $pdfa
= false
][,
bool $compress
= true
]) : mixed
Parameters
- $kunit : float
-
Unit of measure conversion ratio.
- $enc : Encrypt
-
Encrypt object.
- $pdfa : bool = false
-
True if we are in PDF/A mode.
- $compress : bool = true
-
Set to false to disable stream compression.
Return values
mixed —getObjectNumber()
Returns current PDF object number.
public getObjectNumber()
: int
Return values
int —getOutImagesBlock()
Get the PDF output string for Images.
public getOutImagesBlock(int $pon)
: string
Parameters
- $pon : int
-
Current PDF Object Number.
Return values
string —PDF code for the images block.
getSetImage()
Get the PDF output string to print the specified image ID.
public getSetImage(int $iid,
int $xpos,
int $ypos,
int $width,
int $height,
int $pageheight)
: string
Parameters
- $iid : int
-
Image ID.
- $xpos : int
-
Abscissa (X coordinate) of the upper-left Image corner.
- $ypos : int
-
Ordinate (Y coordinate) of the upper-left Image corner.
- $width : int
-
Image width in user units.
- $height : int
-
Image height in user units.
- $pageheight : int
-
Page height in user units.
Return values
string —Image PDF page content.
getXobjectDict()
Return XObjects Dictionary portion for the images.
public getXobjectDict()
: string
Return values
string —getOutAltImages()
Get the PDF output string for Alternate images object.
protected getOutAltImages(array<string|int,
mixed> $img,
array<string|int,
mixed> &$data[,
string $sub
= ''
]) : string
Parameters
- $img : array<string|int, mixed>
-
Image reference.
- $data : array<string|int, mixed>
-
Image raw data.
- $sub : string = ''
-
Sub image ('mask', 'plain' or empty string).
Return values
string —getOutColorInfo()
Get the PDF output string for color and mask information.
protected getOutColorInfo(array<string|int,
mixed> $data)
: string
Parameters
- $data : array<string|int, mixed>
-
Image raw data.
Return values
string —getOutIcc()
Get the PDF output string for ICC object.
protected getOutIcc(array<string|int,
mixed> &$data)
: string
Parameters
- $data : array<string|int, mixed>
-
Image raw data.
Return values
string —getOutImage()
Get the PDF output string for Image object.
protected getOutImage(array<string|int,
mixed> &$img,
array<string|int,
mixed> &$data[,
string $sub
= ''
]) : string
Parameters
- $img : array<string|int, mixed>
-
Image reference.
- $data : array<string|int, mixed>
-
Image raw data.
- $sub : string = ''
-
Sub image ('mask', 'plain' or empty string).
Return values
string —PDF Image object.
getOutPalette()
Get the PDF output string for Indexed palette object.
protected getOutPalette(array<string|int,
mixed> &$data)
: string
Parameters
- $data : array<string|int, mixed>
-
Image raw data.
Return values
string —getOutTransparency()
Get the PDF output string for color and mask information.
protected getOutTransparency(array<string|int,
mixed> $data)
: string
Parameters
- $data : array<string|int, mixed>
-
Image raw data.