Class SetaPDF_Core_Document_ObjectCollector in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. ObjectCollector
    2. ObjectCollector

SetaPDF_Core_Document_ObjectCollector Class for collecting objects

File: /SetaPDF v2/Core/Document/ObjectCollector.php

Class hierarchy

SetaPDF_Core_Document_ObjectCollector

Implements

SetaPDF_Core_Document_ObjectCollectorInterface

Summary

Constants

COLLECT_ACRO_FORM

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_ACRO_FORM = 128

Flag to collect interactive form objects.

COLLECT_ACTIONS

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_ACTIONS = 64

Flag to collect action objects in annotation or outline items.

COLLECT_ALL

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_ALL = 255

Flag to collect all kind of objects.

COLLECT_ANNOTATIONS

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_ANNOTATIONS = 16

Flag to collect objects related to page annotations.

COLLECT_DESTS

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_DESTS = 32

Flag to collect destination objects in annotations or outline items.

COLLECT_FONTS

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_FONTS = 8

Flag to collect objects related to font objects.

COLLECT_OUTLINES

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_OUTLINES = 2

Flag to collect objects of the document outline.

COLLECT_PAGES

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_PAGES = 4

Flag to collect objects related to the document page tree.

COLLECT_STRUCT_TREE

public const int SetaPDF_Core_Document_ObjectCollector::COLLECT_STRUCT_TREE = 1

Flag to collect objects with its origin in the documens structure tree root.

Properties

$_addObjectCallback

protected callable SetaPDF_Core_Document_ObjectCollector::$_addObjectCallback

$_document

protected SetaPDF_Core_Document SetaPDF_Core_Document_ObjectCollector::$_document

$_types

protected int SetaPDF_Core_Document_ObjectCollector::$_types = 255

Flag what object types should be collected by the collect() method.

Methods

__construct()

public SetaPDF_Core_Document_ObjectCollector::__construct (

SetaPDF_Core_Document $document

)

Parameters

$document : SetaPDF_Core_Document

_addObject()

protected SetaPDF_Core_Document_ObjectCollector::_addObject (

SetaPDF_Core_Type_IndirectObjectInterface $object

): void

Parameters

$object : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

collect()

public SetaPDF_Core_Document_ObjectCollector::collect (

callable $addObjectCallback

): void

Collect all specified objects.

Parameters

$addObjectCallback : callable

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

getDocument()

public SetaPDF_Core_Document_ObjectCollector::getDocument (

void

): SetaPDF_Core_Document

setTypes()

public SetaPDF_Core_Document_ObjectCollector::setTypes (

int $types

): void

Set the object types to be collected.

Parameters

$types : int