SetaPDF-Merger Manual

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\PageFormats;
use setasign\SetaPDF2\Core\Reader\StringReader;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document as the cover sheet
$writer = new HttpWriter('simple-portfolio.pdf', true);
$document = new Document($writer);
$document->getCatalog()->getPages()->create(PageFormats::A4);
// we leave it empty for demonstration purpose...

// create a collection instance
$collection = new Collection($document);

// add a file through a local path
$collection->addFile(
    'files/pdfs/tektown/Laboratory-Report.pdf',
    'Laboratory-Report.pdf',
    'Description of Laboratory-Report.pdf'
);

// add a dynamically created text file
$textFile = 'A simple text content';
$collection->addFile(
    new StringReader($textFile),
    'text-file.txt',
    'The description of the text file.'
);

// save and finish
$document->save()->finish();

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\EmbeddedFileStream;
use setasign\SetaPDF2\Core\PageFormats;
use setasign\SetaPDF2\Core\Reader\StringReader;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document as the cover sheet
$writer = new HttpWriter('dynamic-portfolio.pdf', true);
$document = new Document($writer);
$document->getCatalog()->getPages()->create(PageFormats::A4);
// we leave it empty for demonstration purpose...

// create a collection instance
$collection = new Collection($document);

// add a dynamically created text file
$textFile = 'A simple text content';
$collection->addFile(
    new StringReader($textFile),
    'text-file.txt',
    'The description of the text file.',
    [
        // an optional check sum
        EmbeddedFileStream::PARAM_CHECK_SUM => md5($textFile, true),
        // modification and creation date are default columns and set automatically
        // to the current date time. If you want to define them manually:
        EmbeddedFileStream::PARAM_MODIFICATION_DATE => new \DateTime('yesterday'),
        EmbeddedFileStream::PARAM_CREATION_DATE => new \DateTime('-1 week')
    ]
);

// add another dynamically created text file
$textFile = 'Another simple text content';
$name = $collection->addFile(
    new StringReader($textFile),
    'another-text-file.txt',
    'The description of the other text file.'
);
// get the file specification by its name
$fileSpecification = $collection->getFile($name);

// get the embedded file stream and add additional parameters
$fileSpecification->getEmbeddedFileStream()->setParams([
    EmbeddedFileStream::PARAM_CHECK_SUM => md5($textFile, true),
    EmbeddedFileStream::PARAM_MODIFICATION_DATE => new \DateTime('yesterday'),
    EmbeddedFileStream::PARAM_CREATION_DATE => new \DateTime('last Wednesday')
], false);

// save and finish
$document->save()->finish();

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\FileSpecification;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document
$document = Document::loadByFilename('files/pdfs/tektown/products/All-Portfolio.pdf');

// get the collection instance
$collection = new Collection($document);

// get all files
$files = $collection->getFiles();

// extract the file
if (isset($_GET['f']) && isset($files[$_GET['f']])) {
    $file = $files[$_GET['f']];
    if ($file instanceof FileSpecification) {
        // resolve the filename
        $filename = $file->getFileSpecification();
        // resolve the file stream
        $embeddedFileStream = $file->getEmbeddedFileStream();

        // get the content type
        $contentType = $embeddedFileStream->getMimeType();
        // or set a default content type
        if ($contentType === null) {
            $contentType = 'application/force-download';
        }

        // pass the file to the client
        $stream = $embeddedFileStream->getStream();
        header('Content-Type: ' . $contentType);
        header('Content-Disposition: attachment; filename="' . $filename . '";');
        header('Content-Transfer-Encoding: binary');
        header('Content-Length: ' . strlen($stream));
        echo $stream;
        die();
    }
}

foreach ($files AS $name => $file) {
    $filename = $file->getFileSpecification();
    echo '<a href="?f=' . urlencode($name) . '">' . htmlspecialchars($filename) . '</a><br />';
}

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\PageFormats;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document as the cover sheet
$writer = new HttpWriter('portfolio-with-folders.pdf', true);
$document = new Document($writer);
$document->getCatalog()->getPages()->create(PageFormats::A4);
// we leave it empty for demonstration purpose...

// create a collection instance
$collection = new Collection($document);

// thorugh the proxy method
$folderA = $collection->addFolder('Folder (A)');
// add more sub folders
$folderA->addFolder('Folder (AA)');
$folderA->addFolder('Folder (AB)')->addFolder('Folder (ABA)');
$folderA->addFolder('Folder (AC)')->addFolder('Folder (ACA)');

// through the root folder
$rootFolder = $collection->getRootFolder();
$folderB = $rootFolder->addFolder('Folder (B)');
// add more sub folders
$folderB->addFolder('Folder (BA)')->addFolder('Folder (BAA)');
$folderB->addFolder('Folder (BB)');
$folderB->addFolder('Folder (BC)');

// save and finish
$document->save()->finish();

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\PageFormats;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document as the cover sheet
$writer = new HttpWriter('portfolio-with-folders-and-files.pdf', true);
$document = new Document($writer);
$document->getCatalog()->getPages()->create(PageFormats::A4);
// we leave it empty for demonstration purpose...

// create a collection instance
$collection = new Collection($document);

