Interface IndirectObjectInterface in namespace setasign\SetaPDF2\Core\Type in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Type

setasign\SetaPDF2\Core\Type

IndirectObjectInterface Interface indirect objects and object references

File: /SetaPDF v2/Core/Type/IndirectObjectInterface.php
Old class name (alias): \SetaPDF_Core_Type_IndirectObjectInterface

Implemented in

Implements

\SplSubject

Summary

Methods

attach()

Internal PHP method: SplSubject::attach

cleanUp()

abstract public IndirectObjectInterface::cleanUp (

void

): void

This method is used to clean up an object by releasing memory and references.

The observers have to be removed with the "detach()"-method. Only if there is no observer left this method should really release resources.

The method has to be implemented by each object type

detach()

Internal PHP method: SplSubject::detach

ensure()

abstract public IndirectObjectInterface::ensure (

bool $forceObservation = null,
array &$ensuredObjectsList = array ( )

): AbstractType

Ensures the access to the value.

Parameters

$forceObservation: bool
$ensuredObjectsList: array: A list of all ensured indirect objects to prevent recursion

getGen()

abstract public IndirectObjectInterface::getGen (

void

): int

Returns the initial generation number.

getObjectId()

abstract public IndirectObjectInterface::getObjectId (

void

): int

Returns the initial object id.

getObjectIdent()

abstract public IndirectObjectInterface::getObjectIdent (

void

): string

Get the Object Identifier.

This identifier has nothing to do with the object numbers of a PDF document. They will be used to map an object to document related object numbers.

getOwnerPdfDocument()

abstract public IndirectObjectInterface::getOwnerPdfDocument (

void

): \setasign\SetaPDF2\Core\Document

Returns the owner document.

notify()

Internal PHP method: SplSubject::notify