Calendar agenda list. More...

Inheritance diagram for ilCalendarAgendaListGUI:

Collaboration diagram for ilCalendarAgendaListGUI:

Public Member Functions
	__construct (ilDate $seed)
	Constructor. More...

	executeCommand ()
	Execute command. More...

	getHTML ()
	Get output. More...

	getPluginAgendaItem ($a_item, $appointment)

Public Member Functions inherited from ilCalendarViewGUI
	__construct (ilDate $seed, $presentation_type)

	setConsulationHoursUserId ($a_user_id)

	getConsultationHoursUserId ()

	initialize ($a_calendar_presentation_type)
	View initialization. More...

	getCurrentApp ()
	Get app for id. More...

	getEvents ()
	Get events. More...

	getDatesForItem ($item)
	Get start/end date for item. More...

	getModalForApp ()
	Get modal for appointment (see similar code in ilCalendarBlockGUI) More...

	getAppointmentShyButton ($a_calendar_entry, $a_dstart, $a_title_forced="")

	getActivePlugins ($a_slot_id)

	getModalTitleByPlugins ($a_current_title)

	getContentByPlugins ($a_cal_entry, $a_start_date, $a_content, $a_tpl)

	addToolbarActions ()
	Add download link to toolbar. More...

	downloadFiles ()
	Download files related to the appointments showed in the current calendar view (day,week,month,list). More...

	getBucketTitle ()
	get proper label to add in the background task popover More...

	countEventsInView ()
	get the events starting between 2 dates based in seed + view options. More...

Static Public Member Functions
static	getPeriod ()
	needed in CalendarInboxGUI to get events using a proper period. More...

Data Fields
const	PERIOD_DAY = 1

const	PERIOD_WEEK = 2

const	PERIOD_MONTH = 3

const	PERIOD_HALF_YEAR = 4

Data Fields inherited from ilCalendarViewGUI
const	CAL_PRESENTATION_DAY = 1

const	CAL_PRESENTATION_WEEK = 2

const	CAL_PRESENTATION_MONTH = 3

const	CAL_PRESENTATION_AGENDA_LIST = 9

Protected Member Functions
	initPeriod ()
	Initialises time Period for calendar list view. More...

	initEndPeriod ()
	Initialises end date for calendar list view. More...

Protected Attributes
	$ctrl

	$user

	$lng

	$period = self::PERIOD_WEEK

	$period_end_day = null

Protected Attributes inherited from ilCalendarViewGUI
	$ui_factory

	$ui_renderer

	$ctrl

	$presentation_type

	$toolbar

	$logger

	$ui

	$view_with_appointments

	$lng

	$user

	$seed

	$ch_user_id = 0

Detailed Description

Calendar agenda list.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

ilCalendarAgendaListGUI: ilCalendarAppointmentPresentationGUI

Definition at line 12 of file class.ilCalendarAgendaListGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAgendaListGUI::__construct ( ilDate $seed )

Constructor.

Parameters

ilDate $seed

Todo:: make parent constructor (initialize) and init also seed and other common stuff

