Bacon\Pdf\Encryption\Permissions

Complexity

Total Complexity

5

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	5
Bugs	0	Features	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	19	1
A	allowNothing()	0	4	1
A	allowEverything()	0	4	1
A	toInt()	0	17	2

<?php
/**
 * BaconPdf
 *
 * @link      http://github.com/Bacon/BaconPdf For the canonical source repository
 * @copyright 2015 Ben Scholzen (DASPRiD)
 * @license   http://opensource.org/licenses/BSD-2-Clause Simplified BSD License
 */

namespace Bacon\Pdf\Encryption;

/**
 * Permissions as defined in table 3.20 in section 3.5.
 */
final class Permissions
{
    /**
     * @var bool
     */
    private $mayPrint;

    /**
     * @var bool
     */
    private $mayPrintHighResolution;

    /**
     * @var bool
     */
    private $mayModify;

    /**
     * @var bool
     */
    private $mayCopy;

    /**
     * @var bool
     */
    private $mayAnnotate;

    /**
     * @var bool
     */
    private $mayFillInForms;

    /**
     * @var bool
     */
    private $mayExtractForAccessibility;

    /**
     * @var bool
     */
    private $mayAssemble;

    /**
     * @param bool $mayPrint
     * @param bool $mayPrintHighResolution
     * @param bool $mayModify
     * @param bool $mayCopy
     * @param bool $mayAnnotate
     * @param bool $mayFillInForms
     * @param bool $mayExtractForAccessibility
     * @param bool $mayAssemble
     */
    public function __construct(
        $mayPrint,
        $mayPrintHighResolution,
        $mayModify,
        $mayCopy,
        $mayAnnotate,
        $mayFillInForms,
        $mayExtractForAccessibility,
        $mayAssemble
    ) {
        $this->mayPrint                   = $mayPrint;
        $this->mayPrintHighResolution     = $mayPrintHighResolution;
        $this->mayModify                  = $mayModify;
        $this->mayCopy                    = $mayCopy;
        $this->mayAnnotate                = $mayAnnotate;
        $this->mayFillInForms             = $mayFillInForms;
        $this->mayExtractForAccessibility = $mayExtractForAccessibility;
        $this->mayAssemble                = $mayAssemble;
    }

    /**
     * Creates permissions which allow nothing.
     *
     * @return self
     */
    public static function allowNothing()
    {
        return new self(false, false, false, false, false, false, false, false);
    }

    /**
     * Creates permissions which allow everything.
     *
     * @return self
     */
    public static function allowEverything()
    {
        return new self(true, true, true, true, true, true, true, true);
    }

    /**
     * Convert the permissions to am integer bit mask.
     *
     * {@internal Keep in mind that the bit positions named in the PDF reference are counted from 1, while in here they
     * are counted from 0.}}
     *
     * @param  int $revision
     * @return int
     */
    public function toInt($revision)
    {
        $bitMask = new BitMask();
        $bitMask->set(2, $this->mayPrint);
        $bitMask->set(3, $this->mayModify);
        $bitMask->set(4, $this->mayCopy);
        $bitMask->set(5, $this->mayAnnotate);

        if ($revision >= 3) {
            $bitMask->set(8, $this->mayFillInForms);
            $bitMask->set(9, $this->mayExtractForAccessibility);
            $bitMask->set(10, $this->mayAssemble);
            $bitMask->set(11, $this->mayPrintHighResolution);
        }

        return $bitMask->toInt();
    }
}