PHP

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.

Chilkat2 PHP

<?php

use Chilkat2\BinData;
use Chilkat2\JsonObject;
use Chilkat2\Pdf;

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

$pdf = new Pdf();

try {
    $pdf->LoadFile('qa_data/pdf/embedded_files/my_embedded_files_test.pdf');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\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->NumEmbeddedFiles;
echo 'Number of embedded files: ', $numFiles, "\n";

$json = new JsonObject();
$json->EmitCompact = false;

$bd = new BinData();

// Get information about each file, and extract each to the filesystem.
$i = 0;
while ($i < $numFiles) {
    try {
        $pdf->GetEmbeddedFileInfo($i, $json);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo $json->Emit(), "\n";

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

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

    // Get the file data.
    try {
        $pdf->GetEmbeddedFileBd($i, $bd);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    // Save the contents of the bd to the filename (in the current working directory) in the filesystem.
    try {
        $bd->WriteFile($filename);
    } catch (\Chilkat2\Exception $e) {
        echo "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'"
// }