UploadSummary.php

Go to the documentation of this file.

<?php
/***************************************************************
Copyright (C) 2020 Siemens AG

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
version 2 as published by the Free Software Foundation.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ***************************************************************/
namespace Fossology\UI\Api\Models;

use Fossology\Lib\Data\UploadStatus;

class UploadSummary
{

  private $mainLicense;
  private $uniqueLicenses;
  private $uploadId;
  private $totalLicenses;
  private $uploadName;
  private $uniqueConcludedLicenses;
  private $totalConcludedLicenses;
  private $filesToBeCleared;
  private $filesCleared;
  private $clearingStatus;
  private $copyrightCount;

  public function __construct()
  {
    $this->mainLicense = null;
    $this->uniqueLicenses = 0;
    $this->uploadId = null;
    $this->totalLicenses = 0;
    $this->uploadName = null;
    $this->uniqueConcludedLicenses = 0;
    $this->totalConcludedLicenses = 0;
    $this->filesToBeCleared = 0;
    $this->filesCleared = 0;
    $this->clearingStatus = UploadStatus::OPEN;
    $this->copyrightCount = 0;
  }

  public function getJSON()
  {
    return json_encode($this->getArray());
  }

  public function getArray()
  {
    return [
      "id"                      => $this->uploadId,
      "uploadName"              => $this->uploadName,
      "mainLicense"             => $this->mainLicense,
      "uniqueLicenses"          => $this->uniqueLicenses,
      "totalLicenses"           => $this->totalLicenses,
      "uniqueConcludedLicenses" => $this->uniqueConcludedLicenses,
      "totalConcludedLicenses"  => $this->totalConcludedLicenses,
      "filesToBeCleared"        => $this->filesToBeCleared,
      "filesCleared"            => $this->filesCleared,
      "clearingStatus"          => self::statusToString($this->clearingStatus),
      "copyrightCount"          => $this->copyrightCount
    ];
  }

  public function setMainLicense($mainLicense)
  {
    $this->mainLicense = $mainLicense;
  }

  public function setUniqueLicenses($uniqueLicenses)
  {
    $this->uniqueLicenses = intval($uniqueLicenses);
  }

  public function setUploadId($uploadId)
  {
    $this->uploadId = intval($uploadId);
  }

  public function setTotalLicenses($totalLicenses)
  {
    $this->totalLicenses = intval($totalLicenses);
  }

  public function setUploadName($uploadName)
  {
    $this->uploadName = $uploadName;
  }

  public function setUniqueConcludedLicenses($uniqueConcludedLicenses)
  {
    $this->uniqueConcludedLicenses = intval($uniqueConcludedLicenses);
  }

  public function setTotalConcludedLicenses($totalConcludedLicenses)
  {
    $this->totalConcludedLicenses = intval($totalConcludedLicenses);
  }

  public function setFilesToBeCleared($filesToBeCleared)
  {
    $this->filesToBeCleared = intval($filesToBeCleared);
  }

  public function setFilesCleared($filesCleared)
  {
    $this->filesCleared = intval($filesCleared);
  }

  public function setClearingStatus($clearingStatus)
  {
    $this->clearingStatus = $clearingStatus;
  }

  public function setCopyrightCount($copyrightCount)
  {
    $this->copyrightCount = intval($copyrightCount);
  }

  public static function statusToString($status)
  {
    $string = null;
    switch ($status) {
      case UploadStatus::OPEN:
        $string = "Open";
        break;
      case UploadStatus::IN_PROGRESS:
        $string = "InProgress";
        break;
      case UploadStatus::CLOSED:
        $string = "Closed";
        break;
      case UploadStatus::REJECTED:
        $string = "Rejected";
        break;
      default:
        $string = "NA";
    }
    return $string;
  }
}