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. BitConverter
      31. EmbeddedFileStream
      32. Exception
      33. FileSpecification
      34. OutputIntent
      35. PageBoundaries
      36. PageFormats
      37. Tokenizer
      38. TransparencyGroup
      39. WriteInterface
      40. XmpHelper

SetaPDF_Core_XmpHelper A helper class for an easy lightweight access to XMP data packages

File: /SetaPDF v2/Core/XmpHelper.php

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$xml

protected DOMDocument SetaPDF_Core_XmpHelper::$xml

$xmlAliases

public SetaPDF_Core_XmpHelper::$xmlAliases = array(...)

Static Methods

_escapeTagChar()

private static SetaPDF_Core_XmpHelper::_escapeTagChar (
array $matches
): string

Call back for _encodeTagName()

Parameters
$matches : array
 
See

decodeTagName()

public static SetaPDF_Core_XmpHelper::decodeTagName (
string|string[] $encodedTagName
): string|string[]

Decodes a tag name as specified in the XMP Specification Part 3 - 2.2.1

Parameters
$encodedTagName : string|string[]
 

encodeTagName()

public static SetaPDF_Core_XmpHelper::encodeTagName (
string|string[] $tagName
): string|string[]

Encodes a tag name as specified in the XMP Specification Part 3 - 2.2.1

Parameters
$tagName : string|string[]
 

Methods

__construct()

public SetaPDF_Core_XmpHelper::__construct ()

The constructor.

Parameters
$xml : DOMDocument
 

_findDescription()

protected SetaPDF_Core_XmpHelper::_findDescription (
string $namespace
): DOMElement

Finds or creates a Description tag with the desired namespace.

Parameters
$namespace : string
 

getPackage()

public SetaPDF_Core_XmpHelper::getPackage (
void
): string

Get the XMP data package.

getXml()

public SetaPDF_Core_XmpHelper::getXml (
void
): DOMDocument

set()

public SetaPDF_Core_XmpHelper::set (
string $namespace, string $tagName, bool|string|array $value
): void

Updates a single field in the XMP package.

Parameters
$namespace : string

The namespace of the element

$tagName : string

The tag name

$value : bool|string|array

The value


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