Perl

Transition from BeginCompressStringENC to FirstChunk/LastChunk

Provides instructions for replacing deprecated BeginCompressStringENC method calls with using FirstChunk/LastChunk properties. Perl

use chilkat();

$success = 0;

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$sbCompressedBase64 = chilkat::CkStringBuilder->new();

$compress = chilkat::CkCompression->new();
$compress->put_Algorithm("deflate");
$compress->put_Charset("utf-8");
$compress->put_EncodingMode("base64");

$sbIndex = chilkat::CkStringBuilder->new();

# ----------------------------------------------------------------------------------
# This is the deprecated way of compressing in chunks using Begin/More/End methods..
# ----------------------------------------------------------------------------------

for ($i = 0; $i <= 24; $i++) {
    # Note: It is possible (and normal) for a BeginCompress* or MoreCompress* method to return
    # an empty string (or 0 bytes).  When this happens, the input data is not lost.  It will be flushed
    # in a subsequent call.
    $sbIndex->Clear();
    $sbIndex->AppendInt($i);
    if ($i == 0) {
        $sbCompressedBase64->Append($compress->beginCompressStringENC($sbIndex->getAsString()));
    }
    else {
        $sbCompressedBase64->Append($compress->moreCompressStringENC($sbIndex->getAsString()));
    }

    $sbCompressedBase64->Append($compress->moreCompressStringENC(": This is a line of data to be compressed...\r\n"));
}

# Flush any remaining output.
$sbCompressedBase64->Append($compress->endCompressStringENC());

print "The base64 encoded compressed text:" . "\r\n";
print $sbCompressedBase64->getAsString() . "\r\n";

# Decompress in one call:
$originalText = $compress->decompressStringENC($sbCompressedBase64->getAsString());
print $originalText . "\r\n";

# ----------------------------------------------------------------------------------
# This is new way of compressing in chunks using FirstChunk and LastChunk properties
# ----------------------------------------------------------------------------------

$sbCompressedBase64->Clear();

$compress->put_FirstChunk(1);
$compress->put_LastChunk(0);

$bdCompressed = chilkat::CkBinData->new();
$sbUncompressedChunk = chilkat::CkStringBuilder->new();

for ($i = 0; $i <= 24; $i++) {
    if ($i == 24) {
        $compress->put_LastChunk(1);
    }

    $sbUncompressedChunk->Clear();
    $sbUncompressedChunk->AppendInt($i);
    $sbUncompressedChunk->Append(": This is a line of data to be compressed...\r\n");

    $compress->CompressSb($sbUncompressedChunk,$bdCompressed);

    $compress->put_FirstChunk(0);
}

print "The base64 encoded compressed text:" . "\r\n";
print $bdCompressed->getEncoded("base64") . "\r\n";

# Decompress in one call:
$originalText = $compress->decompressStringENC($bdCompressed->getEncoded("base64"));
print $originalText . "\r\n";