gmitirol / toolkit-pdftk

src/Joiner.php

<?php
/**
 * PDFtk wrapper
 *
 * @copyright 2014-2022 Institute of Legal Medicine, Medical University of Innsbruck
 * @author Andreas Erhard <andreas.erhard@i-med.ac.at>
 * @author Nikola Vrlazic <nikola.vrlazic@i-med.ac.at>
 * @license LGPL-3.0-only
 * @link http://www.gerichtsmedizin.at/
 *
 * @package pdftk
 */

namespace Gmi\Toolkit\Pdftk;

use Symfony\Component\Finder\Finder;
use Symfony\Component\Process\Process;

use Gmi\Toolkit\Pdftk\Exception\JoinException;
use Gmi\Toolkit\Pdftk\Exception\FileNotFoundException;
use Gmi\Toolkit\Sorter\FileSorterInterface;
use Gmi\Toolkit\Sorter\NaturalFileSorter;

use Exception;
use SplFileInfo;

/**
 * Searches folder, and naturally sorts PDF files. After sorting the PDFs, all PDFs will be combined to one file.
 *
 * <pre>
 * $joiner = new PdfJoiner();
 * $joiner->joinByPattern('/var/www/test/foo', '/^FILE123456_.*\.pdf$', '/tmp/my_file.pdf');
 * </pre>
 */
class Joiner
{
    /**
     * @var Finder
     */
    private $finder;

    /**
     * @var FileSorterInterface
     */
    private $sorter;

    /**
     * @var PdftkWrapper
     */
    private $wrapper;

    /**
     * Constructor.
     *
     * @param PdftkWrapper        $wrapper
     * @param Finder              $finder
     * @param FileSorterInterface $sorter
     */
    public function __construct(PdftkWrapper $wrapper = null, Finder $finder = null, FileSorterInterface $sorter = null)
    {
        $this->wrapper = $wrapper ?: new PdftkWrapper();
        $this->finder = $finder ?: new Finder();
        $this->sorter = $sorter ?: new NaturalFileSorter();
    }

    /**
     * Joins all PDFs in a folder matching a pattern, naturally sorted, to one file.
     *
     * @param string $inputFolder
     * @param string $pattern
     * @param string $output
     *
     * @throws FileNotFoundException if no matching input files are found in the input folder
     * @throws JoinException if the PDF join fails
     */
    public function joinByPattern($inputFolder, $pattern, $output)
    {
        // array of files which match the pattern
        $foundFiles = $this->getFiles($inputFolder, $pattern);

        if (count($foundFiles) === 0) {
            throw new FileNotFoundException(
                sprintf(
                    'No files in "%s" are matching to the pattern "%s".',
                    $inputFolder,
                    $pattern
                )
            );
        }

        // array of sorted files
        $files = $this->sorter->sort($foundFiles);

        return $this->join($files, $output);

Are you sure the usage of $this->join($files, $output) targeting Gmi\Toolkit\Pdftk\Joiner::join() seems to always return null.

    }

    /**
     * Joins a list of PDFs (represented by SplFileInfo instances) to one file.
     *
     * @param SplFileInfo[] $files
     * @param string        $output
     *
     * @throws JoinException if the PDF join fails
     */
    public function join($files, $output)
    {
        $filePaths = [];
        foreach ($files as $file) {
            $filePaths[] = escapeshellarg($file->getPathname());
        }

        $fileList = implode(' ', $filePaths);

        $commandLine = sprintf('%s %s cat output %s', $this->wrapper->getBinary(), $fileList, escapeshellarg($output));

        /**
         * @var Process
         */
        $process = $this->wrapper->createProcess($commandLine);

        try {
            $process->mustRun();
        } catch (Exception $e) {
            throw new JoinException(
                sprintf('Failed to join PDF "%s"! Error: %s', $output, $e->getMessage()),
                0,
                $e,
                $process->getErrorOutput(),
                $process->getOutput()
            );
        }

        $process->getOutput();
    }

    /**
     * Finds all files inside the folder with specific pattern.
     *
     * @param string $folder
     * @param string $pattern
     *
     * @return SplFileInfo[]
     */
    private function getFiles($folder, $pattern)
    {
        $files = $this->finder->files()->name($pattern)->in($folder);

        $results = [];

        foreach ($files as $file) {
            $results[] = $file;
        }

        return $results;
    }
}