FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\UI\Api\Helper\FileHelper Class Reference

Handle file related queries. More...

Collaboration diagram for Fossology\UI\Api\Helper\FileHelper:
Collaboration graph

Public Member Functions

 __construct (PfileDao $pfileDao)
 
 getPfile ($hash)
 
 pfileScannerFindings ($pfileId)
 
 pfileConclusions ($groupId, $pfileId)
 
 getPackageUpload ($pfileId)
 
 pfileCopyright ($pfileId)
 

Private Attributes

 $pfileDao
 

Detailed Description

Handle file related queries.

Definition at line 22 of file FileHelper.php.

Constructor & Destructor Documentation

◆ __construct()

Fossology\UI\Api\Helper\FileHelper::__construct ( PfileDao  $pfileDao)

Constructor for FileHelper

Parameters
PfileDao$pfileDao

Definition at line 35 of file FileHelper.php.

Member Function Documentation

◆ getPackageUpload()

Fossology\UI\Api\Helper\FileHelper::getPackageUpload (   $pfileId)

Get the uploads where the pfile was uploaded as package

Parameters
integer$pfileIdPfileid to search from
Returns
array|NULL Array of uploads or NULL if not found
See also
Fossology::Lib::Dao::PfileDao::getUploadForPackage()

Definition at line 85 of file FileHelper.php.

◆ getPfile()

Fossology\UI\Api\Helper\FileHelper::getPfile (   $hash)

Get the pfile info for given Hash

Parameters
Hash$hashHash to get pfile info from
Returns
array|NULL
See also
Fossology::Lib::Dao::PfileDao::getPfile()

Definition at line 47 of file FileHelper.php.

◆ pfileConclusions()

Fossology\UI\Api\Helper\FileHelper::pfileConclusions (   $groupId,
  $pfileId 
)

Get the conclusions for given pfile done by given group

Parameters
integer$groupIdGroup to filter conclusions from
integer$pfileIdPfile to get conclusions for
Returns
array List of licenses concluded
See also
Fossology::Lib::Dao::PfileDao::getConclusions()

Definition at line 73 of file FileHelper.php.

◆ pfileCopyright()

Fossology\UI\Api\Helper\FileHelper::pfileCopyright (   $pfileId)

Get the copyright for given pfile

Parameters
integer$pfileIdPfileId to get copyright for
Returns
array List of copyrights found
See also
Fossology::Lib::Dao::PfileDao::getCopyright()

Definition at line 97 of file FileHelper.php.

◆ pfileScannerFindings()

Fossology\UI\Api\Helper\FileHelper::pfileScannerFindings (   $pfileId)

Get the scanner findings for given pfile

Parameters
integer$pfileIdPfileId to get licenses from
Returns
array List of licenses found
See also
Fossology::Lib::Dao::PfileDao::getScannerFindings()

Definition at line 60 of file FileHelper.php.

Member Data Documentation

◆ $pfileDao

PfileDao Fossology\UI\Api\Helper\FileHelper::$pfileDao
private

Pfile Dao object

Definition at line 28 of file FileHelper.php.


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