Index

  1. \SetaPDF
    1. Merger
    2. Merger
      1. Collection
      2. Collection
        1. Schema
        2. Schema
        3. Folder
        4. Item

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

File: /SetaPDF v2/Merger/Collection/Folder.php

Class hierarchy

Summary

Methods

Properties

Properties

$_collection

protected SetaPDF_Merger_Collection SetaPDF_Merger_Collection_Folder::$_collection

The collection instance.

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Merger_Collection_Folder::$_dictionary

The folder dictionary.

$_indirectObject

protected null|SetaPDF_Core_Type_IndirectObject SetaPDF_Merger_Collection_Folder::$_indirectObject

The indirect object for this folder.


Methods

__construct()

public SetaPDF_Merger_Collection_Folder::__construct (
SetaPDF_Merger_Collection $collection, string|SetaPDF_Core_Type_IndirectObjectInterface $indirectObjectOrName
)

The constructor.

Parameters
$collection : SetaPDF_Merger_Collection
 
$indirectObjectOrName : string|SetaPDF_Core_Type_IndirectObjectInterface

A folder name or an indirect object/reference to a dictionary representing a folder.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_getFiles()

protected SetaPDF_Merger_Collection_Folder::_getFiles (
void
): array

Get all file specifications defined for this folder.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Merger_Exception

addFile()

public SetaPDF_Merger_Collection_Folder::addFile (
SetaPDF_Core_Reader_ReaderInterface|string $pathOrReader, string $filename [, null|string $description = null [, array $fileStreamParams = array ( ) [, null|string $mimeType = null [, null|array|SetaPDF_Merger_Collection_Item $collectionItem = null ]]]]
): string

Add a file to this folder.

Parameters
$pathOrReader : SetaPDF_Core_Reader_ReaderInterface|string

A reader instance or a path to a file.

$filename : string

The filename in UTF-8 encoding.

$description : null|string

The description of the file.

$fileStreamParams : array

See SetaPDF_Core_EmbeddedFileStream::setParams() method.

$mimeType : null|string

The subtype of the embedded file. Shall conform to the MIME media type names defined in Internet RFC 2046

$collectionItem : null|array|SetaPDF_Merger_Collection_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 SetaPDF_Core_DataStructure_Tree_KeyAlreadyExistsException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Merger_Exception

addFolder()

public SetaPDF_Merger_Collection_Folder::addFolder (
string $name [, null|string $description = null [, DateTime|null $creationDate = null [, DateTime|null $modificationDate = null [, null|array|SetaPDF_Merger_Collection_Item $collectionItem = null ]]]]
): SetaPDF_Merger_Collection_Folder

Add a subfolder to this folder.

Parameters
$name : string

The folder name.

$description : null|string

The description of the folder.

$creationDate : DateTime|null

If null "now" will be used.

$modificationDate : DateTime|null

If null "now" will be used.

$collectionItem : null|array|SetaPDF_Merger_Collection_Item

The data described by the collection schema.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Merger_Exception

Throws Exception

delete()

public SetaPDF_Merger_Collection_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 SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Merger_Exception

deleteFile()

public SetaPDF_Merger_Collection_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 SetaPDF_Core_Type_Exception

Throws SetaPDF_Merger_Exception

getChilds()

public SetaPDF_Merger_Collection_Folder::getChilds (
void
): array

Get files and folders in this folder.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Merger_Exception

getCollection()

public SetaPDF_Merger_Collection_Folder::getCollection (
void
): SetaPDF_Merger_Collection

Get the collection instance.

getCollectionItem()

public SetaPDF_Merger_Collection_Folder::getCollectionItem (
void
): null|SetaPDF_Merger_Collection_Item

Get the collection item data.

The data described by the collection schema.

getCreationDate()

public SetaPDF_Merger_Collection_Folder::getCreationDate (
void
): null|DateTime

Get the date the folder was first created.

getDescription()

public SetaPDF_Merger_Collection_Folder::getDescription (
[ string $encoding = 'UTF-8' ]
): null|string

Get the descriptive text associated with the file specification.

Parameters
$encoding : string
 

getDictionary()

public SetaPDF_Merger_Collection_Folder::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the dictionary for this folder.

getFile()

public SetaPDF_Merger_Collection_Folder::getFile (
string $name
): false|SetaPDF_Core_FileSpecification

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

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Merger_Exception

getFiles()

public SetaPDF_Merger_Collection_Folder::getFiles (
void
): SetaPDF_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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Merger_Exception

getId()

public SetaPDF_Merger_Collection_Folder::getId (
void
): integer

Get and/or create the folder id.

Exceptions

Throws SetaPDF_Merger_Exception

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

public SetaPDF_Merger_Collection_Folder::getIndirectObject (
void
): SetaPDF_Core_Type_IndirectObject

Get the indirect reference for this folder.

getModificationDate()

public SetaPDF_Merger_Collection_Folder::getModificationDate (
void
): null|DateTime

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

getName()

public SetaPDF_Merger_Collection_Folder::getName (
void
): string

Get the folder name.

Return Values

The folder name in UTF-8 encoding.

Exceptions

Throws SetaPDF_Core_Type_Exception

getParent()

public SetaPDF_Merger_Collection_Folder::getParent (
void
): SetaPDF_Merger_Collection_Folder|false

Get a folder instance of the parent folder.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

getSubfolder()

public SetaPDF_Merger_Collection_Folder::getSubfolder (
string $name
): false|SetaPDF_Merger_Collection_Folder

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

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

getSubfolders()

public SetaPDF_Merger_Collection_Folder::getSubfolders (
void
): SetaPDF_Merger_Collection_Folder[]

Get all subfolders of this folder.

Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

hasSubfolders()

public SetaPDF_Merger_Collection_Folder::hasSubfolders (
void
): boolean

Checks whether this folder has subfolders or not.

setCollectionItem()

public SetaPDF_Merger_Collection_Folder::setCollectionItem (
[ SetaPDF_Merger_Collection_Item|null $item = null ]
): SetaPDF_Merger_Collection_Folder

Set the collection item data.

The data described by the collection schema.

Parameters
$item : SetaPDF_Merger_Collection_Item|null
 

setCreationDate()

public SetaPDF_Merger_Collection_Folder::setCreationDate (
[ DateTime|null $creationDate = null ]
): SetaPDF_Merger_Collection_Folder

Set the date the folder was first created.

Parameters
$creationDate : DateTime|null
 
Exceptions

Throws Exception

setDescription()

public SetaPDF_Merger_Collection_Folder::setDescription (
string|null $desc [, string $encoding = 'UTF-8' ]
): SetaPDF_Merger_Collection_Folder

Set the descriptive text associated with the file specification.

Parameters
$desc : string|null
 
$encoding : string
 

setModificationDate()

public SetaPDF_Merger_Collection_Folder::setModificationDate (
[ DateTime|null $creationDate = null ]
): SetaPDF_Merger_Collection_Folder

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

Parameters
$creationDate : DateTime|null
 
Exceptions

Throws Exception

setName()

public SetaPDF_Merger_Collection_Folder::setName (
string $name
): SetaPDF_Merger_Collection_Folder

Set the folder name.

Parameters
$name : string

The folder name in UTF-8 encoding.

setParent()

public SetaPDF_Merger_Collection_Folder::setParent (): SetaPDF_Merger_Collection_Folder

Set a parent folder.

Parameters
$parent : SetaPDF_Merger_Collection_Folder
 
Exceptions

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

Throws SetaPDF_Merger_Exception


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