Inheritance diagram for Fossology\UI\Api\Controllers\CopyrightController:

Collaboration diagram for Fossology\UI\Api\Controllers\CopyrightController:

Public Member Functions
	__construct ($container)

	getFileCopyrights ($request, $response, $args)

	getFileEmail ($request, $response, $args)

	getFileUrl ($request, $response, $args)

	getFileAuthor ($request, $response, $args)

	getFileEcc ($request, $response, $args)

	getFileKeyword ($request, $response, $args)

	getFileIpra ($request, $response, $args)

	deleteFileCopyright ($request, $response, $args)

	deleteFileEmail ($request, $response, $args)

	deleteFileUrl ($request, $response, $args)

	deleteFileAuthor ($request, $response, $args)

	deleteFileEcc ($request, $response, $args)

	deleteFileKeyword ($request, $response, $args)

	deleteFileIpra ($request, $response, $args)

	updateFileCopyright ($request, $response, $args)

	updateFileEmail ($request, $response, $args)

	updateFileUrl ($request, $response, $args)

	updateFileAuthor ($request, $response, $args)

	updateFileEcc ($request, $response, $args)

	updateFileKeyword ($request, $response, $args)

	updateFileIpra ($request, $response, $args)

	restoreFileCopyright ($request, $response, $args)

	restoreFileEmail ($request, $response, $args)

	restoreFileUrl ($request, $response, $args)

	restoreFileAuthor ($request, $response, $args)

	restoreFileEcc ($request, $response, $args)

	restoreFileKeyword ($request, $response, $args)

	restoreFileIpra ($request, $response, $args)

	getTotalFileCopyrights ($request, $response, $args)

Public Attributes
const	COPYRIGHT_PARAM = "status"

const	LIMIT_PARAM = "limit"

const	PAGE_PARAM = "page"

const	COPYRIGHT_FETCH_LIMIT = 100

const	TYPE_COPYRIGHT = 1

const	TYPE_EMAIL = 2

const	TYPE_URL = 4

const	TYPE_AUTHOR = 8

const	TYPE_ECC = 16

const	TYPE_KEYWORD = 32

const	TYPE_IPRA = 64

Private Member Functions
	getFileCX ($request, $response, $args, $cxType)

	deleteFileCX ($args, $response, $cxType)

	restoreFileCx ($args, $response, $cxType)

	updateFileCx ($request, $response, $args, $cxType)

	convertTypeToTable (int $cxType)

Private Attributes
	$copyrightHist

	$copyrightDao

Additional Inherited Members
Protected Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	getParsedBody (ServerRequestInterface $request)
	Parse request body as JSON and return associative PHP array. More...

	throwNotAdminException ()

	uploadAccessible ($id)

	isItemExists (int $uploadId, int $itemId)

Protected Attributes inherited from Fossology\UI\Api\Controllers\RestController
	$container

	$restHelper

	$dbHelper

Detailed Description

Definition at line 24 of file CopyrightController.php.

Constructor & Destructor Documentation

◆ __construct()

Fossology\UI\Api\Controllers\CopyrightController::__construct ( $container )

Constructor for base controller

Parameters

ContainerInterface $container

Reimplemented from Fossology\UI\Api\Controllers\RestController.

Definition at line 65 of file CopyrightController.php.

Member Function Documentation

◆ convertTypeToTable()

Fossology\UI\Api\Controllers\CopyrightController::convertTypeToTable ( int $cxType )

private

Convert CX Type to table name and display name.

Parameters

int $cxType

Returns: string[]

Definition at line 676 of file CopyrightController.php.

◆ deleteFileAuthor()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileAuthor	(	$request,
		$response,
		$args
	)

Delete author for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 210 of file CopyrightController.php.

◆ deleteFileCopyright()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileCopyright	(	$request,
		$response,
		$args
	)

Delete copyright for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 171 of file CopyrightController.php.

◆ deleteFileCX()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileCX	(	$args,
		$response,
		$cxType
	)

private

Delete cx for a particular file

Parameters

array	$args
ResponseHelper	$response
int	$cxType	Type of data to fetch (self::TYPE_*)

Returns: ResponseHelper

Exceptions

HttpErrorException

Definition at line 590 of file CopyrightController.php.

◆ deleteFileEcc()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileEcc	(	$request,
		$response,
		$args
	)

Delete ECC for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 223 of file CopyrightController.php.

◆ deleteFileEmail()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileEmail	(	$request,
		$response,
		$args
	)

