Provides helper methods to access database for REST api. More...

Collaboration diagram for Fossology\UI\Api\Helper\DbHelper:

Public Member Functions
	__construct (DbManager $dbManager, FolderDao $folderDao, UploadDao $uploadDao)

	getDbManager ()

	getUploads ($userId, $groupId, $limit, $page=1, $uploadId=null, $options=null, $recursive=true, $apiVersion=ApiVersion::V1)

	getFilenameFromUploadTree ($uploadTreePk)

	doesIdExist ($tableName, $idRowName, $id)

	deleteUser ($id)

	getUsers ($id=null)

	getJobs ($id=null, $status=null, $sort="ASC", $limit=0, $page=1, $uploadId=null, $userId=null)
	Get the recent jobs. More...

	getUserJobs ($userId=null, $status=null, $sort="ASC", $limit=0, $page=1)
	Get the recent jobs created by an user. More...

	getTokenKey ($tokenId)

	invalidateToken ($tokenId)

	insertNewTokenKey ($userId, $expire, $scope, $name, $key)

	addNewClient ($name, $userId, $clientId, $scope)

	getMaxTokenValidity ()

	getPfileInfoForUpload ($uploadId)

	getLicensesPaginated ($page, $limit, $kind, $groupId, $active)

	getLicenseCount ($kind, $groupId)

	getTokenIdFromClientId ($clientId)

Private Member Functions
	getJobStatusCteSQLStatement ()

	checkTokenNameUnique ($userId, $tokenName)

	checkTokenKeyUnique ($userId, $tokenKey)

	getFolderForUpload ($uploadId)

Private Attributes
	$dbManager

	$folderDao

	$uploadDao

Detailed Description

Provides helper methods to access database for REST api.

Definition at line 37 of file DbHelper.php.

Constructor & Destructor Documentation

◆ __construct()

Fossology\UI\Api\Helper\DbHelper::__construct	(	DbManager	$dbManager,
		FolderDao	$folderDao,
		UploadDao	$uploadDao
	)

DbHelper constructor.

Parameters

DbManager	$dbManager	DB manager in use
FolderDao	$folderDao	Folder Dao to use
UploadDao	$uploadDao	Upload Dao to use

Definition at line 64 of file DbHelper.php.

Member Function Documentation

◆ addNewClient()

Fossology\UI\Api\Helper\DbHelper::addNewClient	(	$name,
		$userId,
		$clientId,
		$scope
	)

Adds new oauth client to the user.

Parameters

string	$name	Name of the new client
integer	$userId	User PK
string	$clientId	New client ID
string	$scope	Token scope

Definition at line 489 of file DbHelper.php.

◆ checkTokenKeyUnique()

Fossology\UI\Api\Helper\DbHelper::checkTokenKeyUnique	(	$userId,
		$tokenKey
	)

private

Checks if the personal_access_tokens_token_key_ukey constraint is followed by this token.

Parameters

int	$userId	User id
string	$tokenKey	Token secret key

Returns: boolean True if the constraint is followed, false otherwise.

Definition at line 528 of file DbHelper.php.

◆ checkTokenNameUnique()

Fossology\UI\Api\Helper\DbHelper::checkTokenNameUnique	(	$userId,
		$tokenName
	)

private

Checks if the personal_access_tokens_token_name_ukey constraint is followed by this token.

Parameters

int	$userId	User id
string	$tokenName	Name of the token

Returns: boolean True if the constraint is followed, false otherwise.

Definition at line 507 of file DbHelper.php.

◆ deleteUser()

Fossology\UI\Api\Helper\DbHelper::deleteUser ( $id )

Delete the given user id

Parameters

integer $id User id to be deleted

Definition at line 239 of file DbHelper.php.

◆ doesIdExist()

Fossology\UI\Api\Helper\DbHelper::doesIdExist	(	$tableName,
		$idRowName,
		$id
	)

Check if a given id exists under given table.

Parameters

string	$tableName	Table name
string	$idRowName	ID column name
string	$id	ID to check

