openmediavault  4.0 (Arrakis)
The open network attached storage solution
Public Member Functions | Protected Member Functions | List of all members
OMV\ControlPanel\ControlPanelAbstract Class Reference
Inheritance diagram for OMV\ControlPanel\ControlPanelAbstract:
OMV\ControlPanel\Administration OMV\ControlPanel\Login

Public Member Functions

 render ()
 
 getJavascriptIncludes ()
 
 getCssIncludes ()
 

Protected Member Functions

 scanFiles ($fileName, &$incList)
 
 scanDir ($dirPath, &$incList, $recursive=TRUE)
 
 getTitle ()
 
 getCacheFileId ()
 
 getBodyClass ()
 
 getBaseBodyContent ()
 
 getBodyContent ()
 

Member Function Documentation

◆ getBaseBodyContent()

OMV\ControlPanel\ControlPanelAbstract::getBaseBodyContent ( )
protected

Get the base HTML body code.

◆ getBodyClass()

OMV\ControlPanel\ControlPanelAbstract::getBodyClass ( )
abstractprotected

Get the body class.

◆ getBodyContent()

OMV\ControlPanel\ControlPanelAbstract::getBodyContent ( )
abstractprotected

Get the HTML body code.

◆ getCacheFileId()

OMV\ControlPanel\ControlPanelAbstract::getCacheFileId ( )
protected

Get the identifier to make the cache file unique, e.g. "xyz". Defaults to empty.

Returns
The cache file identifier.

◆ getCssIncludes()

OMV\ControlPanel\ControlPanelAbstract::getCssIncludes ( )

Get an list of CSS files to be included.

Returns
An array of files to be included.

◆ getJavascriptIncludes()

OMV\ControlPanel\ControlPanelAbstract::getJavascriptIncludes ( )

Get an list of javascript files to be included.

Returns
An array of files to be included.

◆ getTitle()

OMV\ControlPanel\ControlPanelAbstract::getTitle ( )
protected

Get the title of the HTML page.

Returns
The page title string.

◆ render()

OMV\ControlPanel\ControlPanelAbstract::render ( )

Renders the HTML page

◆ scanDir()

OMV\ControlPanel\ControlPanelAbstract::scanDir (   $dirPath,
$incList,
  $recursive = TRUE 
)
protected

Scan the given directory for Javascript files to be added

Parameters
dirPathThe name of the directory to scan
incListThe list where to add the files to include
recursiveScan subdirs

◆ scanFiles()

OMV\ControlPanel\ControlPanelAbstract::scanFiles (   $fileName,
$incList 
)
protected

Includes the given file

Parameters
fileNameThe name of the file to add
incListThe list where to add the files to include

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