ClearingEventBuilder.php

<?php
/***********************************************************
 * Copyright (C) 2014-2018, Siemens AG
 * Author: J.Najjar
 *
 * 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\Clearing;

use Fossology\Lib\Data\LicenseRef;
use Fossology\Lib\Data\Clearing\ClearingEventTypes;

class ClearingEventBuilder
{
  private $eventId;
  private $uploadTreeId;
  private $timeStamp;
  private $userId;
  private $groupId;
  private $eventType;
  private $licenseRef;
  private $removed;
  private $reportinfo;
  private $comment;
  private $acknowledgement;

  public function __construct()
  {
    $this->eventId = 0;
    $this->uploadTreeId = 0;
    $this->timeStamp = null;
    $this->userId = 1;
    $this->groupId = 1;
    $this->eventType = ClearingEventTypes::USER;
    $this->licenseRef = null;
    $this->removed = false;
    $this->reportinfo = "";
    $this->comment = "";
    $this->acknowledgement = "";
  }

  public static function create()
  {
    return new ClearingEventBuilder();
  }

  public function build()
  {
    $clearingLicense = new ClearingLicense($this->licenseRef, $this->removed, $this->eventType, $this->reportinfo, $this->comment, $this->acknowledgement);
    return new ClearingEvent($this->eventId, $this->uploadTreeId, $this->timeStamp?: time(), $this->userId, $this->groupId, $this->eventType, $clearingLicense);
  }

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

  public function setTimeStamp($timestamp)
  {
    $this->timeStamp = $timestamp;
    return $this;
  }

  public function setEventId($eventId)
  {
    $this->eventId = intval($eventId);
    return $this;
  }

  public function setEventType($eventType)
  {
    $this->eventType = $eventType;
    return $this;
  }

  public function setGroupId($groupId)
  {
    $this->groupId = intval($groupId);
    return $this;
  }

  public function setLicenseRef(LicenseRef $licenseRef)
  {
    $this->licenseRef = $licenseRef;
    return $this;
  }

  public function setRemoved($removed)
  {
    $this->removed = $removed;
    return $this;
  }

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

  public function setAcknowledgement($acknowledgement)
  {
    $this->acknowledgement = $acknowledgement;
    return $this;
  }
  public function setUploadTreeId($uploadTreeId)
  {
    $this->uploadTreeId = intval($uploadTreeId);
    return $this;
  }

  public function setUserId($userId)
  {
    $this->userId = intval($userId);
    return $this;
  }
}