Fossology\Lib\Plugin\DefaultPlugin Class Reference

Inherits Fossology\Lib\Plugin\Plugin.

Inherited by AdminContentDelete, AdminContentMove, AgentAdder, AjaxSHDetailsBrowser, AjaxUploadAgents, ChangeLicenseBulk, Fossology\Agent\Copyright\UI\Xpview, Fossology\DelAgent\UI\Page\AdminUploadDelete, Fossology\DemoHello\DemoHello, Fossology\Lib\Plugin\TestPlugin, Fossology\Monk\AdminMonkRevision, Fossology\Monk\UI\OneShot, Fossology\Reuser\ReuserPlugin, Fossology\SoftwareHeritage\UI\softwareHeritagePlugin, Fossology\SpdxTwo\SpdxTwoGeneratorUi, Fossology\UI\Ajax\AjaxAdminScheduler, Fossology\UI\Ajax\AjaxAllJobStatus, Fossology\UI\Ajax\AjaxBrowse, Fossology\UI\Ajax\AjaxBulkHistory, Fossology\UI\Ajax\AjaxExplorer, Fossology\UI\Ajax\AjaxFileBrowser, Fossology\UI\Ajax\AjaxFolderContents, Fossology\UI\Ajax\AjaxJobInfo, Fossology\UI\Ajax\AjaxJobStatus, Fossology\UI\Ajax\AjaxLicenseStdComments, Fossology\UI\Ajax\AjaxManageToken, Fossology\UI\Ajax\ScheduleAgent, Fossology\UI\Page\AboutPage, Fossology\UI\Page\AdminGroupDelete, Fossology\UI\Page\AdminGroupUsers, Fossology\UI\Page\AdminLicenseCandidate, Fossology\UI\Page\AdminLicenseFromCSV, Fossology\UI\Page\AdminLicenseStdComments, Fossology\UI\Page\AdminLicenseToCSV, Fossology\UI\Page\AdminObligationFromCSV, Fossology\UI\Page\AdminObligationToCSV, Fossology\UI\Page\AdviceLicense, Fossology\UI\Page\AllJobStatus, Fossology\UI\Page\BrowseLicense, Fossology\UI\Page\GettingStartedPage, Fossology\UI\Page\HomePage, Fossology\UI\Page\UploadPageBase, FoUnifiedReportGenerator, ReadMeOssPlugin, ReportImportPlugin, ui_file_browse, UploadInstructions, UploadPermissionPage, and UserEditPage.

Collaboration diagram for Fossology\Lib\Plugin\DefaultPlugin:

Public Member Functions
	__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	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
	RegisterMenus ()
	Customize submenus.
	handle (Request $request)
	render ($templateName, $vars=null, $headers=null)
	getDefaultHeaders ()
	getDefaultVars ()
	mergeWithDefault ($vars)
	flushContent ($content)

Protected Attributes
	$container
	$renderer
	$microMenu

Private Member Functions
	setParameter ($key, $value)
	checkPrerequisites ()

Private Attributes
	$session
	$logger
	$menu
	$name
	$version = "1.0"
	$title
	$permission = Auth::PERM_NONE
	$requiresLogin = true
	$PluginLevel = 10
	$dependencies = array()
	$InitOrder = 0
	$MenuList = NULL
	$MenuOrder = 0
	$MenuTarget = NULL

Detailed Description

Definition at line 32 of file DefaultPlugin.php.

Member Function Documentation

Fossology\Lib\Plugin\DefaultPlugin::__get

(

$name

)

Parameters

string

$name

Exceptions

Definition at line 399 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getDBaccess

(

)

Returns

int

Definition at line 191 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getDefaultHeaders ( )

protected

Returns

array

Definition at line 332 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getDefaultVars ( )

protected

Returns

array

Definition at line 344 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getDependency

(

)

Returns

array

Definition at line 175 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getInitOrder

(

)

Returns

int

Definition at line 207 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getName

(

)

Returns

string

Implements Fossology\Lib\Plugin\Plugin.

Definition at line 143 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getObject

(

$name

)

Parameters

$name

Returns

object

Definition at line 249 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getPluginLevel

(

)

Returns

int

Definition at line 183 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getResponse

(

)

Returns

Response

Definition at line 231 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getState

(

)

Returns

int

Definition at line 199 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getTitle

(

)

Returns

string

Definition at line 159 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::getVersion

(

)

Returns

string

Definition at line 151 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::handle ( Request  $request )

abstractprotected

Parameters

Request

$request

Returns

Response

Fossology\Lib\Plugin\DefaultPlugin::isRequiresLogin

(

)

Returns

int

Definition at line 167 of file DefaultPlugin.php.

Fossology\Lib\Plugin\DefaultPlugin::render (   $templateName,   $vars = null,   $headers = null  )

protected

Parameters

string	$templateName
array	$vars
	string[]	$headers

Returns

Response

Definition at line 290 of file DefaultPlugin.php.

---

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

• src/lib/php/Plugin/DefaultPlugin.php