ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
ilCalendarAppointmentPanelGUI Class Reference
Services/Calendar

GUI class for YUI appointment panels. More...

+ Collaboration diagram for ilCalendarAppointmentPanelGUI:

Public Member Functions

 getSeed ()
 
 getHTML ($a_app)
 

Static Public Member Functions

static _getInstance (ilDate $seed)
 get singleton instance More...
 

Protected Member Functions

 __construct (ilDate $seed=null)
 

Protected Attributes

ilDate $seed
 
ilCalendarSettings $settings
 
ilTemplate $tpl = null
 
ilLanguage $lng
 
ilCtrlInterface $ctrl
 
ilTree $tree
 
ilObjUser $user
 

Static Protected Attributes

static int $counter = 0
 
static self $instance = null
 

Detailed Description

GUI class for YUI appointment panels.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 31 of file class.ilCalendarAppointmentPanelGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAppointmentPanelGUI::__construct ( ilDate  $seed = null)
protected

Definition at line 46 of file class.ilCalendarAppointmentPanelGUI.php.

References $DIC, $seed, ilCalendarSettings\_getInstance(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

47  {
48  global $DIC;
49 
50  $this->lng = $DIC->language();
51  $this->ctrl = $DIC->ctrl();
52  $this->tree = $DIC->repositoryTree();
53  $this->user = $DIC->user();
54  $this->settings = ilCalendarSettings::_getInstance();
55  $this->seed = $seed;
56  }
$DIC
global $DIC
Definition: shib_login.php:25
+ Here is the call graph for this function:

Member Function Documentation

◆ _getInstance()

static ilCalendarAppointmentPanelGUI::_getInstance ( ilDate  $seed)
static

get singleton instance

Definition at line 61 of file class.ilCalendarAppointmentPanelGUI.php.

References $seed.

61  : self
62  {
63  if (!self::$instance instanceof self) {
64  self::$instance = new self($seed);
65  }
66  return self::$instance;
67  }

◆ getHTML()

ilCalendarAppointmentPanelGUI::getHTML (   $a_app)

Definition at line 74 of file class.ilCalendarAppointmentPanelGUI.php.

References $DIC, $GLOBALS, $user_id, ilDateTime\_after(), ilObject\_getAllReferences(), ilCalendarCategories\_getInstance(), ilLink\_getStaticLink(), ilCalendarCategoryAssignments\_lookupCategory(), ilObjUser\_lookupFullname(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Repository\ctrl(), ilDatePresentation\formatPeriod(), ilConsultationHourAppointments\getAppointmentIds(), getSeed(), IL_CAL_DATE, IL_CAL_UNIX, ILIAS\Repository\lng(), ilUtil\makeClickable(), ilCalendarCategories\MODE_PORTFOLIO_CONSULTATION, ILIAS\Repository\settings(), ilCalendarCategory\TYPE_BOOK, ilCalendarCategory\TYPE_CH, ilCalendarCategory\TYPE_GLOBAL, ilCalendarCategory\TYPE_OBJ, ilCalendarCategory\TYPE_USR, and ILIAS\Repository\user().

74  : string
75  {
76  global $DIC;
77 
78  self::$counter++;
79 
80  $this->tpl = new ilTemplate('tpl.appointment_panel.html', true, true, 'components/ILIAS/Calendar');
81 
82  // Panel variables
83  $this->tpl->setVariable('PANEL_NUM', self::$counter);
84  $this->tpl->setVariable('PANEL_TITLE', str_replace(' ()', '', $a_app['event']->getPresentationTitle(false)));
85  $this->tpl->setVariable('PANEL_DETAILS', $this->lng->txt('cal_details'));
86  $this->tpl->setVariable('PANEL_TXT_DATE', $this->lng->txt('date'));
87 
88  if ($a_app['fullday']) {
89  $this->tpl->setVariable('PANEL_DATE', ilDatePresentation::formatPeriod(
90  new ilDate($a_app['dstart'], IL_CAL_UNIX),
91  new ilDate($a_app['dend'], IL_CAL_UNIX)
92  ));
93  } else {
94  $this->tpl->setVariable('PANEL_DATE', ilDatePresentation::formatPeriod(
95  new ilDateTime($a_app['dstart'], IL_CAL_UNIX),
96  new ilDateTime($a_app['dend'], IL_CAL_UNIX)
97  ));
98  }
99  if ($a_app['event']->getLocation()) {
100  $this->tpl->setVariable('PANEL_TXT_WHERE', $this->lng->txt('cal_where'));
101  $this->tpl->setVariable('PANEL_WHERE', ilUtil::makeClickable($a_app['event']->getLocation(), true));
102  }
103  if ($a_app['event']->getDescription()) {
104  $this->tpl->setVariable('PANEL_TXT_DESC', $this->lng->txt('description'));
105  $this->tpl->setVariable('PANEL_DESC', ilUtil::makeClickable(nl2br($a_app['event']->getDescription())));
106  }
107 
108  $cat_id = ilCalendarCategoryAssignments::_lookupCategory($a_app['event']->getEntryId());
109  $cat_info = ilCalendarCategories::_getInstance()->getCategoryInfo($cat_id);
110  $entry_obj_id = $cat_info['subitem_obj_ids'][$cat_id] ?? $cat_info['obj_id'];
111 
112  $this->tpl->setVariable('PANEL_TXT_CAL_TYPE', $this->lng->txt('cal_cal_type'));
113  switch ($cat_info['type']) {
114  case ilCalendarCategory::TYPE_GLOBAL:
115  $this->tpl->setVariable('PANEL_CAL_TYPE', $this->lng->txt('cal_type_system'));
116  break;
117 
118  case ilCalendarCategory::TYPE_USR:
119  $this->tpl->setVariable('PANEL_CAL_TYPE', $this->lng->txt('cal_type_personal'));
120  break;
121 
122  case ilCalendarCategory::TYPE_OBJ:
123  $type = ilObject::_lookupType($cat_info['obj_id']);
124  $this->tpl->setVariable('PANEL_CAL_TYPE', $this->lng->txt('cal_type_' . $type));
125 
126  // Course group appointment registration
127  if ($this->settings->isCGRegistrationEnabled() and $type == 'crs' or $type == 'grp') {
128  if (!$a_app['event']->isAutoGenerated()) {
129  $reg = new ilCalendarRegistration($a_app['event']->getEntryId());
130 
131  if ($reg->isRegistered(
132  $this->user->getId(),
133  new ilDateTime($a_app['dstart'], IL_CAL_UNIX),
134  new ilDateTime($a_app['dend'], IL_CAL_UNIX)
135  )) {
136  $this->tpl->setCurrentBlock('panel_cancel_book_link');
137  $this->ctrl->setParameterByClass(
138  'ilcalendarappointmentgui',
139  'seed',
140  $this->getSeed()->get(IL_CAL_DATE)
141  );
142  $this->ctrl->setParameterByClass(
143  'ilcalendarappointmentgui',
144  'app_id',
145  $a_app['event']->getEntryId()
146  );
147  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'dstart', $a_app['dstart']);
148  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'dend', $a_app['dend']);
149 
150  $this->tpl->setVariable('TXT_PANEL_CANCELBOOK', $this->lng->txt('cal_reg_unregister'));
151  $this->tpl->setVariable(
152  'PANEL_CANCELBOOK_HREF',
153  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'confirmUnregister')
154  );
155  $this->tpl->parseCurrentBlock();
156  } else {
157  $this->tpl->setCurrentBlock('panel_book_link');
158  $this->ctrl->setParameterByClass(
159  'ilcalendarappointmentgui',
160  'seed',
161  $this->getSeed()->get(IL_CAL_DATE)
162  );
163  $this->ctrl->setParameterByClass(
164  'ilcalendarappointmentgui',
165  'app_id',
166  $a_app['event']->getEntryId()
167  );
168  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'dstart', $a_app['dstart']);
169  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'dend', $a_app['dend']);
170  $this->tpl->setVariable('TXT_PANEL_BOOK', $this->lng->txt('cal_reg_register'));
171  $this->tpl->setVariable(
172  'PANEL_BOOK_HREF',
173  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'confirmRegister')
174  );
175  $this->tpl->parseCurrentBlock();
176  }
177 
178  $registrations = array();
179  foreach ($reg->getRegisteredUsers(
180  new ilDateTime($a_app['dstart'], IL_CAL_UNIX),
181  new ilDateTime($a_app['dend'], IL_CAL_UNIX)
182  ) as $usr_data) {
183  $usr_id = $usr_data;
184  $this->ctrl->setParameterByClass('ilconsultationhoursgui', 'user', $usr_id);
185  $registrations[] = '<a href="' . $this->ctrl->getLinkTargetByClass(
186  'ilconsultationhoursgui',
187  'showprofile'
188  ) . '">' . ilObjUser::_lookupFullname($usr_id);
189  $this->ctrl->setParameterByClass('ilconsultationhoursgui', 'user', '');
190  }
191  if (count($registrations)) {
192  $this->tpl->setCurrentBlock('panel_current_booking');
193  $this->tpl->setVariable(
194  'PANEL_TXT_CURRENT_BOOKING',
195  $this->lng->txt('cal_reg_registered_users')
196  );
197  $this->tpl->setVariable('PANEL_CURRENT_BOOKING', implode('<br />', $registrations));
198  $this->tpl->parseCurrentBlock();
199  }
200  }
201  }
202  break;
203 
204  case ilCalendarCategory::TYPE_CH:
205  $this->tpl->setVariable('PANEL_CAL_TYPE', $this->lng->txt('cal_ch_ch'));
206 
207  $entry = new ilBookingEntry($a_app['event']->getContextId());
208 
209  $is_owner = $entry->isOwner();
210  $user_entry = ($cat_info['obj_id'] == $this->user->getId());
211 
212  if ($user_entry && !$is_owner) {
213  // find source calendar entry in owner calendar
214  $apps = ilConsultationHourAppointments::getAppointmentIds(
215  $entry->getObjId(),
216  $a_app['event']->getContextId(),
217  $a_app['event']->getStart()
218  );
219  $ref_event = $apps[0];
220  } else {
221  $ref_event = $a_app['event']->getEntryId();
222  }
223 
224  $this->tpl->setCurrentBlock('panel_booking_owner');
225  $this->tpl->setVariable('PANEL_TXT_BOOKING_OWNER', $this->lng->txt('cal_ch_booking_owner'));
226  $this->tpl->setVariable('PANEL_BOOKING_OWNER', ilObjUser::_lookupFullname($entry->getObjId()));
227  $this->tpl->parseCurrentBlock();
228 
229  $this->tpl->setCurrentBlock('panel_max_booking');
230  $this->tpl->setVariable('PANEL_TXT_MAX_BOOKING', $this->lng->txt('cal_ch_num_bookings'));
231  $this->tpl->setVariable('PANEL_MAX_BOOKING', $entry->getNumberOfBookings());
232  $this->tpl->parseCurrentBlock();
233 
234  if (!$is_owner) {
235  if ($entry->hasBooked($ref_event)) {
236  if (ilDateTime::_after($a_app['event']->getStart(), new ilDateTime(time(), IL_CAL_UNIX))) {
237  $this->tpl->setCurrentBlock('panel_cancel_book_link');
238  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'app_id', $ref_event);
239  $this->ctrl->setParameterByClass(
240  'ilcalendarappointmentgui',
241  'seed',
242  $this->getSeed()->get(IL_CAL_DATE)
243  );
244  $this->tpl->setVariable('TXT_PANEL_CANCELBOOK', $this->lng->txt('cal_ch_cancel_booking'));
245  $this->tpl->setVariable(
246  'PANEL_CANCELBOOK_HREF',
247  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'cancelBooking')
248  );
249  $this->tpl->parseCurrentBlock();
250  }
251  } #else if(!$entry->isBookedOut($ref_event))
252  elseif ($entry->isAppointmentBookableForUser($ref_event, $GLOBALS['DIC']['ilUser']->getId())) {
253  $this->tpl->setCurrentBlock('panel_book_link');
254  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'app_id', $ref_event);
255  $this->ctrl->setParameterByClass(
256  'ilcalendarappointmentgui',
257  'seed',
258  $this->getSeed()->get(IL_CAL_DATE)
259  );
260  $this->tpl->setVariable('TXT_PANEL_BOOK', $this->lng->txt('cal_ch_book'));
261  $this->tpl->setVariable(
262  'PANEL_BOOK_HREF',
263  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'book')
264  );
265  $this->tpl->parseCurrentBlock();
266  }
267 
268  $this->tpl->setCurrentBlock('panel_current_booking');
269  $this->tpl->setVariable('PANEL_TXT_CURRENT_BOOKING', $this->lng->txt('cal_ch_current_bookings'));
270  $this->tpl->setVariable('PANEL_CURRENT_BOOKING', $entry->getCurrentNumberOfBookings($ref_event));
271  $this->tpl->parseCurrentBlock();
272  } else {
273  $obj_ids = $entry->getTargetObjIds();
274  foreach ($obj_ids as $obj_id) {
275  $title = ilObject::_lookupTitle($obj_id);
276  $refs = ilObject::_getAllReferences($obj_id);
277  $this->tpl->setCurrentBlock('panel_booking_target_row');
278  $this->tpl->setVariable('PANEL_BOOKING_TARGET_TITLE', $title);
279  $this->tpl->setVariable('PANEL_BOOKING_TARGET', ilLink::_getLink(end($refs)));
280  $this->tpl->parseCurrentBlock();
281  }
282  if ($obj_ids) {
283  $this->tpl->setCurrentBlock('panel_booking_target');
284  $this->tpl->setVariable('PANEL_TXT_BOOKING_TARGET', $this->lng->txt('cal_ch_target_object'));
285  $this->tpl->parseCurrentBlock();
286  }
287 
288  $link_users = true;
289  if (ilCalendarCategories::_getInstance()->getMode() == ilCalendarCategories::MODE_PORTFOLIO_CONSULTATION) {
290  $link_users = false;
291  }
292 
293  $bookings = array();
294  $this->ctrl->setParameterByClass('ilconsultationhoursgui', 'panel', 1);
295  foreach ($entry->getCurrentBookings($a_app['event']->getEntryId()) as $user_id) {
296  if ($link_users) {
297  $this->ctrl->setParameterByClass('ilconsultationhoursgui', 'user', $user_id);
298  $bookings[] = '<a href="' . $this->ctrl->getLinkTargetByClass(
299  'ilconsultationhoursgui',
300  'showprofile'
301  ) . '">' .
302  ilObjUser::_lookupFullname($user_id) . '</a>';
303  $this->ctrl->setParameterByClass('ilconsultationhoursgui', 'user', '');
304  } else {
305  $bookings[] = ilObjUser::_lookupFullname($user_id);
306  }
307  }
308  $this->ctrl->setParameterByClass('ilconsultationhoursgui', 'panel', '');
309  $this->tpl->setCurrentBlock('panel_current_booking');
310  $this->tpl->setVariable('PANEL_TXT_CURRENT_BOOKING', $this->lng->txt('cal_ch_current_bookings'));
311  $this->tpl->setVariable('PANEL_CURRENT_BOOKING', implode('<br />', $bookings));
312  $this->tpl->parseCurrentBlock();
313  }
314  break;
315 
316  case ilCalendarCategory::TYPE_BOOK:
317  $this->tpl->setVariable('PANEL_CAL_TYPE', $this->lng->txt('cal_ch_booking'));
318 
319  $this->tpl->setCurrentBlock('panel_cancel_book_link');
320  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'app_id', $a_app['event']->getEntryId());
321  $this->ctrl->setParameterByClass(
322  'ilcalendarappointmentgui',
323  'seed',
324  $this->getSeed()->get(IL_CAL_DATE)
325  );
326  $this->tpl->setVariable('TXT_PANEL_CANCELBOOK', $this->lng->txt('cal_ch_cancel_booking'));
327  $this->tpl->setVariable(
328  'PANEL_CANCELBOOK_HREF',
329  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'cancelBooking')
330  );
331  $this->tpl->parseCurrentBlock();
332  break;
333  }
334 
335  $this->tpl->setVariable('PANEL_TXT_CAL_NAME', $this->lng->txt('cal_calendar_name'));
336  $this->tpl->setVariable('PANEL_CAL_NAME', $cat_info['title']);
337 
338  if ($cat_info['editable'] and !$a_app['event']->isAutoGenerated()) {
339  $this->tpl->setCurrentBlock('panel_edit_link');
340  $this->tpl->setVariable('TXT_PANEL_EDIT', $this->lng->txt('edit'));
341 
342  $this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
343  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'seed', $this->getSeed()->get(IL_CAL_DATE));
344  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'app_id', $a_app['event']->getEntryId());
345  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'dt', $a_app['dstart']);
346  $this->tpl->setVariable(
347  'PANEL_EDIT_HREF',
348  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'askEdit')
349  );
350 
351  $this->tpl->setCurrentBlock('panel_delete_link');
352  $this->tpl->setVariable('TXT_PANEL_DELETE', $this->lng->txt('delete'));
353 
354  $this->ctrl->clearParametersByClass('ilcalendarappointmentgui');
355  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'seed', $this->getSeed()->get(IL_CAL_DATE));
356  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'app_id', $a_app['event']->getEntryId());
357  $this->ctrl->setParameterByClass('ilcalendarappointmentgui', 'dt', $a_app['dstart']);
358  $this->tpl->setVariable(
359  'PANEL_DELETE_HREF',
360  $this->ctrl->getLinkTargetByClass('ilcalendarappointmentgui', 'askdelete')
361  );
362  $this->tpl->parseCurrentBlock();
363  }
364  if ($cat_info['type'] == ilCalendarCategory::TYPE_OBJ) {
365  $refs = ilObject::_getAllReferences($entry_obj_id);
366  $type = ilObject::_lookupType($entry_obj_id);
367  $title = ilObject::_lookupTitle($entry_obj_id) ?
368  ilObject::_lookupTitle($entry_obj_id) :
369  $this->lng->txt('obj_' . $type);
370 
371  $href = ilLink::_getStaticLink(current($refs), ilObject::_lookupType($entry_obj_id));
372  $parent = $this->tree->getParentId(current($refs));
373  $parent_title = ilObject::_lookupTitle(ilObject::_lookupObjId($parent));
374  $this->tpl->setVariable('PANEL_TXT_LINK', $this->lng->txt('ext_link'));
375  $this->tpl->setVariable('PANEL_LINK_HREF', $href);
376  $this->tpl->setVariable('PANEL_LINK_NAME', $title);
377  $this->tpl->setVariable('PANEL_PARENT', $parent_title);
378  }
379 
380  return $this->tpl->get();
381  }
ilObjUser\_lookupFullname
static _lookupFullname(int $a_user_id)
Definition: class.ilObjUser.php:588
ilObject\_getAllReferences
static _getAllReferences(int $id)
get all reference ids for object ID
Definition: class.ilObject.php:810
IL_CAL_UNIX
const IL_CAL_UNIX
Definition: class.ilDateTime.php:9
ilObject\_lookupObjId
static _lookupObjId(int $ref_id)
Definition: class.ilObject.php:924
ilConsultationHourAppointments\getAppointmentIds
static getAppointmentIds(int $a_user_id, int $a_context_id=null, ?ilDateTime $a_start=null, ?int $a_type=null, bool $a_check_owner=true)
Definition: class.ilConsultationHourAppointments.php:31
ilObject\_lookupTitle
static _lookupTitle(int $obj_id)
Definition: class.ilObject.php:831
$GLOBALS
$GLOBALS["DIC"]
Definition: wac.php:30
ilDateTime\_after
static _after(ilDateTime $start, ilDateTime $end, string $a_compare_field='', string $a_tz='')
compare two dates and check start is after end This method does not consider tz offsets.
Definition: class.ilDateTime.php:195
ilCalendarRegistration
registration for calendar appointments
Definition: class.ilCalendarRegistration.php:11
$DIC
global $DIC
Definition: shib_login.php:25
ilCalendarCategories\_getInstance
static _getInstance($a_usr_id=0)
get singleton instance
Definition: class.ilCalendarCategories.php:89
IL_CAL_DATE
const IL_CAL_DATE
Definition: class.ilDateTime.php:8
ilDatePresentation\formatPeriod
static formatPeriod(ilDateTime $start, ilDateTime $end, bool $a_skip_starting_day=false, ilObjUser $user=null)
Format a period of two dates Shows: 14.
Definition: class.ilDatePresentation.php:174
ilObject\_lookupType
static _lookupType(int $id, bool $reference=false)
Definition: class.ilObject.php:1085
ilUtil\makeClickable
static makeClickable(string $a_text, bool $detectGotoLinks=false)
Definition: class.ilUtil.php:219
+ Here is the call graph for this function:

