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
- __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
Methods
__construct()
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.
addFile()
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.
addFolder()
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.
delete()
Delete this folder, subfolders and files.
Parameters
- $recursive : bool
Whether folders should be delete folders recursively or not.
- $removeEmbeddedFiles : bool
Whether file specifications in this folder should be deleted or not.
deleteFile()
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.
getCollectionItem()
Get the collection item data.
The data described by the collection schema.
getDescription()
Get the descriptive text associated with the file specification.
Parameters
- $encoding : string
getFile()
Get a file in this folder by its name in the embedded files name tree.
Parameters
- $name : string
getFiles()
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.
getId()
getIndirectObject()
Get the indirect reference for this folder.
getModificationDate()
Get the date of the most recent change to immediate child files or folders of this folder.
getSubfolder()
Get a folder by its name in UTF-8 encoding.
Parameters
- $name : string
setCollectionItem()
Set the collection item data.
The data described by the collection schema.
Parameters
- $item : SetaPDF_Merger_Collection_Item|null
setCreationDate()
Set the date the folder was first created.
Parameters
- $creationDate : DateTime|null
setDescription()
Set the descriptive text associated with the file specification.
Parameters
- $desc : string|null
- $encoding : string
setModificationDate()
Set the date of the most recent change to immediate child files or folders of this folder.
Parameters
- $creationDate : DateTime|null
setParent()
Set a parent folder.
Parameters
- $parent : SetaPDF_Merger_Collection_Folder