ImageXObject
extends PdfStream
in package
Image XObject (/Subtype /Image) — ISO 32000-2 §8.9.5, Table 89.
Table of Contents
Constants
- PDF_SUBTYPE = 'Image'
- PDF_TYPE = 'XObject'
Properties
- $af : PdfArray|null
- $alternates : PdfArray|null
- $bitsPerComponent : int
- $colorSpace : mixed
- $data : string
- $decode : PdfArray|null
- $decodeParams : PdfDictionary|PdfArray|null
- /DecodeParms may be a single dict or an array of dicts (one per filter).
- $dictionary : PdfDictionary
- $filter : PdfName|PdfArray|null
- /Filter may be a single name or an array of names for filter chains.
- $generationNumber : int
- $height : int
- $id : PdfString|null
- $imageMask : bool|null
- $intent : PdfName|null
- $interpolate : bool|null
- $mask : PdfReference|null
- $matte : PdfArray|null
- $measure : PdfReference|null
- $metadata : PdfReference|null
- $nameField : PdfName|null
- $objectNumber : int
- $oc : PdfReference|null
- $opi : PdfDictionary|null
- $ptData : PdfReference|null
- $sMask : PdfReference|null
- $sMaskInData : int|null
- $structParent : int|null
- $width : int
Methods
- __construct() : mixed
- setFilter() : void
- Set a filter to encode/decode the stream data.
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Returns the stream body: dictionary, stream keyword, data, endstream.
Constants
PDF_SUBTYPE
public
mixed
PDF_SUBTYPE
= 'Image'
PDF_TYPE
public
mixed
PDF_TYPE
= 'XObject'
Properties
$af
public
PdfArray|null
$af
= null
$alternates
public
PdfArray|null
$alternates
= null
$bitsPerComponent
public
int
$bitsPerComponent
$colorSpace
public
mixed
$colorSpace
$data
public
string
$data
= ''
$decode
public
PdfArray|null
$decode
= null
$decodeParams
/DecodeParms may be a single dict or an array of dicts (one per filter).
public
PdfDictionary|PdfArray|null
$decodeParams
= null
$dictionary
public
PdfDictionary
$dictionary
$filter
/Filter may be a single name or an array of names for filter chains.
public
PdfName|PdfArray|null
$filter
= null
$generationNumber
public
int
$generationNumber
= 0
$height
public
int
$height
$id
public
PdfString|null
$id
= null
$imageMask
public
bool|null
$imageMask
= null
$intent
public
PdfName|null
$intent
= null
$interpolate
public
bool|null
$interpolate
= null
$mask
public
PdfReference|null
$mask
= null
$matte
public
PdfArray|null
$matte
= null
$measure
public
PdfReference|null
$measure
= null
$metadata
public
PdfReference|null
$metadata
= null
$nameField
public
PdfName|null
$nameField
= null
$objectNumber
public
int
$objectNumber
= 0
$oc
public
PdfReference|null
$oc
= null
$opi
public
PdfDictionary|null
$opi
= null
$ptData
public
PdfReference|null
$ptData
= null
$sMask
public
PdfReference|null
$sMask
= null
$sMaskInData
public
int|null
$sMaskInData
= null
$structParent
public
int|null
$structParent
= null
$width
public
int
$width
Methods
__construct()
public
__construct(int $width, int $height, mixed $colorSpace[, int $bitsPerComponent = 8 ][, string $data = '' ]) : mixed
Parameters
- $width : int
- $height : int
- $colorSpace : mixed
- $bitsPerComponent : int = 8
- $data : string = ''
setFilter()
Set a filter to encode/decode the stream data.
public
setFilter(FilterInterface $filter, string $pdfFilterName) : void
Parameters
- $filter : FilterInterface
-
The filter implementation
- $pdfFilterName : string
-
The PDF filter name (e.g. 'FlateDecode', 'ASCII85Decode')
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Returns the stream body: dictionary, stream keyword, data, endstream.
public
toPdf() : string
/Length is injected into the dictionary at serialization time. If a filter is set, the data is encoded before writing.