modules/Charts/Dashlets/MyTeamModulesUsedChartDashlet/MyTeamModulesUsedChartDashlet.php

Show:

inherited

Classes
- \MyTeamModulesUsedChartDashlet

Table of Contents

\MyTeamModulesUsedChartDashlet
jump to top

Package:

Basic Dashlet

Parent(s): \DashletGenericChart < \Dashlet

Properties

object
                 $_configureSS= ''

inherited

smarty object for the generic configuration template

Inherited from: \DashletGenericChart::$$_configureSS

Details

Type: object
Inherited_from: \DashletGenericChart::$$_configureSS

string
                 $_configureTpl= ''include/Dashlets/DashletGenericChartConfigure.tpl''

inherited

location of smarty template file for configuring

Inherited from: \DashletGenericChart::$$_configureTpl

Default value'include/Dashlets/DashletGenericChartConfigure.tpl'Details

Type: string
Inherited_from: \DashletGenericChart::$$_configureTpl

array
                 $_searchFields= ''

inherited

Array of fields and thier defintions that we are searching on

Inherited from: \DashletGenericChart::$$_searchFields

Details

Type: array
Inherited_from: \DashletGenericChart::$$_searchFields

object
                 $_seedBean= ''

inherited

Bean file used in this Dashlet

Inherited from: \DashletGenericChart::$$_seedBean

Details

Type: object
Inherited_from: \DashletGenericChart::$$_seedBean

string
                 $_seedName= ''Trackers''

Module used in this Dashlet

Default value'Trackers'Details

Type: string
See: \DashletGenericChart::$_seedName

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 \DashletGenericChart::$$autoRefresh

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

Default value"0"Details

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

array
                 $dashletStrings= ''

inherited

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

Inherited from: \Dashlet::$$dashletStrings \DashletGenericChart::$$dashletStrings

Details

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

bool
                 $hasScript= 'false'

inherited

true if the Dashlet contains javascript

Inherited from: \Dashlet::$$hasScript \DashletGenericChart::$$hasScript

Default valuefalseDetails

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

\guid
                 $id= ''

inherited

Id of the Dashlet

Inherited from: \Dashlet::$$id \DashletGenericChart::$$id

Details

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

bool
                 $isConfigPanelClearShown= 'false'

true if the Dashlet configuration options panel has the clear button

Default valuefalseDetails

Type: bool
See: \Dashlet::$isConfigPanelClearShown

bool
                 $isConfigurable= 'true'

true if the Dashlet has configuration options.

Default valuetrueDetails

Type: bool
See: \Dashlet::$isConfigurable

bool
                 $isRefreshable= 'true'

inherited

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

Inherited from: \DashletGenericChart::$$isRefreshable

Default valuetrueDetails

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

string
                 $title= ''

inherited

The title of the dashlet

Inherited from: \DashletGenericChart::$$title

Details

Type: string
Inherited_from: \DashletGenericChart::$$title

Methods

Dashlet(
           $id
          )
        
        :
          void

inherited

Constructor

Inherited from: \Dashlet::Dashlet()\DashletGenericChart::Dashlet()

Parameters

Name	Type	Description
$id

__construct(
          int $id, array $options
              =
              null
          )
        
        :
          void

inherited

Constructor

Inherited from: \DashletGenericChart::__construct()

Parameters

Name	Type	Description
$id	int
$options	array

constructGroupBy(
          
          )
        
        :
          string

inherited

Returns the array of group by parameters for SugarChart::$group_by

Inherited from: \DashletGenericChart::constructGroupBy()

Returns

Type	Description
string	SQL query

constructQuery(
          
          )
        
        :
          string

Returns the built query read to feed into SugarChart::getData()

Returns

Type	Description
string	SQL query

Details

See: \DashletGenericChart::constructQuery()

display(
          
          )
        
        :
          string

Displays the Dashlet, must call process() prior to calling this

Returns

Type	Description
string	HTML that displays Dashlet

Details

See: \DashletGenericChart::display()

