Inheritance diagram for admin_bucket_pool:

Collaboration diagram for admin_bucket_pool:

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

	CloneBucketpool ($bucketpool_pk, $UpdateDefault, &$msg)
	Clone a bucketpool and its bucketdef records. Increment the bucketpool version. More...

	Output ()
	User chooses a bucketpool to duplicate from a select list. 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...

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

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

UI plugin for bucket pool

Definition at line 19 of file admin-bucket-pool.php.

Constructor & Destructor Documentation

◆ __construct()

admin_bucket_pool::__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 21 of file admin-bucket-pool.php.

Member Function Documentation

◆ CloneBucketpool()

admin_bucket_pool::CloneBucketpool	(		$bucketpool_pk,
			$UpdateDefault,
		&	$msg
	)

Clone a bucketpool and its bucketdef records. Increment the bucketpool version.

Parameters

int	$bucketpool_pk	pk to clone.
string	$UpdateDefault	'on' if true, or empty if false

Returns: int The new bucketpool_pk A message suitable to display to the user is returned in $msg. This may be a success message or a non-fatal error message.

Definition at line 41 of file admin-bucket-pool.php.

◆ Output()

admin_bucket_pool::Output ( )

User chooses a bucketpool to duplicate from a select list.

The new bucketpool and bucket_def records will be identical to the originals except for the primary keys and bucketpool version (which will be bumped).
The user can optionally also set their default bucketpool to the new one. This is the default.
The user must then manually modify the bucketpool and/or bucketdef records to create their new (modified) bucketpool.

Returns: string

See also: FO_Plugin::Output()

Reimplemented from FO_Plugin.

Definition at line 114 of file admin-bucket-pool.php.

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

src/buckets/ui/admin-bucket-pool.php