Fossology\UI\Api\Controllers\UploadController Class Reference

Controller for Upload model. More...

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

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

Public Member Functions
	__construct ($container)
	getUploads ($request, $response, $args)
	getUploadSummary ($request, $response, $args)
	deleteUpload ($request, $response, $args)
	copyUpload ($request, $response, $args)
	moveUpload ($request, $response, $args)
	postUpload ($request, $response, $args)
	getUploadLicenses ($request, $response, $args)
Public Member Functions inherited from Fossology\UI\Api\Controllers\RestController
	__construct ($container)

Public Attributes
const	AGENT_PARAM = "agent"
const	CONTAINER_PARAM = "containers"

Private Member Functions
	changeUpload ($request, $response, $args, $isCopy)
	uploadAccessible ($groupId, $id)
	isAdj2nestDone ($id, $response)
	areAgentsScheduled ($uploadId, $agents, $response)

Additional Inherited Members
Protected Attributes inherited from Fossology\UI\Api\Controllers\RestController
	$container
	$restHelper
	$dbHelper

Detailed Description

Controller for Upload model.

Definition at line 42 of file UploadController.php.

Member Function Documentation

Fossology\UI\Api\Controllers\UploadController::areAgentsScheduled (   $uploadId,   $agents,   $response  )

private

Check if every agent passed is scheduled for the upload

Parameters

integer	$uploadId	Upload ID to check agents for
array	$agents	List of agents to check
ResponseInterface	$response

Returns

ResponseInterface|boolean Error response on failure, true on success

Definition at line 339 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::changeUpload (   $request,   $response,   $args,   $isCopy  )

private

Perform copy/move based on $isCopy

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args
boolean	$isCopy	True to perform copy, else false

Returns

ResponseInterface

Definition at line 184 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::copyUpload	(		$request,
			$response,
			$args
	)

Copy a given upload to a new folder

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 157 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::deleteUpload	(		$request,
			$response,
			$args
	)

Delete a given upload

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 126 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::getUploadLicenses	(		$request,
			$response,
			$args
	)

Get list of licenses for given upload

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 259 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::getUploads	(		$request,
			$response,
			$args
	)

Get list of uploads for current user

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 72 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::getUploadSummary	(		$request,
			$response,
			$args
	)

Get summary of given upload

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 101 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::isAdj2nestDone (   $id,   $response  )

private

Check if adj2nest agent finished on upload

Parameters

integer	$id	Upload ID
ResponseInterface	$response

Returns

ResponseInterface|boolean Response if failure, true otherwise

Definition at line 316 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::moveUpload	(		$request,
			$response,
			$args
	)

Move a given upload to a new folder

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 170 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::postUpload	(		$request,
			$response,
			$args
	)

Get a new upload from the POST method

Parameters

ServerRequestInterface	$request
ResponseInterface	$response
array	$args

Returns

ResponseInterface

Definition at line 206 of file UploadController.php.

Fossology\UI\Api\Controllers\UploadController::uploadAccessible (   $groupId,   $id  )

private

Check if upload is accessible

Parameters

integer	$groupId	Group ID
integer	$id	Upload ID

Returns

Fossology::UI::Api::Models::Info|boolean Info object on failure or true otherwise

Definition at line 300 of file UploadController.php.

Member Data Documentation

const Fossology\UI\Api\Controllers\UploadController::AGENT_PARAM = "agent"

Get query parameter name for agent listing

Definition at line 48 of file UploadController.php.

const Fossology\UI\Api\Controllers\UploadController::CONTAINER_PARAM = "containers"

Get query parameter name for container listing

Definition at line 53 of file UploadController.php.

---

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

• src/www/ui/api/Controllers/UploadController.php