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\CliXml\UI\CliXmlGeneratorUi, Fossology\CycloneDX\UI\CycloneDXGeneratorUi, Fossology\DecisionExporter\UI\FoDecisionExporter, Fossology\DecisionImporter\UI\AgentDecisionImporterPlugin, Fossology\DelAgent\UI\Page\AdminUploadDelete, Fossology\DelAgent\UI\Page\BrowseUploadDelete, Fossology\DemoHello\DemoHello, Fossology\Lib\Plugin\TestPlugin, Fossology\Monk\AdminMonkRevision, Fossology\Monk\UI\OneShot, Fossology\ReadmeOSS\UI\ReadMeOssPlugin, Fossology\Reuser\ReuserPlugin, Fossology\SoftwareHeritage\UI\softwareHeritagePlugin, Fossology\SpdxTwo\UI\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\AjaxLicenseStdAcknowledgements, Fossology\UI\Ajax\AjaxLicenseStdComments, Fossology\UI\Ajax\AjaxManageToken, Fossology\UI\Ajax\AjaxReuseReport, Fossology\UI\Ajax\ScheduleAgent, Fossology\UI\Page\AboutPage, Fossology\UI\Page\AdminAllLicenseToCSV, Fossology\UI\Page\AdminGroupDelete, Fossology\UI\Page\AdminGroupUsers, Fossology\UI\Page\AdminLicenseAcknowledgements, 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\ThirdPartyLicensesPage, Fossology\UI\Page\UploadPageBase, Fossology\UnifiedReport\UI\FoUnifiedReportGenerator, ReportImportPlugin, UploadInstructions, UploadPermissionPage, UserEditPage, ui_file_browse, and user_add.

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 21 of file DefaultPlugin.php.

Member Function Documentation

__get()

Fossology\Lib\Plugin\DefaultPlugin::__get

(

$name

)

Parameters

string

$name

Exceptions

Definition at line 391 of file DefaultPlugin.php.

getDBaccess()

Fossology\Lib\Plugin\DefaultPlugin::getDBaccess

(

)

Returns

int

Definition at line 180 of file DefaultPlugin.php.

getDefaultHeaders()

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

protected

Returns

array

Definition at line 321 of file DefaultPlugin.php.

getDefaultVars()

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

protected

Returns

array

Definition at line 333 of file DefaultPlugin.php.

getDependency()

Fossology\Lib\Plugin\DefaultPlugin::getDependency

(

)

Returns

array

Definition at line 164 of file DefaultPlugin.php.

getInitOrder()

Fossology\Lib\Plugin\DefaultPlugin::getInitOrder

(

)

Returns

int

Definition at line 196 of file DefaultPlugin.php.

getName()

Fossology\Lib\Plugin\DefaultPlugin::getName

(

)

Returns

string

Implements Fossology\Lib\Plugin\Plugin.

Definition at line 132 of file DefaultPlugin.php.

getObject()

Fossology\Lib\Plugin\DefaultPlugin::getObject

(

$name

)

Parameters

$name

Returns

object

Definition at line 238 of file DefaultPlugin.php.

getPluginLevel()

Fossology\Lib\Plugin\DefaultPlugin::getPluginLevel

(

)

Returns

int

Definition at line 172 of file DefaultPlugin.php.

getResponse()

Fossology\Lib\Plugin\DefaultPlugin::getResponse

(

)

Returns

Response

Definition at line 220 of file DefaultPlugin.php.

getState()

Fossology\Lib\Plugin\DefaultPlugin::getState

(

)

Returns

int

Definition at line 188 of file DefaultPlugin.php.

getTitle()

Fossology\Lib\Plugin\DefaultPlugin::getTitle

(

)

Returns

string

Definition at line 148 of file DefaultPlugin.php.

getVersion()

Fossology\Lib\Plugin\DefaultPlugin::getVersion

(

)

Returns

string

Definition at line 140 of file DefaultPlugin.php.

handle()

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

abstractprotected

Parameters

Request

$request

Returns

Response

Reimplemented in UserEditPage, user_add, UploadInstructions, ui_file_browse, UploadPermissionPage, Fossology\UI\Page\UploadPageBase, Fossology\UI\Page\ThirdPartyLicensesPage, Fossology\UI\Page\HomePage, Fossology\UI\Page\GettingStartedPage, Fossology\UI\Page\BrowseLicense, Fossology\UI\Page\AllJobStatus, Fossology\UI\Page\AdminObligationToCSV, Fossology\UI\Page\AdminObligationFromCSV, Fossology\UI\Page\AdminLicenseToCSV, Fossology\UI\Page\AdminLicenseStdComments, Fossology\UI\Page\AdminLicenseFromCSV, Fossology\UI\Page\AdminLicenseCandidate, Fossology\UI\Page\AdminLicenseAcknowledgements, AdminContentMove, AdminContentDelete, Fossology\UI\Page\AdminAllLicenseToCSV, Fossology\UI\Page\AboutPage, ChangeLicenseBulk, Fossology\UI\Ajax\ScheduleAgent, Fossology\UI\Ajax\AjaxReuseReport, Fossology\UI\Ajax\AjaxManageToken, Fossology\UI\Ajax\AjaxLicenseStdComments, Fossology\UI\Ajax\AjaxLicenseStdAcknowledgements, Fossology\UI\Ajax\AjaxJobStatus, Fossology\UI\Ajax\AjaxJobInfo, Fossology\UI\Ajax\AjaxFolderContents, Fossology\UI\Ajax\AjaxFileBrowser, Fossology\UI\Ajax\AjaxExplorer, Fossology\UI\Ajax\AjaxBrowse, Fossology\UI\Ajax\AjaxAllJobStatus, AjaxUploadAgents, AgentAdder, Fossology\UnifiedReport\UI\FoUnifiedReportGenerator, Fossology\SpdxTwo\UI\SpdxTwoGeneratorUi, Fossology\SoftwareHeritage\UI\softwareHeritagePlugin, AjaxSHDetailsBrowser, Fossology\Reuser\ReuserPlugin, ReportImportPlugin, Fossology\ReadmeOSS\UI\ReadMeOssPlugin, Fossology\Lib\Plugin\TestPlugin, Fossology\DemoHello\DemoHello, Fossology\DelAgent\UI\Page\AdminUploadDelete, Fossology\DecisionExporter\UI\FoDecisionExporter, Fossology\CycloneDX\UI\CycloneDXGeneratorUi, Fossology\Agent\Copyright\UI\Xpview, and Fossology\CliXml\UI\CliXmlGeneratorUi.

isRequiresLogin()

Fossology\Lib\Plugin\DefaultPlugin::isRequiresLogin

(

)

Returns

int

Definition at line 156 of file DefaultPlugin.php.

render()

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

protected

Parameters

string	$templateName
array	$vars
string[]	$headers

Returns

Response

Definition at line 279 of file DefaultPlugin.php.

---

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

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