(PHP Extension) Extract Embedded Files from PDF

Demonstrates how to get information about the embedded files (if any) contained within a PDF, and shows how to extract each file.

Note: This example requires Chilkat v9.5.0.95 or greater.

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

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

$pdf = new CkPdf();

$success = $pdf->LoadFile('qa_data/pdf/embedded_files/my_embedded_files_test.pdf');
if ($success == false) {
    print $pdf->lastErrorText() . "\n";
    exit;
}

// Note: The embedded file functionality was added in Chilkat v9.5.0.95

// How many embedded files exist within the opened PDF?
$numFiles = $pdf->get_NumEmbeddedFiles();
print 'Number of embedded files: ' . $numFiles . "\n";

$json = new CkJsonObject();
$json->put_EmitCompact(false);

$bd = new CkBinData();

// Get information about each file, and extract each to the filesystem.
$i = 0;
while ($i < $numFiles) {

    $success = $pdf->GetEmbeddedFileInfo($i,$json);
    if ($success == false) {
        print $pdf->lastErrorText() . "\n";
        exit;
    }

    print $json->emit() . "\n";

    // Get the filename from the JSON.
    $filename = 'someFile.dat';

    // The filename SHOULD always be present..
    if ($json->HasMember('filename') == true) {
        $filename = $json->stringOf('filename');
    }

    // Get the file data.
    $success = $pdf->GetEmbeddedFileBd($i,$bd);
    if ($success == false) {
        print $pdf->lastErrorText() . "\n";
        exit;
    }

    // Save the contents of the bd to the filename (in the current working directory) in the filesystem.
    $success = $bd->WriteFile($filename);
    if ($success == false) {
        print 'Failed to write output file.' . "\n";
    }

    $i = $i + 1;
}

// Sample output for the above code:

// Number of embedded files: 3
// {
//   "filename": "employees.json",
//   "desc": "JSON",
//   "subType": "application/json",
//   "size": 159,
//   "creationDate": "D:20230715170506-05'00'",
//   "modDate": "D:20160207153838-05'00'"
// }
// 
// {
//   "filename": "rsaPubKey.pem",
//   "desc": "RSA Public Key PEM",
//   "size": 451,
//   "creationDate": "D:20230715170546-05'00'",
//   "modDate": "D:20150724133153-05'00'"
// }
// 
// {
//   "filename": "starfish.jpg",
//   "desc": "Starfish JPG",
//   "subType": "image/jpeg",
//   "size": 6229,
//   "creationDate": "D:20230715170356-05'00'",
//   "modDate": "D:20080529103055-05'00'"
// }

?>