Index

  1. \setasign\SetaPDF2
    1. Core
      1. Type
        1. AbstractType
        2. BypassSecHandlerInterface
        3. Dictionary
        4. Exception
        5. IndirectObjectInterface
        6. IndirectReference
        7. OwnerInterface
        8. PdfArray
        9. PdfBoolean
        10. PdfCallback
        11. PdfDictionary
        12. PdfHexString
        13. PdfIndirectObject
        14. PdfIndirectReference
        15. PdfName
        16. PdfNull
        17. PdfNumeric
        18. PdfObjectStream
        19. PdfRaw
        20. PdfScalarValueInterface
        21. PdfStream
        22. PdfString
        23. PdfStringInterface
        24. PdfToken

setasign\SetaPDF2\Core\Type

PdfName Class representing a name object

File: /SetaPDF v2/Core/Type/PdfName.php
Old class name (alias): \SetaPDF_Core_Type_Name

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_observed

protected bool AbstractType::$_observed = false

Defines if this object is under observation

$_observers

protected array AbstractType::$_observers = array()

The Objects to notify on any change

This will be the PDF document or another value holding this one. Initially this will be an array.

$_rawValue

protected string PdfName::$_rawValue = ''

The escaped value

$_value

protected string PdfName::$_value = ''

The plaintext value

$metadata

public array AbstractType::$metadata = array()

An array for individual metadata.


Static Methods

_ensureType()

protected static AbstractType::_ensureType (
string $type,
mixed $value,
string $errorMessage,
$ensure = true
): mixed

Ensure that a value is an instance of a specific PDF type.

Parameters
$type : string
 
$value : mixed
 
$errorMessage : string
 
$ensure
 
Exceptions

Throws Exception

_escapeChar()

protected static PdfName::_escapeChar (
array $matches
): string

Converting a character into a 2-digit hexadecimal code prefixed by a number sign.

Parameters
$matches : array
 

_unescapeChar()

protected static PdfName::_unescapeChar (
array $matches
): string

Converts a 2-digit hexadecimal code representation into a single byte/character.

Parameters
$matches : array
 

ensureType()

public static PdfName::ensureType (
mixed $name
): self

Ensures that the passed value is a PdfName instance.

Parameters
$name : mixed
 
Exceptions

Throws Exception

ensureWithType()

public static AbstractType::ensureWithType (
string $type,
mixed $value
): \SetaPDF_Core_Type_AbstractType

Ensures that the passed value is an instance of the passed type.

Parameters
$type : string
 
$value : mixed
 
Exceptions

Throws Exception

escape()

public static PdfName::escape (
string $value
): string

Escapes a name string.

Parameters
$value : string
 

is()

public static AbstractType::is (
string $type,
mixed $value,
bool $ensure = true
): bool

Checks if the type of a value is the expected one.

Indirect references will be evaluated if $ensure is set to true.

Parameters
$type : string
 
$value : mixed
 
$ensure : bool
 

unescape()

public static PdfName::unescape (
string $value
): string

Unescapes a name string.

Parameters
$value : string
 

writePdfString()

public static PdfName::writePdfString (
\SetaPDF_Core_WriteInterface $writer,
string $value,
bool $isRawValue = false
): void

Parses a php string value to a pdf name string and write it into a writer.

Parameters
$writer : \SetaPDF_Core_WriteInterface
 
$value : string
 
$isRawValue : bool
 
Exceptions

Throws \InvalidArgumentException

See

Methods

__construct()

public PdfName::__construct (
string $value = null,
bool $raw = false
)

The constructor.

Parameters
$value : string
 
$raw : bool
 

__clone()

public AbstractType::__clone (
void
): void

Implementation of __clone().

__sleep()

public AbstractType::__sleep (
void
): array

Implementation of __sleep.

We remove the observers from all elements because they will get read if they are waked up in an observed object.

attach()

public AbstractType::attach (
\SplObserver $observer
): void

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters
$observer : \SplObserver
 

cleanUp()

public AbstractType::cleanUp (
void
): void

This method is used to clean up an object by releasing memory and references.

The observers have to be removed with the "detach()"-method. Only if there is no observer left this method should really release resources.

The method has to be implemented by each object type

deepClone()

public AbstractType::deepClone (): \SetaPDF_Core_Type_AbstractType

Clone the object recursively in the context of a document.

Parameters
$document : \SetaPDF_Core_Document
 

detach()

public AbstractType::detach (
\SplObserver $observer
): void

Detach an observer from the object.

Implementation of the Observer Pattern.

Parameters
$observer : \SplObserver
 

detachAll()

public AbstractType::detachAll (
void
): void

Detach all observers from this object.

Be careful with this method!!!

ensure()

public AbstractType::ensure (
?bool $forceObservation = null,
array &$ensuredObjectsList = array ( )
): \SetaPDF_Core_Type_AbstractType

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation : ?bool
 
$ensuredObjectsList : array

A list of all ensured indirect objects to prevent recursion

getValue()

public PdfName::getValue (
void
): string

Get the name value.

See

isObserved()

public AbstractType::isObserved (
void
): bool

Checks if this object is observed.

notify()

public AbstractType::notify (
void
): void

Notifies all attached observers.

Implementation of the Observer Pattern.

Has to be called by any method that changes a value.

setValue()

public PdfName::setValue (
mixed $value
): void

Set the name value.

Parameters
$value : mixed
 
See

toPdfString()

public PdfName::toPdfString (
?\SetaPDF_Core_Document $pdfDocument = null
): string

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : ?\SetaPDF_Core_Document
 

toPhp()

public PdfName::toPhp (
void
): string

Converts the PDF data type to a PHP data type and returns it.

writeTo()

public PdfName::writeTo (
\SetaPDF_Core_Document $pdfDocument
): void

Writes the type as a formatted PDF string to the document.

Parameters
$pdfDocument : \SetaPDF_Core_Document
 

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