◆ getSeed()

ilCalendarAppointmentPanelGUI::getSeed ( )

Definition at line 69 of file class.ilCalendarAppointmentPanelGUI.php.

References $seed.

Referenced by getHTML().

69  : ?ilDate
70  {
71  return $this->seed;
72  }
+ Here is the caller graph for this function:

Field Documentation

◆ $counter

int ilCalendarAppointmentPanelGUI::$counter = 0
staticprotected

Definition at line 35 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $ctrl

ilCtrlInterface ilCalendarAppointmentPanelGUI::$ctrl
protected

Definition at line 42 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $instance

self ilCalendarAppointmentPanelGUI::$instance = null
staticprotected

Definition at line 36 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $lng

ilLanguage ilCalendarAppointmentPanelGUI::$lng
protected

Definition at line 41 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $seed

ilDate ilCalendarAppointmentPanelGUI::$seed
protected

Definition at line 33 of file class.ilCalendarAppointmentPanelGUI.php.

Referenced by __construct(), _getInstance(), and getSeed().

◆ $settings

ilCalendarSettings ilCalendarAppointmentPanelGUI::$settings
protected

Definition at line 38 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $tpl

ilTemplate ilCalendarAppointmentPanelGUI::$tpl = null
protected

Definition at line 40 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $tree

ilTree ilCalendarAppointmentPanelGUI::$tree
protected

Definition at line 43 of file class.ilCalendarAppointmentPanelGUI.php.

◆ $user

ilObjUser ilCalendarAppointmentPanelGUI::$user
protected

Definition at line 44 of file class.ilCalendarAppointmentPanelGUI.php.

The documentation for this class was generated from the following file: