EmployeesWorkloadGrid extends Base
Class EmployeesWorkloadGrid
Table of Contents
Constants
- DEFAULT_EMPTY_REPORT_COUNT = 1
- MAX_RENDER_REPORT_COUNT = 1
- USE_IN_VISUAL_CONSTRUCTOR = false
- VIEW_KEY = 'employees_workload_grid'
Methods
- __construct() : mixed
- EmployeesWorkloadGrid constructor.
- addComponentParameters() : mixed
- addDefaultReportHandlersToWidgetHandler() : BaseWidget
- When building new widget, add default Report handlers to widget.
- buildWidgetHandlerForBoard() : BaseWidget
- Use if need to construct widget entity by view type.
- collectReportHandlerFormElements() : void
- Method to modify widget form elements.
- collectWidgetHandlerFormElements() : void
- Method to modify widget form elements.
- getCompatibleDataType() : string
- getCompatibleViewTypes() : array<string|int, mixed>
- Return list of compatible view type keys, to this view types can switch without reform configurations.
- getComponentName() : mixed
- getComponentParameters() : string
- getComponentTemplateName() : string
- getHeight() : mixed
- getJsClassName() : string
- getKey() : string
- getLabel() : string
- getLogoUri() : string
- getPreviewImageUri() : mixed
- getReportDefaultColor() : string
- Default colors set for reports.
- getReportHandler() : null
- Find report handler by class name and build Report handler in context of widget handler and view type.
- handlerFinallyBeforePassToView() : array<string|int, mixed>
- Handle all data prepared for this view.
- isCompatibleWithView() : bool
- Check is $view compatible with current view type.
- isDraggable() : bool
- isHorizontalResizable() : bool
- prepareWidgetContent() : array<string|int, mixed>
- Method to modify Content which pass to widget view, in absolute end.
- prepareWidgetFormBeforeRender() : WidgetForm
- Method to modify widget configuration form in context of view.
- setCompatibleDataType() : void
- Set compatible data type.
- setComponentName() : void
- Setter for component name.
- setComponentParameters() : void
- Component parameters setter.
- setComponentTemplateName() : mixed
- setDraggable() : void
- Setter for draggable.
- setHeight() : void
- Setter for height.
- setHorizontalResizable() : mixed
- If true then big widget can set to small place.
- setJsClassName() : void
- Setter for js class name.
- setLabel() : void
- Setter for label.
- setLogoUri() : void
- Setter for miniature src.
- setPreviewImageUri() : mixed
Constants
DEFAULT_EMPTY_REPORT_COUNT
public
mixed
DEFAULT_EMPTY_REPORT_COUNT
= 1
MAX_RENDER_REPORT_COUNT
public
mixed
MAX_RENDER_REPORT_COUNT
= 1
USE_IN_VISUAL_CONSTRUCTOR
public
mixed
USE_IN_VISUAL_CONSTRUCTOR
= false
VIEW_KEY
public
mixed
VIEW_KEY
= 'employees_workload_grid'
Methods
__construct()
EmployeesWorkloadGrid constructor.
public
__construct() : mixed
addComponentParameters()
public
addComponentParameters(mixed $key, mixed $value) : mixed
Parameters
- $key : mixed
- $value : mixed
addDefaultReportHandlersToWidgetHandler()
When building new widget, add default Report handlers to widget.
public
addDefaultReportHandlersToWidgetHandler(BaseWidget $widgetHandler) : BaseWidget
Parameters
- $widgetHandler : BaseWidget
-
Widget handler.
Return values
BaseWidgetbuildWidgetHandlerForBoard()
Use if need to construct widget entity by view type.
public
final buildWidgetHandlerForBoard(string $boardId) : BaseWidget
Parameters
- $boardId : string
-
Board id.
Return values
BaseWidgetcollectReportHandlerFormElements()
Method to modify widget form elements.
public
collectReportHandlerFormElements(BaseReport $reportHandler) : void
Parameters
- $reportHandler : BaseReport
-
Widget handler.
collectWidgetHandlerFormElements()
Method to modify widget form elements.
public
collectWidgetHandlerFormElements(BaseWidget $widgetHandler) : void
Parameters
- $widgetHandler : BaseWidget
-
Widget handler.
getCompatibleDataType()
public
getCompatibleDataType() : string
Return values
stringgetCompatibleViewTypes()
Return list of compatible view type keys, to this view types can switch without reform configurations.
public
getCompatibleViewTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>getComponentName()
public
getComponentName() : mixed
getComponentParameters()
public
getComponentParameters() : string
Return values
stringgetComponentTemplateName()
public
getComponentTemplateName() : string
Return values
stringgetHeight()
public
getHeight() : mixed
getJsClassName()
public
getJsClassName() : string
Return values
stringgetKey()
public
getKey() : string
Return values
stringgetLabel()
public
getLabel() : string
Return values
stringgetLogoUri()
public
getLogoUri() : string
Return values
stringgetPreviewImageUri()
public
getPreviewImageUri() : mixed
getReportDefaultColor()
Default colors set for reports.
public
getReportDefaultColor(int $num) : string
Parameters
- $num : int
-
Number of color which need.
Return values
stringgetReportHandler()
Find report handler by class name and build Report handler in context of widget handler and view type.
public
getReportHandler(string $reportHandlerClassName, BaseWidget $widgetHandler) : null
Parameters
- $reportHandlerClassName : string
-
Report handler class name.
- $widgetHandler : BaseWidget
-
Widget handler.
Return values
nullhandlerFinallyBeforePassToView()
Handle all data prepared for this view.
public
handlerFinallyBeforePassToView(array<string|int, mixed> $calculatedPerformedData) : array<string|int, mixed>
Parameters
- $calculatedPerformedData : array<string|int, mixed>
-
Performed data from report handler.
Return values
array<string|int, mixed>isCompatibleWithView()
Check is $view compatible with current view type.
public
isCompatibleWithView(View $view) : bool
Parameters
- $view : View
-
View entity.
Return values
boolisDraggable()
public
isDraggable() : bool
Return values
boolisHorizontalResizable()
public
isHorizontalResizable() : bool
Return values
boolprepareWidgetContent()
Method to modify Content which pass to widget view, in absolute end.
public
prepareWidgetContent(Widget $widget[, bool $withCalculatedData = false ]) : array<string|int, mixed>
Parameters
- $widget : Widget
-
Widget entity.
- $withCalculatedData : bool = false
-
Marker for calculate or no data in widget.
Return values
array<string|int, mixed>prepareWidgetFormBeforeRender()
Method to modify widget configuration form in context of view.
public
prepareWidgetFormBeforeRender(WidgetForm $form) : WidgetForm
Parameters
- $form : WidgetForm
-
Form Entity.
Return values
WidgetForm —$form
setCompatibleDataType()
Set compatible data type.
public
setCompatibleDataType(string $compatibleDataType) : void
Parameters
- $compatibleDataType : string
-
Data type which compatible with view type.
setComponentName()
Setter for component name.
public
setComponentName(string $componentName) : void
Parameters
- $componentName : string
-
Component name.
setComponentParameters()
Component parameters setter.
public
setComponentParameters(array<string|int, mixed> $componentParameters) : void
Parameters
- $componentParameters : array<string|int, mixed>
-
Parameters which pass to component.
setComponentTemplateName()
public
setComponentTemplateName(string $componentTemplateName) : mixed
Parameters
- $componentTemplateName : string
setDraggable()
Setter for draggable.
public
setDraggable(bool $draggable) : void
Parameters
- $draggable : bool
-
Marker for dragging functionality.
setHeight()
Setter for height.
public
setHeight(mixed $height) : void
Can be 'auto'
Parameters
- $height : mixed
-
Height of widget with header 55px.
setHorizontalResizable()
If true then big widget can set to small place.
public
setHorizontalResizable(bool $horizontalResizable) : mixed
Parameters
- $horizontalResizable : bool
-
Marker to set resizable mode. #return void
setJsClassName()
Setter for js class name.
public
setJsClassName(string $jsClassName) : void
Parameters
- $jsClassName : string
-
Js class name.
setLabel()
Setter for label.
public
setLabel(string $label) : void
Parameters
- $label : string
-
Label text.
setLogoUri()
Setter for miniature src.
public
setLogoUri(string $logoUri) : void
Parameters
- $logoUri : string
-
Path to miniature image.
setPreviewImageUri()
public
setPreviewImageUri(mixed $previewImageUri) : mixed
Parameters
- $previewImageUri : mixed