ClearingDecision.php

<?php
/*
Copyright (C) 2014-2018, Siemens AG
Author: Johannes Najjar, Steffen Weber

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\Lib\Data;

use Fossology\Lib\Data\Clearing\ClearingEvent;
use Fossology\Lib\Data\Clearing\ClearingLicense;

class ClearingDecision
{
  private $sameFolder;
  private $clearingEvents;
  private $clearingId;
  private $uploadTreeId;
  private $pfileId;
  private $userName;
  private $userId;
  private $type;
  private $comment;
  private $reportinfo;
  private $acknowledgement;
  private $scope;
  private $timeStamp;

  public function __construct($sameFolder, $clearingId, $uploadTreeId, $pfileId, $userName, $userId, $type, $scope, $ts_added, $clearingEvents, $comment = "", $reportinfo = "", $acknowledgement = "")
  {
    $this->sameFolder = $sameFolder;
    $this->clearingId = $clearingId;
    $this->uploadTreeId = $uploadTreeId;
    $this->pfileId = $pfileId;
    $this->userName = $userName;
    $this->userId = $userId;
    $this->type = $type;
    $this->scope = $scope;
    $this->timeStamp = $ts_added;
    $this->comment = $comment;
    $this->reportinfo = $reportinfo;
    $this->acknowledgement = $acknowledgement;
    $this->clearingEvents = $clearingEvents;
  }

  public function getClearingId()
  {
    return $this->clearingId;
  }

  public function getComment()
  {
    return $this->comment;
  }

  public function getTimeStamp()
  {
    return $this->timeStamp;
  }

  public function getClearingLicenses()
  {
    $clearingLicenses = array();
    foreach ($this->clearingEvents as $clearingEvent) {
      $clearingLicenses[] = $clearingEvent->getClearingLicense();
    }
    return $clearingLicenses;
  }

  public function getPositiveLicenses()
  {
    $result = array();
    foreach ($this->clearingEvents as $clearingEvent) {
      $clearingLicense = $clearingEvent->getClearingLicense();
      if (! $clearingLicense->isRemoved()) {
        $result[] = $clearingLicense->getLicenseRef();
      }
    }

    return $result;
  }

  public function getClearingEvents()
  {
    return $this->clearingEvents;
  }

  public function getPfileId()
  {
    return $this->pfileId;
  }

  public function getReportinfo()
  {
    return $this->reportinfo;
  }

  public function getAcknowledgement()
  {
    return $this->acknowledgement;
  }

  public function getSameFolder()
  {
    return $this->sameFolder;
  }

  public function getScope()
  {
    return $this->scope;
  }

  public function getType()
  {
    return $this->type;
  }

  public function getUploadTreeId()
  {
    return $this->uploadTreeId;
  }

  public function getUserId()
  {
    return $this->userId;
  }

  public function getUserName()
  {
    return $this->userName;
  }

  public function isInScope()
  {
    switch ($this->getScope()) {
      case 'global':
        return true;
      case 'upload':
        return $this->sameFolder;
    }
    return false;
  }

  function __toString()
  {
    $output = "ClearingDecision(#" . $this->clearingId . ", ";

    foreach ($this->clearingLicenses as $clearingLicense) {
      $output .= ($clearingLicense->isRemoved() ? "-" : ""). $clearingLicense->getShortName() . ", ";
    }

    return $output . $this->getUserName() . ")";
  }
}