Public Member Functions
	getConfigurationFormNavigation ()

	getExternPageName ()

	isSystemPage ()

	isInstitutePage ()

	getExternPage (ExternPageConfig $config)

	getConfigurationFormTemplate ()

Member Function Documentation

◆ getConfigurationFormNavigation()

getConfigurationFormNavigation ( )

Returns a Navigation-object. Only the title, description and the image will be used. The title is used as a link to open the configuration form.

Returns: Navigation with title, description and image

◆ getConfigurationFormTemplate()

getConfigurationFormTemplate ( )

Returns a Flexi_Template or a path to the template file. This template contains the form to configure the external page.

Returns: string|Flexi_Template

◆ getExternPage()

getExternPage ( ExternPageConfig $config )

Returns an object from type ExternPage. The class name begins with "ExternPage" followed by the name of the external page. If the name is "ModuleSearch" the class name is "ExternalPageModuleSearch"

Returns: ExternPage

◆ getExternPageName()

getExternPageName ( )

The name is one word describing the scope of the page. This word is part of the class name of the provided ExternPage object e.g. "ExternPageModules" the name is "Modules". Do not translate this string...

Returns: string The name of the external page.

◆ isInstitutePage()

isInstitutePage ( )

Returns true if this is an external page for institutes and faculties (located under "Institutes")

Returns: boolean

◆ isSystemPage()

isSystemPage ( )

Returns true if this is a system-wide external page (located under "Location" ;-) )

Returns: boolean

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

lib/plugins/core/ExternPagePlugin.php