modules/Emails/Dashlets/MyEmailsDashlet/MyEmailsDashlet.php

Show:

inherited

Classes
- \MyEmailsDashlet

Table of Contents

\MyEmailsDashlet
jump to top

Package:

Generic Dashlet class

Parent(s): \DashletGeneric < \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 \DashletGeneric::$$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: \DashletGeneric::$$autoRefresh

array
                 $columns= ''

inherited

Displayable columns (ones available to display)

Inherited from: \DashletGeneric::$$columns

Details

Type: array
Inherited_from: \DashletGeneric::$$columns

string
                 $configureSS= ''

inherited

smarty object for the generic configuration template

Inherited from: \DashletGeneric::$$configureSS

Details

Type: string
Inherited_from: \DashletGeneric::$$configureSS

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

inherited

location of smarty template file for configuring

Inherited from: \DashletGeneric::$$configureTpl

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

Type: string
Inherited_from: \DashletGeneric::$$configureTpl

array
                 $currentSearchFields= ''

inherited

search inputs to be populated in configure template.

Inherited from: \DashletGeneric::$$currentSearchFields

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

Details

Type: array
Inherited_from: \DashletGeneric::$$currentSearchFields

array
                 $dashletStrings= ''

inherited

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

Inherited from: \Dashlet::$$dashletStrings \DashletGeneric::$$dashletStrings

Details

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

array
                 $displayColumns= 'null'

inherited

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

Inherited from: \DashletGeneric::$$displayColumns

Default valuenullDetails

Type: array
Inherited_from: \DashletGeneric::$$displayColumns

int
                 $displayRows= ''5''

inherited

Number of Rows to display

Inherited from: \DashletGeneric::$$displayRows

Default value'5'Details

Type: int
Inherited_from: \DashletGeneric::$$displayRows

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

inherited

location of Smarty template file for display

Inherited from: \DashletGeneric::$$displayTpl

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

Type: string
Inherited_from: \DashletGeneric::$$displayTpl

array
                 $filters= 'null'

inherited

collection of filters to apply

Inherited from: \DashletGeneric::$$filters

Default valuenullDetails

Type: array
Inherited_from: \DashletGeneric::$$filters

bool
                 $hasScript= 'false'

inherited

true if the Dashlet contains javascript

Inherited from: \Dashlet::$$hasScript \DashletGeneric::$$hasScript

Default valuefalseDetails

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

\guid
                 $id= ''

inherited

Id of the Dashlet

Inherited from: \Dashlet::$$id \DashletGeneric::$$id

Details

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

bool
                 $isConfigPanelClearShown= 'true'

inherited

true if the Dashlet configuration options panel has the clear button

Inherited from: \Dashlet::$$isConfigPanelClearShown \DashletGeneric::$$isConfigPanelClearShown

Default valuetrueDetails

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

bool
                 $isConfigurable= 'false'

inherited

true if the Dashlet has configuration options.

Inherited from: \Dashlet::$$isConfigurable \DashletGeneric::$$isConfigurable

Default valuefalseDetails

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

bool
                 $isRefreshable= 'true'

inherited

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

Inherited from: \Dashlet::$$isRefreshable \DashletGeneric::$$isRefreshable

Default valuetrueDetails

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


                 $layoutManager= ''

inheritedInherited from: \DashletGeneric::$$layoutManager

Details

Type: n/a
Inherited_from: \DashletGeneric::$$layoutManager

\Smarty
                 $lvs= ''

inherited

ListView Smarty Class

Inherited from: \DashletGeneric::$$lvs

Details

Type: \Smarty
Inherited_from: \DashletGeneric::$$lvs

bool
                 $myItemsOnly= 'true'

inherited

Flag to display only the current users's items.

Inherited from: \DashletGeneric::$$myItemsOnly

Default valuetrueDetails

Type: bool
Inherited_from: \DashletGeneric::$$myItemsOnly

array
                 $searchFields= ''

inherited

Fields that are searchable

Inherited from: \DashletGeneric::$$searchFields

Details

Type: array
Inherited_from: \DashletGeneric::$$searchFields

\bean
                 $seedBean= ''

inherited

Bean file used in this Dashlet

Inherited from: \DashletGeneric::$$seedBean

Details

