InfoObject
extends AbstractObject
in package
Pdf info object class
Tags
Table of Contents
- $data : string
- PDF object data
- $index : int
- PDF info object index
- $isImported : string
- Imported flag
- $metadata : Metadata
- PDF metadata for the info object
- __construct() : mixed
- Constructor
- __toString() : string
- Method to print the PDF info object.
- getData() : string
- Get the object stream
- getDictionaryReferences() : array<string|int, mixed>
- Get the integer references within a dictionary stream
- getIndex() : int
- Get the object index
- getMetadata() : Metadata
- Get the info object metadata
- isImported() : bool
- Determine if the object is imported
- parse() : InfoObject
- Parse a info object from a string
- setData() : AbstractObject
- Set the object data
- setImported() : AbstractObject
- Set whether the object is imported
- setIndex() : AbstractObject
- Set the object index
- setMetadata() : InfoObject
- Set the info object metadata
Properties
$data
PDF object data
protected
string
$data
= null
$index
PDF info object index
protected
int
$index
= 3
$isImported
Imported flag
protected
string
$isImported
= false
$metadata
PDF metadata for the info object
protected
Metadata
$metadata
= null
Methods
__construct()
Constructor
public
__construct([int $index = 3 ][, Metadata $metadata = null ]) : mixed
Instantiate a PDF info object.
Parameters
- $index : int = 3
- $metadata : Metadata = null
Return values
mixed —__toString()
Method to print the PDF info object.
public
__toString() : string
Return values
string —getData()
Get the object stream
public
getData() : string
Return values
string —getDictionaryReferences()
Get the integer references within a dictionary stream
public
getDictionaryReferences(string $dictionary) : array<string|int, mixed>
Parameters
- $dictionary : string
Return values
array<string|int, mixed> —getIndex()
Get the object index
public
getIndex() : int
Return values
int —getMetadata()
Get the info object metadata
public
getMetadata() : Metadata
Return values
Metadata —isImported()
Determine if the object is imported
public
isImported() : bool
Return values
bool —parse()
Parse a info object from a string
public
static parse(string $stream) : InfoObject
Parameters
- $stream : string
Return values
InfoObject —setData()
Set the object data
public
setData(string $data) : AbstractObject
Parameters
- $data : string
Return values
AbstractObject —setImported()
Set whether the object is imported
public
setImported(bool $imported) : AbstractObject
Parameters
- $imported : bool
Return values
AbstractObject —setIndex()
Set the object index
public
setIndex(int $i) : AbstractObject
Parameters
- $i : int
Return values
AbstractObject —setMetadata()
Set the info object metadata
public
setMetadata(Metadata $metadata) : InfoObject
Parameters
- $metadata : Metadata