Class DictionaryHelper in namespace setasign\SetaPDF2\Core\Type\Dictionary in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Type
    1. Dictionary
      1. DictionaryHelper
      2. Entry

setasign\SetaPDF2\Core\Type\Dictionary

DictionaryHelper Helper class for handling of dictionaries

File: /SetaPDF v2/Core/Type/Dictionary/DictionaryHelper.php
Old class name (alias): \SetaPDF_Core_Type_Dictionary_Helper

Class hierarchy

DictionaryHelper

Summary

Static Methods

getValue()

public static DictionaryHelper::getValue (

\SetaPDF_Core_Type_Dictionary $dictionary,
string $key,
?mixed $defaultValue = null,
bool $phpValueFromScalarTypes = false

): mixed

Get the value.

Parameters

$dictionary : \SetaPDF_Core_Type_Dictionary
$key : string
$defaultValue : ?mixed
$phpValueFromScalarTypes : bool

keyHasValue()

public static DictionaryHelper::keyHasValue (

\SetaPDF_Core_Type_Dictionary $dictionary,
string $key,
mixed $value

): bool

Checks if a value of a key equals an expected value.

Parameters

$dictionary : \SetaPDF_Core_Type_Dictionary
$key : string
$value : mixed

resolveAttribute()

public static DictionaryHelper::resolveAttribute (

\SetaPDF_Core_Type_Dictionary $dict,
string $name,
null $default = null,
bool $ensure = true,
string $parentName = 'Parent'

): null|\SetaPDF_Core_Type_AbstractType|\SetaPDF_Core_Type_Dictionary|\SetaPDF_Core_Type_Array

Resolves an attributes value by name.

If the $name key is in the dictionary this will return the value of this entry.

If the $parent key is in the dictionary and is also a dictionary this will search the $name key in this and return it if found.

If nothing is found $default will be returned.

Parameters

$dict : \SetaPDF_Core_Type_Dictionary
$name : string
$default : null
$ensure : bool
$parentName : string

resolveDictionaryByAttribute()

public static DictionaryHelper::resolveDictionaryByAttribute (

\SetaPDF_Core_Type_Dictionary $dict,
string $name,
string $parentName = 'Parent'

): \SetaPDF_Core_Type_Dictionary|bool

Resolves a dictionary in a tree containing a specific name.

If the $name key is in the dictionary this will return the dictionary.

If the $parent key is in the dictionary and is also a dictionary this will search the $name key in this and return the child dictionary.

If nothing is found false will be returned.

Parameters

$dict : \SetaPDF_Core_Type_Dictionary
$name : string: attribute/key name
$parentName : string

resolveObjectByAttribute()

public static DictionaryHelper::resolveObjectByAttribute (

\SetaPDF_Core_Type_IndirectObjectInterface $object,
string $name,
string $parentName = 'Parent'

): false|\SetaPDF_Core_Type_IndirectObject

Resolves an object in a tree containing a specific name.

Parameters

$object : \SetaPDF_Core_Type_IndirectObjectInterface
$name : string: attribute/key name
$parentName : string