Obligation.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2021 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
namespace Fossology\UI\Api\Models;
 
class Obligation
{
  private $id;
  private $topic;
  private $type;
  private $text;
  private $classification;
  private $comment;
  private $modification;
  private $active;
  private $textUpdatable;
  private $hash;
  private $licenses;
  private $candidateLicenses;
  private $extended;
 
  public function __construct($id, $topic = "", $type = "", $text = "",
    $classification = "", $comment = "", $extended = false)
  {
    $this->id = intval($id);
    $this->setTopic($topic);
    $this->setType($type);
    $this->setText($text);
    $this->setClassification($classification);
    $this->setComment($comment);
    $this->setExtended($extended);
    $this->setHash(null);
    $this->licenses = [];
    $this->candidateLicenses = [];
  }
 
  public function getJSON()
  {
    return json_encode($this->getArray());
  }
 
  public function getArray()
  {
    $obligation = [
      'id' => $this->id,
      'topic' => $this->getTopic(),
      'type' => $this->getType(),
      'text' => $this->getText(),
      'classification' => $this->getClassification(),
      'comment' => $this->getComment()
    ];
    if ($this->getExtended()) {
      $obligation['modification'] = $this->isModification();
      $obligation['active'] = $this->isActive();
      $obligation['textUpdatable'] = $this->isTextUpdatable();
      $obligation['licenses'] = $this->getLicenses();
      $obligation['candidateLicenses'] = $this->getCandidateLicenses();
      $obligation['hash'] = $this->getHash();
    }
    return $obligation;
  }
 
  public function getTopic()
  {
    if ($this->topic === null) {
      return "";
    }
    return $this->topic;
  }
 
  public function getType()
  {
    if ($this->type === null) {
      return "";
    }
    return $this->type;
  }
 
  public function getText()
  {
    if ($this->text === null) {
      return "";
    }
    return $this->text;
  }
 
  public function getClassification()
  {
    if ($this->classification === null) {
      return "";
    }
    return $this->classification;
  }
 
  public function getComment()
  {
    if ($this->comment === null) {
      return "";
    }
    return $this->comment;
  }
 
  public function isModification()
  {
    return $this->modification == true;
  }
 
  public function isTextUpdatable()
  {
    return $this->textUpdatable == true;
  }
 
  public function isActive()
  {
    return $this->active == true;
  }
 
  public function getHash()
  {
    return $this->hash;
  }
 
  public function getLicenses()
  {
    return $this->licenses;
  }
 
  public function getCandidateLicenses()
  {
    return $this->candidateLicenses;
  }
 
  public function getExtended()
  {
    return $this->extended;
  }
 
  public function setTopic($topic)
  {
    $this->topic = convertToUTF8($topic, false);
  }
 
  public function setType($type)
  {
    $this->type = convertToUTF8($type, false);
  }
 
  public function setText($text)
  {
    $this->text = convertToUTF8($text, false);
  }
 
  public function setClassification($classification)
  {
    $this->classification = convertToUTF8($classification, false);
  }
 
  public function setComment($comment)
  {
    $this->comment = convertToUTF8($comment, false);
  }
 
  public function setModification($modification)
  {
    if ($modification == "t") {
      $modification = true;
    }
    $this->modification = filter_var($modification, FILTER_VALIDATE_BOOLEAN);
  }
 
  public function setTextUpdatable($textUpdatable)
  {
    if ($textUpdatable == "t") {
      $textUpdatable = true;
    }
    $this->textUpdatable = filter_var($textUpdatable, FILTER_VALIDATE_BOOLEAN);
  }
 
  public function setActive($active)
  {
    if ($active == "t") {
      $active = true;
    }
    $this->active = filter_var($active, FILTER_VALIDATE_BOOLEAN);
  }
 
  public function setHash($hash)
  {
    $this->hash = $hash;
  }
 
  public function addLicense($shortname)
  {
    if (empty($shortname)) {
      return;
    }
    $this->licenses[] = $shortname;
  }
 
  public function addCandidateLicense($shortname)
  {
    if (empty($shortname)) {
      return;
    }
    $this->candidateLicenses[] = $shortname;
  }
 
  public function setExtended($extended)
  {
    $this->extended = filter_var($extended, FILTER_VALIDATE_BOOLEAN);
  }
 
  public static function fromArray($db, $extended, $licenses, $candidateLicenses)
  {
    $obligation = new Obligation($db['ob_pk'], $db['ob_topic'], $db['ob_type'],
      $db['ob_text'], $db['ob_classification'], $db['ob_comment'], $extended);
    if ($extended) {
      $obligation->setModification($db['ob_modifications']);
      $obligation->setActive($db['ob_active']);
      $obligation->setTextUpdatable($db['ob_text_updatable']);
      $obligation->setHash($db['ob_md5']);
      foreach ($licenses as $license) {
        $obligation->addLicense($license);
      }
      foreach ($candidateLicenses as $candidateLicense) {
        $obligation->addCandidateLicense($candidateLicense);
      }
    }
    return $obligation;
  }
}