Documentation

ParentObject extends AbstractObject
in package

Pdf parent object class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2023 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.2.0

Table of Contents

$data  : string
PDF object data
$index  : int
PDF parent object index
$isImported  : string
Imported flag
$kids  : array<string|int, mixed>
PDF parent kids
__construct()  : mixed
Constructor
__toString()  : string
Method to print the parent object.
addKid()  : ParentObject
Add a kid index to the parent object
getCount()  : int
Get the parent object kid count
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
getKids()  : array<string|int, mixed>
Get the parent object kid indices
hasKid()  : bool
Determine whether the parent object contains a kid object index
isImported()  : bool
Determine if the object is imported
parse()  : ParentObject
Parse a parent object from a string
removeKid()  : ParentObject
Remove a kid index from the parent object
setData()  : AbstractObject
Set the object data
setImported()  : AbstractObject
Set whether the object is imported
setIndex()  : AbstractObject
Set the object index
setKids()  : ParentObject
Set the parent object kids

Properties

$kids

PDF parent kids

protected array<string|int, mixed> $kids = []

Methods

__construct()

Constructor

public __construct([int $index = 2 ]) : mixed

Instantiate a PDF parent object.

Parameters
$index : int = 2
Return values
mixed

__toString()

Method to print the parent object.

public __toString() : string
Return values
string

getCount()

Get the parent object kid count

public getCount() : int
Return values
int

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

getKids()

Get the parent object kid indices

public getKids() : array<string|int, mixed>
Return values
array<string|int, mixed>

hasKid()

Determine whether the parent object contains a kid object index

public hasKid(int $kid) : bool
Parameters
$kid : int
Return values
bool

isImported()

Determine if the object is imported

public isImported() : bool
Return values
bool

Search results