Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Page
        2. Page
          1. Annotation
          2. Annotation
          3. AdditionalActions
          4. Annotations
          5. Contents

SetaPDF_Core_Document_Page_Contents A class representing a pages content

File: /SetaPDF v2/Core/Document/Page/Contents.php

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_currentOffset

protected int SetaPDF_Core_Document_Page_Contents::$_currentOffset

The current content stream offset

$_currentStream

protected SetaPDF_Core_Type_Stream SetaPDF_Core_Document_Page_Contents::$_currentStream

The current active content stream

$_encapsulatedInGraphicState

protected bool SetaPDF_Core_Document_Page_Contents::$_encapsulatedInGraphicState = false

Flag saying if the content is already encapsulated in a graphic state

$_page

protected SetaPDF_Core_Document_Page SetaPDF_Core_Document_Page_Contents::$_page

The page object to which this helper instance depends on


Methods

__construct()

public SetaPDF_Core_Document_Page_Contents::__construct ()

The constructor.

Parameters
$page : SetaPDF_Core_Document_Page
 

_addStream()

protected SetaPDF_Core_Document_Page_Contents::_addStream (
int|null $beforeIndex [, bool $setActive = true [, SetaPDF_Core_Type_IndirectObjectInterface $streamObject = null ]]
): SetaPDF_Core_Type_IndirectObjectInterface

Method for adding streams to the Contents entry.

Parameters
$beforeIndex : int|null
 
$setActive : bool
 
$streamObject : SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Page_Contents::cleanUp (
void
): void

Release memory/resources.

clear()

public SetaPDF_Core_Document_Page_Contents::clear (
void
): void

Clears the stream object.

count()

public SetaPDF_Core_Document_Page_Contents::count (
void
): int

Gets the count of contents streams available for this page.

encapsulateExistingContentInGraphicState()

public SetaPDF_Core_Document_Page_Contents::encapsulateExistingContentInGraphicState (
[ bool $force = false ]
): void

Encapsulate the existing content stream(s) in separate graphic state operators.

Parameters
$force : bool
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getLastStreamObject()

public SetaPDF_Core_Document_Page_Contents::getLastStreamObject (
[ bool $create = false [, bool $setActive = true ]]
): bool|SetaPDF_Core_Type_Stream

Get and/or create the last stream.

Parameters
$create : bool
 
$setActive : bool
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getStream()

public SetaPDF_Core_Document_Page_Contents::getStream (
[ bool $ignoreFaultyStreams = false ]
): string

Get the stream content.

Parameters
$ignoreFaultyStreams : bool
 

getStreamObject()

public SetaPDF_Core_Document_Page_Contents::getStreamObject (
[ bool $create = false ]
): bool|SetaPDF_Core_Type_Stream

Get the stream object.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_Type_Exception

getStreamObjectByOffset()

public SetaPDF_Core_Document_Page_Contents::getStreamObjectByOffset (
[ int $offset = 0 [, bool $setActive = true ]]
): bool|SetaPDF_Core_Type_Stream

Get a stream by offset in the contents array.

Parameters
$offset : int
 
$setActive : bool
 

isLastStreamActive()

public SetaPDF_Core_Document_Page_Contents::isLastStreamActive (
void
): bool

Checks if the last content stream is active.

prependStream()

public SetaPDF_Core_Document_Page_Contents::prependStream (
[ bool $setActive = true [, SetaPDF_Core_Type_IndirectObjectInterface $streamObject = null ]]
): SetaPDF_Core_Type_IndirectObjectInterface

Prepend a stream to the beginning of the Contents array.

Parameters
$setActive : bool
 
$streamObject : SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Core_Type_Exception

pushStream()

public SetaPDF_Core_Document_Page_Contents::pushStream (
[ bool $setActive = true [, SetaPDF_Core_Type_IndirectObjectInterface $streamObject = null ]]
): SetaPDF_Core_Type_IndirectObjectInterface

Append a stream to the end of the Contents array.

Parameters
$setActive : bool
 
$streamObject : SetaPDF_Core_Type_IndirectObjectInterface
 
Exceptions

Throws SetaPDF_Core_Type_Exception

write()

public SetaPDF_Core_Document_Page_Contents::write (
string $bytes
): void

Writes a string to the stream object.

Parameters
$bytes : string
 
Exceptions

Throws SetaPDF_Core_Type_Exception


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