ArchiveWriter Class

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter class allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Class Name

SecureBlackbox_ArchiveWriter

Procedural Interface

 secureblackbox_archivewriter_open();
 secureblackbox_archivewriter_close($res);
 secureblackbox_archivewriter_register_callback($res, $id, $function);
 secureblackbox_archivewriter_get_last_error($res);
 secureblackbox_archivewriter_get_last_error_code($res);
 secureblackbox_archivewriter_set($res, $id, $index, $value);
 secureblackbox_archivewriter_get($res, $id, $index);
 secureblackbox_archivewriter_do_addemptydir($res, $path);
 secureblackbox_archivewriter_do_addfile($res, $path, $localpath);
 secureblackbox_archivewriter_do_addfiles($res, $folder, $localpath, $recursive);
 secureblackbox_archivewriter_do_addvirtual($res, $path);
 secureblackbox_archivewriter_do_close($res);
 secureblackbox_archivewriter_do_config($res, $configurationstring);
 secureblackbox_archivewriter_do_createnew($res, $archivetype);
 secureblackbox_archivewriter_do_doaction($res, $actionid, $actionparams);
 secureblackbox_archivewriter_do_open($res, $archivetype, $archivename);
 secureblackbox_archivewriter_do_openbytes($res, $archivetype, $archivebytes);
 secureblackbox_archivewriter_do_remove($res, $path);
 secureblackbox_archivewriter_do_reset($res);
 secureblackbox_archivewriter_do_save($res, $archivename);
 secureblackbox_archivewriter_do_savebytes($res);
 secureblackbox_archivewriter_do_updatefile($res, $path, $localpath);
 secureblackbox_archivewriter_do_updatefiles($res, $folder, $localpath, $addmissingfiles, $removemissingfiles, $recursive);
 secureblackbox_archivewriter_do_updatevirtual($res, $path);

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Work with ArchiveWriter builds on the following steps:

Creating or opening the archive.

Use CreateNew to create a new archive, or one of the Open* methods (such as Open or OpenBytes) to open an existing compressed file.

Inspecting the archive contents

Use the Files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' > and > properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• AddFile - adds an entry with the contents of a local file.
• AddFiles - adds a set of files from a local directory.
• AddVirtual - allocates an entry in the archive. The actual data can be provided later using PrepareFile and BeforeCompressFile events.

You can combine different entry types when building your archive.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using UpdateFile and UpdateFiles methods. The Remove method lets you delete individual files from the archive.

Use DecryptionPassword property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the DecryptionPasswordNeeded event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's Save (or SaveBytes) method to save the updated archive, and then Close to close the archive file and release the associated memory.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ArchiveType Property (SecureBlackbox_ArchiveWriter Class)

The type of the archive.

Object Oriented Interface

public function getArchiveType();

Procedural Interface

secureblackbox_archivewriter_get($res, 1 );

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

Data Type

Integer

CompressionAlgorithm Property (SecureBlackbox_ArchiveWriter Class)

Specifies the compression algorithm to use when forming the ZIP archive.

Object Oriented Interface

public function getCompressionAlgorithm();
public function setCompressionAlgorithm($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 2 );
secureblackbox_archivewriter_set($res, 2, $value );

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

Data Type

Integer

CompressionLevel Property (SecureBlackbox_ArchiveWriter Class)

The compression level to apply to the archived data.

Object Oriented Interface

public function getCompressionLevel();
public function setCompressionLevel($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 3 );
secureblackbox_archivewriter_set($res, 3, $value );

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

Data Type

Integer

DecryptionCertCount Property (SecureBlackbox_ArchiveWriter Class)

The number of records in the DecryptionCert arrays.

Object Oriented Interface

