LicenseCandidate.php

Go to the documentation of this file.

<?php
/*
 SPDX-FileCopyrightText: © 2023 Siemens AG
 Author: Gaurav Mishra <mishra.gaurav@siemens.com>
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\UI\Api\Models;
 
use Fossology\UI\Api\Models\ApiVersion;
 
class LicenseCandidate
{
  private $id;
 
  private $shortname;
 
  private $spdxid;
 
  private $fullname;
 
  private $text;
 
  private $group_name;
 
  private $group_id;
 
  public function __construct($id, $shortname, $spdxid, $fullname, $text,
                              $group_name, $group_id)
  {
    $this->setId($id);
    $this->setShortname($shortname);
    $this->setSpdxId($spdxid);
    $this->setFullname($fullname);
    $this->setText($text);
    $this->setGroupName($group_name);
    $this->setGroupId($group_id);
  }
 
  public function getId(): int
  {
    return $this->id;
  }
 
  public function setId($id): void
  {
    $this->id = $id;
  }
 
  public function getShortname(): string
  {
    return $this->shortname;
  }
 
  public function setShortname($shortname): void
  {
    $this->shortname = $shortname;
  }
 
  public function getSpdxid()
  {
    return $this->spdxid;
  }
 
  public function setSpdxid($spdxid): void
  {
    $this->spdxid = $spdxid;
  }
 
  public function getFullname()
  {
    return $this->fullname;
  }
 
  public function setFullname($fullname): void
  {
    $this->fullname = $fullname;
  }
 
  public function getText()
  {
    return $this->text;
  }
 
  public function setText($text): void
  {
    $this->text = $text;
  }
 
  public function getGroupName(): string
  {
    return $this->group_name;
  }
 
  public function setGroupName($group_name): void
  {
    $this->group_name = $group_name;
  }
 
  public function getGroupId(): int
  {
    return $this->group_id;
  }
 
  public function setGroupId($group_id): void
  {
    $this->group_id = $group_id;
  }
 
  public function getArray($apiVersion = ApiVersion::V1)
  {
    if ($apiVersion == ApiVersion::V2) {
      return [
        "id"         => $this->getId(),
        "shortname"  => $this->getShortname(),
        "spdxid"     => $this->getSpdxid(),
        "fullname"   => $this->getFullname(),
        "text"       => $this->getText(),
        "groupName" => $this->getGroupName(),
        "groupId"   => $this->getGroupId()
      ];
    } else {
      return [
        "id"         => $this->getId(),
        "shortname"  => $this->getShortname(),
        "spdxid"     => $this->getSpdxid(),
        "fullname"   => $this->getFullname(),
        "text"       => $this->getText(),
        "group_name" => $this->getGroupName(),
        "group_id"   => $this->getGroupId()
      ];
    }
  }
 
  public static function createFromArray($licenseData)
  {
    return new LicenseCandidate($licenseData['rf_pk'],
      $licenseData['rf_shortname'], $licenseData['rf_spdx_id'],
      $licenseData['rf_fullname'], $licenseData['rf_text'],
      $licenseData['group_name'], $licenseData['group_pk']);
  }
 
  public static function convertDbArray($rows , $version = ApiVersion::V1)
  {
    $candidates = [];
    if (empty($rows)) {
      return $candidates;
    }
    foreach ($rows as $row) {
      $candidates[] = self::createFromArray($row)->getArray($version);
    }
    return $candidates;
  }
}