include/DashletContainer/DCFactory.php

Show:

inherited

Classes
- \DCFactory

Table of Contents

\DCFactory
jump to top

Package: SugarCRM

The Dashlet Container Factory (DCF) provides a facility for loading the appropriate Dashlet Container.

It will make the decision based on what container is requested as well as system and user settings.

Api
Author: mitani

Properties


                 $defaultContainer= ''DCList''

static

Default value'DCList'Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

Prevent Instantiation of DCFactory it should only be used statically

getContainer(
          string $dashletMetaDataFile, string $container
              =
              null
          )
        
        :
          \DashletContainer

static

This function will make the decision for which container to load.

If container is not specified 1. check if user has a default container they prefer load

Parameters

Name	Type	Description
$dashletMetaDataFile	string	file path to the meta-data specificying the Dashlets used in this container
$container	string	name of the Dashlet Container to use if not specified it will use the system default

Returns

Type	Description
\DashletContainer

Details

Static

include/DashletContainer/DCFactory.php

\DCFactoryjump to top

Properties

Methods

\DCFactory
jump to top