Class ObjectCollector in namespace setasign\SetaPDF2\Core\Document\ObjectCollector in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. ObjectCollector
      1. AcroForm
      2. Annotations
      3. Dests
      4. Fonts
      5. ObjectCollector
      6. ObjectCollectorInterface
      7. Outlines
      8. Pages
      9. StructTree
      10. Tree

setasign\SetaPDF2\Core\Document\ObjectCollector

ObjectCollector Class for collecting objects

File: /SetaPDF v2/Core/Document/ObjectCollector/ObjectCollector.php
Old class name (alias): \SetaPDF_Core_Document_ObjectCollector

Class hierarchy

ObjectCollector

Implements

ObjectCollectorInterface

Summary

Constants

COLLECT_ACRO_FORM

public const int ObjectCollector::COLLECT_ACRO_FORM = 128

Flag to collect interactive form objects.

COLLECT_ACTIONS

public const int ObjectCollector::COLLECT_ACTIONS = 64

Flag to collect action objects in annotation or outline items.

COLLECT_ALL

public const int ObjectCollector::COLLECT_ALL = 255

Flag to collect all kind of objects.

COLLECT_ANNOTATIONS

public const int ObjectCollector::COLLECT_ANNOTATIONS = 16

Flag to collect objects related to page annotations.

COLLECT_DESTS

public const int ObjectCollector::COLLECT_DESTS = 32

Flag to collect destination objects in annotations or outline items.

COLLECT_FONTS

public const int ObjectCollector::COLLECT_FONTS = 8

Flag to collect objects related to font objects.

COLLECT_OUTLINES

public const int ObjectCollector::COLLECT_OUTLINES = 2

Flag to collect objects of the document outline.

COLLECT_PAGES

public const int ObjectCollector::COLLECT_PAGES = 4

Flag to collect objects related to the document page tree.

COLLECT_STRUCT_TREE

public const int ObjectCollector::COLLECT_STRUCT_TREE = 1

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

Properties

$_addObjectCallback

protected callable ObjectCollector::$_addObjectCallback

$_document

protected \SetaPDF_Core_Document ObjectCollector::$_document

$_types

protected int ObjectCollector::$_types = 255

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

Methods

__construct()

public ObjectCollector::__construct (

\SetaPDF_Core_Document $document

)

Parameters

$document : \SetaPDF_Core_Document

_addObject()

protected ObjectCollector::_addObject (

\SetaPDF_Core_Type_IndirectObjectInterface $object

): void

Parameters

$object : \SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

collect()

public ObjectCollector::collect (

callable $addObjectCallback

): void

Collect all specified objects.

Parameters

$addObjectCallback : callable

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getDocument()

public ObjectCollector::getDocument (

void

): \SetaPDF_Core_Document

setTypes()

public ObjectCollector::setTypes (

int $types

): void

Set the object types to be collected.

Parameters

$types : int