Версия: 6.x
burger close
Открытые члены | Поля данных | Защищенные члены | Защищенные данные
Класс GantApi

Подробное описание

Класс содержит методы для работы с диаграммой ганта

Открытые члены

 getDateFilterPresets ()
 
 getCurrentDateRange ()
 
 setDateFilter ($date_from, $date_to)
 
 setViewType ($view_type)
 
 getViewTypes ()
 
 setTaskPreset ($preset)
 
 getChartData ()
 
 addOffsetData ($tasks, $date_range)
 
 getRangeDates ($date_range)
 

Поля данных

const DATE_PRESET_WEEK = 'week'
 
const DATE_PRESET_MONTH = 'month'
 
const DATE_PRESET_YEAR = 'year'
 
const VIEW_TYPE_TASK = 'task'
 
const VIEW_TYPE_USER = 'user'
 

Защищенные члены

 groupByUsers ($result)
 
 getTimeLineData ($date_range)
 
 getDayOffsetSeconds ($time)
 

Защищенные данные

 $current_date_filter
 
 $current_task_preset = 0
 
 $current_view_type = self::VIEW_TYPE_TASK
 

Методы

addOffsetData (   $tasks,
  $date_range 
)

Добавляет информацию о позиционировании внутри grid layout, используемой для отображения диаграммы. Помимо смещения (измеряемое в колонках) к задаче добавляется еще смещение внутри первого дня и последнего в виде готового значения, которое нужно удет добаить в margin-left и margin-right

Аргументы
Task[]$tasks
[]$days
Возвращает
Task[]
getChartData ( )

Возращает подготовленные данные для отображения

Возвращает
array
getCurrentDateRange ( )

Возвращает текущие значения фильтра по дате

Возвращает
[]
getDateFilterPresets ( )

Возвращает набор пресетов для фильтра по дате

Возвращает
array
getDayOffsetSeconds (   $time)
protected

Возвращает смещение времени относительно начала дня в секундах

Аргументы
int$timetimestamp
Возвращает
int
getRangeDates (   $date_range)

Возвращает массив с днями для заданного диапазона

Аргументы
array$date_rangeМассив с ключами from и to, означающими начало и конец видимого диапазона
Возвращает
array
getTimeLineData (   $date_range)
protected

Возращает сведения по линии текущего времени

Аргументы
[]$date_range Фильтр по дате
Возвращает
array|bool(false)
getViewTypes ( )

Возвращает полный список возможных отображений диаграммы

Возвращает
array
groupByUsers (   $result)
protected

Трансформирует данные для отображения, с учетом группировки по исполнителю

Аргументы
array$result
Возвращает
array
setDateFilter (   $date_from,
  $date_to 
)

Устанавливает текущий фильтр по дате

Аргументы
$date_from
$date_to
setTaskPreset (   $preset)

Устанавливает ID фильтра для задач

Аргументы
integer$preset
setViewType (   $view_type)

Устанавливает вид отображения диаграммы. В левой колонке будут Пользователи или Задачи

Аргументы
$view_type

Поля

$current_date_filter
protected
Инициализатор
= [
'from' => self::DATE_PRESET_WEEK
$current_task_preset = 0
protected
$current_view_type = self::VIEW_TYPE_TASK
protected
const DATE_PRESET_MONTH = 'month'
const DATE_PRESET_WEEK = 'week'
const DATE_PRESET_YEAR = 'year'
const VIEW_TYPE_TASK = 'task'
const VIEW_TYPE_USER = 'user'