Index

  1. \setasign\SetaPDF2
    1. Core
      1. BitConverter
      2. Canvas
      3. ColorSpace
      4. Core
      5. DataStructure
      6. Document
      7. Document
      8. EmbeddedFileStream
      9. Encoding
      10. Exception
      11. FileSpecification
      12. Filter
      13. Font
      14. Geometry
      15. IccProfile
      16. Image
      17. OutputIntent
      18. PageBoundaries
      19. PageFormats
      20. Parser
      21. Reader
      22. Resource
      23. SecHandler
      24. Text
      25. Tokenizer
      26. TransparencyGroup
      27. Type
      28. Writer
      29. XObject
      30. Xmp
      31. Zugferd

setasign\SetaPDF2\Core

OutputIntent A class representing an Output Intent dictionary entry

File: /SetaPDF v2/Core/OutputIntent.php
Old class name (alias): \SetaPDF_Core_OutputIntent

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

SUBTYPE_GTS_PDFA1

public const string OutputIntent::SUBTYPE_GTS_PDFA1 = 'GTS_PDFA1'

Predefined output intent subtype

SUBTYPE_GTS_PDFX

public const string OutputIntent::SUBTYPE_GTS_PDFX = 'GTS_PDFX'

Predefined output intent subtype

SUBTYPE_ISO_PDFE1

public const string OutputIntent::SUBTYPE_ISO_PDFE1 = 'ISO_PDFE1'

Predefined output intent subtype


Properties

$_dictionary

protected \SetaPDF_Core_Type_Dictionary OutputIntent::$_dictionary

Static Methods

createByProfile()

public static OutputIntent::createByProfile (
string $subtype,
\SetaPDF_Core_IccProfile_Stream $profile
): \SetaPDF_Core_OutputIntent

Creates an output intent instance.

Parameters
$subtype : string
 
$profile : \SetaPDF_Core_IccProfile_Stream
 

Methods

__construct()

public OutputIntent::__construct ()

The constructor.

Parameters
$dictionary : \SetaPDF_Core_Type_Dictionary
 
Exceptions

Throws \InvalidArgumentException if

_getTextString()

protected OutputIntent::_getTextString (
string $key,
string $encoding
): ?string
Parameters
$key : string
 
$encoding : string
 

_setTextString()

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

Set a text stream in the dictionary.

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

getDestOutputProfile()

public OutputIntent::getDestOutputProfile (
void
): ?\SetaPDF_Core_IccProfile_Stream

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

getDictionary()

public OutputIntent::getDictionary (
void
): \SetaPDF_Core_Type_Dictionary

Get the dictionary.

getInfo()

public OutputIntent::getInfo (
string $encoding = 'UTF-8'
): ?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 OutputIntent::getOutputCondition (
string $encoding = 'UTF-8'
): ?string

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

Parameters
$encoding : string
 

getOutputConditionIdentifier()

public OutputIntent::getOutputConditionIdentifier (
string $encoding = 'UTF-8'
): ?string

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

Parameters
$encoding : string
 

getRegistryName()

public OutputIntent::getRegistryName (
string $encoding = 'UTF-8'
): ?string

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

Parameters
$encoding : string
 

getSubtype()

public OutputIntent::getSubtype (
void
): mixed

Get the subtype.

setDestOutputProfile()

public OutputIntent::setDestOutputProfile (): void

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 OutputIntent::setInfo (
?string $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
 
$encoding : string
 

setOutputCondition()

public OutputIntent::setOutputCondition (
?string $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
 
$encoding : string
 

setOutputConditionIdentifier()

public OutputIntent::setOutputConditionIdentifier (
?string $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
 
$encoding : string
 

setRegistryName()

public OutputIntent::setRegistryName (
?string $registryName,
string $encoding = 'UTF-8'
): void

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

Parameters
$registryName : ?string
 
$encoding : string
 

setSubtype()

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

Set the subtype.

Parameters
$subtype : string
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)