Returns: boolean True if id exists, false otherwise

Definition at line 227 of file DbHelper.php.

◆ getDbManager()

Fossology\UI\Api\Helper\DbHelper::getDbManager ( )

Get the DB manager

Returns: ModernDbManager

Definition at line 77 of file DbHelper.php.

◆ getFilenameFromUploadTree()

Fossology\UI\Api\Helper\DbHelper::getFilenameFromUploadTree ( $uploadTreePk )

Get first upload name under a given upload tree id

Parameters

integer $uploadTreePk Upload tree id to check.

Returns: string

Definition at line 212 of file DbHelper.php.

◆ getFolderForUpload()

Fossology\UI\Api\Helper\DbHelper::getFolderForUpload ( $uploadId )

private

Get the folder for given upload

Parameters

integer $uploadId Upload to get folder for

Returns: Folder|null Folder object if found, null otherwise

Definition at line 580 of file DbHelper.php.

◆ getJobs()

Fossology\UI\Api\Helper\DbHelper::getJobs	(	$id = `null`,
		$status = `null`,
		$sort = `"ASC"`,
		$limit = `0`,
		$page = `1`,
		$uploadId = `null`,
		$userId = `null`
	)

Get the recent jobs.

If a limit is passed, the results are trimmed. If an ID is passed, the information for the given id is only retrieved.

Parameters

integer	$id	Set to get information of only given job id
integer	$status	Set to get information of only jobs with given status
string	$sort	Set to sort the results asc or desc
integer	$limit	Set to limit the result length
integer	$page	Page number required
integer	$uploadId	Upload ID to be filtered
integer	$userId	Set to get information of only given user's ID

Returns: array[] List of jobs at first index and total number of pages at second.

Definition at line 328 of file DbHelper.php.

◆ getJobStatusCteSQLStatement()

Fossology\UI\Api\Helper\DbHelper::getJobStatusCteSQLStatement ( )

private

Generates the SQL statement for the Common Table Expression (CTE) that retrieves the jobs including their status received by the jobqueue table.

Returns: string The SQL statement for the job status CTE.

Definition at line 296 of file DbHelper.php.

◆ getLicenseCount()

Fossology\UI\Api\Helper\DbHelper::getLicenseCount	(	$kind,
		$groupId
	)

Get the count of licenses accessible by user based on group ID

Parameters

string	$kind	Which kind of licenses to look for
integer	$groupId	Group of the user

Returns: int Count of licenses

Definition at line 629 of file DbHelper.php.

◆ getLicensesPaginated()

Fossology\UI\Api\Helper\DbHelper::getLicensesPaginated	(	$page,
		$limit,
		$kind,
		$groupId,
		$active
	)

Get the licenses from database in paginated way

Parameters

integer	$page	Which page number to fetch
integer	$limit	Limit of results
string	$kind	Which kind of licenses to fetch
integer	$groupId	Group of the user
boolean	$active	True to get only active licenses

Returns: array

Definition at line 598 of file DbHelper.php.

◆ getMaxTokenValidity()

Fossology\UI\Api\Helper\DbHelper::getMaxTokenValidity ( )

Get the value for maximum API token validity from sysconfig table.

Returns: integer The value stored in DB or 30 (default).

Definition at line 546 of file DbHelper.php.

◆ getPfileInfoForUpload()

Fossology\UI\Api\Helper\DbHelper::getPfileInfoForUpload ( $uploadId )

Get all info from pfile for given upload

Parameters

integer $uploadId Upload to get info for

Returns: array|NULL Array of pfile if upload found, null otherwise

Definition at line 563 of file DbHelper.php.

◆ getTokenKey()

Fossology\UI\Api\Helper\DbHelper::getTokenKey ( $tokenId )

Get the required information to validate a token based on token id.

Parameters

int $tokenId Token id (primary key of the table).

