Fossology\UI\Api\Helper\DbHelper Class Reference

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

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

Public Member Functions
	__construct (DbManager $dbManager)
	getDbManager ()
	getUploads ($userId, $uploadId=null)
	getFilenameFromUploadTree ($uploadTreePk)
	doesIdExist ($tableName, $idRowName, $id)
	deleteUser ($id)
	getUsers ($id=null)
	getJobs ($id=null, $limit=0, $page=1, $uploadId=null)
	Get the recent jobs. More...
	getTokenKey ($tokenId)
	invalidateToken ($tokenId)
	insertNewTokenKey ($userId, $expire, $scope, $name, $key)
	getMaxTokenValidity ()

Private Member Functions
	checkTokenNameUnique ($userId, $tokenName)
	checkTokenKeyUnique ($userId, $tokenKey)

Private Attributes
	$dbManager

Detailed Description

Provides helper methods to access database for REST api.

Definition at line 43 of file DbHelper.php.

Constructor & Destructor Documentation

Fossology\UI\Api\Helper\DbHelper::__construct

(

DbManager

$dbManager

)

DbHelper constructor.

Parameters

DbManager

$dbManager

DB manager in use

Definition at line 56 of file DbHelper.php.

Member Function Documentation

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 361 of file DbHelper.php.

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 340 of file DbHelper.php.

Fossology\UI\Api\Helper\DbHelper::deleteUser

(

$id

)

Delete the given user id

Parameters

integer

$id

User id to be deleted

Definition at line 151 of file DbHelper.php.

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 140 of file DbHelper.php.

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

(

)

Get the DB manager

Returns

ModernDbManager

Definition at line 66 of file DbHelper.php.

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 125 of file DbHelper.php.

Fossology\UI\Api\Helper\DbHelper::getJobs	(		$id = null,
			$limit = 0,
			$page = 1,
			$uploadId = 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	$limit	Set to limit the result length
integer	$page	Page number required
integer	$uploadId	Upload ID to be filtered

Returns

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

Definition at line 215 of file DbHelper.php.

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 379 of file DbHelper.php.

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 280 of file DbHelper.php.

Fossology\UI\Api\Helper\DbHelper::getUploads	(		$userId,
			$uploadId = null
	)

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	$uploadId	Pass the upload id to check for single upload.

Returns

Upload[][] Uploads as an associative array

Definition at line 80 of file DbHelper.php.

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 164 of file DbHelper.php.

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 314 of file DbHelper.php.

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 293 of file DbHelper.php.

Member Data Documentation

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

private

DB manager in use

Definition at line 49 of file DbHelper.php.

---

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

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