// thorugh the proxy method
$folderA = $collection->addFolder('tektown');
$folderA->addFile(
    'files/pdfs/tektown/Laboratory-Report.pdf',
    'Laboratory-Report.pdf'
);
$folderA->addFile(
    'files/pdfs/tektown/Terms-and-Conditions.pdf',
    'Terms-and-Conditions.pdf'
);

$folderB = $collection->addFolder('camtown');
$folderB->addFile(
    'files/pdfs/camtown/Laboratory-Report.pdf',
    'Laboratory-Report.pdf'
);
$folderB->addFile(
    'files/pdfs/camtown/Terms-and-Conditions.pdf',
    'Terms-and-Conditions.pdf'
);

// save and finish
$document->save()->finish();

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\FileSpecification;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document
$document = Document::loadByFilename('files/pdfs/Logos-Portfolio.pdf');

// get the collection instance
$collection = new Collection($document);

// extract the file
if (isset($_GET['f'])) {
    // get the file specification
    $file = $collection->getFile($_GET['f']);
    if ($file instanceof FileSpecification) {
        // resolve the filename
        $filename = $file->getFileSpecification();
        // resolve the file stream
        $embeddedFileStream = $file->getEmbeddedFileStream();

        // we force a content type
        $contentType = 'application/force-download';

        // pass the file to the client
        $stream = $embeddedFileStream->getStream();
        header('Content-Type: ' . $contentType);
        header('Content-Disposition: attachment; filename="' . $filename . '";');
        header('Content-Transfer-Encoding: binary');
        header('Content-Length: ' . strlen($stream));
        echo $stream;
        die();
    }
}

// function which is called recursively to print out all folders and files
function printFolder(Collection\Folder $folder, $level = 0) {
    $files = $folder->getFiles();

    echo str_repeat('&nbsp', $level++ * 4);
    echo $folder->getName() . '/<br />';
    foreach ($files AS $name => $file) {
        $filename = $file->getFileSpecification();
        echo str_repeat('&nbsp', $level * 4);
        echo '<a href="?f=' . urlencode($name) . '">' . htmlspecialchars($filename) . '</a><br />';
    }

    // get sub folders and print them out, too
    foreach ($folder->getSubfolders() AS $subFolder) {
        printFolder($subFolder, $level);
    }
}

printFolder($collection->getRootFolder());

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document as the cover sheet
$writer = new HttpWriter('moved-folders.pdf', true);
// create a document
$document = Document::loadByFilename('files/pdfs/Logos-Portfolio.pdf', $writer);

// get the collection instance
$collection = new Collection($document);
$rootFolder = $collection->getRootFolder();

// get all existing folders
$camtown = $rootFolder->getSubfolder('camtown');
$etown = $rootFolder->getSubfolder('etown');
$lentown = $rootFolder->getSubfolder('lenstown');
$tektown = $rootFolder->getSubfolder('tektown');

// create a new folder
$newFolder = $rootFolder->addFolder('New Folder');

// move all folders to this new folder
$camtown->setParent($newFolder);
$etown->setParent($newFolder);
$lentown->setParent($newFolder);
$tektown->setParent($newFolder);

$document->save()->finish();

• copy

<?php

use setasign\SetaPDF2\Core\Document;
use setasign\SetaPDF2\Core\Encoding\Encoding;
use setasign\SetaPDF2\Core\PageFormats;
use setasign\SetaPDF2\Core\Writer\HttpWriter;
use setasign\SetaPDF2\Merger\Collection;

require_once('library/SetaPDF/Autoload.php');

// create a document as the cover sheet
$writer = new HttpWriter('portfolio-with-schema.pdf', true);
$document = new Document($writer);
$document->getCatalog()->getPages()->create(PageFormats::A4);
// we leave it empty for demonstration purpose...

// create a collection instance
$collection = new Collection($document);

// get the schema instance
$schema = $collection->getSchema();

// create a field instance manually
$filenameField = Collection\Schema\Field::create(
    'Filename', // the visible field name
    Collection\Schema::DATA_FILE_NAME // refer to the file name
);
$filenameField->setOrder(1);
// add it to the schema
$schema->addField('filename', $filenameField);

// let addField() do the field creation
$schema->addField(
    'description',
    'Description',
    Collection\Schema::DATA_DESCRIPTION,
    2
);

// let's create an individual field
$schema->addField(
    'company', 'Company Name', Collection\Schema::TYPE_STRING, 3
);

// let's create another individual field
$schema->addField(
    'order', 'Order', Collection\Schema::TYPE_NUMBER, 4
);

// for demonstration purpose, we add some files now...
$collection->addFile(
    'files/pdfs/tektown/Logo.pdf',
    'tektown-logo.pdf',
    'The logo of tektown',
    [],
    'application/pdf',
    [
        'company' => Encoding::toPdfString('tektown'),
        'order'   => 1
    ]
);

$collection->addFile(
    'files/pdfs/etown/Logo.pdf',
    'etown-logo.pdf',
    'The logo of etown',
    [],
    'application/pdf',
    [
        'company' => Encoding::toPdfString('etown'),
        'order'   => 2
    ]
);

$collection->addFile(
    'files/pdfs/lenstown/Logo.pdf',
    'lenstown-logo.pdf',
    'The logo of lenstown',
    [],
    'application/pdf',
    [
        'company' => Encoding::toPdfString('lenstown'),
        'order'   => 3
    ]
);

// save and finish
$document->save()->finish();