SetaPDF v2 API Reference

SetaPDF_Core_EmbeddedFileStream Class representing an embedded file stream

File: /SetaPDF v2/Core/EmbeddedFileStream.php

Class hierarchy

SetaPDF_Core_EmbeddedFileStream

Summary

Static Methods

create()

Methods

__construct()
_getDictionary()
getIndirectObject()
getMimeType()
getParams()
getStream()
setMimeType()
setParams()

Properties

$_indirectObject

Constants

PARAM_CHECK_SUM
PARAM_CREATION_DATE
PARAM_MODIFICATION_DATE
PARAM_SIZE

Constants

PARAM_CHECK_SUM

public const string SetaPDF_Core_EmbeddedFileStream::PARAM_CHECK_SUM = 'CheckSum'

Constanst for the "CheckSum" key in a embedded file parameter dictionary.

The checksum shall be calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream.

PARAM_CREATION_DATE

public const string SetaPDF_Core_EmbeddedFileStream::PARAM_CREATION_DATE = 'CreationDate'

Constanst for the "CreationDate" key in a embedded file parameter dictionary.

PARAM_MODIFICATION_DATE

public const string SetaPDF_Core_EmbeddedFileStream::PARAM_MODIFICATION_DATE = 'ModDate'

Constanst for the "ModDate" key in a embedded file parameter dictionary.

PARAM_SIZE

public const string SetaPDF_Core_EmbeddedFileStream::PARAM_SIZE = 'Size'

Constanst for the "Size" key in a embedded file parameter dictionary.

Properties

$_indirectObject

protected SetaPDF_Core_Type_IndirectObject SetaPDF_Core_EmbeddedFileStream::$_indirectObject

The indirect object

Static Methods

create()

public static SetaPDF_Core_EmbeddedFileStream::create (

SetaPDF_Core_Document $document, SetaPDF_Core_Reader_ReaderInterface|string $pathOrReader [, array $params = array ( ) [, null|string $mimeType = null ]]

): SetaPDF_Core_EmbeddedFileStream

Create an embedded file stream.

Parameters

$document : SetaPDF_Core_Document
$pathOrReader : SetaPDF_Core_Reader_ReaderInterface|string: A reader instance or a path to a file.
$params : array: See setParams() method.
$mimeType : null|string: The subtype of the embedded file. Shall conform to the MIME media type names defined in Internet RFC 2046

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws Exception

Methods

__construct()

public SetaPDF_Core_EmbeddedFileStream::__construct (

SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

)

The constructor.

Parameters

$indirectObject : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_getDictionary()

protected SetaPDF_Core_EmbeddedFileStream::_getDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the stream dictionary.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

public SetaPDF_Core_EmbeddedFileStream::getIndirectObject (

void

): SetaPDF_Core_Type_IndirectObject

Get the indirect object.

getMimeType()

public SetaPDF_Core_EmbeddedFileStream::getMimeType (

void

): null|string

Get the subtype of the embedded file.

Exceptions

Throws SetaPDF_Core_Type_Exception

getParams()

public SetaPDF_Core_EmbeddedFileStream::getParams (

void

): array

Get the entries and data of the embedded file parameter dictionary.

Exceptions

Throws SetaPDF_Core_Type_Exception

getStream()

public SetaPDF_Core_EmbeddedFileStream::getStream (

void

): string

Get the stream content.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

setMimeType()

public SetaPDF_Core_EmbeddedFileStream::setMimeType (

string|null $mimeType

): void

Set the mime type (or subtype) of the embedded file stream.

Parameters

$mimeType : string|null

Exceptions

Throws SetaPDF_Core_Type_Exception

setParams()

public SetaPDF_Core_EmbeddedFileStream::setParams (

array $params [, bool $reset = true ]

): void

Set the entries in the embedded file parameter dictionary.

Parameters

$params : array: See class constants self::PARAMS_* for possible keys.
$reset : bool: Defines whether to remove all previously set entries or not.

Exceptions

Throws Exception

See