KanbanBoard Class Reference

Inheritance diagram for KanbanBoard:
TaskKanbanBoard

Public Member Functions

 __construct (RedBeanModel $model, $groupByAttribute)
 getIsActive ()
 setIsActive ()
 setIsNotActive ()
 getGridViewParams ()
 getGroupByAttributeVisibleValues ()
 setGroupByAttributeVisibleValues ($groupByAttributeVisibleValues)
 getGroupByDataAndTranslatedLabels ()
 getSelectedTheme ()
 setSelectedTheme ($selectedTheme)
 getDefaultTheme ()
 getSelectedThemeKeyByModelName ($modelName)
 getThemeNamesAndLabels ()
 getThemeColorNamesAndUnlockedAtLevel ()
 setClearSticky ()
 getClearSticky ()
 resolveVisibleValuesForAdaptedMetadata (&$metadata)

Static Public Member Functions

static resolveKanbanBoardOptionsForSearchModelFromArray ($searchModel, $getArrayName, $sourceData)
static getGridViewWidgetPath ()

Data Fields

const GROUP_BY_ATTRIBUTE_VISIBLE_VALUES = 'groupByAttributeVisibleValues'
const SELECTED_THEME = 'selectedTheme'
const ATTRIBUTE_SEPARATOR = '_'

Protected Member Functions

 resolveAndGetSelectedTheme ()
 resolveGroupByDataAndTranslatedLabels ()

Protected Attributes

 $model
 $groupByAttribute
 $groupByDataAndTranslatedLabels
 $groupByAttributeVisibleValues
 $selectedTheme
 $active
 $clearSticky = false

Detailed Description

Helper class to work with KanbanBoard views

Definition at line 40 of file KanbanBoard.php.


Constructor & Destructor Documentation

__construct ( RedBeanModel model,
groupByAttribute 
)
Parameters:
RedBeanModel $model
string $groupByAttribute
Exceptions:
NotSupportedException 

Definition at line 124 of file KanbanBoard.php.


Member Function Documentation

static resolveKanbanBoardOptionsForSearchModelFromArray ( searchModel,
getArrayName,
sourceData 
) [static]

From the get array, if the groupByAttributeVisibleValues variable is present, retrieve and set into the $searchModel. Also resolves for the selectedTheme variable.

Parameters:
object $searchModel
string $getArrayName
$sourceData 

Definition at line 76 of file KanbanBoard.php.

static getGridViewWidgetPath (  )  [static]
Returns:
string

Reimplemented in TaskKanbanBoard.

Definition at line 114 of file KanbanBoard.php.

getIsActive (  ) 
Returns:
bool

Definition at line 139 of file KanbanBoard.php.

getGridViewParams (  ) 
Returns:
array

Reimplemented in TaskKanbanBoard.

Definition at line 157 of file KanbanBoard.php.

getGroupByAttributeVisibleValues (  ) 
Returns:
array

Definition at line 168 of file KanbanBoard.php.

setGroupByAttributeVisibleValues ( groupByAttributeVisibleValues  ) 
Parameters:
$groupByAttributeVisibleValues 

Definition at line 176 of file KanbanBoard.php.

getGroupByDataAndTranslatedLabels (  ) 
Returns:
array

Definition at line 185 of file KanbanBoard.php.

getSelectedTheme (  ) 
Returns:
mixed

Definition at line 193 of file KanbanBoard.php.

setSelectedTheme ( selectedTheme  ) 
Parameters:
$selectedTheme 

Definition at line 201 of file KanbanBoard.php.

getDefaultTheme (  ) 
Returns:
null

Definition at line 214 of file KanbanBoard.php.

resolveAndGetSelectedTheme (  )  [protected]
Returns:
configuration|null if selected theme exists in database, return that, else return default theme

Definition at line 223 of file KanbanBoard.php.

getThemeNamesAndLabels (  ) 
Returns:
array

Definition at line 247 of file KanbanBoard.php.

getClearSticky (  ) 
Returns:
bool

Definition at line 289 of file KanbanBoard.php.

resolveVisibleValuesForAdaptedMetadata ( &$  metadata  ) 
Parameters:
array $metadata

Definition at line 297 of file KanbanBoard.php.

resolveGroupByDataAndTranslatedLabels (  )  [protected]
Returns:
array

Definition at line 340 of file KanbanBoard.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Aug 21 07:10:26 2017