ZipEntry PHP Extension Reference Documentation
CkZipEntry
Current Version: 11.0.0
Represents a single file or directory entry within a Chilkat Zip object. A zip entry can be one of 5 types (see the description of the EntryType property below).
Object Creation
$obj = new CkZipEntry();
Properties
Comment
void put_Comment(string strVal);
The comment stored within the Zip for this entry.
topCompressedLength
int get_CompressedLength()
The size in bytes of this entry's file data when compression is applied
topCompressedLength64
int64 get_CompressedLength64()
The size in bytes of this entry's file data when compression is applied
topCompressedLengthStr
string compressedLengthStr();
The size in decimal string format of this file when Zip compression is applied.
topCompressionLevel
void put_CompressionLevel(int intVal);
The compression level. 0 = no compression, while 9 = maximum compression. The default is 6.
topCompressionMethod
void put_CompressionMethod(int intVal);
Set to 0 for no compression, or 8 for the Deflate algorithm. The Deflate algorithm is the default algorithm of the most popular Zip utility programs, such as WinZip
topCrc
int get_Crc()
The CRC for the zip entry. For AES encrypted entries, the CRC value will be 0. (See http://www.winzip.com/aes_info.htm#CRC )
topDebugLogFilePath
void put_DebugLogFilePath(string strVal);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
EncryptionKeyLen
int get_EncryptionKeyLen()
If this entry is AES encrypted, then this property contains the AES key length (128, 192, or 256). If the entry is not AES encrypted, then the value is 0.
topEntryID
int get_EntryID()
A unique ID assigned to the entry while the object is instantiated in memory.
topEntryType
int get_EntryType()
Indicates the origin of the entry. There are three possible values:
- Mapped Entry: An entry in an existing Zip file.
- File Entry: A file not yet in memory, but referenced. These entries are added by calling AppendFiles, AppendFilesEx, AppendOneFileOrDir, etc.
- Data Entry: An entry containing uncompressed data from memory. These entries are added by calling AppendData, AppendString, etc.
- Null Entry: An entry that no longer exists in the .zip.
- New Directory Entry: A directory entry added by calling AppendNewDir.
FileDateTimeStr
void put_FileDateTimeStr(string strVal);
The local last-modified date/time in RFC822 string format.
topFileName
void put_FileName(string strVal);
FileNameHex
string fileNameHex();
A string containing the hex encoded raw filename bytes found in the Zip entry.
topIsAesEncrypted
bool get_IsAesEncrypted()
true if the entry is AES encrypted. This property can only be true for entries already contained in a .zip (i.e. entries obtained from a zip archive that was opened via OpenZip, OpenBd, OpenFromMemory, etc.) The property is false if the entry contained in the zip is not AES encrypted.
IsDirectory
bool get_IsDirectory()
True if the Zip entry is a directory, false if it is a file.
topLastErrorHtml
string lastErrorHtml();
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
string lastErrorText();
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
string lastErrorXml();
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void put_LastMethodSuccess(bool boolVal);
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
TextFlag
void put_TextFlag(bool boolVal);
Controls whether the "text flag" of the internal file attributes for this entry within the zip is set. This is a bit flag that indicates whether the file contents are text or binary. It is for informational use and it is not imperative that this bit flag is accurately set. The ability to set this bit flag is only provided to satisfy certain cases where another application might be sensitive to the flag.
topUncompressedLength
int get_UncompressedLength()
The size in bytes of this entry's file data when uncompressed.
topUncompressedLength64
int64 get_UncompressedLength64()
The size in bytes of this entry's file data when uncompressed.
topUncompressedLengthStr
string uncompressedLengthStr();
The size in bytes (in decimal string format) of this zip entry's data when uncompressed.
topVerboseLogging
void put_VerboseLogging(bool boolVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
string version();
Methods
AppendData Deprecated
Appends binary data to the zip entry's file contents.
Returns true for success, false for failure.
topAppendDataAsync Deprecated (1)
Creates an asynchronous task to call the AppendData method with the arguments provided.
Returns null on failure
AppendString
Appends text data to the zip entry's file contents. The text is appended using the character encoding specified by the charset, which can be "utf-8", "ansi", etc.
Returns true for success, false for failure.
topAppendStringAsync (1)
Creates an asynchronous task to call the AppendString method with the arguments provided.
Returns null on failure
Copy Deprecated
Returns the compressed data as a byte array.
Note: The Copy method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry"). This is the case when an existing .zip is opened (from memory or from a file), or after the .zip has been written (by calling WriteZip or WriteToMemory). If a zip entry is created via AppendData, AppendFiles, etc., then it does not yet contain compressed data. When the zip is written, each entry becomes a "mapped entry" (The value of the EntryType property becomes 0.)
Returns true for success, false for failure.
topCopyToBase64
Returns the compressed data as a Base64-encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.
Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry").
Returns true for success, false for failure.
topCopyToHex
Returns the compressed data as a hexidecimal encoded string. It is only possible to retrieve the compressed data from a pre-existing .zip that has been opened or after writing the .zip but not closing it.
Note: The CopyToBase64 method can only be called if the zip entry already contains compressed data (i.e. it is a "mapped entry").
Returns true for success, false for failure.
topExtract
Unzips this entry into the specified base directory. The file is unzipped to the subdirectory according to the relative path stored with the entry in the Zip. Use ExtractInto to unzip into a specific directory regardless of the path information stored in the Zip.
Returns true for success, false for failure.
topExtractAsync (1)
Creates an asynchronous task to call the Extract method with the arguments provided.
Returns null on failure
ExtractInto
Unzip a file into a specific directory. If this entry is a directory, then nothing occurs. (An application can check the IsDirectory property and instead call Extract if it is desired to create the directory. )
Returns true for success, false for failure.
topExtractIntoAsync (1)
Creates an asynchronous task to call the ExtractInto method with the arguments provided.
Returns null on failure
GetNext
Updates this object to the next entry (file or directory) within this zip.
Returns true for success, false for failure.
topGetNextMatch
Updates this object to the next matching entry (file or directory) within this zip. The "*" characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern.
Returns true for success, false for failure.
topInflate Deprecated
InflateAsync Deprecated (1)
Creates an asynchronous task to call the Inflate method with the arguments provided.
Returns null on failure
LoadTaskCaller
NextMatchingEntry
This method is deprecated. Applications should instead call GetNextMatch.
Returns the next entry having a filename matching a pattern. The "*" characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern. A NULL is returned if nothing matches.
Returns null on failure
ReplaceData Deprecated
Replaces the zip entry's existing contents with new data.
Returns true for success, false for failure.
topReplaceString
Replaces the zip entry's existing contents with new text data. The text will be stored using the character encoding as specified by charset, which can be "utf-8", "ansi", etc.
Returns true for success, false for failure.
SetDt
Sets the last-modified date/time for this zip entry.
topUnzipToBd
UnzipToBdAsync (1)
Creates an asynchronous task to call the UnzipToBd method with the arguments provided.
Returns null on failure
UnzipToSb
Unzips a text file to the sb. The contents of sb are appended with the unzipped file. The lineEndingBehavior is as follows:
0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's
The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.
Returns true for success, false for failure.
topUnzipToSbAsync (1)
Creates an asynchronous task to call the UnzipToSb method with the arguments provided.
Returns null on failure
UnzipToStream
Unzips a file within a Zip to a stream. If called synchronously, the toStream must have a sink, such as a file or another stream object. If called asynchronously, then the foreground thread can read the stream.
Returns true for success, false for failure.
UnzipToStreamAsync (1)
Creates an asynchronous task to call the UnzipToStream method with the arguments provided.
Returns null on failure
UnzipToString
string unzipToString(int lineEndingBehavior, string srcCharset);
Inflate and return the uncompressed data as a string The lineEndingBehavior is as follows:
0 = leave unchanged.
1 = convert all to bare LF's
2 = convert all to CRLF's
The srcCharset tells the component how to interpret the bytes of the uncompressed file -- i.e. as utf-8, utf-16, windows-1252, etc.
Returns true for success, false for failure.
UnzipToStringAsync (1)
Creates an asynchronous task to call the UnzipToString method with the arguments provided.
Returns null on failure
Deprecated
GetDt
This method is deprecated and will be removed in a future version. Use the FileDateTimeStr property instead. Returns the last-modified date/time of this zip entry.
Returns null on failure
NextEntry
This method is deprecated. Applications should instead call GetNext.
Return the next entry (file or directory) within the Zip
Returns null on failure