Type: \bean
Inherited_from: \DashletGeneric::$$seedBean

bool
                 $showMyItemsOnly= 'true'

inherited

Flag to display "myItemsOnly" checkbox in the DashletGenericConfigure.

Inherited from: \DashletGeneric::$$showMyItemsOnly

Default valuetrueDetails

Type: bool
Inherited_from: \DashletGeneric::$$showMyItemsOnly

string
                 $title= ''Generic Dashlet''

inherited

Title of the Dashlet

Inherited from: \Dashlet::$$title \DashletGeneric::$$title

Default value'Generic Dashlet'Details

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

Methods

Dashlet(
           $id
          )
        
        :
          void

inherited

Constructor

Inherited from: \Dashlet::Dashlet()\DashletGeneric::Dashlet()

Parameters

Name	Type	Description
$id

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

inherited

Inherited from: \DashletGeneric::DashletGeneric()

Parameters

Name	Type	Description
$id
$options

MyEmailsDashlet(
           $id,  $def
              =
              null
          )
        
        :
          void

Parameters

Name	Type	Description
$id
$def

addCustomFields(
          
          )
        
        :
          void

inherited

Internal function to add custom fields

Inherited from: \DashletGeneric::addCustomFields()

buildWhere(
          
          )
        
        :
          void

inherited

Inherited from: \DashletGeneric::buildWhere()

display(
          
          )
        
        :
          string

inherited

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

Inherited from: \DashletGeneric::display()

Returns

Type	Description
string	HTML that displays Dashlet

displayOptions(
          
          )
        
        :
          string

inherited

Displays the options for this Dashlet

Inherited from: \DashletGeneric::displayOptions()

Returns

Type	Description
string	HTML that shows options

displayScript(
          
          )
        
        :
          void

getAutoRefreshOptions(
          
          )
        
        :
          array

inherited

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

Inherited from: \Dashlet::getAutoRefreshOptions()\DashletGeneric::getAutoRefreshOptions()

Returns

Type	Description
array	options available

getFooter(
          
          )
        
        :
          string

inherited

Called when Dashlet is displayed

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

Returns

Type	Description
string	footer HTML

getHeader(
          string $text
              =
              ''
          )
        
        :
          string

inherited

Called when Dashlet is displayed

Inherited from: \Dashlet::getHeader()\DashletGeneric::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()\DashletGeneric::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()\DashletGeneric::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()\DashletGeneric::isAutoRefreshable()

Returns

Type	Description
bool

loadCustomMetadata(
          
          )
        
        :
          void

inherited

Inherited from: \DashletGeneric::loadCustomMetadata()

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

inherited

Sets the language strings

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

Returns

Type	Description
array	options array stored in UserPreferences

process(
          
          )
        
        :
          void

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

processAutoRefresh(
          int $dashletOffset
              =
              0
          )
        
        :
          string

inherited

Processes and displays the auto refresh code for the dashlet

Inherited from: \Dashlet::processAutoRefresh()\DashletGeneric::processAutoRefresh()

Parameters

Name	Type	Description
$dashletOffset	int

Returns

Type	Description
string	HTML code

processDisplayOptions(
          
          )
        
        :
          string

inherited

Sets up the display options template

Inherited from: \DashletGeneric::processDisplayOptions()

Returns

Type	Description
string	HTML that shows options

saveOptions(
          array $req
          )
        
        :
          array

inherited

Filter the $_REQUEST and only save only the needed options

Inherited from: \DashletGeneric::saveOptions()

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()\DashletGeneric::setConfigureIcon()

Returns

Type	Description
string	HTML

setDeleteIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the delete icon

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

Returns

Type	Description
string	HTML

setRefreshIcon(
          
          )
        
        :
          string

inherited

Returns the HTML for the refresh icon

Inherited from: \Dashlet::setRefreshIcon()\DashletGeneric::setRefreshIcon()

Returns

Type	Description
string	HTML

storeOptions(
          array $optionsArray
          )
        
        :
          void

inherited

Generic way to store an options array into UserPreferences

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

Parameters

Name	Type	Description
$optionsArray	array	the array to save

modules/Emails/Dashlets/MyEmailsDashlet/MyEmailsDashlet.php

\MyEmailsDashletjump to top

Properties

Methods

\MyEmailsDashlet
jump to top