FOSSology  4.4.0
Open Source License Compliance by Open Source Software
Fossology\DelAgent\UI\Page\AdminUploadDelete Class Reference

UI plugin to delete uploaded files. More...

Inheritance diagram for Fossology\DelAgent\UI\Page\AdminUploadDelete:
Inheritance graph
Collaboration diagram for Fossology\DelAgent\UI\Page\AdminUploadDelete:
Collaboration graph

Public Member Functions

 TryToDelete ($uploadpk, $folderId)
 Given a folder_pk, try to add a job after checking permissions. More...
 
- Public Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 __construct ($name, $parameters=array())
 
 getName ()
 
 getVersion ()
 
 getTitle ()
 
 isRequiresLogin ()
 
 getDependency ()
 
 getPluginLevel ()
 
 getDBaccess ()
 
 getState ()
 
 getInitOrder ()
 
 getNoMenu ()
 
 getResponse ()
 
 getObject ($name)
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 execute ()
 
 isLoggedIn ()
 
 __get ($name)
 
 __toString ()
 

Public Attributes

const NAME = "admin_upload_delete"
 
- Public Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
const PERMISSION = "permission"
 
const REQUIRES_LOGIN = "requiresLogin"
 
const ENABLE_MENU = "ENABLE_MENU"
 
const LEVEL = "level"
 
const DEPENDENCIES = "dependencies"
 
const INIT_ORDER = "initOrder"
 
const MENU_LIST = "menuList"
 
const MENU_ORDER = "menuOrder"
 
const MENU_TARGET = "menuTarget"
 
const TITLE = "title"
 

Protected Member Functions

 handle (Request $request)
 
- Protected Member Functions inherited from Fossology\Lib\Plugin\DefaultPlugin
 RegisterMenus ()
 Customize submenus.
 
 render ($templateName, $vars=null, $headers=null)
 
 getDefaultHeaders ()
 
 getDefaultVars ()
 
 mergeWithDefault ($vars)
 
 flushContent ($content)
 

Private Member Functions

 delete ($uploadpk)
 Delete a given upload. More...
 
 initDeletion ($uploadpks, $folderId)
 starts deletion and handles error messages More...
 

Private Attributes

 $uploadDao
 
 $folderDao
 

Additional Inherited Members

- Protected Attributes inherited from Fossology\Lib\Plugin\DefaultPlugin
 $container
 
 $renderer
 
 $microMenu
 

Detailed Description

UI plugin to delete uploaded files.

Definition at line 27 of file AdminUploadDelete.php.

Member Function Documentation

◆ delete()

Fossology\DelAgent\UI\Page\AdminUploadDelete::delete (   $uploadpk)
private

Delete a given upload.

Parameters
int$uploadpkThe upload(upload_id) you want to delete
Returns
NULL on success, string on failure.

Definition at line 57 of file AdminUploadDelete.php.

◆ handle()

Fossology\DelAgent\UI\Page\AdminUploadDelete::handle ( Request  $request)
protected

Parameters
Request$request
Returns
Response
See also
Fossology::Lib::Plugin::DefaultPlugin::handle()

Reimplemented from Fossology\Lib\Plugin\DefaultPlugin.

Definition at line 88 of file AdminUploadDelete.php.

◆ initDeletion()

Fossology\DelAgent\UI\Page\AdminUploadDelete::initDeletion (   $uploadpks,
  $folderId 
)
private

starts deletion and handles error messages

Parameters
array$uploadpksUpload ids to be deleted
int$folderIdId of folder containing uploads
Returns
string Error or success message

Definition at line 128 of file AdminUploadDelete.php.

◆ TryToDelete()

Fossology\DelAgent\UI\Page\AdminUploadDelete::TryToDelete (   $uploadpk,
  $folderId 
)

Given a folder_pk, try to add a job after checking permissions.

Parameters
$uploadpkThe upload(upload_id) you want to delete
$folderIdThe folder(folder_id) containing the uploads
Returns
string with the message.

Definition at line 171 of file AdminUploadDelete.php.


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