Documentation

Header
in package

Class Header

Table of Contents

Properties

$document  : Document|null
$elements  : array<string|int, Element>

Methods

__construct()  : mixed
get()  : Element|PDFObject
getDetails()  : array<string|int, mixed>
getElements()  : mixed
Returns all elements.
getElementTypes()  : array<string|int, mixed>
Used only for debug.
has()  : bool
Indicate if an element name is available in header.
init()  : mixed
parse()  : self
resolveXRef()  : Element|PDFObject
Resolve XRef to object.

Properties

Methods

__construct()

public __construct([array<string|int, Element$elements = [] ][, Document $document = null ]) : mixed
Parameters
$elements : array<string|int, Element> = []

list of elements

$document : Document = null

document

getDetails()

public getDetails([bool $deep = true ]) : array<string|int, mixed>
Parameters
$deep : bool = true
Return values
array<string|int, mixed>

getElements()

Returns all elements.

public getElements() : mixed

getElementTypes()

Used only for debug.

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

has()

Indicate if an element name is available in header.

public has(string $name) : bool
Parameters
$name : string

the name of the element

Return values
bool

parse()

public static parse(string $content, Document $document[, int &$position = 0 ]) : self
Parameters
$content : string

The content to parse

$document : Document

The document

$position : int = 0

The new position of the cursor after parsing

Return values
self

        
On this page

Search results