SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Merger
  1. Collection
  2. Collection
    1. Folder
    2. Item
    3. Schema
    4. Schema

setasign\SetaPDF2\Merger\Collection

Folder Class representing a folder in a PDF Collection/Portfolio/Package.

File: /SetaPDF v2/Merger/Collection/Folder.php
Old class name (alias): \SetaPDF_Merger_Collection_Folder

Class hierarchy

Folder

Summary

Methods

__construct()
_getFiles()
addFile()
addFolder()
delete()
deleteFile()
getChilds()
getCollection()
getCollectionItem()
getCreationDate()
getDescription()
getDictionary()
getFile()
getFiles()
getId()
getIndirectObject()
getModificationDate()
getName()
getParent()
getSubfolder()
getSubfolders()
hasSubfolders()
setCollectionItem()
setCreationDate()
setDescription()
setModificationDate()
setName()
setParent()

Properties

$_collection
$_dictionary
$_indirectObject

Properties

$_collection

protected \setasign\SetaPDF2\Merger\Collection Folder::$_collection

The collection instance.

$_dictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary Folder::$_dictionary

The folder dictionary.

$_indirectObject

protected ?\setasign\SetaPDF2\Core\Type\PdfIndirectObject Folder::$_indirectObject

The indirect object for this folder.

Methods

__construct()

public Folder::__construct (

\setasign\SetaPDF2\Merger\Collection $collection,
string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $indirectObjectOrName

)

The constructor.

Parameters

$collection : \setasign\SetaPDF2\Merger\Collection
$indirectObjectOrName : string|\setasign\SetaPDF2\Core\Type\IndirectObjectInterface: A folder name or an indirect object/reference to a dictionary representing a folder.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_getFiles()

protected Folder::_getFiles (

void

): array

Get all file specifications defined for this folder.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

addFile()

public Folder::addFile (

\setasign\SetaPDF2\Core\Reader\ReaderInterface|string $pathOrReader,
string $filename,
?string $description = null,
array $fileStreamParams = array ( ),
?string $mimeType = null,
null|array|Item $collectionItem = null

): string

Add a file to this folder.

Parameters

$pathOrReader : \setasign\SetaPDF2\Core\Reader\ReaderInterface|string: A reader instance or a path to a file.
$filename : string: The filename in UTF-8 encoding.
$description : ?string: The description of the file.
$fileStreamParams : array: See \setasign\SetaPDF2\Core\EmbeddedFileStream::setParams() method.
$mimeType : ?string: The subtype of the embedded file. Shall conform to the MIME media type names defined in Internet RFC 2046
$collectionItem : null|array|Item: The data described by the collection schema.

Return Values

The name that was used to register the file specification in the embedded files name tree.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\DataStructure\Tree\KeyAlreadyExistsException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

addFolder()

public Folder::addFolder (

string $name,
?string $description = null,
?\DateTime $creationDate = null,
?\DateTime $modificationDate = null,
null|array|Item $collectionItem = null

Add a subfolder to this folder.

Parameters

$name : string: The folder name.
$description : ?string: The description of the folder.
$creationDate : ?\DateTime: If null "now" will be used.
$modificationDate : ?\DateTime: If null "now" will be used.
$collectionItem : null|array|Item: The data described by the collection schema.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \Exception

delete()

public Folder::delete (

bool $recursive = true,
bool $removeEmbeddedFiles = true

): void

Delete this folder, subfolders and files.

Parameters

$recursive : bool: Whether folders should be deleted recursively or not.
$removeEmbeddedFiles : bool: Whether file specifications in this folder should be deleted or not.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Merger\Exception

deleteFile()

public Folder::deleteFile (

string $fileName

): bool

Delete a file within this folder.

Parameters

$fileName : string: The file name (in PDFDoc or UTF-16BE encoding) needs to be prefixed with the folder id.

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

getChilds()

public Folder::getChilds (

void

): array

Get files and folders in this folder.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Merger\Exception

getCollection()

public Folder::getCollection (

void

): \setasign\SetaPDF2\Merger\Collection

Get the collection instance.

getCollectionItem()

public Folder::getCollectionItem (

void

): ?Item

Get the collection item data.

The data described by the collection schema.

getCreationDate()

public Folder::getCreationDate (

void

Get the date the folder was first created.

getDescription()

public Folder::getDescription (

string $encoding = 'UTF-8'

): ?string

Get the descriptive text associated with the file specification.

Parameters

$encoding : string

getDictionary()

public Folder::getDictionary (

void

): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the dictionary for this folder.

getFile()

public Folder::getFile (

string $name

): false|\setasign\SetaPDF2\Core\FileSpecification

Get a file in this folder by its name in the embedded files name tree.

Parameters

$name : string

Exceptions

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

getFiles()

public Folder::getFiles (

void

): \setasign\SetaPDF2\Core\FileSpecification[]

Get all files in this folder.

Return Values

The keys are the names with which the files are registered in the embedded files name tree.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Merger\Exception

getId()

public Folder::getId (

void

): int

Get and/or create the folder id.

Exceptions

Throws \setasign\SetaPDF2\Merger\Exception

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getIndirectObject()

public Folder::getIndirectObject (

void

): \setasign\SetaPDF2\Core\Type\PdfIndirectObject

Get the indirect reference for this folder.

getModificationDate()

public Folder::getModificationDate (

void

Get the date of the most recent change to immediate child files or folders of this folder.

getName()

public Folder::getName (

void

): string

Get the folder name.

Return Values

The folder name in UTF-8 encoding.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getParent()

public Folder::getParent (

void

): self|false

Get a folder instance of the parent folder.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getSubfolder()

public Folder::getSubfolder (

string $name

): false|Folder

Get a folder by its name in UTF-8 encoding.

Parameters

$name : string

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getSubfolders()

public Folder::getSubfolders (

void

Get all subfolders of this folder.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

hasSubfolders()

public Folder::hasSubfolders (

void

): bool

Checks whether this folder has subfolders or not.

setCollectionItem()

public Folder::setCollectionItem (

?Item $item = null

Set the collection item data.

The data described by the collection schema.

Parameters

$item : ?Item

setCreationDate()

public Folder::setCreationDate (

?\DateTime $creationDate = null

Set the date the folder was first created.

Parameters

$creationDate : ?\DateTime

Exceptions

Throws \Exception

setDescription()

public Folder::setDescription (

?string $desc,
string $encoding = 'UTF-8'

Set the descriptive text associated with the file specification.

Parameters

$desc : ?string
$encoding : string

setModificationDate()

public Folder::setModificationDate (

?\DateTime $creationDate = null

Set the date of the most recent change to immediate child files or folders of this folder.

Parameters

$creationDate : ?\DateTime

Exceptions

Throws \Exception

setName()

public Folder::setName (

string $name

Set the folder name.

Parameters

$name : string: The folder name in UTF-8 encoding.

setParent()

public Folder::setParent (

Folder $parent

Set a parent folder.

Parameters

$parent : Folder

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

Throws \setasign\SetaPDF2\Merger\Exception