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

Properties


Methods

__construct()

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

Release memory and cycled references.

getDictionary()

Get the mark info dictionary.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

Get the document instance.

hasSuspects()

Checks the flag indicating the presence of tag suspects.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

hasUserProperties()

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

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