API - XOOPS 2.5.11 Beta 2
By monxoops.fr
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes
Admin Class Reference

Public Member Functions

 addConfigBoxLine ($value='', $type='default')
 
 addInfoBox ($title, $type='default', $extra='')
 
 addInfoBoxLine ($text='', $type='default', $color='inherit')
 
 addItemButton ($title, $link, $icon='add', $extra='')
 
 renderButton ($position=null, $delimiter=" ")
 
 displayButton ($position=null, $delimiter=" ")
 
 renderInfoBox ()
 
 displayInfoBox ()
 
 renderIndex ()
 
 displayIndex ()
 
 renderNavigation ($menu='')
 
 displayNavigation ($menu='')
 
 renderAbout ($logo_xoops=true)
 
 displayAbout ($logo_xoops=true)
 
 addConfigError ($value='')
 
 addConfigAccept ($value='')
 
 addConfigWarning ($value='')
 
 addConfigModuleVersion ($moddir, $minversion)
 

Static Public Member Functions

static getInstance ()
 
static menuIconPath ($image)
 
static iconUrl ($name='', $size='32')
 
static setPaypal ($paypal='')
 

Protected Member Functions

 __construct ()
 

Static Protected Member Functions

static isXng ()
 

Protected Attributes

 $lastInfoBoxTitle = null
 

Static Protected Attributes

static $ModuleAdmin = null
 
static $paypal = ''
 

Constructor & Destructor Documentation

◆ __construct()

__construct ( )
protected

Constructor

Member Function Documentation

◆ addConfigAccept()

addConfigAccept (   $value = '')

Add accept (OK) message to config box

Parameters
string$valuethe OK message
Returns
bool
Here is the caller graph for this function:

◆ addConfigBoxLine()

addConfigBoxLine (   $value = '',
  $type = 'default' 
)

Add config line

Parameters
string$valuemessage to include in config box
string$typetype of line to add minimal set of acceptable types and value expectation 'default' - value is message displayed directly (also used for unknown types) 'folder' - value is directory name, will display accept if exists, error if not 'chmod' - value is array(directory, permission) accept if exists with permission, else error 'module' - value is string module name, or array(module name, errortype) If module is active, an accept line displays, otherwise, a warning (if value is array(module, "warning") or an error displays.
Returns
bool
Here is the call graph for this function:

◆ addConfigError()

addConfigError (   $value = '')

Add error to config box

Parameters
string$valuethe error message
Returns
bool
Here is the caller graph for this function:

◆ addConfigModuleVersion()

addConfigModuleVersion (   $moddir,
  $minversion 
)

Check for installed module and version and do addConfigBoxLine()

Parameters
string$moddir- module directory name
integer$minversion- minimum acceptable module version
Returns
bool true if requested version of the module is available
Here is the call graph for this function:

◆ addConfigWarning()

addConfigWarning (   $value = '')

Add warning to config box

Parameters
string$valuethe warning message
Returns
bool
Here is the caller graph for this function:

◆ addInfoBox()

addInfoBox (   $title,
  $type = 'default',
  $extra = '' 
)

Add Info box

Parameters
string$titleinfo box title
string$typefor compatibility only
string$extrafor compatibility only
Returns
bool

◆ addInfoBoxLine()

addInfoBoxLine (   $text = '',
  $type = 'default',
  $color = 'inherit' 
)

Add line to the info box

Parameters
string$texttext to add to info box
string$typetype of infobox line
string$colorcolor for infobox line
Returns
bool

◆ addItemButton()

addItemButton (   $title,
  $link,
  $icon = 'add',
  $extra = '' 
)

Add Item button

Parameters
string$titletitle of button
string$linklink for button
string$iconicon for button
string$extraextra
Returns
bool

◆ displayAbout()

displayAbout (   $logo_xoops = true)

Display about page

Parameters
bool$logo_xoopsdisplay XOOPS logo
Returns
void
Here is the call graph for this function:

◆ displayButton()

displayButton (   $position = null,
  $delimiter = " " 
)

Display all item buttons

Parameters
string$positionbutton position (left, right)
string$delimiterdelimiter between buttons
Returns
void
Here is the call graph for this function:

◆ displayIndex()

displayIndex ( )

Display index page for admin

Returns
void
Here is the call graph for this function:

◆ displayInfoBox()

displayInfoBox ( )

Display InfoBox

Returns
void
Here is the call graph for this function:

◆ displayNavigation()

displayNavigation (   $menu = '')

Display the navigation menu

Parameters
string$menumenu key (script name, i.e. index.php)
Returns
void

◆ getInstance()

static getInstance ( )
static

Retrieve a module admin instance

If we are on a next generation system this will be the a native Xoops\Module\Admin instance. Older systems with the Frameworks based admin class will get an instance of this class which provides compatible methods built from the old Frameworks version.

Returns
object a ModuleAdmin or Xoops\Module\Admin instance.
Here is the call graph for this function:

◆ iconUrl()

static iconUrl (   $name = '',
  $size = '32' 
)
static

Get an appropriate URL for system provided icons.

Things which were in Frameworks in 2.5 are in media in later versions, making it harder to use and rely on the standard icons.

not part of next generation Xoops\Module\Admin

Parameters
string$namethe image name to provide URL for, or blank to just get the URL path.
string$sizethe icon size (directory). Valid values are 16, 32 or /. A '/' slash will simply set the path to the icon directory and append $image.
Returns
string path to icons

◆ isXng()

static isXng ( )
staticprotected

Are we in a next generation environment?

not part of next generation Xoops\Module\Admin

Returns
bool true if we are in a post XOOPS 2.5.x environment

◆ menuIconPath()

static menuIconPath (   $image)
static

Get an appropriate imagePath for menu.php use.

just to help with other admin things than ModuleAdmin

not part of next generation Xoops\Module\Admin

Parameters
string$imageicon name to prepend with path
Returns
string the icon path

◆ renderAbout()

renderAbout (   $logo_xoops = true)

Render about page

Parameters
bool$logo_xoopsdisplay XOOPS logo
Returns
bool|mixed|string
Here is the caller graph for this function:

◆ renderButton()

renderButton (   $position = null,
  $delimiter = " " 
)

Render all items buttons

Parameters
string$positionbutton position (left, right)
string$delimiterdelimiter between buttons
Returns
string
Here is the caller graph for this function:

◆ renderIndex()

renderIndex ( )

Render index page for admin

Returns
string HTML rendered info box
Here is the caller graph for this function:

◆ renderInfoBox()

renderInfoBox ( )

Render InfoBox

Returns
string HTML rendered info box
Here is the caller graph for this function:

◆ renderNavigation()

renderNavigation (   $menu = '')

Render the navigation menu

Parameters
string$menumenu key (script name, i.e. index.php)
Returns
string

◆ setPaypal()

static setPaypal (   $paypal = '')
static

set paypal for 2.5.x renderAbout

not part of next generation Xoops\Module\Admin

Parameters
string$paypalPayPal identifier for donate button
Returns
void

Field Documentation

◆ $lastInfoBoxTitle

$lastInfoBoxTitle = null
protected

◆ $ModuleAdmin

$ModuleAdmin = null
staticprotected

◆ $paypal

$paypal = ''
staticprotected
The documentation for this class was generated from the following file: