Application\Model\Export

Complexity

Total Complexity

23

Size/Duplication

Total Lines	262
Duplicated Lines	0 %

Test Coverage

Coverage

92.31%

Importance

Changes	1
Bugs	0	Features	0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	getCardCount()	0	3	1
A	markAsInProgress()	0	5	1
A	getBackgroundColor()	0	3	1
A	stats()	0	9	2
A	isIncludeLegend()	0	3	1
A	getMemory()	0	3	1
A	getMaxHeight()	0	3	1
A	setIncludeLegend()	0	3	1
A	getPath()	0	3	1
A	getStatus()	0	3	1
A	setMaxHeight()	0	3	1
A	getTextColor()	0	3	1
A	markAsErrored()	0	5	1
A	getFormat()	0	3	1
A	__construct()	0	4	1
A	setTextColor()	0	3	1
A	getStart()	0	3	1
A	setFormat()	0	3	1
A	markAsDone()	0	4	1
A	getDuration()	0	3	1
A	getFilename()	0	3	1
A	setBackgroundColor()	0	3	1

<?php

declare(strict_types=1);

namespace Application\Model;

use Application\DBAL\Types\ExportFormatType;
use Application\DBAL\Types\ExportStatusType;
use Application\Traits\HasFileSize;
use Application\Traits\HasSite;
use Application\Traits\HasSiteInterface;
use Cake\Chronos\Chronos;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection as DoctrineCollection;
use Doctrine\ORM\Mapping as ORM;
use GraphQL\Doctrine\Annotation as API;
use Throwable;

/**
 * An export of cards in various format
 *
 * @ORM\Entity(repositoryClass="Application\Repository\ExportRepository")
 */
class Export extends AbstractModel implements HasSiteInterface
{
    private const EXPORT_PATH = 'htdocs/export/';

    use HasSite;
    use HasFileSize;

    /**
     * Number of card exported.
     *
     * This is kept separated from cards and collection, because those could
     * be deleted and we want to keep the count of card forever.
     *
     * @var int
     *
     * @ORM\Column(type="integer", options={"default" = 0, "unsigned" = true})
     */
    private $cardCount = 0;

    /**
     * @var string
     *
     * @ORM\Column(type="string", length=2000, options={"default" = ""})
     */
    private $filename = '';

    /**
     * @var string
     *
     * @ORM\Column(type="ExportStatus", options={"default" = ExportStatusType::TODO})
     */
    private $status = ExportStatusType::TODO;

    /**
     * @var string
     *
     * @ORM\Column(type="ExportFormat", options={"default" = ExportFormatType::ZIP})
     */
    private $format = ExportFormatType::ZIP;

    /**
     * Max height of image. Zero means no max.
     *
     * @var int
     *
     * @ORM\Column(type="integer", options={"default" = 0, "unsigned" = true})
     */
    private $maxHeight = 0;

    /**
     * @var bool
     * @ORM\Column(type="boolean", options={"default" = true})
     */
    private $includeLegend = true;

    /**
     * @var string
     * @ORM\Column(type="string", options={"default" = "#FFFFFF"})
     */
    private $textColor = '#FFFFFF';

    /**
     * @var string
     * @ORM\Column(type="string", options={"default" = "#000000"})
     */
    private $backgroundColor = '#000000';

    /**
     * Start time of export process
     *
     * @var null|Chronos
     * @ORM\Column(type="datetime", nullable=true)
     */
    private $start;

    /**
     * Duration of export process in seconds
     *
     * @var null|int
     * @ORM\Column(type="integer", nullable=true, options={"unsigned" = true})
     */
    private $duration;

    /**
     * Peak memory usage in MiB
     *
     * @var null|int
     * @ORM\Column(type="integer", nullable=true, options={"unsigned" = true})
     */
    private $memory;

    /**
     * @ORM\Column(type="string", length=2000, options={"default" = ""})
     */
    private string $errorMessage = '';

    /**
     * The collections exported. This is only for informative purpose and only `cards`
     * contains the real cards that will be exported.
     *
     * @var DoctrineCollection
     *
     * @ORM\ManyToMany(targetEntity="Collection")
     */
    private $collections;

    /**
     * All cards to export, either picked one-by-one, or selected via a collection.
     *
     * @var DoctrineCollection
     *
     * @ORM\ManyToMany(targetEntity="Card")
     */
    private $cards;

    public function __construct()
    {
        $this->collections = new ArrayCollection();
        $this->cards = new ArrayCollection();
    }

    public function getCardCount(): int
    {
        return $this->cardCount;
    }

    /**
     * Get absolute path to export on disk
     *
     * @API\Exclude
     */
    public function getPath(): string
    {
        return realpath('.') . '/' . self::EXPORT_PATH . $this->getFilename();
    }

    public function getFilename(): string
    {
        return $this->filename;
    }

    /**
     * @API\Field(type="ExportStatus")
     */
    public function getStatus(): string
    {
        return $this->status;
    }

    public function markAsInProgress(string $filename): void
    {
        $this->status = ExportStatusType::IN_PROGRESS;
        $this->start = new Chronos();
        $this->filename = $filename;
    }

    public function markAsDone(): void
    {
        $this->status = ExportStatusType::DONE;
        $this->stats();
    }

    public function markAsErrored(Throwable $throwable): void
    {
        $this->status = ExportStatusType::ERRORED;
        $this->errorMessage = $throwable->getMessage();
        $this->stats();
    }

    private function stats(): void
    {
        $now = new Chronos();
        $this->duration = $now->getTimestamp() - $this->start->getTimestamp();

The method getTimestamp() does not exist on null.

        $this->memory = (int) round(memory_get_peak_usage() / 1024 / 1024);

        $path = $this->getPath();
        if (is_readable($path)) {
            $this->fileSize = filesize($path);
        }
    }

    /**
     * @API\Field(type="ExportFormat")
     */
    public function getFormat(): string
    {
        return $this->format;
    }

    /**
     * @API\Input(type="ExportFormat")
     */
    public function setFormat(string $format): void
    {
        $this->format = $format;
    }

    public function getMaxHeight(): int
    {
        return $this->maxHeight;
    }

    public function setMaxHeight(int $maxHeight): void
    {
        $this->maxHeight = $maxHeight;
    }

    public function isIncludeLegend(): bool
    {
        return $this->includeLegend;
    }

    public function setIncludeLegend(bool $includeLegend): void
    {
        $this->includeLegend = $includeLegend;
    }

    /**
     * @API\Field(type="Color")
     */
    public function getTextColor(): string
    {
        return $this->textColor;
    }

    /**
     * @API\Input(type="Color")
     */
    public function setTextColor(string $textColor): void
    {
        $this->textColor = $textColor;
    }

    /**
     * @API\Field(type="Color")
     */
    public function getBackgroundColor(): string
    {
        return $this->backgroundColor;
    }

    /**
     * @API\Input(type="Color")
     */
    public function setBackgroundColor(string $backgroundColor): void
    {
        $this->backgroundColor = $backgroundColor;
    }

    public function getStart(): ?Chronos
    {
        return $this->start;
    }

    public function getDuration(): ?int
    {
        return $this->duration;
    }

    public function getMemory(): ?int
    {
        return $this->memory;
    }
}