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

PdfString Class representing a string

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

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_bypassSecHandler

protected bool PdfString::$_bypassSecHandler = false

Flag indicating that the object should bypass the security handler

$_encrypted

protected bool PdfString::$_encrypted = false

Flag saying that the stream is encrypted or not

$_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.

$_owningObject

protected PdfIndirectObject PdfString::$_owningObject

The original owning object.

Needed if the string is encrypted

$_rawValue

protected string PdfString::$_rawValue = ''

The escaped/encrypted value

$_value

protected string PdfString::$_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

ensureType()

public static PdfString::ensureType (
mixed $string
): self

Ensures that the passed value is a PdfString instance.

Parameters
$string : mixed
 
Exceptions

Throws Exception

ensureWithType()

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

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

Parameters
$type : string
 
$value : mixed
 
Exceptions

Throws Exception

escape()

public static PdfString::escape (
string $s
): string

Escapes sequences in a string according to the PDF specification.

Parameters
$s : 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 PdfString::unescape (
string $s
): string

Unescapes escaped sequences in a PDF string according to the PDF specification.

Parameters
$s : string
 

writePdfString()

public static PdfString::writePdfString (
\setasign\SetaPDF2\Core\Writer\WriteInterface $writer,
string|mixed $value
): void

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

Parameters
$writer : \setasign\SetaPDF2\Core\Writer\WriteInterface
 
$value : string|mixed

If it's not a string, it need to have a __toString() implementation.

Exceptions

Throws \InvalidArgumentException

See

Methods

__construct()

public PdfString::__construct (
string $value = '',
bool $raw = false,
?PdfIndirectObject $owningObject = null
)

The constructor.

Parameters
$value : string
 
$raw : bool
 
$owningObject : ?PdfIndirectObject
 

__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.

_decrypt()

protected PdfString::_decrypt (
void
): string

Decrypts the string (if needed).

attach()

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

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters
$observer : \SplObserver
 

cleanUp()

public PdfString::cleanUp (
void
): void

Release objects/memory.

See

deepClone()

public AbstractType::deepClone (): AbstractType

Clone the object recursively in the context of a document.

Parameters
$document : \setasign\SetaPDF2\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 ( )
): 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 PdfString::getValue (
void
): string

Get the string 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.

setBypassSecHandler()

public PdfString::setBypassSecHandler (
bool $bypassSecHandler = true
): void

Set the bypass security handler flag.

Parameters
$bypassSecHandler : bool
 

setValue()

public PdfString::setValue (
string $value
): void

Set the string value.

Parameters
$value : string
 
See

toPdfString()

public PdfString::toPdfString (
?\setasign\SetaPDF2\Core\Document $pdfDocument = null
): string

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : ?\setasign\SetaPDF2\Core\Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

toPhp()

public PdfString::toPhp (
void
): string

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

writeTo()

public PdfString::writeTo (): void

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

Parameters
$pdfDocument : \setasign\SetaPDF2\Core\Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception


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