SetaPDF_Core_EmbeddedFileStream Class representing an embedded file stream

File: /SetaPDF v2/Core/EmbeddedFileStream.php

Class hierarchy

Summary

Constants

PARAM_CHECK_SUM

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

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

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, 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


Methods

__construct()

_getDictionary()

Get the stream dictionary.

getIndirectObject()

getMimeType()

public SetaPDF_Core_EmbeddedFileStream::getMimeType (
void
): null|string

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 (
string|null $mimeType
): void

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

Parameters
$mimeType : string|null
 

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.

See