FOSSology  4.7.0-rc1
Open Source License Compliance by Open Source Software
AjaxAcknowledgementConf Class Reference

AJAX handler for acknowledgement operations on report-conf page. More...

Inheritance diagram for AjaxAcknowledgementConf:
Inheritance graph
Collaboration diagram for AjaxAcknowledgementConf:
Collaboration graph

Public Member Functions

 __construct ()
 base constructor. Most plugins will just use this More...
 
 PostInitialize ()
 This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here. More...
 
 Output ()
 This function is called when user output is requested. This function is responsible for content. (OutputOpen and Output are separated so one plugin can call another plugin's Output.)
 
- Public Member Functions inherited from FO_Plugin
 Install ()
 This function (when defined) is only called when the plugin is first installed. It should make sure all requirements are available and create anything it needs to run. It returns 0 on success, non-zero on failure. A failed install is not inserted in the system. More...
 
 Remove ()
 This function (when defined) is only called once, when the plugin is removed. It should uninstall and remove all items that are only used by this plugin. There should be no residues – if the plugin is ever installed again, it should act like a clean install. Thus, any DB, files, or state variables specific to this plugin must be removed. This function must always succeed.
 
 Initialize ()
 dummy stub till all references are removed.
 
 RegisterMenus ()
 While menus can be added to any time at or after the PostInitialize phase, this is the standard location for registering this item with menus. More...
 
 Destroy ()
 This is a destructor called after the plugin is no longer needed. It should assume that PostInitialize() was already run one time (this session) and succeeded. This function must always succeed.
 
 OutputOpen ()
 This function is called when user output is requested. This function is responsible for assigning headers.
 
 OutputUnSet ()
 Similar to OutputClose, this ends the output type for this object. However, this does NOT change any global settings. This is called when this object is a dependency for another object.
 
 getResponse ()
 
 getTemplateName ()
 
 renderString ($templateName, $vars=null)
 
 renderScripts ($scripts)
 Render JavaScript in the template's footer. More...
 
 getRequest ()
 
 execute ()
 
 preInstall ()
 
 postInstall ()
 
 unInstall ()
 
 getName ()
 
 __toString ()
 

Private Member Functions

 latestValidDecisionCte ($uploadTreeTable)
 
 cteParams ($groupId, $uploadId, $ackText)
 Return Common params array for the query. More...
 
 doGetFiles ($uploadId, $groupId)
 Return files containing a given acknowledgement text for an upload. More...
 
 doUpdateAcknowledgement ($uploadId, $groupId)
 Update acknowledgement text on the clearing_event records. More...
 
 doDeleteAcknowledgement ($uploadId, $groupId)
 Clear acknowledgement from the clearing_event records. More...
 

Private Attributes

 $uploadDao
 
 $dbManager
 

Additional Inherited Members

- Public Attributes inherited from FO_Plugin
 $State = PLUGIN_STATE_INVALID
 
 $Name = ""
 
 $Version = "1.0"
 
 $Title = ""
 
 $DBaccess = PLUGIN_DB_NONE
 
 $LoginFlag = 0
 
 $NoMenu = 0
 
 $NoHeader = 0
 
 $PluginLevel = 10
 
 $Dependency = array()
 
 $InitOrder = 0
 
 $MenuList = NULL
 
 $MenuOrder = 0
 
 $MenuTarget = NULL
 
 $OutputType = "HTML"
 
 $OutputToStdout = 0
 
- Protected Member Functions inherited from FO_Plugin
 render ($templateName, $vars=null)
 
- Protected Attributes inherited from FO_Plugin
 $microMenu
 
 $renderer
 
 $vars = array()
 

Detailed Description

AJAX handler for acknowledgement operations on report-conf page.

Definition at line 19 of file ajax-acknowledgement-conf.php.

Constructor & Destructor Documentation

◆ __construct()

AjaxAcknowledgementConf::__construct ( )

base constructor. Most plugins will just use this

Makes sure the plugin is in the correct state. If so, the plugin is inserted into the Plugins data structure.

The constructor assumes that Install() was already run one time (possibly years ago and not during this object's creation).

Returns
true on success, false on failure.

On failure the plugin is not used by the system. NOTE: This function must NOT assume that other plugins are installed. See PostInitialize.

Reimplemented from FO_Plugin.

Definition at line 27 of file ajax-acknowledgement-conf.php.

Member Function Documentation

◆ cteParams()

AjaxAcknowledgementConf::cteParams (   $groupId,
  $uploadId,
  $ackText 
)
private

Return Common params array for the query.

Parameters
int$groupId
int$uploadId
string$ackText
Returns
array()

Definition at line 103 of file ajax-acknowledgement-conf.php.

◆ doDeleteAcknowledgement()

AjaxAcknowledgementConf::doDeleteAcknowledgement (   $uploadId,
  $groupId 
)
private

Clear acknowledgement from the clearing_event records.

Parameters
int$uploadId
int$groupId
Returns
JsonResponse

Definition at line 213 of file ajax-acknowledgement-conf.php.

◆ doGetFiles()

AjaxAcknowledgementConf::doGetFiles (   $uploadId,
  $groupId 
)
private

Return files containing a given acknowledgement text for an upload.

Parameters
int$uploadId
int$groupId
Returns
JsonResponse

Definition at line 120 of file ajax-acknowledgement-conf.php.

◆ doUpdateAcknowledgement()

AjaxAcknowledgementConf::doUpdateAcknowledgement (   $uploadId,
  $groupId 
)
private

Update acknowledgement text on the clearing_event records.

Parameters
int$uploadId
int$groupId
Returns
JsonResponse

Definition at line 161 of file ajax-acknowledgement-conf.php.

◆ latestValidDecisionCte()

AjaxAcknowledgementConf::latestValidDecisionCte (   $uploadTreeTable)
private
Parameters
string$uploadTreeTable
Returns
string CTE SQL fragment

Definition at line 79 of file ajax-acknowledgement-conf.php.

◆ PostInitialize()

AjaxAcknowledgementConf::PostInitialize ( )

This function is called before the plugin is used and after all plugins have been initialized. If there is any initialization step that is dependent on other plugins, put it here.

Returns
true on success, false on failure.
Note
Do not assume that the plugin exists! Actually check it!

Reimplemented from FO_Plugin.

Definition at line 39 of file ajax-acknowledgement-conf.php.


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