XOOPS API 2.5.11 Beta1  UI v0.5
Réalisé par monxoops.fr
Fonctions membres publiques | Fonctions membres publiques statiques | Fonctions membres protégées | Fonctions membres protégées statiques | Attributs protégés | Attributs protégés statiques
Référence de la classe Admin

Fonctions membres publiques

 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 ()
 
 displayNavigation ($menu='')
 
 renderAbout ($logo_xoops=true)
 
 displayAbout ($logo_xoops=true)
 
 addConfigError ($value='')
 
 addConfigAccept ($value='')
 
 addConfigWarning ($value='')
 
 addConfigModuleVersion ($moddir, $minversion)
 

Fonctions membres publiques statiques

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

Fonctions membres protégées

 __construct ()
 

Fonctions membres protégées statiques

static isXng ()
 

Attributs protégés

 $lastInfoBoxTitle = null
 

Attributs protégés statiques

static $ModuleAdmin = null
 
static $paypal = ''
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )
protected

Constructor

Documentation des fonctions membres

◆ addConfigAccept()

addConfigAccept (   $value = '')

Add accept (OK) message to config box

Paramètres
string$valuethe OK message
Renvoie
bool
+ Voici le graphe des appelants de cette fonction :

◆ addConfigBoxLine()

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

Add config line

Paramètres
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.
Renvoie
bool
+ Voici le graphe d'appel pour cette fonction :

◆ addConfigError()

addConfigError (   $value = '')

Add error to config box

Paramètres
string$valuethe error message
Renvoie
bool
+ Voici le graphe des appelants de cette fonction :

◆ addConfigModuleVersion()

addConfigModuleVersion (   $moddir,
  $minversion 
)

Check for installed module and version and do addConfigBoxLine()

Paramètres
string$moddir- module directory name
integer$minversion- minimum acceptable module version (100 = V1.00)
Renvoie
bool true if requested version of the module is available
+ Voici le graphe d'appel pour cette fonction :

◆ addConfigWarning()

addConfigWarning (   $value = '')

Add warning to config box

Paramètres
string$valuethe warning message
Renvoie
bool
+ Voici le graphe des appelants de cette fonction :

◆ addInfoBox()

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

Add Info box

Paramètres
string$titleinfo box title
string$typefor compatibility only
string$extrafor compatibility only
Renvoie
bool

◆ addInfoBoxLine()

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

Add line to the info box

Paramètres
string$texttext to add to info box
string$typetype of infobox line
string$colorcolor for infobox line
Renvoie
bool

◆ addItemButton()

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

Add Item button

Paramètres
string$titletitle of button
string$linklink for button
string$iconicon for button
string$extraextra
Renvoie
bool

◆ displayAbout()

displayAbout (   $logo_xoops = true)

Display about page

Paramètres
bool$logo_xoopsdisplay XOOPS logo
Renvoie
void
+ Voici le graphe d'appel pour cette fonction :

◆ displayButton()

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

Display all item buttons

Paramètres
string$positionbutton position (left, right)
string$delimiterdelimiter between buttons
Renvoie
void
+ Voici le graphe d'appel pour cette fonction :

◆ displayIndex()

displayIndex ( )

Display index page for admin

Renvoie
void
+ Voici le graphe d'appel pour cette fonction :

◆ displayInfoBox()

displayInfoBox ( )

Display InfoBox

Renvoie
void
+ Voici le graphe d'appel pour cette fonction :

◆ displayNavigation()

displayNavigation (   $menu = '')

Display the navigation menu

Paramètres
string$menumenu key (script name, i.e. index.php)
Renvoie
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.

Renvoie
object a ModuleAdmin or Xoops\Module\Admin instance.
+ Voici le graphe d'appel pour cette fonction :

◆ 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

Paramètres
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.
Renvoie
string path to icons

◆ isXng()

static isXng ( )
staticprotected

Are we in a next generation environment?

not part of next generation Xoops\Module\Admin

Renvoie
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

Paramètres
string$imageicon name to prepend with path
Renvoie
string the icon path

◆ renderAbout()

renderAbout (   $logo_xoops = true)

Render about page

Paramètres
bool$logo_xoopsdisplay XOOPS logo
Renvoie
bool|mixed|string
+ Voici le graphe des appelants de cette fonction :

◆ renderButton()

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

Render all items buttons

Paramètres
string$positionbutton position (left, right)
string$delimiterdelimiter between buttons
Renvoie
string
+ Voici le graphe des appelants de cette fonction :

◆ renderIndex()

renderIndex ( )

Render index page for admin

Renvoie
string HTML rendered info box
+ Voici le graphe des appelants de cette fonction :

◆ renderInfoBox()

renderInfoBox ( )

Render InfoBox

Renvoie
string HTML rendered info box
+ Voici le graphe des appelants de cette fonction :

◆ setPaypal()

static setPaypal (   $paypal = '')
static

set paypal for 2.5.x renderAbout

not part of next generation Xoops\Module\Admin

Paramètres
string$paypalPayPal identifier for donate button
Renvoie
void

Documentation des champs

◆ $lastInfoBoxTitle

$lastInfoBoxTitle = null
protected

◆ $ModuleAdmin

$ModuleAdmin = null
staticprotected

◆ $paypal

$paypal = ''
staticprotected
La documentation de cette classe a été générée à partir du fichier suivant :