include/DashletContainer/DashletManager.php

Show:

inherited

Classes
- \DashletManager

Table of Contents

\DashletManager
jump to top

Package: SugarCRM

The DashletManager is a way for searching for Dashlets installed on the current system as well as providing a method for accessing a specific Dashlets information. It also allows for instantiating an instance of a Dashlet.

Api
Author: mitani

Properties


                 $dashDefs= 'array()'

static

Default valuearray()Details

Type: n/a


                 $dashletCache= 'array()'

static

Default valuearray()Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

All methods should be called statically prevent instantiation of this class

_loadCache(
           $refresh
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$refresh

getDashlet(
          \GUID $dashletID,  $options
              =
              array(), Object $focusBean
              =
              null
          )
        
        :
          \Dashlet

static

Returns an instance of a Dashlet based on the provided DashletID

Parameters

Name	Type	Description
$dashletID	\GUID	ID of Dashlet to be instantiated
$options
$focusBean	Object	the bean used to generate the dashlet (optional)

Returns

Type	Description
\Dashlet

getDashletFromSubDef(
           $subdefID,  $focusBean
          )
        
        :
          void

static

Parameters

Name	Type	Description
$subdefID
$focusBean

info(
          \GUID $dashletID
          )
        
        :
          \Associative

static

Provides information for a given dashlet in the form of array( 'name'=> dashlet name 'type'=> dashlet type 'category'=> dashlet category 'description'=> description 'author'=> author 'version'=>version 'date_published'=>date published ...

Parameters

Name	Type	Description
$dashletID	\GUID	ID of the dashlet you wish to get information on

Returns

Type	Description
\Associative	Array containg all meta-data about a given dashlet

Details

Static

search(
          string $name
              =
              null, string $module
              =
              null, string $category
              =
              null, string $type
              =
              null
          )
        
        :
          \Associative

static

Allows for searching for a specific dashlet available on the installation to add to a given layout. Search may filter on name, category and type Returns an array in the format array( 'dashlet1-id'=>array('icon'=>icon-image-path ,'name'=>name of dashlet, 'description'=>description of dashlet), 'dashlet2-id'=>array('icon'=>icon-image-path ,'name'=>name of dashlet, 'description'=>description of dashlet), 'dashlet3-id'=>array('icon'=>icon-image-path ,'name'=>name of dashlet, 'description'=>description of dashlet), ...

);

Parameters

Name	Type	Description
$name	string	name to search for by default it searches returns all dashlets
$module	string	module of dashlet to search in by default it searches all modules
$category	string	the category that the dashlet falls into. Acceptable values: module, portal, charts, tools, misc
$type	string	type of dashlet to search for Standard, FocusBean by default it searches for both. Acceptable values: standard, bean, both

Returns

Type	Description
\Associative	Array containing search results keyed by dashlet id

Details

Static

include/DashletContainer/DashletManager.php

\DashletManagerjump to top

Properties

Methods

\DashletManager
jump to top