SetaPDF_Core_OutputIntent A class representing an Output Intent dictionary entry

File: /SetaPDF v2/Core/OutputIntent.php

Class hierarchy

Summary

Constants

SUBTYPE_GTS_PDFA1

const string SetaPDF_Core_OutputIntent::SUBTYPE_GTS_PDFA1 = 'GTS_PDFA1'

Predefined output intent subtype

SUBTYPE_GTS_PDFX

const string SetaPDF_Core_OutputIntent::SUBTYPE_GTS_PDFX = 'GTS_PDFX'

Predefined output intent subtype

SUBTYPE_ISO_PDFE1

const string SetaPDF_Core_OutputIntent::SUBTYPE_ISO_PDFE1 = 'ISO_PDFE1'

Predefined output intent subtype


Properties


Static Methods

createByProfile()

Creates an output intent instance.

Parameters
$subtype : string
 
$profile : SetaPDF_Core_IccProfile_Stream
 

Methods

__construct()

The constructor.

Parameters
$dictionary : SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws InvalidArgumentException if

_getTextString()

protected SetaPDF_Core_OutputIntent::_getTextString (
string $key, string $encoding
): null|string

Parameters
$key : string
 
$encoding : string
 

_setTextString()

protected SetaPDF_Core_OutputIntent::_setTextString (
string $key, string $value, string $encoding
): void

Set a text stream in the dictionary.

Parameters
$key : string
 
$value : string
 
$encoding : string
 

getDestOutputProfile()

Get the ICC profile stream defining the transformation from the PDF document’s source colours to output device colorants.

getDictionary()

getInfo()

public SetaPDF_Core_OutputIntent::getInfo (
[ string $encoding = 'UTF-8' ]
): null|string

Get the human-readable text string containing additional information or comments about the intended target device or production condition.

Parameters
$encoding : string
 

getOutputCondition()

public SetaPDF_Core_OutputIntent::getOutputCondition (
[ string $encoding = 'UTF-8' ]
): null|string

Get the text string concisely identifying the intended output device or production condition in human-readable form.

Parameters
$encoding : string
 

getOutputConditionIdentifier()

public SetaPDF_Core_OutputIntent::getOutputConditionIdentifier (
[ string $encoding = 'UTF-8' ]
): null|string

Get the text string identifying the intended output device or production condition in human- or machine-readable form.

Parameters
$encoding : string
 

getRegistryName()

public SetaPDF_Core_OutputIntent::getRegistryName (
[ string $encoding = 'UTF-8' ]
): null|string

Get the registry in which the condition designated by OutputConditionIdentifier is defined.

Parameters
$encoding : string
 

getSubtype()

public SetaPDF_Core_OutputIntent::getSubtype (
void
): mixed

Get the subtype.

setDestOutputProfile()

Set the ICC profile stream defining the transformation from the PDF document’s source colours to output device colorants.

Parameters
$stream : SetaPDF_Core_IccProfile_Stream
 

setInfo()

public SetaPDF_Core_OutputIntent::setInfo (
string|null $info [, string $encoding = 'UTF-8' ]
): void

Set the human-readable text string containing additional information or comments about the intended target device or production condition.

Parameters
$info : string|null
 
$encoding : string
 

setOutputCondition()

public SetaPDF_Core_OutputIntent::setOutputCondition (
string|null $outputCondition [, string $encoding = 'UTF-8' ]
): void

Set the text string concisely identifying the intended output device or production condition in human-readable form.

Parameters
$outputCondition : string|null
 
$encoding : string
 

setOutputConditionIdentifier()

public SetaPDF_Core_OutputIntent::setOutputConditionIdentifier (
string|null $outputConditionIdentifier [, string $encoding = 'UTF-8' ]
): void

Set the text string identifying the intended output device or production condition in human- or machine-readable form.

Parameters
$outputConditionIdentifier : string|null
 
$encoding : string
 

setRegistryName()

public SetaPDF_Core_OutputIntent::setRegistryName (
string|null $registryName [, string $encoding = 'UTF-8' ]
): void

Set the registry in which the condition designated by OutputConditionIdentifier is defined.

Parameters
$registryName : string|null
 
$encoding : string
 

setSubtype()

public SetaPDF_Core_OutputIntent::setSubtype (
string $subtype
): void

Set the subtype.

Parameters
$subtype : string