FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\ReportImport\ReportImportAgent Class Reference
Inheritance diagram for Fossology\ReportImport\ReportImportAgent:
Inheritance graph
Collaboration diagram for Fossology\ReportImport\ReportImportAgent:
Collaboration graph

Public Member Functions

 processUploadId ($uploadId)
 Given an upload ID, process the items in it. More...
 
- Public Member Functions inherited from Fossology\Lib\Agent\Agent
 __construct ($agentName, $version, $revision)
 
 scheduler_connect ()
 Connect with scheduler and initialize options. More...
 
 heartbeat ($newProcessed)
 Send hear beat to the scheduler. More...
 
 bail ($exitvalue)
 Bail the agent, print the stack and disconnect from scheduler. More...
 
 scheduler_disconnect ($exitvalue)
 Closes connection from scheduler. More...
 
 scheduler_greet ()
 Greet the scheduler at the beginning of connection. More...
 
 initArsTable ()
 Initialize ARS table.
 
 run_scheduler_event_loop ()
 Runs a loop to read commands from scheduler and process them. More...
 

Public Attributes

const REPORT_KEY = "report"
 
const ACLA_KEY = "addConcludedAsDecisions"
 

Protected Attributes

 $dbManager
 
 $licenseDao
 
 $clearingDao
 
 $agent_pk
 
- Protected Attributes inherited from Fossology\Lib\Agent\Agent
 $userId
 
 $groupId
 
 $jobId
 
 $agentSpecifOptions = ""
 
 $agentSpecifLongOptions = array()
 
 $args = array()
 
 $dbManager
 
 $agentDao
 
 $container
 
 $schedulerMode
 

Private Member Functions

 setAgent_PK ()
 
 getImportSource ($reportFilename)
 

Static Private Member Functions

static preWorkOnArgsFlp (&$args, $longArgsKey)
 
static getEntries ($fileId, $fileName, &$pfilePerFileName, &$hashMap=NULL, &$pfilesPerHash=NULL, $hashAlgo="sha1")
 
static getEntriesForFilename ($filename, &$pfilesPerFileName)
 
static getEntriesForHash (&$hashMap, &$pfilesPerHash, $hashAlgo)
 

Private Attributes

 $uploadDao
 
 $userDao
 
 $copyrightDao
 

Additional Inherited Members

- Static Public Member Functions inherited from Fossology\Lib\Agent\Agent
static heartbeat_handler ($signo)
 Function to handle hear beats from the agent and send them to the scheduler from STDOUT. More...
 

Detailed Description

Definition at line 27 of file ReportImportAgent.php.

Member Function Documentation

◆ getImportSource()

Fossology\ReportImport\ReportImportAgent::getImportSource (   $reportFilename)
private
Parameters
string$reportFilename
Returns
SpdxTwoImportSource|XmlImportSource
Exceptions

Definition at line 226 of file ReportImportAgent.php.

◆ preWorkOnArgsFlp()

static Fossology\ReportImport\ReportImportAgent::preWorkOnArgsFlp ( $args,
  $longArgsKey 
)
staticprivate
Parameters
string[]$args
string$longArgsKeyDuplicate of function in file ../../spdx2/agent/spdx2utils.php

Definition at line 83 of file ReportImportAgent.php.

◆ processUploadId()

Fossology\ReportImport\ReportImportAgent::processUploadId (   $uploadId)

Given an upload ID, process the items in it.

This function is implemented by agent and should call heartbeat() at regular intervals.

Parameters
int$uploadIdUpload to be processed by the agent.
Returns
bool Process status

Reimplemented from Fossology\Lib\Agent\Agent.

Definition at line 108 of file ReportImportAgent.php.


The documentation for this class was generated from the following file: