UploadResult.php

Go to the documentation of this file.

<?php

namespace ILIAS\FileUpload\DTO;

use ILIAS\FileUpload\Collection\ImmutableStringMap;
use ILIAS\FileUpload\ScalarTypeCheckAware;

/******************************************************************************
 *
 * This file is part of ILIAS, a powerful learning management system.
 *
 * ILIAS is licensed with the GPL-3.0, you should have received a copy
 * of said license along with the source code.
 *
 * If this is not the case or you just want to try ILIAS, you'll find
 * us at:
 *      https://www.ilias.de
 *      https://github.com/ILIAS-eLearning
 *
 *****************************************************************************/
final class UploadResult
{
    use ScalarTypeCheckAware;
    private string $name;
    private int $size;
    private string $mimeType;
    private ImmutableStringMap $metaData;
    private ProcessingStatus $status;
    private string $path;


    public function __construct(string $name, int $size, string $mimeType, ImmutableStringMap $metaData, ProcessingStatus $status, string $path)
    {
        $this->stringTypeCheck($name, "name");
        $this->stringTypeCheck($mimeType, "mimeType");
        $this->stringTypeCheck($path, "path");
        $this->intTypeCheck($size, "size");

        $this->name = $name;
        $this->size = $size;
        $this->mimeType = $mimeType;
        $this->metaData = $metaData;
        $this->status = $status;
        $this->path = $path;
    }


    public function getName(): string
    {
        return $this->name;
    }


    public function getSize(): int
    {
        return $this->size;
    }


    public function getMimeType(): string
    {
        return $this->mimeType;
    }


    public function getMetaData(): ImmutableStringMap
    {
        return $this->metaData;
    }


    public function getStatus(): ProcessingStatus
    {
        return $this->status;
    }


    public function isOK(): bool
    {
        return $this->status->getCode() === ProcessingStatus::OK;
    }


    public function getPath(): string
    {
        return $this->path;
    }
}