admin_license_file Class Reference

Inheritance diagram for admin_license_file:

Collaboration diagram for admin_license_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...
	getLicenseListData ($namestr, $filter)
	Build the input form. More...
	Updatefm ($rf_pk)
	getUpdatefmData ($rf_pk)
	Update forms. More...
	Updatedb ()
	Update the database. More...
	Adddb ()
	Add a new license_ref to the database. More...
	FamilyNames ()
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
	getLicenseData ($where)
	isTrue ($value)
	Check if a variable is true. More...
	isShortnameBlocked ($rfId, $shortname, $text)
	check if shortname or license text of this license is existing
	isShortNameExists ($rfId, $shortname)
	check if shortname is changed
	getLicenseTextForID ($licenseID)

Private Attributes
	$dbManager
	$licenseDao

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 20 of file admin-license-file.php.

Constructor & Destructor Documentation

__construct()

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

< Selector name for obligation list

< Selector id for obligation list

Reimplemented from FO_Plugin.

Definition at line 28 of file admin-license-file.php.

Member Function Documentation

Adddb()

admin_license_file::Adddb

(

)

Add a new license_ref to the database.

Returns

An add status string

Definition at line 501 of file admin-license-file.php.

getLicenseListData()

admin_license_file::getLicenseListData	(		$namestr,
			$filter
	)

Build the input form.

Parameters

$namestr	- license family name
$filter	- marydone value requested

Returns

The input form as a string

Definition at line 184 of file admin-license-file.php.

getUpdatefmData()

admin_license_file::getUpdatefmData

(

$rf_pk

)

Update forms.

Parameters

int

$rf_pk

- for the license to update, empty to add

Returns

string The input form

Definition at line 240 of file admin-license-file.php.

Inputfm()

admin_license_file::Inputfm

(

)

Build the input form.

Returns

The input form as a string

Definition at line 124 of file admin-license-file.php.

isTrue()

admin_license_file::isTrue (   $value )

private

Check if a variable is true.

Parameters

mixed

$value

Returns

boolean

Definition at line 345 of file admin-license-file.php.

Updatedb()

admin_license_file::Updatedb

(

)

Update the database.

Returns

An update status string

Definition at line 386 of file admin-license-file.php.

---

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

• src/www/ui/admin-license-file.php