Delete email for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 184 of file CopyrightController.php.

◆ deleteFileIpra()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileIpra	(	$request,
		$response,
		$args
	)

Delete IPRA for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 249 of file CopyrightController.php.

◆ deleteFileKeyword()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileKeyword	(	$request,
		$response,
		$args
	)

Delete keyword for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 236 of file CopyrightController.php.

◆ deleteFileUrl()

Fossology\UI\Api\Controllers\CopyrightController::deleteFileUrl	(	$request,
		$response,
		$args
	)

Delete URL for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 197 of file CopyrightController.php.

◆ getFileAuthor()

Fossology\UI\Api\Controllers\CopyrightController::getFileAuthor	(	$request,
		$response,
		$args
	)

Get all authors for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 119 of file CopyrightController.php.

◆ getFileCopyrights()

Fossology\UI\Api\Controllers\CopyrightController::getFileCopyrights	(	$request,
		$response,
		$args
	)

Get all copyrights for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 80 of file CopyrightController.php.

◆ getFileCX()

Fossology\UI\Api\Controllers\CopyrightController::getFileCX	(	$request,
		$response,
		$args,
		$cxType
	)

private

Get all cx for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args
int	$cxType	Type of data to fetch (self::TYPE_*)

Returns: ResponseHelper

Exceptions

HttpErrorException

Definition at line 484 of file CopyrightController.php.

◆ getFileEcc()

Fossology\UI\Api\Controllers\CopyrightController::getFileEcc	(	$request,
		$response,
		$args
	)

Get all ecc for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 132 of file CopyrightController.php.

◆ getFileEmail()

Fossology\UI\Api\Controllers\CopyrightController::getFileEmail	(	$request,
		$response,
		$args
	)

Get all emails for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 93 of file CopyrightController.php.

◆ getFileIpra()

Fossology\UI\Api\Controllers\CopyrightController::getFileIpra	(	$request,
		$response,
		$args
	)

Get all ipra for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 158 of file CopyrightController.php.

◆ getFileKeyword()

Fossology\UI\Api\Controllers\CopyrightController::getFileKeyword	(	$request,
		$response,
		$args
	)

Get all keywords for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 145 of file CopyrightController.php.

◆ getFileUrl()

Fossology\UI\Api\Controllers\CopyrightController::getFileUrl	(	$request,
		$response,
		$args
	)

Get all urls for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 106 of file CopyrightController.php.

◆ getTotalFileCopyrights()

Fossology\UI\Api\Controllers\CopyrightController::getTotalFileCopyrights	(	$request,
		$response,
		$args
	)

Get total number of copyrights for a particular upload-tree

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Exceptions

HttpErrorException

Definition at line 445 of file CopyrightController.php.

◆ restoreFileAuthor()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileAuthor	(	$request,
		$response,
		$args
	)

Restore author for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 392 of file CopyrightController.php.

◆ restoreFileCopyright()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileCopyright	(	$request,
		$response,
		$args
	)

Restore copyright for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 353 of file CopyrightController.php.

◆ restoreFileCx()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileCx	(	$args,
		$response,
		$cxType
	)

private

Restore cx for a particular file

Parameters

array	$args
ResponseHelper	$response
int	$cxType	Type of data to fetch (self::TYPE_*)

Returns: ResponseHelper

Exceptions

HttpErrorException

Definition at line 620 of file CopyrightController.php.

◆ restoreFileEcc()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileEcc	(	$request,
		$response,
		$args
	)

Restore ECC for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 405 of file CopyrightController.php.

◆ restoreFileEmail()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileEmail	(	$request,
		$response,
		$args
	)

Restore email for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 366 of file CopyrightController.php.

◆ restoreFileIpra()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileIpra	(	$request,
		$response,
		$args
	)

Restore IPRA for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 431 of file CopyrightController.php.

◆ restoreFileKeyword()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileKeyword	(	$request,
		$response,
		$args
	)

Restore keyword for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 418 of file CopyrightController.php.

◆ restoreFileUrl()

Fossology\UI\Api\Controllers\CopyrightController::restoreFileUrl	(	$request,
		$response,
		$args
	)

Restore URL for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 379 of file CopyrightController.php.

◆ updateFileAuthor()

Fossology\UI\Api\Controllers\CopyrightController::updateFileAuthor	(	$request,
		$response,
		$args
	)

Update author for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 301 of file CopyrightController.php.

◆ updateFileCopyright()

