SetaPDF_Core_Document_CrossReferenceTable Class representing a cross reference table

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

Class hierarchy

Summary

Properties

$_maxObjId

The greatest used object id

$_objectOffsets

The cross reference content

$_pointerToXref

The pointer to the last written xref table

$_updatedOffsets

Updated offsets


Methods

cleanUp()

Release memory and cycled references.

deleteObject()

public void SetaPDF_Core_Document_CrossReferenceTable::deleteObject ( integer $objectId )

Mark an object as deleted.

Parameters
$objectId : integer
 

getCompressed()

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

Get the cross reference as a compressed stream object.

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

getDefinedObjectIds()

Get all defined object ids.

getDefiniedObjectIds()

Alias for getDefinedObjectIds()

getGenerationNumberByObjectId()

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

Get the generation number by an object id.

Parameters
$objectId : integer
 

getOffsetFor()

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

Get an offset for an object.

Parameters
$objectId : integer
 
$generation : integer|null
 

getPointerToXref()

Returns the offset of the last written xref table.

getSize()

Get the size of the cross reference table.

isOffsetUpdated()

public boolean SetaPDF_Core_Document_CrossReferenceTable::isOffsetUpdated ( integer $objectId )

Checks if an objects offset is updated.

Parameters
$objectId : integer
 

setOffsetFor()

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

Set an object offset.

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

updateSize()

public void SetaPDF_Core_Document_CrossReferenceTable::updateSize ( integer $objectId )

Updates the size value of this cross-reference table.

Parameters
$objectId : integer
 

writeNormal()

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

Writes the cross reference to a writer.

Parameters
$writer : SetaPDF_Core_Writer_WriterInterface
 
$onlyUpdated : boolean