<?php

/*
 * This file is part of the Maestro Project.
 * Copyright (C) Compos Juliot
 */

namespace App\Application\Message;

/**
 * [Represents a message about the generated archive that we want to send to the system that will manage the queues].
 */
class GenerationNotificationMessage
{
    /** @var int */
    private int $pageId;

    /** @var int */
    private int $generationType;

    /** @var string */
    private string $generationInLocation;

    /** @var string */
    private string $generationOutLocation;

    /** @var int */
    private int $userId;

    /** @var int */
    private int $projectId;

    /** @var int */
    private int $exportId;

    /** @var int|null */
    private $pageDuplicateId;

    /** @var int|null */
    private $version;

    /** @var string */
    private $dirName;

    /** @var string|null */
    private $token;

    public function __construct(int $pageId, int $generationType, string $generationInLocation, string $generationOutLocation, int $userId, int $projectId, int $exportId, ?int $pageDuplicateId, ?int $version, string $dirName, ?string $token)
    {
        $this->pageId = $pageId;
        $this->generationType = $generationType;
        $this->generationInLocation = $generationInLocation;
        $this->generationOutLocation = $generationOutLocation;
        $this->userId = $userId;
        $this->projectId = $projectId;
        $this->exportId = $exportId;
        $this->pageDuplicateId = $pageDuplicateId;
        $this->version = $version;
        $this->dirName = $dirName;
        $this->token = $token;
    }

    /**
     * @return int [CDF page's id]
     */
    public function getPageId(): int
    {
        return $this->pageId;
    }

    /**
     * @return int [Ex : 0 = low def, 1 = high def, 2 = package, etc ...]
     */
    public function getGenerationType(): int
    {
        return $this->generationType;
    }

    /**
     * @return string [generation in location (ex : /var/www/html/generation/in/ProjectID_ExportID_PageID_Folio_Time/)]
     */
    public function getGenerationInLocation(): string
    {
        return $this->generationInLocation;
    }

    /**
     * @return string [generation out location (ex : /var/www/html/generation/out/ProjectID_ExportID_PageID_Folio_Time/)]
     */
    public function getGenerationOutLocation(): string
    {
        return $this->generationOutLocation;
    }

    /**
     * @return int [User's id to send in Mercure hub]
     */
    public function getUserId(): int
    {
        return $this->userId;
    }

    /**
     * @return int [Project's id to send in Mercure hub]
     */
    public function getProjectId(): int
    {
        return $this->projectId;
    }

    /**
     * @return int [Export's id to send in Mercure hub]
     */
    public function getExportId(): int
    {
        return $this->exportId;
    }

    /**
     * @return int|null [Export's page duplicate id to send in Mercure hub]
     */
    public function getPageDuplicateId(): ?int
    {
        return $this->pageDuplicateId;
    }

    /**
     * @return int|null [Export's version to send in Mercure hub]
     */
    public function getVersion(): ?int
    {
        return $this->version;
    }

    /**
     * @return string [Export's dirName to send in Mercure hub (for package)]
     */
    public function getDirName(): string
    {
        return $this->dirName;
    }

    /**
     * @return string|null [Export's token to call notification provider (for package)]
     */
    public function getToken(): ?string
    {
        return $this->token;
    }
}