Inheritance diagram for admin_obligation_file:

Collaboration diagram for admin_obligation_file:

Public Member Functions
	__construct ()
	base constructor. Most plugins will just use this More...

	RegisterMenus ()
	Customize submenus.

	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.)

	Inputfm ()
	Build the input form. More...

	ObligationTopic ($topic)
	Build the input form. More...

	Updatefm ($ob_pk)
	Update forms. More...

	Updatedb ()
	Update the database. More...

	Adddb ()
	Add a new obligation_ref to the database. More...

	Deldb ()
	Remove obligation_ref from the database and unassociate licenses. More...

	addNewLicenses ($shortnames, $obId, $candidate=false)
	Associate selected licenses to the obligation. More...

	removeLicenses ($shortnames, $obId, $candidate=false)
	Unassociate selected licenses to the obligation. More...

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.

	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...

	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
	ObligationTopics ()
	return an array of all obligation topics from the DB

	isObligationTopicAndTextBlocked ($obId, $topic, $text)
	check if the text of this obligation is existing

Private Attributes
	$dbManager

	$obligationMap

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

Definition at line 15 of file admin-obligation-file.php.

Constructor & Destructor Documentation

◆ __construct()

admin_obligation_file::__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 23 of file admin-obligation-file.php.

Member Function Documentation

◆ Adddb()

admin_obligation_file::Adddb ( )

Add a new obligation_ref to the database.

Returns: An add status string

Definition at line 428 of file admin-obligation-file.php.

◆ addNewLicenses()

admin_obligation_file::addNewLicenses	(	$shortnames,
		$obId,
		$candidate = `false`
	)

Associate selected licenses to the obligation.

Parameters

array	$shortnames	- new licenses to be associated
int	$obId	- obligation being processed
boolean	$candidate	- do we handle candidate licenses?

Returns: string the list of associated licences

Definition at line 505 of file admin-obligation-file.php.

◆ Deldb()

admin_obligation_file::Deldb ( )

Remove obligation_ref from the database and unassociate licenses.

Returns: True

Definition at line 490 of file admin-obligation-file.php.

◆ Inputfm()

admin_obligation_file::Inputfm ( )

Build the input form.

Returns: The input form as a string

Definition at line 131 of file admin-obligation-file.php.

◆ ObligationTopic()

admin_obligation_file::ObligationTopic ( $topic )

Build the input form.

Parameters

$license - license name

Returns: The input form as a string

Definition at line 162 of file admin-obligation-file.php.

◆ removeLicenses()

admin_obligation_file::removeLicenses	(	$shortnames,
		$obId,
		$candidate = `false`
	)

Unassociate selected licenses to the obligation.

Parameters

array	$shortnames	- new licenses to be associated
int	$obId	- obligation being processed
boolean	$candidate	- do we handle candidate licenses?

Returns: string the list of associated licences

Definition at line 535 of file admin-obligation-file.php.

◆ Updatedb()

admin_obligation_file::Updatedb ( )

Update the database.

Returns: An update status string

Definition at line 366 of file admin-obligation-file.php.

◆ Updatefm()

admin_obligation_file::Updatefm ( $ob_pk )

Update forms.

Parameters

int $ob_pk - for the obligation to update, empty to add

Returns: string The input form

Todo:: Add colors $dbManager->risksFromDB

Definition at line 255 of file admin-obligation-file.php.

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

src/www/ui/admin-obligation-file.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ Adddb()

◆ addNewLicenses()

◆ Deldb()

◆ Inputfm()

◆ ObligationTopic()

◆ removeLicenses()

◆ Updatedb()

◆ Updatefm()