displayOptions(
          
          )
        
        :
          string

inherited

Handles displaying the chart dashlet configuration popup window

Inherited from: \DashletGenericChart::displayOptions()

Returns

Type	Description
string	HTML to return to the browser

displayScript(
          
          )
        
        :
          string

inherited

Displays the javascript for the dashlet

Inherited from: \DashletGenericChart::displayScript()

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()\DashletGenericChart::getAutoRefreshOptions()

Returns

Type	Description
array	options available

getConfigureSmartyInstance(
          
          )
        
        :
          void

inherited

Gets the smarty object for the config window. Designed to allow lazy loading the object when it's needed.

Inherited from: \DashletGenericChart::getConfigureSmartyInstance()

getFooter(
          
          )
        
        :
          string

inherited

Called when Dashlet is displayed

Inherited from: \Dashlet::getFooter()\DashletGenericChart::getFooter()

Returns

Type	Description
string	footer HTML

getHeader(
          string $text
              =
              ''
          )
        
        :
          string

inherited

Called when Dashlet is displayed

Inherited from: \Dashlet::getHeader()\DashletGenericChart::getHeader()

Parameters

Name	Type	Description
$text	string	text after the title

Returns

Type	Description
string	Header html

getSeedBean(
          
          )
        
        :
          object

inherited

Returns the DashletGenericChart::_seedBean object. Designed to allow lazy loading the object when it's needed.

Inherited from: \DashletGenericChart::getSeedBean()

Returns

Type	Description
object

getTitle(
          string $text
              =
              ''
          )
        
        :
          string

inherited

Inherited from: \Dashlet::getTitle()\DashletGenericChart::getTitle()

Parameters

Name	Type	Description
$text	string

Returns

Type	Description
string	HTML

hasAccess(
          
          )
        
        :
          bool

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

Returns

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

Details

See: \Dashlet::hasAccess()

isAutoRefreshable(
          
          )
        
        :
          bool

inherited

Returns true if the dashlet is auto refreshable

Inherited from: \Dashlet::isAutoRefreshable()\DashletGenericChart::isAutoRefreshable()

Returns

Type	Description
bool

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

inherited

Sets the language strings

Inherited from: \Dashlet::loadLanguage()\DashletGenericChart::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()\DashletGenericChart::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()\DashletGenericChart::process()

processAutoRefresh(
          int $dashletOffset
              =
              0
          )
        
        :
          string

inherited

Processes and displays the auto refresh code for the dashlet

Inherited from: \DashletGenericChart::processAutoRefresh()

Parameters

Name	Type	Description
$dashletOffset	int

Returns

Type	Description
string	HTML code

saveOptions(
          array $req
          )
        
        :
          array

inherited

Saves the chart config options Filter the $_REQUEST and only save only the needed options

Inherited from: \DashletGenericChart::saveOptions()

Parameters

Name	Type	Description
$req	array

Returns

Type	Description
array

setConfigureIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the configure icon

Inherited from: \Dashlet::setConfigureIcon()\DashletGenericChart::setConfigureIcon()

Returns

Type	Description
string	HTML

setDeleteIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the delete icon

Inherited from: \Dashlet::setDeleteIcon()\DashletGenericChart::setDeleteIcon()

Returns

Type	Description
string	HTML

setRefreshIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the refresh icon

Inherited from: \DashletGenericChart::setRefreshIcon()

Returns

Type	Description
string	HTML

Details

See: \Dashlet::setRefreshIcon()

storeOptions(
          array $optionsArray
          )
        
        :
          void

inherited

Generic way to store an options array into UserPreferences

Inherited from: \Dashlet::storeOptions()\DashletGenericChart::storeOptions()

Parameters

Name	Type	Description
$optionsArray	array	the array to save

modules/Charts/Dashlets/MyTeamModulesUsedChartDashlet/MyTeamModulesUsedChartDashlet.php

\MyTeamModulesUsedChartDashletjump to top

Properties

Methods

\MyTeamModulesUsedChartDashlet
jump to top