SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. Catalog
    2. Catalog
      1. Names
      2. Names
        EmbeddedFiles

SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles Class allowing access to embedded files.

File: /SetaPDF v2/Core/Document/Catalog/Names/EmbeddedFiles.php

Class hierarchy

SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles

Summary

Methods

__construct()
_getTree()
add()
cleanUp()
get()
getAll()
remove()

Properties

$_names

Properties

$_names

protected SetaPDF_Core_Document_Catalog_Names SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::$_names

The names instance

Methods

__construct()

public SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::__construct (

SetaPDF_Core_Document_Catalog_Names $names

)

The constructor.

Parameters

$names : SetaPDF_Core_Document_Catalog_Names

_getTree()

private SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::_getTree (

[ boolean $create = false ]

): null|SetaPDF_Core_DataStructure_NameTree

Get the tree instance.

Parameters

$create : boolean

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

add()

public SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::add (

string $name, SetaPDF_Core_FileSpecification $fileSpecification

): SetaPDF_Core_Type_IndirectObject

Adds an embedded file by its file specification.

Parameters

$name : string: The unique name in the name tree for embedded files. This string shall be a PDF string in PDFDoc encoding oder UTF-16BE.
$fileSpecification : SetaPDF_Core_FileSpecification

Exceptions

Throws SetaPDF_Core_DataStructure_Tree_KeyAlreadyExistsException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::cleanUp (

void

): void

Release cycled references.

get()

public SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::get (

string $name

): false|SetaPDF_Core_FileSpecification

Get an embedded file by its name.

Parameters

$name : string

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

getAll()

public SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::getAll (

void

): SetaPDF_Core_FileSpecification[]

Get all embedded files.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

remove()

public SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles::remove (

string $name [, bool $removeObjects = true ]

): bool

Remove an embedded file.

Parameters

$name : string: No encoding is used. The name needs to be passed as it is registered in the name tree.
$removeObjects : bool: If this is set to false only the registration in the name tree is removed. By default also the embedded streams will be deleted.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception