gmitirol / toolkit-pdftk

src/Bookmarks.php

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

namespace Gmi\Toolkit\Pdftk;

use Gmi\Toolkit\Pdftk\Exception\PdfException;

/**
 * Apply bookmarks to PDF.
 */
class Bookmarks
{
    /**
     * Bookmarks.
     *
     * @var Bookmark[]
     */
    private $bookmarks = [];

    /**
     * Maximum page number.
     *
     * @var int
     */
    private $maxpage = -1;

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

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

    /**
     * Add bookmark to page.
     *
     * @param Bookmark $bookmark
     *
     * @return self
     */
    public function add(Bookmark $bookmark)
    {
        if (!is_int($bookmark->getPageNumber()) || $bookmark->getPageNumber() < 1) {

The condition is_int($bookmark->getPageNumber()) is always true.

            throw new PdfException(sprintf('Invalid page number: %s', $bookmark->getPageNumber()));
        } elseif ($this->maxpage > 0 && $bookmark->getPageNumber() > $this->maxpage) {
            throw new PdfException('Page number out of range!');
        }

        $this->bookmarks[] = $bookmark;

        return $this;
    }

    /**
     * Returns all bookmarks.
     *
     * @return Bookmark[]
     */
    public function all()
    {
        return $this->bookmarks;
    }

    /**
     * Deletes a bookmark.
     *
     * @param Bookmark $bookmark
     *
     * @return self
     */
    public function remove(Bookmark $bookmark)
    {
        foreach ($this->bookmarks as $key => $currentBookmark) {
            // weak comparison - value objects with equal values are considered equal
            if ($currentBookmark == $bookmark) {
                unset($this->bookmarks[$key]);
            }
        }

        $this->resetArrayIndizes();

        return $this;
    }

    /**
     * Delete bookmark from page.
     *
     * @param int $pageNumber
     *
     * @return self
     */
    public function removeByPageNumber($pageNumber)
    {
        foreach ($this->bookmarks as $key => $currentBookmark) {
            if ($currentBookmark->getPageNumber() === $pageNumber) {
                unset($this->bookmarks[$key]);
            }
        }

        $this->resetArrayIndizes();

        return $this;
    }

    /**
     * Remove all bookmarks.
     *
     * @return self
     */
    public function clear()
    {
        $this->bookmarks = [];

        return $this;
    }

    /**
     * Apply bookmarks to PDF file.
     *
     * @param string $infile
     * @param string $outfile
     *
     * @return self
     */
    public function apply($infile, $outfile = null)
    {
        $this->wrapper->updatePdfDataFromDump($infile, $this->buildBookmarksBlock(), $outfile);

        return $this;
    }

    /**
     * Imports bookmarks from a PDF file.
     *
     * @param string $infile
     *
     * @return self
     */
    public function import($infile)
    {
        $dump = $this->wrapper->getPdfDataDump($infile);
        $this->importFromDump($dump);

        return $this;
    }

    /**
     * Imports bookmarks from a pdftk dump.
     *
     * @param string $dump
     *
     * @return self
     */
    public function importFromDump($dump)
    {
        $matches = [];
        $regex = '/BookmarkBegin\nBookmarkTitle: (?<title>.+)\n' .
                 'BookmarkLevel: (?<level>[0-9]+)\nBookmarkPageNumber: (?<page>[0-9]+)/';
        preg_match_all($regex, $dump, $matches, PREG_SET_ORDER);

        foreach ($matches as $bm) {
            $bookmark = new Bookmark();
            $bookmark
                ->setTitle($bm['title'])
                ->setPageNumber((int) $bm['page'])
                ->setLevel((int) $bm['level'])
            ;

            $this->add($bookmark);
        }

        return $this;
    }

    /**
     * Sets the maximum page number of the PDF to validate page numbers.
     *
     * @internal
     *
     * @param int $maxpage
     *
     * @return self
     */
    public function setMaxpage($maxpage)
    {
        $this->maxpage = $maxpage;

        return $this;
    }

    /**
     * Builds an Bookmark string for all bookmarks.
     *
     * @return string
     */
    private function buildBookmarksBlock()
    {
        $result = '';

        foreach ($this->bookmarks as $bookmark) {
            $result .= $this->buildBookmarkBlock($bookmark);
        }

        return $result;
    }

    /**
     * Builds an Bookmark string for a single bookmark.
     *
     * @param Bookmark $bookmark
     *
     * @return string
     */
    private function buildBookmarkBlock(Bookmark $bookmark)
    {
        return
            'BookmarkBegin' . PHP_EOL .
            'BookmarkTitle: ' . $bookmark->getTitle() . PHP_EOL .
            'BookmarkLevel: ' . $bookmark->getLevel() . PHP_EOL .
            'BookmarkPageNumber: ' . $bookmark->getPageNumber() . PHP_EOL;
    }

    /**
     * Resets the bookmark array indizes (e.g. after removal of a bookmark).
     */
    private function resetArrayIndizes()
    {
        $this->bookmarks = array_values($this->bookmarks);
    }
}