Fossology\UI\Api\Controllers\CopyrightController::updateFileCopyright	(	$request,
		$response,
		$args
	)

Update copyright for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 262 of file CopyrightController.php.

◆ updateFileCx()

Fossology\UI\Api\Controllers\CopyrightController::updateFileCx	(	$request,
		$response,
		$args,
		$cxType
	)

private

Update cx for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args
int	$cxType	Type of data to fetch (self::TYPE_*)

Returns: ResponseHelper

Exceptions

HttpErrorException

Definition at line 649 of file CopyrightController.php.

◆ updateFileEcc()

Fossology\UI\Api\Controllers\CopyrightController::updateFileEcc	(	$request,
		$response,
		$args
	)

Update ECC for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 314 of file CopyrightController.php.

◆ updateFileEmail()

Fossology\UI\Api\Controllers\CopyrightController::updateFileEmail	(	$request,
		$response,
		$args
	)

Update email for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 275 of file CopyrightController.php.

◆ updateFileIpra()

Fossology\UI\Api\Controllers\CopyrightController::updateFileIpra	(	$request,
		$response,
		$args
	)

Update IPRA for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 340 of file CopyrightController.php.

◆ updateFileKeyword()

Fossology\UI\Api\Controllers\CopyrightController::updateFileKeyword	(	$request,
		$response,
		$args
	)

Update keyword for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 327 of file CopyrightController.php.

◆ updateFileUrl()

Fossology\UI\Api\Controllers\CopyrightController::updateFileUrl	(	$request,
		$response,
		$args
	)

Update URL for a particular file

Parameters

ServerRequestInterface	$request
ResponseHelper	$response
array	$args

Returns: ResponseHelper

Definition at line 288 of file CopyrightController.php.

Member Data Documentation

◆ $copyrightDao

CopyrightDao Fossology\UI\Api\Controllers\CopyrightController::$copyrightDao

private

Copyright Dao object

Definition at line 56 of file CopyrightController.php.

◆ $copyrightHist

CopyrightHistogram Fossology\UI\Api\Controllers\CopyrightController::$copyrightHist

private

Copyright Histogram object

Definition at line 50 of file CopyrightController.php.

◆ COPYRIGHT_FETCH_LIMIT

const Fossology\UI\Api\Controllers\CopyrightController::COPYRIGHT_FETCH_LIMIT = 100

Limit of copyrights in get query

Definition at line 44 of file CopyrightController.php.

◆ COPYRIGHT_PARAM

const Fossology\UI\Api\Controllers\CopyrightController::COPYRIGHT_PARAM = "status"

Get query parameter name for copyright filtering

Definition at line 29 of file CopyrightController.php.

◆ LIMIT_PARAM

const Fossology\UI\Api\Controllers\CopyrightController::LIMIT_PARAM = "limit"

Get header parameter name for limiting listing

Definition at line 34 of file CopyrightController.php.

◆ PAGE_PARAM

const Fossology\UI\Api\Controllers\CopyrightController::PAGE_PARAM = "page"

Get header parameter name for page listing

Definition at line 39 of file CopyrightController.php.

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

src/www/ui/api/Controllers/CopyrightController.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ convertTypeToTable()

◆ deleteFileAuthor()

◆ deleteFileCopyright()

◆ deleteFileCX()

◆ deleteFileEcc()

◆ deleteFileEmail()

◆ deleteFileIpra()

◆ deleteFileKeyword()

◆ deleteFileUrl()

◆ getFileAuthor()

◆ getFileCopyrights()

◆ getFileCX()

◆ getFileEcc()

◆ getFileEmail()

◆ getFileIpra()

◆ getFileKeyword()

◆ getFileUrl()

◆ getTotalFileCopyrights()

◆ restoreFileAuthor()

◆ restoreFileCopyright()

◆ restoreFileCx()

◆ restoreFileEcc()

◆ restoreFileEmail()

◆ restoreFileIpra()

◆ restoreFileKeyword()

◆ restoreFileUrl()

◆ updateFileAuthor()

◆ updateFileCopyright()

◆ updateFileCx()

◆ updateFileEcc()

◆ updateFileEmail()

◆ updateFileIpra()

◆ updateFileKeyword()

◆ updateFileUrl()

Member Data Documentation

◆ $copyrightDao

◆ $copyrightHist

◆ COPYRIGHT_FETCH_LIMIT

◆ COPYRIGHT_PARAM

◆ LIMIT_PARAM

◆ PAGE_PARAM