modules/Home/Dashlets/InvadersDashlet/InvadersDashlet.php

Show:

inherited

Classes
- \InvadersDashlet

Table of Contents

\InvadersDashlet
jump to top

Package:

Basic Dashlet

Parent(s): \Dashlet

Properties

int
                 $autoRefresh= '"0"'

inherited

Time period in minutes to refresh the dashlet (0 for never) Do not refresh if $isRefreshable is set to false

Inherited from: \Dashlet::$$autoRefresh

To support auto refresh all refreshable dashlets that override process() must call processAutoRefresh()

Default value"0"Details

Type: int
Inherited_from: \Dashlet::$$autoRefresh

array
                 $dashletStrings= ''

inherited

Language strings, must be loaded at the Dashlet level w/ loadLanguage

Inherited from: \Dashlet::$$dashletStrings

Details

Type: array
Inherited_from: \Dashlet::$$dashletStrings

bool
                 $hasScript= 'false'

inherited

true if the Dashlet contains javascript

Inherited from: \Dashlet::$$hasScript

Default valuefalseDetails

Type: bool
Inherited_from: \Dashlet::$$hasScript


                 $height= ''100''

Default value'100'Details

Type: n/a

\guid
                 $id= ''

inherited

Id of the Dashlet

Inherited from: \Dashlet::$$id

Details

Type: \guid
Inherited_from: \Dashlet::$$id

bool
                 $isConfigPanelClearShown= 'true'

inherited

true if the Dashlet configuration options panel has the clear button

Inherited from: \Dashlet::$$isConfigPanelClearShown

Default valuetrueDetails

Type: bool
Inherited_from: \Dashlet::$$isConfigPanelClearShown

bool
                 $isConfigurable= 'false'

inherited

true if the Dashlet has configuration options.

Inherited from: \Dashlet::$$isConfigurable

Default valuefalseDetails

Type: bool
Inherited_from: \Dashlet::$$isConfigurable

bool
                 $isRefreshable= 'true'

inherited

true if the Dashlet is refreshable (ie charts that provide their own refresh)

Inherited from: \Dashlet::$$isRefreshable

Default valuetrueDetails

Type: bool
Inherited_from: \Dashlet::$$isRefreshable


                 $savedText= ''

Details

Type: n/a

string
                 $title= ''Generic Dashlet''

inherited

Title of the Dashlet

Inherited from: \Dashlet::$$title

Default value'Generic Dashlet'Details

Type: string
Inherited_from: \Dashlet::$$title

Methods

Dashlet(
           $id
          )
        
        :
          void

inherited

Constructor

Inherited from: \Dashlet::Dashlet()

Parameters

Name	Type	Description
$id

InvadersDashlet(
          \guid $id, array $def
          )
        
        :
          void

Constructor

Parameters

Name	Type	Description
$id	\guid	id for the current dashlet (assigned from Home module)
$def	array	options saved for this dashlet

Details

Global: string current language

display(
          
          )
        
        :
          string

Displays the dashlet

Returns

Type	Description
string	html to display dashlet

displayOptions(
          
          )
        
        :
          string

Displays the configuration form for the dashlet

Returns

Type	Description
string	html to display form

displayScript(
          
          )
        
        :
          string

Displays the javascript for the dashlet

Returns

Type	Description
string	javascript to use with this dashlet

getAutoRefreshOptions(
          
          )
        
        :
          array

inherited

Returns the available auto refresh settings you can set a dashlet to

Inherited from: \Dashlet::getAutoRefreshOptions()

Returns

Type	Description
array	options available

getFooter(
          
          )
        
        :
          string

inherited

Called when Dashlet is displayed

Inherited from: \Dashlet::getFooter()

Returns

Type	Description
string	footer HTML

getHeader(
          string $text
              =
              ''
          )
        
        :
          string

inherited

Called when Dashlet is displayed

Inherited from: \Dashlet::getHeader()

Parameters

Name	Type	Description
$text	string	text after the title

Returns

Type	Description
string	Header html

getTitle(
          string $text
              =
              ''
          )
        
        :
          string

inherited

Inherited from: \Dashlet::getTitle()

Parameters

Name	Type	Description
$text	string

Returns

Type	Description
string	HTML

hasAccess(
          
          )
        
        :
          bool

inherited

Override this in the subclass. It is used to determine whether the dashlet can be displayed.

Inherited from: \Dashlet::hasAccess()

Returns

Type	Description
bool	indicating whether or not the current user has access to display this Dashlet.

isAutoRefreshable(
          
          )
        
        :
          bool

inherited

Returns true if the dashlet is auto refreshable

Inherited from: \Dashlet::isAutoRefreshable()

Returns

Type	Description
bool

loadLanguage(
          string $dashletClassname, string $dashletDirectory
              =
              'modules/Home/Dashlets/'
          )
        
        :
          void

inherited

Sets the language strings

Inherited from: \Dashlet::loadLanguage()

Parameters

Name	Type	Description
$dashletClassname	string	classname of the dashlet
$dashletDirectory	string	directory path of the dashlet

loadOptions(
          
          )
        
        :
          array

inherited

Generic way to retrieve options array from UserPreferences

Inherited from: \Dashlet::loadOptions()

Returns

Type	Description
array	options array stored in UserPreferences

process(
          
          )
        
        :
          void

inherited

Override if you need to do pre-processing before display is called

Inherited from: \Dashlet::process()

processAutoRefresh(
          int $dashletOffset
              =
              0
          )
        
        :
          string

inherited

Processes and displays the auto refresh code for the dashlet

Inherited from: \Dashlet::processAutoRefresh()

Parameters

Name	Type	Description
$dashletOffset	int

Returns

Type	Description
string	HTML code

saveOptions(
          array $req
          )
        
        :
          array

called to filter out $_REQUEST object when the user submits the configure dropdown

Parameters

Name	Type	Description
$req	array	$_REQUEST

Returns

Type	Description
array	filtered options to save

saveText(
          
          )
        
        :
          void

Used to save text on textarea blur. Accessed via Home/CallMethodDashlet.php This is an example of how to to call a custom method via ajax

setConfigureIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the configure icon

Inherited from: \Dashlet::setConfigureIcon()

Returns

Type	Description
string	HTML

setDeleteIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the delete icon

Inherited from: \Dashlet::setDeleteIcon()

Returns

Type	Description
string	HTML

setRefreshIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the refresh icon

Inherited from: \Dashlet::setRefreshIcon()

Returns

Type	Description
string	HTML

storeOptions(
          array $optionsArray
          )
        
        :
          void

inherited

Generic way to store an options array into UserPreferences

Inherited from: \Dashlet::storeOptions()

Parameters

Name	Type	Description
$optionsArray	array	the array to save

modules/Home/Dashlets/InvadersDashlet/InvadersDashlet.php

\InvadersDashletjump to top

Properties

Methods

\InvadersDashlet
jump to top