include/Dashlets/DashletGeneric.php

Show:

inherited

Classes
- \DashletGeneric

Table of Contents

\DashletGeneric
jump to top

Package: SugarCRM

Generic Dashlet class

Parent(s): \Dashlet
Children: \SugarFavoritesDashlet; \MyCallsDashlet; \MyReportsDashlet; \MyProjectTaskDashlet; \MyDocumentsDashlet; \MyAccountsDashlet; \MyOpportunitiesDashlet; \MyMeetingsDashlet; \MyNotesDashlet; \SugarFeedDashlet; \MyTasksDashlet; \MyLeadsDashlet; \MyContactsDashlet; \MyQuotesDashlet; \MyCasesDashlet; \MyBugsDashlet; \MyEmailsDashlet; \<module_name>Dashlet
Api

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
                 $columns= ''

Displayable columns (ones available to display)

Details

Type: array

string
                 $configureSS= ''

smarty object for the generic configuration template

Details

Type: string

string
                 $configureTpl= ''include/Dashlets/DashletGenericConfigure.tpl''

location of smarty template file for configuring

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

Type: string

array
                 $currentSearchFields= ''

search inputs to be populated in configure template.

modify this after processDisplayOptions, but before displayOptions to modify search inputs

Details

Type: array

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

array
                 $displayColumns= 'null'

Actual columns to display, will be a subset of $columns

Default valuenullDetails

Type: array

int
                 $displayRows= ''5''

Number of Rows to display

Default value'5'Details

Type: int

string
                 $displayTpl= ''include/Dashlets/DashletGenericDisplay.tpl''

location of Smarty template file for display

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

Type: string

array
                 $filters= 'null'

collection of filters to apply

Default valuenullDetails

Type: array

bool
                 $hasScript= 'false'

inherited

true if the Dashlet contains javascript

Inherited from: \Dashlet::$$hasScript

Default valuefalseDetails

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

\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


                 $layoutManager= ''

Details

Type: n/a

\Smarty
                 $lvs= ''

ListView Smarty Class

Details

Type: \Smarty

bool
                 $myItemsOnly= 'true'

Flag to display only the current users's items.

Default valuetrueDetails

Type: bool

array
                 $searchFields= ''

Fields that are searchable

Details

Type: array

\bean
                 $seedBean= ''

Bean file used in this Dashlet

Details

Type: \bean

bool
                 $showMyItemsOnly= 'true'

Flag to display "myItemsOnly" checkbox in the DashletGenericConfigure.

Default valuetrueDetails

Type: bool

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

DashletGeneric(
           $id,  $options
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$id
$options

addCustomFields(
          
          )
        
        :
          void

Internal function to add custom fields

buildWhere(
          
          )
        
        :
          void

display(
          
          )
        
        :
          string

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

Returns

Type	Description
string	HTML that displays Dashlet

displayOptions(
          
          )
        
        :
          string

Displays the options for this Dashlet

Returns

Type	Description
string	HTML that shows options

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

loadCustomMetadata(
          
          )
        
        :
          void

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(
           $lvsParams
              =
              array()
          )
        
        :
          void

Does all dashlet processing, here's your chance to modify the rows being displayed!

Parameters

Name	Type	Description
$lvsParams

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

processDisplayOptions(
          
          )
        
        :
          string

Sets up the display options template

Returns

Type	Description
string	HTML that shows options

saveOptions(
          array $req
          )
        
        :
          array

Filter the $_REQUEST and only save only the needed options

Parameters

Name	Type	Description
$req	array	the array to pull options from

Returns

Type	Description
array	options array

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

include/Dashlets/DashletGeneric.php

\DashletGenericjump to top

Properties

Methods

\DashletGeneric
jump to top