PHP Extension

Find ZIP Entries Matching a Wildcard Pattern Using EntryMatching

See more Zip Examples

This example demonstrates how to use the EntryMatching method to find ZIP entries whose stored paths match a wildcard pattern.

The wildcard character * matches zero or more characters. The comparison is performed against the full stored path within the ZIP archive.

This method is useful for:

• Finding files having a particular extension
• Locating files within specific subdirectories
• Searching ZIP archives without manually iterating through every entry

Suppose the ZIP archive contains:

docs/
docs/readme.txt
docs/manual.pdf
images/logo.png
images/banner.jpg
data/config/settings.json

Notice that the ZIP archive contains an explicit directory entry named docs/. ZIP archives may optionally contain separate directory entries in addition to file entries.

When searching with the pattern docs/*, the first matching entry could therefore be the directory entry docs/ rather than a file contained within that directory.

The example searches for:

• The first .png file
• The first entry beneath the docs directory
• The first JSON file anywhere within the ZIP archive

PHP Extension

<?php

include("chilkat.php");

$success = false;

$success = false;

// Open an existing ZIP archive.
$zip = new CkZip();

$success = $zip->OpenZip('example.zip');
if ($success == false) {
    print $zip->lastErrorText() . "\n";
    exit;
}

$entry = new CkZipEntry();

// ------------------------------------------------------------
// Find the first .png file in the ZIP archive.

$success = $zip->EntryMatching('*.png',$entry);

if ($success == true) {
    print 'Found PNG file:' . "\n";
    print '  ' . $entry->fileName() . "\n";
    print '' . "\n";
}

// ------------------------------------------------------------
// Find the first entry beneath the docs directory.
// 
// Note: ZIP archives may optionally contain explicit directory
// entries such as "docs/" in addition to file entries.
// Therefore, the first matching entry could be the directory
// itself rather than a file contained within the directory.

$success = $zip->EntryMatching('docs/*',$entry);

if ($success == true) {
    print 'First matching docs entry:' . "\n";
    print '  ' . $entry->fileName() . "\n";
    print '  IsDirectory = ' . $entry->get_IsDirectory() . "\n";
    print '' . "\n";
}

// ------------------------------------------------------------
// Find the first JSON file anywhere in the ZIP archive.

$success = $zip->EntryMatching('*.json',$entry);

if ($success == true) {
    print 'Found JSON file:' . "\n";
    print '  ' . $entry->fileName() . "\n";
    print '' . "\n";
}

// ------------------------------------------------------------
// The matching is performed against the full stored ZIP path.
// For example:
// 
//     docs/readme.txt
//     images/logo.png
//     data/config/settings.json
// 
// The wildcard '*' matches zero or more characters.

$zip->CloseZip();

print 'Done.' . "\n";

?>