Definition at line 52 of file class.ilCalendarAgendaListGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), ilCalendarViewGUI\CAL_PRESENTATION_AGENDA_LIST, IL_CAL_DATE, initEndPeriod(), and initPeriod().

     {
         parent::__construct($seed, ilCalendarViewGUI::CAL_PRESENTATION_AGENDA_LIST);
         
         $this->ctrl->saveParameter($this, "cal_agenda_per");
 
         $this->initPeriod();
 
         $this->ctrl->setParameterByClass("ilcalendarinboxgui", "seed", $this->seed->get(IL_CAL_DATE));
 
         $this->initEndPeriod();
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilCalendarAgendaListGUI::executeCommand ( )

Execute command.

Definition at line 116 of file class.ilCalendarAgendaListGUI.php.

References ilCalendarAppointmentPresentationGUI\_getInstance(), ilCalendarViewGUI\getCurrentApp(), and IL_CAL_DATE.

     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd("getHTML");
 
         switch ($next_class) {
             case "ilcalendarappointmentpresentationgui":
                 $this->ctrl->setReturn($this, "");
                 include_once("./Services/Calendar/classes/class.ilCalendarAppointmentPresentationGUI.php");
                 $gui = ilCalendarAppointmentPresentationGUI::_getInstance(new ilDate($this->seed->get(IL_CAL_DATE), IL_CAL_DATE), $this->getCurrentApp());
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             default:
                 $this->ctrl->setReturn($this, "");
                 if (in_array($cmd, array("getHTML", "getModalForApp"))) {
                     return $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getHTML()

ilCalendarAgendaListGUI::getHTML ( )

Get output.

Parameters

Definition at line 143 of file class.ilCalendarAgendaListGUI.php.

References $_GET, Vendor\Package\$e, $GLOBALS, $period, $url, ilDateTime\_after(), ilDateTime\_before(), ilDateTime\_equals(), ilCalendarAppointmentPresentationGUI\_getInstance(), ilCalendarCategories\_getInstance(), ilCalendarCategoryAssignments\_lookupCategory(), ilDateTime\DAY, ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ilCalendarViewGUI\getEvents(), getPluginAgendaItem(), ilUtil\getSystemMessageHTML(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_UNIX, ilUtil\sortArray(), and user().

     {
         $navigation = new ilCalendarHeaderNavigationGUI($this, new ilDate($this->seed->get(IL_CAL_DATE), IL_CAL_DATE), ilDateTime::DAY);
         $navigation->getHTML();
 
         // set return now (after header navigation) to the list (e.g. for profile links)
         $this->ctrl->setReturn($this, "");
 
         // get events
         $events = $this->getEvents();
         $events = ilUtil::sortArray($events, "dstart", "asc", true);
 
         $df = new \ILIAS\Data\Factory();
         $items = array();
         $groups = array();
         $modals = array();
         $group_date = new ilDate(0, IL_CAL_UNIX);
         $end_day = new ilDate($this->period_end_day, IL_CAL_DATE);
         $end_day->increment(ilDateTime::DAY, -1);
         foreach ($events as $e) {
             if ($e['event']->isFullDay()) {
                 // begin/end is Date (without timzone)
                 $begin = new ilDate($e['dstart'], IL_CAL_UNIX);
                 $end = new ilDate($e['dend'], IL_CAL_UNIX);
             } else {
                 // begin/end is DateTime (with timezone conversion)
                 $begin = new ilDateTime($e['dstart'], IL_CAL_UNIX);
                 $end = new ilDateTime($e['dend'], IL_CAL_UNIX);
             }
             
             //  if the begin is before seed date (due to timezone conversion) => continue
             if (ilDateTime::_before(
                 $begin,
                 $this->seed,
                 ilDateTime::DAY,
                 $GLOBALS['DIC']->user()->getTimezone()
             )) {
                 continue;
             }
             
             if (ilDateTime::_after(
                 $begin,
                 $end_day,
                 ilDateTime::DAY,
                 $GLOBALS['DIC']->user()->getTimezone()
             )
             ) {
                 break;
             }
                 
             
             // initialize group date for first iteration
             if ($group_date->isNull()) {
                 $group_date = new ilDate(
                     $begin->get(IL_CAL_DATE, '', $GLOBALS['DIC']->user()->getTimezone()),
                     IL_CAL_DATE
                 );
             }
             
             if (!ilDateTime::_equals($group_date, $begin, IL_CAL_DAY, $GLOBALS['DIC']->user()->getTimezone())) {
                 // create new group
                 $groups[] = $this->ui_factory->item()->group(
                     ilDatePresentation::formatDate($group_date, false, true),
                     $items
                 );
                 
                 $group_date = new ilDate(
                     $begin->get(IL_CAL_DATE, '', $GLOBALS['DIC']->user()->getTimezone()),
                     IL_CAL_DATE
                 );
                 $items = [];
             }
             
             // get calendar
             $cat_id = ilCalendarCategoryAssignments::_lookupCategory($e["event"]->getEntryId());
             $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat_id);
 
             $properties = array();
 
             /*TODO:
              * All this code related with the ctrl and shy button can be centralized in
              * ilCalendarViewGUI refactoring the method getAppointmentShyButton or
              * if we want extend this class from ilCalendarInboxGUI we can just keep it here.
              */
 
             // shy button for title
             $this->ctrl->setParameter($this, 'app_id', $e["event"]->getEntryId());
             $this->ctrl->setParameter($this, 'dt', $e['dstart']);
             $this->ctrl->setParameter($this, 'seed', $this->seed->get(IL_CAL_DATE));
 
             $url = $this->ctrl->getLinkTarget($this, "getModalForApp", "", true, false);
             $this->ctrl->setParameter($this, "app_id", $_GET["app_id"]);
             $this->ctrl->setParameter($this, "dt", $_GET["dt"]);
             $this->ctrl->setParameter($this, 'modal_title', $_GET["modal_title"]);
             $modal = $this->ui_factory->modal()->roundtrip('', [])->withAsyncRenderUrl($url);
             $shy = $this->ui_factory->button()->shy($e["event"]->getPresentationTitle(false), "")->withOnClick($modal->getShowSignal());
 
             $modals[] = $modal;
             if ($e['event']->isFullDay()) {
                 $lead_text = $this->lng->txt("cal_all_day");
             } else {
                 $lead_text = ilDatePresentation::formatPeriod($begin, $end, true);
             }
             $li = $this->ui_factory->item()->standard($shy)
                 ->withDescription("" . nl2br(strip_tags($e["event"]->getDescription())))
                 ->withLeadText($lead_text)
                 ->withProperties($properties)
                 ->withColor($df->color('#' . $cat_info["color"]));
 
             if ($li_edited_by_plugin = $this->getPluginAgendaItem($li, $e['event'])) {
                 $li = $li_edited_by_plugin;
             }
 
             // add type specific actions/properties
             include_once("./Services/Calendar/classes/class.ilCalendarAppointmentPresentationGUI.php");
             $app_gui = ilCalendarAppointmentPresentationGUI::_getInstance(new ilDate($this->seed->get(IL_CAL_DATE), IL_CAL_DATE), $e);
             $app_gui->setListItemMode($li);
             $this->ctrl->getHTML($app_gui);
             $items[] = $app_gui->getListItem();
         }
         // terminate last group
         if (!$group_date->isNull()) {
             $groups[] = $this->ui_factory->item()->group(
                 ilDatePresentation::formatDate($group_date, false, true),
                 $items
             );
         }
 
         // list actions
         $images = array_fill(1, 4, "<span class=\"ilAdvNoImg\"></span>");
         if ($cal_agenda_per = (int) $_GET['cal_agenda_per']) {
             $images[$cal_agenda_per] = "<img src='./templates/default/images/icon_checked.svg' alt='Month'>";
         } else {
             $images[$this->period] = "<img src='./templates/default/images/icon_checked.svg' alt='Month'>";
         }
 
         #21479 Set seed if the view does not contain any event.
         $this->ctrl->setParameter($this, 'seed', $this->seed->get(IL_CAL_DATE));
 
         $items = array();
         $this->ctrl->setParameter($this, "cal_agenda_per", self::PERIOD_DAY);
         $items[] = $this->ui_factory->button()->shy($images[1] . "1 " . $this->lng->txt("day"), $this->ctrl->getLinkTarget($this, "getHTML"));
         $this->ctrl->setParameter($this, "cal_agenda_per", self::PERIOD_WEEK);
         $items[] = $this->ui_factory->button()->shy($images[2] . "1 " . $this->lng->txt("week"), $this->ctrl->getLinkTarget($this, "getHTML"));
         $this->ctrl->setParameter($this, "cal_agenda_per", self::PERIOD_MONTH);
         $items[] = $this->ui_factory->button()->shy($images[3] . "1 " . $this->lng->txt("month"), $this->ctrl->getLinkTarget($this, "getHTML"));
         $this->ctrl->setParameter($this, "cal_agenda_per", self::PERIOD_HALF_YEAR);
         $items[] = $this->ui_factory->button()->shy($images[4] . "6 " . $this->lng->txt("months"), $this->ctrl->getLinkTarget($this, "getHTML"));
         $this->ctrl->setParameter($this, "cal_agenda_per", $this->period);
 
 
         $actions = $this->ui_factory->dropdown()->standard($items)->withLabel($this->lng->txt("cal_period"));
 
         $list_title =
             $this->lng->txt("cal_agenda") . ": " . ilDatePresentation::formatDate(new ilDate($this->seed->get(IL_CAL_DATE), IL_CAL_DATE));
         if ($this->period != self::PERIOD_DAY) {
             $end_day = new ilDate($this->period_end_day, IL_CAL_DATE);
             $end_day->increment(ilDateTime::DAY, -1);
             $list_title .= " - " . ilDatePresentation::formatDate($end_day);
         }
 
         $list = $this->ui_factory->panel()->listing()->standard($list_title, $groups)
             ->withActions($actions);
 
 
         $comps = array_merge($modals, array($list));
 
         $html = $this->ui_renderer->render($comps);
 
         if (count($groups) == 0) {
             $html .= ilUtil::getSystemMessageHTML($this->lng->txt("cal_no_events_info"));
         }
 
         return $html;
     }

Here is the call graph for this function:

◆ getPeriod()

static ilCalendarAgendaListGUI::getPeriod ( )

static

needed in CalendarInboxGUI to get events using a proper period.

todo define default period only once (self::PERIOD_WEEK, protected $period = self::PERIOD_WEEK)

Returns: int|mixed

Definition at line 339 of file class.ilCalendarAgendaListGUI.php.

References $DIC, $ilUser, $period, and ilCalendarSettings\_getInstance().

Referenced by ilCalendarViewGUI\countEventsInView(), and ilCalendarViewGUI\getEvents().

     {
         global $DIC;
 
         $settings = ilCalendarSettings::_getInstance();
         $ilUser = $DIC->user();
 
         $qp = $DIC->http()->request()->getQueryParams();
         if ((int) $qp["cal_agenda_per"] > 0 && (int) $qp["cal_agenda_per"] <= 4) {
             return $qp["cal_agenda_per"];
         } elseif ($period = $ilUser->getPref('cal_list_view')) {
             return $period;
         } else {
             return $settings->getDefaultPeriod();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginAgendaItem()

ilCalendarAgendaListGUI::getPluginAgendaItem	(	$a_item,
		$appointment
	)

Parameters

$a_item	ILIAS
$appointment

Returns: $li ILIAS

Definition at line 324 of file class.ilCalendarAgendaListGUI.php.

References XapiProxy\$plugin, and ilCalendarViewGUI\getActivePlugins().

Referenced by getHTML().

     {
         //"capg" is the plugin slot id for AppointmentCustomGrid
         foreach ($this->getActivePlugins("capg") as $plugin) {
             $plugin->setAppointment($appointment, $appointment->getStart());
             $li = $plugin->editAgendaItem($a_item);
         }
         return $li;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEndPeriod()

ilCalendarAgendaListGUI::initEndPeriod ( )

protected

Initialises end date for calendar list view.

Definition at line 89 of file class.ilCalendarAgendaListGUI.php.

References ilCalendarViewGUI\$seed, IL_CAL_DATE, IL_CAL_DAY, IL_CAL_MONTH, and IL_CAL_WEEK.

Referenced by __construct().

     {
         $end_date = clone $this->seed;
 
         switch ($this->period) {
             case self::PERIOD_DAY:
                 $end_date->increment(IL_CAL_DAY, 1);
                 break;
 
             case self::PERIOD_WEEK:
                 $end_date->increment(IL_CAL_WEEK, 1);
                 break;
 
             case self::PERIOD_MONTH:
                 $end_date->increment(IL_CAL_MONTH, 1);
                 break;
 
             case self::PERIOD_HALF_YEAR:
                 $end_date->increment(IL_CAL_MONTH, 6);
                 break;
         }
         $this->period_end_day = $end_date->get(IL_CAL_DATE);
     }

Here is the caller graph for this function:

◆ initPeriod()

ilCalendarAgendaListGUI::initPeriod ( )

protected

Initialises time Period for calendar list view.

Definition at line 68 of file class.ilCalendarAgendaListGUI.php.

References $DIC, ilCalendarSettings\_getInstance(), and user().

Referenced by __construct().

     {
         global $DIC;
 
         $cal_setting = ilCalendarSettings::_getInstance();
 
         $qp = $DIC->http()->request()->getQueryParams();
         if ((int) $qp["cal_agenda_per"] > 0 && (int) $qp["cal_agenda_per"] <= 4) {
             $this->period = $qp["cal_agenda_per"];
         } elseif (!empty($this->user->getPref('cal_list_view'))) {
             $this->period = intval($this->user->getPref('cal_list_view'));
         } else {
             $this->period = $cal_setting->getDefaultPeriod();
         }
 
         $this->user->writePref('cal_list_view', $this->period);
     }