SetaPDF_Core_EmbeddedFileStream Class representing an embedded file stream

File: /SetaPDF v2/Core/EmbeddedFileStream.php

Class hierarchy

Summary

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

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


Static Methods

create()

public static SetaPDF_Core_EmbeddedFileStream::create (
SetaPDF_Core_Document $document, $pathOrReader [, array $params = array ( ) [, $mimeType = null ]]
):

Create an embedded file stream.

Parameters
$document : SetaPDF_Core_Document
 
$pathOrReader

A reader instance or a path to a file.

$params : array

See setParams() method.

$mimeType

The subtype of the embedded file. Shall conform to the MIME media type names defined in Internet RFC 2046


Methods

__construct()

_getDictionary()

Get the stream dictionary.

getIndirectObject()

Get the indirect object.

getMimeType()

Get the subtype of the embedded file.

getParams()

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

getStream()

Get the stream content.

setMimeType()

public SetaPDF_Core_EmbeddedFileStream::setMimeType (
$mimeType
): void

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

Parameters
$mimeType
 

setParams()

public SetaPDF_Core_EmbeddedFileStream::setParams (
array $params [, $reset = true ]
): void

Set the entries in the embedded file parameter dictionary.

Parameters
$params : array

See class constants self::PARAMS_* for possible keys.

$reset

Defines whether to remove all previously set entries or not.

See