Class Stream in namespace setasign\SetaPDF2\Core\IccProfile in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. IccProfile
    1. Parser
    2. Stream

setasign\SetaPDF2\Core\IccProfile

Stream Class for handling a ICC profile stream

File: /SetaPDF v2/Core/IccProfile/Stream.php
Old class name (alias): \SetaPDF_Core_IccProfile_Stream

Class hierarchy

Stream

Summary

Properties

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObjectInterface Stream::$_indirectObject

The indirect object of this stream

$_parser

protected \SetaPDF_Core_IccProfile_Parser Stream::$_parser

A ICC profile parser instance

Static Methods

create()

public static Stream::create (

\SetaPDF_Core_Document $document,
\SetaPDF_Core_Reader_Binary|string $iccProfile

): \SetaPDF_Core_IccProfile_Stream

Creates an ICC profile stream.

Parameters

$document : \SetaPDF_Core_Document
$iccProfile : \SetaPDF_Core_Reader_Binary|string: A path to a ICC profile or a reader object

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Methods

__construct()

public Stream::__construct (

\SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

)

The constructor.

Parameters

$indirectObject : \SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws \InvalidArgumentException

_getDictionary()

protected Stream::_getDictionary (

void

): \SetaPDF_Core_Type_Dictionary

Get the stream dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public Stream::cleanUp (

void

): void

Release resources.

getAlternate()

public Stream::getAlternate (

void

Get the alternate color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getColorComponents()

public Stream::getColorComponents (

void

): int

Get the color component count.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getIndirectObject()

public Stream::getIndirectObject (

void

): \SetaPDF_Core_Type_IndirectObjectInterface

Get the indirect object.

getParser()

public Stream::getParser (

void

): \SetaPDF_Core_IccProfile_Parser

Get a parser instance for this ICC profile stream.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getStreamObject()

public Stream::getStreamObject (

void

): \SetaPDF_Core_Type_Stream

Get the stream object.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setAlternate()

public Stream::setAlternate (

?\SetaPDF_Core_ColorSpace $colorSpace = null

): void

Set the alternate color space.

Parameters

$colorSpace : ?\SetaPDF_Core_ColorSpace

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception