Index

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

SetaPDF_Core_Document_Catalog_MarkInfo Class representing the access to the mark information dictionary.

File: /SetaPDF v2/Core/Document/Catalog/MarkInfo.php

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_MarkInfo::$_catalog

The catalog instance


Methods

__construct()

public SetaPDF_Core_Document_Catalog_MarkInfo::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

_is()

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

Checks if an entry is set or not.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_set()

protected SetaPDF_Core_Document_Catalog_MarkInfo::_set (
string $name, boolean $value
): void

Set a value in the mark information dictionary.

Parameters
$name : string
 
$value : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_MarkInfo::cleanUp (
void
): void

Release memory and cycled references.

getDictionary()

public SetaPDF_Core_Document_Catalog_MarkInfo::getDictionary (
[ bool $create = false ]
): null|SetaPDF_Core_Type_Dictionary

Get the mark info dictionary.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_MarkInfo::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

hasSuspects()

public SetaPDF_Core_Document_Catalog_MarkInfo::hasSuspects (
void
): bool

Checks the flag indicating the presence of tag suspects.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

hasUserProperties()

public SetaPDF_Core_Document_Catalog_MarkInfo::hasUserProperties (
void
): bool

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

isMarked()

public SetaPDF_Core_Document_Catalog_MarkInfo::isMarked (
void
): bool

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setMarked()

public SetaPDF_Core_Document_Catalog_MarkInfo::setMarked (
[ bool $marked = true ]
): void

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

Parameters
$marked : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setSuspects()

public SetaPDF_Core_Document_Catalog_MarkInfo::setSuspects (
[ bool $suspects = true ]
): void

Set the flag indicating the presence of tag suspects.

Parameters
$suspects : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setUserProperties()

public SetaPDF_Core_Document_Catalog_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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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