License.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2021 HH Partners
 
 SPDX-License-Identifier: GPL-2.0-only
*/
namespace Fossology\UI\Api\Models;
 
class License
{
  const ALLOWED_KEYS = ['shortName', 'fullName', 'text', 'url', 'risk',
    'isCandidate', 'mergeRequest'];
  private $id;
  private $shortName;
  private $fullName;
  private $text;
  private $url;
  private $obligations;
  private $risk;
  private $isCandidate;
  private $mergeRequest;
 
  public function __construct(
    $id,
    $shortName = "",
    $fullName = "",
    $text = "",
    $url = "",
    $obligations = null,
    $risk = null,
    $isCandidate = false
  )
  {
    $this->id = intval($id);
    $this->setShortName($shortName);
    $this->setFullName($fullName);
    $this->setText($text);
    $this->setUrl($url);
    $this->setObligations($obligations);
    $this->setRisk($risk);
    $this->setIsCandidate($isCandidate);
    $this->mergeRequest = false;
  }
 
  public function getJSON()
  {
    return json_encode($this->getArray());
  }
 
  public function getArray()
  {
    $data = [
      'id' => $this->getId(),
      'shortName' => $this->getShortName(),
      'fullName' => $this->getFullName(),
      'text' => $this->getText(),
      'url' => $this->getUrl(),
      'risk' => $this->getRisk(),
      'isCandidate' => $this->getIsCandidate()
    ];
    if ($this->obligations !== null) {
      $data['obligations'] = $this->getObligations();
    }
    return $data;
  }
 
  public function getId()
  {
    return $this->id;
  }
 
  public function getShortName()
  {
    if ($this->shortName === null) {
      return "";
    }
    return $this->shortName;
  }
 
  public function getFullName()
  {
    if ($this->fullName === null) {
      return "";
    }
    return $this->fullName;
  }
 
  public function getText()
  {
    if ($this->text === null) {
      return "";
    }
    return $this->text;
  }
 
  public function getUrl()
  {
    if ($this->url === null) {
      return "";
    }
    return $this->url;
  }
 
  public function getRisk()
  {
    return $this->risk;
  }
 
  public function getIsCandidate()
  {
    return $this->isCandidate;
  }
 
  public function getObligations()
  {
    $obligationList = [];
    foreach ($this->obligations as $obligation) {
      $obligationList[] = $obligation->getArray();
    }
    return $obligationList;
  }
 
  public function getMergeRequest()
  {
    return $this->mergeRequest;
  }
 
  public function setShortName($shortName)
  {
    $this->shortName = convertToUTF8($shortName, false);
  }
 
  public function setFullName($fullName)
  {
    $this->fullName = convertToUTF8($fullName, false);
  }
 
  public function setText($text)
  {
    $this->text = convertToUTF8($text, false);
  }
 
  public function setUrl($url)
  {
    $this->url = convertToUTF8($url, false);
  }
 
  public function setRisk($risk)
  {
    // invtval returns 0 for null, so check for nullness to preserve the
    // difference in the response.
    if (!is_null($risk)) {
      $this->risk = intval($risk);
    } else {
      $this->risk = $risk;
    }
  }
 
  public function setIsCandidate($isCandidate)
  {
    $this->isCandidate = filter_var($isCandidate, FILTER_VALIDATE_BOOLEAN);
  }
 
  public function setObligations($obligations)
  {
    if (is_array($obligations)) {
      $this->obligations = [];
    } elseif ($obligations === null) {
      $this->obligations = null;
      return;
    }
    foreach ($obligations as $obligation) {
      $this->addObligation($obligation);
    }
  }
 
  public function addObligation($obligation)
  {
    if ($this->obligations === null) {
      $this->obligations = [];
    }
    $this->obligations[] = $obligation;
  }
 
  public function setMergeRequest($mergeRequest)
  {
    $this->mergeRequest = filter_var($mergeRequest, FILTER_VALIDATE_BOOLEAN);
  }
 
  public static function parseFromArray($inputLicense)
  {
    $inputKeys = array_keys($inputLicense);
    $intersectKeys = array_intersect($inputKeys, self::ALLOWED_KEYS);
    if (count($inputKeys) > 0 && count($intersectKeys) != count($inputKeys)) {
      return -1;
    }
    if (array_search('shortName', $inputKeys) === false) {
      return -2;
    }
    $newLicense = new License(0);
    if (array_key_exists('shortName', $inputLicense)) {
      $newLicense->setShortName($inputLicense['shortName']);
    }
    if (array_key_exists('fullName', $inputLicense)) {
      $newLicense->setFullName($inputLicense['fullName']);
    }
    if (array_key_exists('text', $inputLicense)) {
      $newLicense->setText($inputLicense['text']);
    }
    if (array_key_exists('url', $inputLicense)) {
      $newLicense->setUrl($inputLicense['url']);
    }
    if (array_key_exists('risk', $inputLicense)) {
      $newLicense->setRisk($inputLicense['risk']);
    }
    if (array_key_exists('isCandidate', $inputLicense)) {
      $newLicense->setIsCandidate($inputLicense['isCandidate']);
    }
    if (array_key_exists('mergeRequest', $inputLicense)) {
      $newLicense->setMergeRequest($inputLicense['mergeRequest']);
    }
    return $newLicense;
  }
}