Returns: array Returns the token_key, created_on,expire_onand user_fk` for the given token id.

Definition at line 429 of file DbHelper.php.

◆ getUploads()

Fossology\UI\Api\Helper\DbHelper::getUploads	(	$userId,
		$groupId,
		$limit,
		$page = `1`,
		$uploadId = `null`,
		$options = `null`,
		$recursive = `true`,
		$apiVersion = `ApiVersion::V1`
	)

Get the uploads under the given user id if not upload id is provided.

Get a single upload information under the given user and upload id.

Parameters

integer	$userId	User to check
integer	$groupId	Group trying to access
integer	$limit	Max number of results
integer	$page	Page to get
integer	$uploadId	Pass the upload id to check for single upload.
integer	$options	Filter options
bool	$recursive	True to recursive listing of uploads

Returns: array Total pages as first value, uploads as an array in second value

Definition at line 97 of file DbHelper.php.

◆ getUserJobs()

Fossology\UI\Api\Helper\DbHelper::getUserJobs	(	$userId = `null`,
		$status = `null`,
		$sort = `"ASC"`,
		$limit = `0`,
		$page = `1`
	)

Get the recent jobs created by an user.

If a limit is passed, the results are trimmed.

Parameters

integer	$userId	Set to get information of only given user's ID
integer	$status	Set to get information of only jobs with given status
string	$sort	Set to sort the results asc or desc
integer	$limit	Set to limit the result length
integer	$page	Page number required

Returns: array[] List of jobs at first index and total number of pages at second.

Definition at line 417 of file DbHelper.php.

◆ getUsers()

Fossology\UI\Api\Helper\DbHelper::getUsers ( $id = null )

Get the user under the given user id or every user from the database.

Parameters

integer $id User id of the required user, or NULL to fetch all users.

Returns: User[] Users as an associative array

Definition at line 252 of file DbHelper.php.

◆ insertNewTokenKey()

Fossology\UI\Api\Helper\DbHelper::insertNewTokenKey	(	$userId,
		$expire,
		$scope,
		$name,
		$key
	)

Insert a new token in the DB.

Parameters

int	$userId	User of the new token
string	$expire	When the token will expire
string	$scope	Scope of the token
string	$name	Name of the token
string	$key	Secret key of the token

Returns: array|Fossology::UI::Api::Models::Info New token id and created_on or Info on error.

Exceptions

DuplicateTokenNameException	If user already have a token with same name.
DuplicateTokenKeyException	If user already have a token with same key.

Definition at line 463 of file DbHelper.php.

◆ invalidateToken()

Fossology\UI\Api\Helper\DbHelper::invalidateToken ( $tokenId )

Mark a token as invalid/inactive.

Parameters

int $tokenId The token to be marked as invalid

Definition at line 442 of file DbHelper.php.

Member Data Documentation

◆ $dbManager

ModernDbManager Fossology\UI\Api\Helper\DbHelper::$dbManager

private

DB manager in use

Definition at line 43 of file DbHelper.php.

◆ $folderDao

FolderDao Fossology\UI\Api\Helper\DbHelper::$folderDao

private

FolderDao object

Definition at line 49 of file DbHelper.php.

◆ $uploadDao

UploadDao Fossology\UI\Api\Helper\DbHelper::$uploadDao

private

UploadDao object

Definition at line 55 of file DbHelper.php.

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

src/www/ui/api/Helper/DbHelper.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addNewClient()

◆ checkTokenKeyUnique()

◆ checkTokenNameUnique()

◆ deleteUser()

◆ doesIdExist()

◆ getDbManager()

◆ getFilenameFromUploadTree()

◆ getFolderForUpload()

◆ getJobs()

◆ getJobStatusCteSQLStatement()

◆ getLicenseCount()

◆ getLicensesPaginated()

◆ getMaxTokenValidity()

◆ getPfileInfoForUpload()

◆ getTokenKey()

◆ getUploads()

◆ getUserJobs()

◆ getUsers()

◆ insertNewTokenKey()

◆ invalidateToken()

Member Data Documentation

◆ $dbManager

◆ $folderDao

◆ $uploadDao