TGantt
extends TElement
in package
TGantt
Tags
Table of Contents
Constants
- ADJUST_MARGIN = ['xs' => 0, 'sm' => 2, 'md' => 4, 'lg' => 10]
- COLUMNHOURVAL = 24
- HOURS = ['00', '06', '12', '18']
- HOURS_24 = ['00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23']
- MODE_DAYS = 'MODE_DAYS'
- MODE_DAYS_WITH_HOUR = 'MODE_DAYS_WITH_HOUR'
- MODE_MONTHS = 'MODE_MONTHS'
- MODE_MONTHS_WITH_DAY = 'MODE_MONTHS_WITH_DAY'
- SIZES = ['xs', 'sm', 'md', 'lg']
- SIZESPX = [30, 60, 120, 240]
- SIZESPXHORAS = [120, 240, 480, 960]
Properties
- $children : mixed
- $afterElement : mixed
- $count_hours : mixed
- $dates : mixed
- $dayClickAction : mixed
- $dragEvent : mixed
- $end_date : mixed
- $eventAction : mixed
- $events : mixed
- $headerActions : mixed
- $hidden : mixed
- $hours : mixed
- $interval : mixed
- $isVoidElement : mixed
- $minutesStep : mixed
- $properties : mixed
- $reloadAction : mixed
- $remove_space : mixed
- $rows : mixed
- $size : mixed
- $size_mode_button : mixed
- $size_mode_options : mixed
- $start_date : mixed
- $stripedMonths : mixed
- $stripedRows : mixed
- $tagname : mixed
- $title : mixed
- $transformEventLabel : mixed
- $transformTimeTitle : mixed
- $updateAction : mixed
- $useLineBreaks : mixed
- $useSingleQuotes : mixed
- $view_mode : mixed
- $view_mode_button : mixed
- $view_mode_options : mixed
- $voidelements : mixed
- $wrapped : mixed
Methods
- __clone() : mixed
- Clone the object
- __construct() : mixed
- Constructor method
- __get() : mixed
- Returns a property's value
- __isset() : mixed
- Returns is a property's is set
- __set() : mixed
- Intercepts whenever someones assign a new property's value
- __toString() : mixed
- Converts the object into a string
- __unset() : mixed
- Intercepts whenever someones unset a property's value
- add() : mixed
- Add an child element
- addEvent() : mixed
- Add new event on Gantt
- addHeaderAction() : mixed
- Define reload events action
- addHeaderWidget() : mixed
- Add a form header widget
- addMany() : mixed
- Add many children
- addRow() : mixed
- Add new row
- after() : mixed
- Insert element after
- clearChildren() : mixed
- Clear element children
- clearEvents() : mixed
- close() : mixed
- BC only
- closeTag() : mixed
- Closes the tag
- del() : mixed
- Del an child element
- enableDragEvent() : mixed
- Define drag event action
- enableFullHours() : mixed
- Enable hour when MODE_DAYS_WITH_HOUR 24h
- enableSizeModeButton() : mixed
- Enable size_mode button
- enableStripedMonths() : mixed
- Add background striped on columns
- enableStripedRows() : mixed
- Add background striped on rows
- enableViewModeButton() : mixed
- Enable view_mode button
- enableVoidElement() : mixed
- Turn element into a void element
- find() : mixed
- Find child element
- get() : mixed
- Get an child element
- getAfterElement() : mixed
- Return the after element
- getChildren() : mixed
- get children
- getContents() : mixed
- Returns the element content as a string
- getEndDate() : mixed
- Return date end gantt
- getIsWrapped() : mixed
- Return if the element is wrapped inside another one
- getName() : mixed
- Returns tag name
- getProperties() : mixed
- Return element properties
- getProperty() : mixed
- Return a property
- getSizeMode() : mixed
- Get size mode
- getStartDate() : mixed
- Return date start gantt
- getViewMode() : mixed
- Get view mode
- hide() : mixed
- hide object
- insert() : mixed
- Insert an child element
- open() : mixed
- BC only
- openTag() : mixed
- Opens the tag
- removeSpaceBetweenEvents() : mixed
- Remove spaces between events
- renderPopover() : mixed
- Render title popover
- setDayClickAction() : mixed
- Define the day click action
- setEventClickAction() : mixed
- Define click event action
- setInterval() : mixed
- Define interval between dates
- setIsWrapped() : mixed
- Define if the element is wrapped inside another one
- setName() : mixed
- Change the element name
- setProperties() : mixed
- Set element properties
- setProperty() : mixed
- Set tag property
- setReloadAction() : mixed
- Define reload events action
- setSizeMode() : mixed
- Define view mode
- setStartDate() : mixed
- Define date start gantt
- setTitle() : mixed
- Define title of header gantt
- setTransformerEventLabel() : mixed
- Define transformer event label
- setTransformerTimeTitle() : mixed
- Define transformer time title
- setUseLineBreaks() : mixed
- Set the use of linebreaks
- setUseSingleQuotes() : mixed
- Set the use of single quotes
- setViewMode() : mixed
- Change view mode
- show() : mixed
- Shows the tag
- tag() : mixed
- Create an element
- getColumnSize() : mixed
- Rerturn size column based into a zoom level
- getDates() : mixed
- Return dates into interval
- geTimeTitle() : mixed
- Return title gantt
- getPixelValue() : mixed
- Return pixel value step minutes
- renderAside() : mixed
- Render rows
- renderDailyHeader() : mixed
- Render header table days
- renderDailyHourHeader() : mixed
- Render header table hours
- renderEvent() : mixed
- Render event
- renderGantt() : mixed
- Render gantt
- renderHeader() : mixed
- renderMonthDayHeader() : mixed
- Render header table month day
- renderMonthHeader() : mixed
- Render header table month
- renderTimeTable() : mixed
- Render time table
- renderTimeTableHeader() : mixed
- Render header table
Constants
ADJUST_MARGIN
public
mixed
ADJUST_MARGIN
= ['xs' => 0, 'sm' => 2, 'md' => 4, 'lg' => 10]
COLUMNHOURVAL
public
mixed
COLUMNHOURVAL
= 24
HOURS
public
mixed
HOURS
= ['00', '06', '12', '18']
HOURS_24
public
mixed
HOURS_24
= ['00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23']
MODE_DAYS
public
mixed
MODE_DAYS
= 'MODE_DAYS'
MODE_DAYS_WITH_HOUR
public
mixed
MODE_DAYS_WITH_HOUR
= 'MODE_DAYS_WITH_HOUR'
MODE_MONTHS
public
mixed
MODE_MONTHS
= 'MODE_MONTHS'
MODE_MONTHS_WITH_DAY
public
mixed
MODE_MONTHS_WITH_DAY
= 'MODE_MONTHS_WITH_DAY'
SIZES
public
mixed
SIZES
= ['xs', 'sm', 'md', 'lg']
SIZESPX
public
mixed
SIZESPX
= [30, 60, 120, 240]
SIZESPXHORAS
public
mixed
SIZESPXHORAS
= [120, 240, 480, 960]
Properties
$children
protected
mixed
$children
$afterElement
private
mixed
$afterElement
$count_hours
private
mixed
$count_hours
$dates
private
mixed
$dates
= []
$dayClickAction
private
mixed
$dayClickAction
$dragEvent
private
mixed
$dragEvent
$end_date
private
mixed
$end_date
$eventAction
private
mixed
$eventAction
$events
private
mixed
$events
$headerActions
private
mixed
$headerActions
= []
$hidden
private
mixed
$hidden
$hours
private
mixed
$hours
$interval
private
mixed
$interval
$isVoidElement
private
mixed
$isVoidElement
$minutesStep
private
mixed
$minutesStep
$properties
private
mixed
$properties
$reloadAction
private
mixed
$reloadAction
$remove_space
private
mixed
$remove_space
= FALSE
$rows
private
mixed
$rows
$size
private
mixed
$size
$size_mode_button
private
mixed
$size_mode_button
= FALSE
$size_mode_options
private
mixed
$size_mode_options
$start_date
private
mixed
$start_date
$stripedMonths
private
mixed
$stripedMonths
= FALSE
$stripedRows
private
mixed
$stripedRows
= FALSE
$tagname
private
mixed
$tagname
$title
private
mixed
$title
= ''
$transformEventLabel
private
mixed
$transformEventLabel
= NULL
$transformTimeTitle
private
mixed
$transformTimeTitle
= NULL
$updateAction
private
mixed
$updateAction
$useLineBreaks
private
mixed
$useLineBreaks
$useSingleQuotes
private
mixed
$useSingleQuotes
$view_mode
private
mixed
$view_mode
$view_mode_button
private
mixed
$view_mode_button
= FALSE
$view_mode_options
private
mixed
$view_mode_options
$voidelements
private
static mixed
$voidelements
$wrapped
private
mixed
$wrapped
Methods
__clone()
Clone the object
public
__clone() : mixed
__construct()
Constructor method
public
__construct(mixed $view_mode[, mixed $size = 'md' ]) : mixed
Parameters
- $view_mode : mixed
- $size : mixed = 'md'
__get()
Returns a property's value
public
__get(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__isset()
Returns is a property's is set
public
__isset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
__set()
Intercepts whenever someones assign a new property's value
public
__set(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
__toString()
Converts the object into a string
public
__toString() : mixed
__unset()
Intercepts whenever someones unset a property's value
public
__unset(mixed $name) : mixed
Parameters
- $name : mixed
-
Property Name
add()
Add an child element
public
add(mixed $child) : mixed
Parameters
- $child : mixed
-
Any object that implements the show() method
addEvent()
Add new event on Gantt
public
addEvent(mixed $id, mixed $rowId, mixed $title, mixed $start_time, mixed $end_time[, mixed $color = NULL ][, mixed $percent = null ]) : mixed
Parameters
- $id : mixed
-
any Key of event
- $rowId : mixed
-
any Key of row
- $title : mixed
-
String title
- $start_time : mixed
-
String date start
- $end_time : mixed
-
String date end
- $color : mixed = NULL
-
String color background
- $percent : mixed = null
-
float percent color
addHeaderAction()
Define reload events action
public
addHeaderAction(TAction $action[, mixed $label = '' ][, mixed $icon = null ]) : mixed
Parameters
- $action : TAction
- $label : mixed = ''
-
String Button label
- $icon : mixed = null
-
TImage Button icon
addHeaderWidget()
Add a form header widget
public
addHeaderWidget(mixed $widget) : mixed
Parameters
- $widget : mixed
-
Widget
addMany()
Add many children
public
addMany(mixed $children) : mixed
Parameters
- $children : mixed
-
Array of child
addRow()
Add new row
public
addRow(mixed $id, mixed $label) : mixed
Parameters
- $id : mixed
-
any Key of row
- $label : mixed
after()
Insert element after
public
after(mixed $element) : mixed
Parameters
- $element : mixed
clearChildren()
Clear element children
public
clearChildren() : mixed
clearEvents()
public
clearEvents() : mixed
close()
BC only
public
close() : mixed
closeTag()
Closes the tag
public
closeTag() : mixed
del()
Del an child element
public
del(mixed $object) : mixed
Parameters
- $object : mixed
enableDragEvent()
Define drag event action
public
enableDragEvent(TAction $updateAction[, mixed $minutesStep = 1440 ]) : mixed
Parameters
- $updateAction : TAction
- $minutesStep : mixed = 1440
enableFullHours()
Enable hour when MODE_DAYS_WITH_HOUR 24h
public
enableFullHours() : mixed
enableSizeModeButton()
Enable size_mode button
public
enableSizeModeButton([mixed $with_label = TRUE ][, mixed $with_icon = TRUE ][, mixed $label = NULL ][, mixed $icon = NULL ]) : mixed
Parameters
- $with_label : mixed = TRUE
- $with_icon : mixed = TRUE
- $label : mixed = NULL
- $icon : mixed = NULL
enableStripedMonths()
Add background striped on columns
public
enableStripedMonths() : mixed
enableStripedRows()
Add background striped on rows
public
enableStripedRows() : mixed
enableViewModeButton()
Enable view_mode button
public
enableViewModeButton([mixed $with_label = TRUE ][, mixed $with_icon = TRUE ][, mixed $label = NULL ][, mixed $icon = NULL ]) : mixed
Parameters
- $with_label : mixed = TRUE
- $with_icon : mixed = TRUE
- $label : mixed = NULL
- $icon : mixed = NULL
enableVoidElement()
Turn element into a void element
public
enableVoidElement() : mixed
find()
Find child element
public
find(mixed $element[, mixed $properties = null ]) : mixed
Parameters
- $element : mixed
-
tag name
- $properties : mixed = null
-
match properties
get()
Get an child element
public
get(mixed $position) : mixed
Parameters
- $position : mixed
-
Element position
getAfterElement()
Return the after element
public
getAfterElement() : mixed
getChildren()
get children
public
getChildren() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getEndDate()
Return date end gantt
public
getEndDate() : mixed
getIsWrapped()
Return if the element is wrapped inside another one
public
getIsWrapped() : mixed
getName()
Returns tag name
public
getName() : mixed
getProperties()
Return element properties
public
getProperties() : mixed
getProperty()
Return a property
public
getProperty(mixed $name) : mixed
Parameters
- $name : mixed
-
property name
getSizeMode()
Get size mode
public
getSizeMode() : mixed
getStartDate()
Return date start gantt
public
getStartDate() : mixed
getViewMode()
Get view mode
public
getViewMode() : mixed
hide()
hide object
public
hide() : mixed
insert()
Insert an child element
public
insert(mixed $position, mixed $child) : mixed
Parameters
- $position : mixed
-
Element position
- $child : mixed
-
Any object that implements the show() method
open()
BC only
public
open() : mixed
openTag()
Opens the tag
public
openTag() : mixed
removeSpaceBetweenEvents()
Remove spaces between events
public
removeSpaceBetweenEvents() : mixed
renderPopover()
Render title popover
public
static renderPopover(mixed $title, mixed $poptitle, mixed $popcontent) : mixed
Parameters
- $title : mixed
-
Event title
- $poptitle : mixed
-
Popover Title
- $popcontent : mixed
-
Popover Content
setDayClickAction()
Define the day click action
public
setDayClickAction(mixed $action) : mixed
Parameters
- $action : mixed
-
day click action
setEventClickAction()
Define click event action
public
setEventClickAction(mixed $action) : mixed
Parameters
- $action : mixed
-
TAction
setInterval()
Define interval between dates
public
setInterval([mixed $interval = '1 month' ]) : mixed
Parameters
- $interval : mixed = '1 month'
-
String 1|2|4 number concat with type month|day|year e.g: 1 month, 10 days
setIsWrapped()
Define if the element is wrapped inside another one
public
setIsWrapped(mixed $bool) : mixed
Parameters
- $bool : mixed
setName()
Change the element name
public
setName(mixed $tagname) : mixed
Parameters
- $tagname : mixed
-
Element name
setProperties()
Set element properties
public
setProperties(mixed $properties) : mixed
Parameters
- $properties : mixed
setProperty()
Set tag property
public
setProperty(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
-
Property Name
- $value : mixed
-
Property Value
setReloadAction()
Define reload events action
public
setReloadAction(mixed $reloadAction) : mixed
Parameters
- $reloadAction : mixed
-
TAction
setSizeMode()
Define view mode
public
setSizeMode(mixed $size) : mixed
Parameters
- $size : mixed
setStartDate()
Define date start gantt
public
setStartDate(mixed $date) : mixed
Parameters
- $date : mixed
-
String date
setTitle()
Define title of header gantt
public
setTitle(mixed $title) : mixed
Parameters
- $title : mixed
-
String title header
setTransformerEventLabel()
Define transformer event label
public
setTransformerEventLabel(callable $transformEventLabel) : mixed
$transformer callable (object event, events, times)
Parameters
- $transformEventLabel : callable
setTransformerTimeTitle()
Define transformer time title
public
setTransformerTimeTitle(callable $transformer) : mixed
$transformer callable (start, end, events)
Parameters
- $transformer : callable
setUseLineBreaks()
Set the use of linebreaks
public
setUseLineBreaks(mixed $linebreaks) : mixed
Parameters
- $linebreaks : mixed
-
boolean
setUseSingleQuotes()
Set the use of single quotes
public
setUseSingleQuotes(mixed $singlequotes) : mixed
Parameters
- $singlequotes : mixed
-
boolean
setViewMode()
Change view mode
public
setViewMode(mixed $view_mode) : mixed
Parameters
- $view_mode : mixed
show()
Shows the tag
public
show() : mixed
tag()
Create an element
public
static tag(mixed $tagname, mixed $value[, mixed $attributes = NULL ]) : mixed
Parameters
- $tagname : mixed
-
Element name
- $value : mixed
-
Element value
- $attributes : mixed = NULL
-
Element attributes
getColumnSize()
Rerturn size column based into a zoom level
private
getColumnSize() : mixed
getDates()
Return dates into interval
private
getDates() : mixed
geTimeTitle()
Return title gantt
private
geTimeTitle() : mixed
getPixelValue()
Return pixel value step minutes
private
getPixelValue() : mixed
renderAside()
Render rows
private
renderAside() : mixed
renderDailyHeader()
Render header table days
private
renderDailyHeader(mixed $time_table) : mixed
Parameters
- $time_table : mixed
-
Table
renderDailyHourHeader()
Render header table hours
private
renderDailyHourHeader(mixed $time_table) : mixed
Parameters
- $time_table : mixed
-
Table
renderEvent()
Render event
private
renderEvent(mixed $event) : mixed
Parameters
- $event : mixed
renderGantt()
Render gantt
private
renderGantt() : mixed
renderHeader()
private
renderHeader() : mixed
renderMonthDayHeader()
Render header table month day
private
renderMonthDayHeader(mixed $time_table) : mixed
Parameters
- $time_table : mixed
-
Table
renderMonthHeader()
Render header table month
private
renderMonthHeader(mixed $time_table) : mixed
Parameters
- $time_table : mixed
-
Table
renderTimeTable()
Render time table
private
renderTimeTable() : mixed
renderTimeTableHeader()
Render header table
private
renderTimeTableHeader(mixed $table) : mixed
Parameters
- $table : mixed