public function getDecryptionCertCount();
public function setDecryptionCertCount($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 4 );
secureblackbox_archivewriter_set($res, 4, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DecryptionCertBytes
• DecryptionCertHandle

The array indices start at 0 and end at DecryptionCertCount - 1.

This property is not available at design time.

Data Type

Integer

DecryptionCertBytes Property (SecureBlackbox_ArchiveWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getDecryptionCertBytes($decryptioncertindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 5 , $decryptioncertindex);

Remarks

Returns the raw certificate data in DER format.

The $decryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

DecryptionCertHandle Property (SecureBlackbox_ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getDecryptionCertHandle($decryptioncertindex);
public function setDecryptionCertHandle($decryptioncertindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 13 , $decryptioncertindex);
secureblackbox_archivewriter_set($res, 13, $value , $decryptioncertindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $decryptioncertindex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is not available at design time.

Data Type

Long64

DecryptionPassword Property (SecureBlackbox_ArchiveWriter Class)

The decryption password.

Object Oriented Interface

public function getDecryptionPassword();
public function setDecryptionPassword($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 44 );
secureblackbox_archivewriter_set($res, 44, $value );

Default Value

''

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from DecryptionPasswordNeeded event handler.

Data Type

String

EncryptionAlgorithm Property (SecureBlackbox_ArchiveWriter Class)

Specifies the encryption algorithm to apply to the archive.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 45 );
secureblackbox_archivewriter_set($res, 45, $value );

Default Value

''

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Class supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

Data Type

String

EncryptionCertBytes Property (SecureBlackbox_ArchiveWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getEncryptionCertBytes();

Procedural Interface

secureblackbox_archivewriter_get($res, 46 );

Remarks

Returns the raw certificate data in DER format.

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

EncryptionCertHandle Property (SecureBlackbox_ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getEncryptionCertHandle();
public function setEncryptionCertHandle($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 54 );
secureblackbox_archivewriter_set($res, 54, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is not available at design time.

Data Type

Long64

EncryptionKeyLength Property (SecureBlackbox_ArchiveWriter Class)

The length of the encryption key.

Object Oriented Interface

public function getEncryptionKeyLength();
public function setEncryptionKeyLength($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 85 );
secureblackbox_archivewriter_set($res, 85, $value );

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

Data Type

Integer

EncryptionPassword Property (SecureBlackbox_ArchiveWriter Class)

Specifies the archive encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 86 );
secureblackbox_archivewriter_set($res, 86, $value );

Default Value

''

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside EncryptionType and EncryptionAlgorithm properties to set up the whole set of protection settings for the archive.

Data Type

String

EncryptionType Property (SecureBlackbox_ArchiveWriter Class)

The type of encryption to apply to the archive.

Object Oriented Interface

public function getEncryptionType();
public function setEncryptionType($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 87 );
secureblackbox_archivewriter_set($res, 87, $value );

Default Value

0

Remarks

Specifies the encryption type for the archive.

Data Type

Integer

FileData Property (SecureBlackbox_ArchiveWriter Class)

The contents of the file being added to the archive.

Object Oriented Interface

public function getFileData();
public function setFileData($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 88 );
secureblackbox_archivewriter_set($res, 88, $value );

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use FileStream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

This property is not available at design time.

Data Type

Byte Array

FileCount Property (SecureBlackbox_ArchiveWriter Class)

The number of records in the File arrays.

Object Oriented Interface

public function getFileCount();
public function setFileCount($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 89 );
secureblackbox_archivewriter_set($res, 89, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• FileAction
• FileAttributes
• FileCompressedSize
• FileDataSource
• FileDirectory
• FileEncryptionAlgorithm
• FileEncryptionKeyLength
• FileEncryptionType
• FileFileName
• FileFolder
• FileLocalPath
• FileMTime
• FileNewFile
• FilePath
• FileSignatureCount
• FileSigned
• FileSize

The array indices start at 0 and end at FileCount - 1.

This property is not available at design time.

Data Type

Integer

FileAction Property (SecureBlackbox_ArchiveWriter Class)

This property contains the action to apply to the file.

Object Oriented Interface

public function getFileAction($fileindex);
public function setFileAction($fileindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 90 , $fileindex);
secureblackbox_archivewriter_set($res, 90, $value , $fileindex);

Default Value

0

Remarks

This property contains the action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileAttributes Property (SecureBlackbox_ArchiveWriter Class)

This property provides access to file attributes.

Object Oriented Interface

public function getFileAttributes($fileindex);
public function setFileAttributes($fileindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 91 , $fileindex);
secureblackbox_archivewriter_set($res, 91, $value , $fileindex);

Default Value

''

Remarks

This property provides access to file attributes.

ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive.

Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows:

Writer.Files[0].Attributes = "unix:-rwxr-xr-x"; Writer.Files[1].Attributes = "unix:-r--r--r--"; Writer.Files[2].Attributes = "dos:readonly"; Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileCompressedSize Property (SecureBlackbox_ArchiveWriter Class)

This property contains the size of the file after compression.

Object Oriented Interface

public function getFileCompressedSize($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 92 , $fileindex);

Default Value

0

Remarks

This property contains the size of the file after compression.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FileDataSource Property (SecureBlackbox_ArchiveWriter Class)

This property contains the type of data source for this entry.

Object Oriented Interface

public function getFileDataSource($fileindex);
public function setFileDataSource($fileindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 93 , $fileindex);
secureblackbox_archivewriter_set($res, 93, $value , $fileindex);

Default Value

0

Remarks

This property contains the type of data source for this entry.

Use this property to control the data source for this entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

Integer

FileDirectory Property (SecureBlackbox_ArchiveWriter Class)

This property tells if the entry is a directory or a regular file.

Object Oriented Interface

public function getFileDirectory($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 94 , $fileindex);

Default Value

false

Remarks

This property tells if the entry is a directory or a regular file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileEncryptionAlgorithm Property (SecureBlackbox_ArchiveWriter Class)

This property returns the symmetric algorithm that was used to encrypt the file.

Object Oriented Interface

public function getFileEncryptionAlgorithm($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 95 , $fileindex);

Default Value

''

Remarks

This property returns the symmetric algorithm that was used to encrypt the file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileEncryptionKeyLength Property (SecureBlackbox_ArchiveWriter Class)

This property returns the length, in bits, of the encryption key.

Object Oriented Interface

public function getFileEncryptionKeyLength($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 96 , $fileindex);

Default Value

0

Remarks

This property returns the length, in bits, of the encryption key.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileEncryptionType Property (SecureBlackbox_ArchiveWriter Class)

This property contains the type of encryption applied to the file.

Object Oriented Interface

public function getFileEncryptionType($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 97 , $fileindex);

Default Value

0

Remarks

This property contains the type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileFileName Property (SecureBlackbox_ArchiveWriter Class)

This property specifies the original name of the compressed file or folder.

Object Oriented Interface

public function getFileFileName($fileindex);
public function setFileFileName($fileindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 98 , $fileindex);
secureblackbox_archivewriter_set($res, 98, $value , $fileindex);

Default Value

''

Remarks

This property specifies the original name of the compressed file or folder.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileFolder Property (SecureBlackbox_ArchiveWriter Class)

This property includes the containing folder of the entry.

Object Oriented Interface

public function getFileFolder($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 99 , $fileindex);

Default Value

''

Remarks

This property includes the containing folder of the entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileLocalPath Property (SecureBlackbox_ArchiveWriter Class)

This property contains the local path associated with this entry.

Object Oriented Interface

public function getFileLocalPath($fileindex);
public function setFileLocalPath($fileindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 100 , $fileindex);
secureblackbox_archivewriter_set($res, 100, $value , $fileindex);

Default Value

''

Remarks

This property contains the local path associated with this entry.

It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileMTime Property (SecureBlackbox_ArchiveWriter Class)

This property contains the entry's last modification time.

Object Oriented Interface

public function getFileMTime($fileindex);
public function setFileMTime($fileindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 101 , $fileindex);
secureblackbox_archivewriter_set($res, 101, $value , $fileindex);

Default Value

''

Remarks

This property contains the entry's last modification time.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is not available at design time.

Data Type

String

FileNewFile Property (SecureBlackbox_ArchiveWriter Class)

This property indicates whether the entry corresponds to a file to be added to the archive.

Object Oriented Interface

public function getFileNewFile($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 102 , $fileindex);

Default Value

false

Remarks

This property indicates whether the entry corresponds to a file to be added to the archive.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FilePath Property (SecureBlackbox_ArchiveWriter Class)

This property contains the full internal path of the archived entry.

Object Oriented Interface

public function getFilePath($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 103 , $fileindex);

Default Value

''

Remarks

This property contains the full internal path of the archived entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

String

FileSignatureCount Property (SecureBlackbox_ArchiveWriter Class)

This property includes the number of signatures covering the entry.

Object Oriented Interface

public function getFileSignatureCount($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 104 , $fileindex);

Default Value

0

Remarks

This property includes the number of signatures covering the entry.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Integer

FileSigned Property (SecureBlackbox_ArchiveWriter Class)

This property indicates whether the entry is signed.

Object Oriented Interface

public function getFileSigned($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 105 , $fileindex);

Default Value

false

Remarks

This property indicates whether the entry is signed.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Boolean

FileSize Property (SecureBlackbox_ArchiveWriter Class)

This property specifies the size of the file before compression.

Object Oriented Interface

public function getFileSize($fileindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 106 , $fileindex);

Default Value

0

Remarks

This property specifies the size of the file before compression.

The $fileindex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only and not available at design time.

Data Type

Long64

FIPSMode Property (SecureBlackbox_ArchiveWriter Class)

Reserved.

Object Oriented Interface

public function getFIPSMode();
public function setFIPSMode($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 107 );
secureblackbox_archivewriter_set($res, 107, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (SecureBlackbox_ArchiveWriter Class)

Specifies the hash algorithm to be used to generate the signature.

Object Oriented Interface

public function getHashAlgorithm();
public function setHashAlgorithm($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 108 );
secureblackbox_archivewriter_set($res, 108, $value );

Default Value

''

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

This property is not available at design time.

Data Type

String

NewArchive Property (SecureBlackbox_ArchiveWriter Class)

Indicates whether the archive object represents a new (rather than opened) archive.

Object Oriented Interface

public function getNewArchive();

Procedural Interface

secureblackbox_archivewriter_get($res, 109 );

Default Value

false

Remarks

This property is set to true if the archive is new, or to false if the class control is editing an existing archive.

NewArchive would typically be set to true after a CreateNew call, and to false after an Open call.

This property is read-only.

Data Type

Boolean

Opened Property (SecureBlackbox_ArchiveWriter Class)

Indicates whether class is currently in edit mode.

Object Oriented Interface

public function getOpened();

Procedural Interface

secureblackbox_archivewriter_get($res, 110 );

Default Value

false

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with Open or created with CreateNew call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Data Type

Boolean

Overwrite Property (SecureBlackbox_ArchiveWriter Class)

Whether the class should overwrite existing files.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 111 );
secureblackbox_archivewriter_set($res, 111, $value );

Default Value

false

Remarks

Enable this property to force overwriting of existing files.

Data Type

Boolean

SigningCertBytes Property (SecureBlackbox_ArchiveWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningCertBytes();

Procedural Interface

secureblackbox_archivewriter_get($res, 112 );

Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertHandle Property (SecureBlackbox_ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningCertHandle();
public function setSigningCertHandle($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 120 );
secureblackbox_archivewriter_set($res, 120, $value );

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

SigningChainCount Property (SecureBlackbox_ArchiveWriter Class)

The number of records in the SigningChain arrays.

Object Oriented Interface

public function getSigningChainCount();
public function setSigningChainCount($value);

Procedural Interface

secureblackbox_archivewriter_get($res, 151 );
secureblackbox_archivewriter_set($res, 151, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SigningChainBytes
• SigningChainHandle

The array indices start at 0 and end at SigningChainCount - 1.

This property is not available at design time.

Data Type

Integer

SigningChainBytes Property (SecureBlackbox_ArchiveWriter Class)

Returns the raw certificate data in DER format.

Object Oriented Interface

public function getSigningChainBytes($signingchainindex);

Procedural Interface

secureblackbox_archivewriter_get($res, 152 , $signingchainindex);

Remarks

Returns the raw certificate data in DER format.

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningChainHandle Property (SecureBlackbox_ArchiveWriter Class)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Object Oriented Interface

public function getSigningChainHandle($signingchainindex);
public function setSigningChainHandle($signingchainindex, $value);

Procedural Interface

secureblackbox_archivewriter_get($res, 160 , $signingchainindex);
secureblackbox_archivewriter_set($res, 160, $value , $signingchainindex);

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The $signingchainindex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is not available at design time.

Data Type

Long64

AddEmptyDir Method (SecureBlackbox_ArchiveWriter Class)

Adds an empty folder to the archive.

Object Oriented Interface

public function doAddEmptyDir($path);

Procedural Interface

secureblackbox_archivewriter_do_addemptydir($res, $path);

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the Files collection.

AddFile Method (SecureBlackbox_ArchiveWriter Class)

Adds a file to the archive.

Object Oriented Interface

public function doAddFile($path, $localpath);

Procedural Interface

secureblackbox_archivewriter_do_addfile($res, $path, $localpath);

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

AddFiles Method (SecureBlackbox_ArchiveWriter Class)

Adds a group of files to the archive.

Object Oriented Interface

public function doAddFiles($folder, $localpath, $recursive);

Procedural Interface

secureblackbox_archivewriter_do_addfiles($res, $folder, $localpath, $recursive);

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

AddVirtual Method (SecureBlackbox_ArchiveWriter Class)

Adds a file placeholder to the archive.

Object Oriented Interface

public function doAddVirtual($path);

Procedural Interface

secureblackbox_archivewriter_do_addvirtual($res, $path);

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use PrepareFile event or Files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the BeforeCompressFile event handler.

This method returns the index of the new entry in the Files collection.

Close Method (SecureBlackbox_ArchiveWriter Class)

Closes the archive.

Object Oriented Interface

public function doClose();

Procedural Interface

secureblackbox_archivewriter_do_close($res);

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

Config Method (SecureBlackbox_ArchiveWriter Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_archivewriter_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateNew Method (SecureBlackbox_ArchiveWriter Class)

Creates a new archive.

Object Oriented Interface

public function doCreateNew($archivetype);

Procedural Interface

secureblackbox_archivewriter_do_createnew($res, $archivetype);

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

DoAction Method (SecureBlackbox_ArchiveWriter Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_archivewriter_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

Open Method (SecureBlackbox_ArchiveWriter Class)

Opens an archive file.

Object Oriented Interface

public function doOpen($archivetype, $archivename);

Procedural Interface

secureblackbox_archivewriter_do_open($res, $archivetype, $archivename);

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save or SaveStream method.

OpenBytes Method (SecureBlackbox_ArchiveWriter Class)

Loads an archive file from a byte array.

Object Oriented Interface

public function doOpenBytes($archivetype, $archivebytes);

Procedural Interface

secureblackbox_archivewriter_do_openbytes($res, $archivetype, $archivebytes);

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with Save, SaveStream, or SaveBytes method.

Remove Method (SecureBlackbox_ArchiveWriter Class)

Removes file(s) and/or folder(s) from the archive.

Object Oriented Interface

public function doRemove($path);

Procedural Interface

secureblackbox_archivewriter_do_remove($res, $path);

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

Reset Method (SecureBlackbox_ArchiveWriter Class)

Resets the class settings.

Object Oriented Interface

public function doReset();

Procedural Interface

secureblackbox_archivewriter_do_reset($res);

Remarks

Reset is a generic method available in every class.

Save Method (SecureBlackbox_ArchiveWriter Class)

Compresses the archive and saves it to a file.

Object Oriented Interface

public function doSave($archivename);

Procedural Interface

secureblackbox_archivewriter_do_save($res, $archivename);

Remarks

Use this method to finalize all preparations, compress all the entries set up in Files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, PrepareFile event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with BeforeCompressFile and AfterCompressFile "brackets". Subscribe to BeforeCompressFile to supply the file contents for entries with Buffer and Stream data sources. AfterCompressFile is a good place to release the content stream alloated in the BeforeCompressFile event handler.

Progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

SaveBytes Method (SecureBlackbox_ArchiveWriter Class)

Compresses the archive and saves it to a byte array.

Object Oriented Interface

public function doSaveBytes();

Procedural Interface

secureblackbox_archivewriter_do_savebytes($res);

Remarks

Use this method to finalize all preparations and compress all entries contained in the Files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events class fires. See the description of the Save method for the details.

UpdateFile Method (SecureBlackbox_ArchiveWriter Class)

Updates an existing compressed entry with a fresher local version.

Object Oriented Interface

public function doUpdateFile($path, $localpath);

Procedural Interface

secureblackbox_archivewriter_do_updatefile($res, $path, $localpath);

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

UpdateFiles Method (SecureBlackbox_ArchiveWriter Class)

Updates a selection of files in the archive.

Object Oriented Interface

public function doUpdateFiles($folder, $localpath, $addmissingfiles, $removemissingfiles, $recursive);

Procedural Interface

secureblackbox_archivewriter_do_updatefiles($res, $folder, $localpath, $addmissingfiles, $removemissingfiles, $recursive);

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

UpdateVirtual Method (SecureBlackbox_ArchiveWriter Class)

Updates an entry in the archive with on-the-fly content.

Object Oriented Interface

public function doUpdateVirtual($path);

Procedural Interface

secureblackbox_archivewriter_do_updatevirtual($res, $path);

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to BeforeCompressFile to supply the actual data via FileData or FileStream properties.

ActionNeeded Event (SecureBlackbox_ArchiveWriter Class)

Requests a decision from the application in case of a conflict.

Object Oriented Interface

public function fireActionNeeded($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 1, array($this, 'fireActionNeeded'));

Parameter List

 'whatfor'
 'entrypath'
 'destpath'
 'description'
 'action'

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

AfterCompressFile Event (SecureBlackbox_ArchiveWriter Class)

Marks the completion of compression of a file.

Object Oriented Interface

public function fireAfterCompressFile($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 2, array($this, 'fireAfterCompressFile'));

Parameter List

 'path'
 'filesize'
 'datasource'

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

BeforeCompressFile Event (SecureBlackbox_ArchiveWriter Class)

Marks the start of compression of a file.

Object Oriented Interface

public function fireBeforeCompressFile($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 3, array($this, 'fireBeforeCompressFile'));

Parameter List

 'path'
 'filesize'
 'datasource'

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

If passing the data from a stream or buffer, use AfterCompressFile to dispose of any objects allocated in this event handler (such as the source stream).

Use PrepareFile event to adjust the file data source on the fly.

DecryptionPasswordNeeded Event (SecureBlackbox_ArchiveWriter Class)

Fires when the class needs a password to decrypt the archive.

Object Oriented Interface

public function fireDecryptionPasswordNeeded($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 4, array($this, 'fireDecryptionPasswordNeeded'));

Parameter List

 'passwordtarget'
 'cancel'

Remarks

Class fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to DecryptionPassword property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

Error Event (SecureBlackbox_ArchiveWriter Class)

Reports information about errors during archive assembling.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SecureBlackbox_ArchiveWriter Class)

This event notifies the application about an underlying control flow event.

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 6, array($this, 'fireNotification'));

Parameter List

 'eventid'
 'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

PrepareFile Event (SecureBlackbox_ArchiveWriter Class)

Fires for every file to be compressed before the compression starts.

Object Oriented Interface

public function firePrepareFile($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 7, array($this, 'firePrepareFile'));

Parameter List

 'path'
 'filesize'
 'datasource'
 'localpath'
 'action'

Remarks

Class fires this event for every file included in the Files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

Please do not assign FileStream or FileData in this event handler: this should be done further down the road in the BeforeCompressFile event handler. The purpose of this event is to prepare the compression plan by summarizing what should be done and to which files.

The Action parameter, which is also tuneable, indicates the action for class to take on the file:

Progress Event (SecureBlackbox_ArchiveWriter Class)

Reports the progress of data compression.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 8, array($this, 'fireProgress'));

Parameter List

 'processed'
 'total'
 'overallprocessed'
 'overalltotal'
 'cancel'

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

RecipientFound Event (SecureBlackbox_ArchiveWriter Class)

Signifies that the archive was found to be encrypted with a digital certificate.

Object Oriented Interface

public function fireRecipientFound($param);

Procedural Interface

secureblackbox_archivewriter_register_callback($res, 9, array($this, 'fireRecipientFound'));

Parameter List

 'publickeyhash'
 'certfound'

Remarks

The class fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the DecryptionCertificates list. If it wasn't, you need to locate it on the system and add it to that list: class won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

Config Settings (ArchiveWriter Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Class)