Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Canvas
      2. Canvas
      3. ColorSpace
      4. ColorSpace
      5. DataStructure
      6. Document
      7. Document
      8. Encoding
      9. Encoding
      10. Filter
      11. Font
      12. Font
      13. Geometry
      14. IccProfile
      15. Image
      16. Image
      17. Parser
      18. Reader
      19. Resource
      20. Resource
      21. SecHandler
      22. SecHandler
      23. Text
      24. Text
      25. Type
      26. Writer
      27. Writer
      28. XObject
      29. XObject
      30. XmpHelper
      31. XmpHelper
      32. BitConverter
      33. EmbeddedFileStream
      34. Exception
      35. FileSpecification
      36. OutputIntent
      37. PageBoundaries
      38. PageFormats
      39. Tokenizer
      40. TransparencyGroup
      41. WriteInterface
      42. Zugferd

SetaPDF_Core_OutputIntent A class representing an Output Intent dictionary entry

File: /SetaPDF v2/Core/OutputIntent.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Constants

Constants

SUBTYPE_GTS_PDFA1

public const string SetaPDF_Core_OutputIntent::SUBTYPE_GTS_PDFA1 = 'GTS_PDFA1'

Predefined output intent subtype

SUBTYPE_GTS_PDFX

public const string SetaPDF_Core_OutputIntent::SUBTYPE_GTS_PDFX = 'GTS_PDFX'

Predefined output intent subtype

SUBTYPE_ISO_PDFE1

public const string SetaPDF_Core_OutputIntent::SUBTYPE_ISO_PDFE1 = 'ISO_PDFE1'

Predefined output intent subtype


Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_OutputIntent::$_dictionary

Static Methods

createByProfile()

public static SetaPDF_Core_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 SetaPDF_Core_OutputIntent::__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()

public SetaPDF_Core_OutputIntent::getDestOutputProfile (
void
): null|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 SetaPDF_Core_OutputIntent::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the dictionary.

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()

public SetaPDF_Core_OutputIntent::setDestOutputProfile (
[ SetaPDF_Core_IccProfile_Stream $stream = null ]
): 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 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
 

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