Platine\PDF\PDF

Complexity

Total Complexity

15

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	setGenerator()	0	4	1
A	__construct()	0	2	1
A	getGenerator()	0	3	1
A	getOrientation()	0	3	1
A	setContent()	0	4	1
A	getFilename()	0	3	1
A	setFormat()	0	4	1
A	getContent()	0	3	1
A	raw()	0	3	1
A	generate()	0	10	1
A	setOrientation()	0	4	1
A	download()	0	3	1
A	getFormat()	0	3	1
A	setFilename()	0	4	1
A	save()	0	3	1

<?php

/**
 * Platine PDF
 *
 * Platine PDF is the lightweight for generating PDF documents
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine PDF
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file PDF.php
 *
 *  The PDF main class.
 *
 *  @package    Platine\PDF
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\PDF;

/**
 * @class PDF
 * @package Platine\PDF
 */
class PDF
{
    /**
     * The content to use to generate PDF document
     * @var string
     */
    protected string $content = '';

    /**
     * The PDF generated filename
     * @var string
     */
    protected string $filename = 'output.pdf';

    /**
     * The PDF document paper type like 'A4', 'A5', 'letter', etc.
     * @var string
     */
    protected string $format = 'A4';

    /**
     * The PDF document orientation like 'portrait', 'landscape'
     * @var string
     */
    protected string $orientation = 'portrait';

    /**
     * Create new instance
     *
     * @param PDFGeneratorInterface $generator
     */
    public function __construct(protected PDFGeneratorInterface $generator)
    {
    }

    /**
     * Return the generator
     * @return PDFGeneratorInterface
     */
    public function getGenerator(): PDFGeneratorInterface
    {
        return $this->generator;
    }

    /**
     * Set the generator
     * @param PDFGeneratorInterface $generator
     * @return $this
     */
    public function setGenerator(PDFGeneratorInterface $generator): self
    {
        $this->generator = $generator;
        return $this;
    }

    /**
     * Return the content
     * @return string
     */
    public function getContent(): string
    {
        return $this->content;
    }

    /**
     * Return the filename
     * @return string
     */
    public function getFilename(): string
    {
        return $this->filename;
    }

    /**
     * Return the format
     * @return string
     */
    public function getFormat(): string
    {
        return $this->format;
    }

    /**
     * Return the orientation
     * @return string
     */
    public function getOrientation(): string
    {
        return $this->orientation;
    }

    /**
     * Set the content
     * @param string $content
     * @return $this
     */
    public function setContent(string $content): self
    {
        $this->content = $content;
        return $this;
    }

    /**
     * Set the filename
     * @param string $filename
     * @return $this
     */
    public function setFilename(string $filename): self
    {
        $this->filename = $filename;
        return $this;
    }

    /**
     * Set the format
     * @param string $format
     * @return $this
     */
    public function setFormat(string $format): self
    {
        $this->format = $format;
        return $this;
    }

    /**
     * Set the orientation
     * @param string $orientation
     * @return $this
     */
    public function setOrientation(string $orientation): self
    {
        $this->orientation = $orientation;
        return $this;
    }

    /**
     * Generate the PDF document
     * @return $this
     */
    public function generate(): self
    {
        $this->generator->generate(
            $this->content,
            $this->filename,
            $this->format,
            $this->orientation
        );

        return $this;
    }

    /**
     * Return the content of the generated PDF document as string
     * @return string
     */
    public function raw(): string
    {
        return $this->generator->raw();
    }

    /**
     * Download the generated PDF document
     * @return void
     */
    public function download(): void
    {
        $this->generator->download();
    }

    /**
     * Save the content of the generated PDF document on
     * the file system, etc.
     * @return void
     */
    public function save(): void
    {
        $this->generator->save();
    }
}