Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. AcroForm
          2. AdditionalActions
          3. Dests
          4. Extensions
          5. MarkInfo
          6. Names
          7. Names
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

setasign\SetaPDF2\Core\Document\Catalog

MarkInfo Class representing the access to the mark information dictionary.

File: /SetaPDF v2/Core/Document/Catalog/MarkInfo.php
Old class name (alias): \SetaPDF_Core_Document_Catalog_MarkInfo

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected \SetaPDF_Core_Document_Catalog MarkInfo::$_catalog

The catalog instance


Methods

__construct()

public MarkInfo::__construct ()

The constructor.

Parameters
$catalog : \SetaPDF_Core_Document_Catalog
 

_is()

protected MarkInfo::_is (
string $name
): bool

Checks if an entry is set or not.

Parameters
$name : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

_set()

protected MarkInfo::_set (
string $name,
bool $value
): void

Set a value in the mark information dictionary.

Parameters
$name : string
 
$value : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public MarkInfo::cleanUp (
void
): void

Release memory and cycled references.

getDictionary()

public MarkInfo::getDictionary (
bool $create = false
): ?\SetaPDF_Core_Type_Dictionary

Get the mark info dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDocument()

public MarkInfo::getDocument (
void
): \SetaPDF_Core_Document

Get the document instance.

hasSuspects()

public MarkInfo::hasSuspects (
void
): bool

Checks the flag indicating the presence of tag suspects.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

hasUserProperties()

public MarkInfo::hasUserProperties (
void
): bool

Checks the flag indicating the presence of structure elements that contain user properties attributes.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

isMarked()

public MarkInfo::isMarked (
void
): bool

Checks the flag indicating whether the document conforms to tagged PDF conventions.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setMarked()

public MarkInfo::setMarked (
bool $marked = true
): void

Set the flag indicating whether the document conforms to tagged PDF conventions.

Parameters
$marked : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setSuspects()

public MarkInfo::setSuspects (
bool $suspects = true
): void

Set the flag indicating the presence of tag suspects.

Parameters
$suspects : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

setUserProperties()

public MarkInfo::setUserProperties (
bool $userProperties = true
): void

Set the flag indicating the presence of structure elements that contain user properties attributes.

Parameters
$userProperties : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception


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