Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Action
        2. Action
        3. Catalog
        4. Catalog
        5. OptionalContent
        6. Page
        7. Page
        8. CrossReferenceTable
        9. Destination
        10. Info
        11. ObjectNotDefinedException
        12. ObjectNotFoundException
        13. OutlinesItem
        14. PageLayout
        15. PageMode

SetaPDF_Core_Document_CrossReferenceTable Class representing a cross-reference table

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

Class hierarchy

Summary

Methods

Properties

Properties

$_maxObjId

protected integer SetaPDF_Core_Document_CrossReferenceTable::$_maxObjId = 0

The greatest used object id

$_objectOffsets

protected array SetaPDF_Core_Document_CrossReferenceTable::$_objectOffsets = array(...)

The cross-reference content

$_pointerToXref

protected integer SetaPDF_Core_Document_CrossReferenceTable::$_pointerToXref

The pointer to the last written xref table

$_updatedOffsets

protected array SetaPDF_Core_Document_CrossReferenceTable::$_updatedOffsets = array()

Updated offsets


Methods

cleanUp()

public SetaPDF_Core_Document_CrossReferenceTable::cleanUp (
void
): void

Release memory and cycled references.

deleteObject()

public SetaPDF_Core_Document_CrossReferenceTable::deleteObject (
integer $objectId
): void

Mark an object as deleted.

Parameters
$objectId : integer
 

getCompressedStream()

public SetaPDF_Core_Document_CrossReferenceTable::getCompressedStream (
SetaPDF_Core_Type_Dictionary $value, integer $newPointerToXref [, boolean $onlyUpdated = true ]
): boolean|SetaPDF_Core_Type_Stream

Get the cross reference as a compressed stream object.

Parameters
$value : SetaPDF_Core_Type_Dictionary
 
$newPointerToXref : integer
 
$onlyUpdated : boolean
 

getDefinedObjectIds()

public SetaPDF_Core_Document_CrossReferenceTable::getDefinedObjectIds (
void
): array

Get all defined object ids.

getDefiniedObjectIds()

WARNING: This method is marked as deprecated!

public SetaPDF_Core_Document_CrossReferenceTable::getDefiniedObjectIds (
void
): array

Alias for getDefinedObjectIds()

getGenerationNumberByObjectId()

public SetaPDF_Core_Document_CrossReferenceTable::getGenerationNumberByObjectId (
integer $objectId
): integer|boolean

Get the generation number by an object id.

Parameters
$objectId : integer
 

getOffsetFor()

public SetaPDF_Core_Document_CrossReferenceTable::getOffsetFor (
integer $objectId [, integer|null $generation = 0 ]
): integer|array|boolean

Get an offset for an object.

Parameters
$objectId : integer
 
$generation : integer|null
 

getPointerToXref()

public SetaPDF_Core_Document_CrossReferenceTable::getPointerToXref (
void
): integer

Returns the offset of the last written xref table.

getSize()

public SetaPDF_Core_Document_CrossReferenceTable::getSize (
void
): integer

Get the size of the cross-reference table.

isOffsetUpdated()

public SetaPDF_Core_Document_CrossReferenceTable::isOffsetUpdated (
integer $objectId
): boolean

Checks if an objects offset is updated.

Parameters
$objectId : integer
 

offsetsUpdated()

public SetaPDF_Core_Document_CrossReferenceTable::offsetsUpdated (
void
): bool

Checks whether any offset was updated or not.

setOffsetFor()

public SetaPDF_Core_Document_CrossReferenceTable::setOffsetFor (
integer $objectId, integer $generation, integer|array $offset
): void

Set an object offset.

Parameters
$objectId : integer
 
$generation : integer
 
$offset : integer|array
 

updateSize()

public SetaPDF_Core_Document_CrossReferenceTable::updateSize (
integer $objectId
): void

Updates the size value of this cross-reference table.

Parameters
$objectId : integer
 

writeNormal()

public SetaPDF_Core_Document_CrossReferenceTable::writeNormal (
SetaPDF_Core_Writer_WriterInterface $writer [, boolean $onlyUpdated = true ]
): integer

Writes the cross reference to a writer.

Parameters
$writer : SetaPDF_Core_Writer_WriterInterface
 
$onlyUpdated : boolean
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)