Collaboration diagram for ILIAS\Calendar\ConsultationHours\BookingCancellationGUI:

Public Member Functions
	__construct (object $parent_object, \ilCalendarEntry $entry, \ilBookingEntry $booking, int $type)

	renderModal ()

Data Fields
const	TYPE_CANCEL = 1

const	TYPE_DELETE = 2

Protected Member Functions
	getInputs ()

Private Member Functions
	getTitle ()

	getSubmitLabel ()

	getConfirmationBox ()

	getInfoBox ()

	getActionButton ()

	getBookingInfo ()

	getAppointmentTitle ()

	init ()

Private Attributes
ilCalendarEntry	$entry

ilBookingEntry	$booking

int	$type

	$parent_object

bool	$has_multiple_bookings = false

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

ilCtrlInterface	$ctrl

ilLanguage	$lng

Detailed Description

Definition at line 21 of file BookingCancellationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::__construct	(	object	$parent_object,
		\ilCalendarEntry	$entry,
		\ilBookingEntry	$booking,
		int	$type
	)

Definition at line 43 of file BookingCancellationGUI.php.

    {
        global $DIC;
 
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
 
        $this->parent_object = $parent_object;
        $this->entry = $entry;
        $this->booking = $booking;
        $this->type = $type;
 
        $this->init();
    }

References ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\$booking, $DIC, ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\$entry, ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\$parent_object, ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\$type, ILIAS\Repository\ctrl(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\init(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ getActionButton()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getActionButton ( )

private

Definition at line 130 of file BookingCancellationGUI.php.

                                      : \ILIAS\UI\Component\Button\Button
    {
        switch ($this->type) {
            case self::TYPE_CANCEL:
                return $this->ui_factory->button()->primary(
                    $this->lng->txt('cal_cancel_booking'),
                    $this->ctrl->getLinkTarget($this->parent_object, 'cancelBooking')
                );
            case self::TYPE_DELETE:
                return $this->ui_factory->button()->primary(
                    $this->lng->txt('cal_ch_delete_booking'),
                    $this->ctrl->getLinkTarget($this->parent_object, 'deleteBooking')
                );
        }
    }

References ILIAS\Repository\lng(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_CANCEL, and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_DELETE.

Here is the call graph for this function:

◆ getAppointmentTitle()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getAppointmentTitle ( )

private

Definition at line 185 of file BookingCancellationGUI.php.

                                          : string
    {
        return
            $this->entry->getTitle() . ', ' .
            \ilDatePresentation::formatDate($this->entry->getStart());
    }

References ilDatePresentation\formatDate().

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getBookingInfo(), and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getInputs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBookingInfo()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getBookingInfo ( )

private

Definition at line 146 of file BookingCancellationGUI.php.

                                     : \ILIAS\UI\Component\Component
    {
        $user_info = [];
        foreach ($this->booking->getCurrentBookings($this->entry->getEntryId()) as $booking_user_id) {
            $user_info[] =
                $this->getAppointmentTitle() . ': ' .
                \ilObjUser::_lookupFullname($booking_user_id);
 
        }
        return $this->ui_factory->legacy()->content(implode('<br/', $user_info));
    }

References ilObjUser\_lookupFullname(), and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getAppointmentTitle().

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\renderModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getConfirmationBox()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getConfirmationBox ( )

private

Definition at line 102 of file BookingCancellationGUI.php.

                                         : \ILIAS\UI\Component\Component
    {
        switch ($this->type) {
            case self::TYPE_CANCEL:
                return $this->ui_factory->messageBox()->confirmation(
                    $this->lng->txt('cal_ch_cancel_booking_sure')
                );
            case self::TYPE_DELETE:
                return $this->ui_factory->messageBox()->confirmation(
                    $this->lng->txt('cal_ch_delete_booking_sure')
                );
        }
    }

References ILIAS\Repository\lng(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_CANCEL, and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_DELETE.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\renderModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInfoBox()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getInfoBox ( )

private

Definition at line 116 of file BookingCancellationGUI.php.

                                 : \ILIAS\UI\Component\Component
    {
        switch ($this->type) {
            case self::TYPE_CANCEL:
                return $this->ui_factory->messageBox()->info(
                    $this->lng->txt('cal_ch_cancel_booking_info')
                );
            case self::TYPE_DELETE:
                return $this->ui_factory->messageBox()->info(
                    $this->lng->txt('cal_ch_delete_booking_info')
                );
        }
    }

References ILIAS\Repository\lng(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_CANCEL, and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_DELETE.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\renderModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInputs()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getInputs ( )

protected

Definition at line 158 of file BookingCancellationGUI.php.

    {
        $section_title = '';
        $inputs = [];
        if ($this->has_multiple_bookings) {
            $section_title = $this->getAppointmentTitle();
            foreach ($this->booking->getCurrentBookings($this->entry->getEntryId()) as $bookuser) {
                $inputs[(string) $bookuser] =
                    $this->ui_factory->input()->field()->checkbox(
                        \ilObjUser::_lookupFullname($bookuser)
                    )->withValue(true);
            }
        } else {
            $section_title = '';
            foreach ($this->booking->getCurrentBookings($this->entry->getEntryId()) as $bookuser) {
                $inputs[(string) $bookuser] =
                    $this->ui_factory->input()->field()->hidden(
                    )->withValue(true);
            }
        }
 
        return $this->ui_factory->input()->field()->section(
            $inputs,
            $section_title
        );
    }

References ILIAS\UI\Implementation\Component\Input\$inputs, ilObjUser\_lookupFullname(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getAppointmentTitle(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\renderModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubmitLabel()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getSubmitLabel ( )

private

Definition at line 92 of file BookingCancellationGUI.php.

                                     : string
    {
        switch ($this->type) {
            case self::TYPE_CANCEL:
                return $this->lng->txt('cal_cancel_booking');
            case self::TYPE_DELETE:
                return $this->lng->txt('cal_ch_delete_booking');
        }
    }

References ILIAS\Repository\lng(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_CANCEL, and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_DELETE.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\renderModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::getTitle ( )

private

Definition at line 82 of file BookingCancellationGUI.php.

                               : string
    {
        switch ($this->type) {
            case self::TYPE_CANCEL:
                return $this->lng->txt('cal_cancel_booking');
            case self::TYPE_DELETE:
                return $this->lng->txt('cal_ch_delete_booking');
        }
    }

References ILIAS\Repository\lng(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_CANCEL, and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\TYPE_DELETE.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\renderModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::init ( )

private

Definition at line 192 of file BookingCancellationGUI.php.

                           : void
    {
        $this->has_multiple_bookings = $this->booking->getCurrentNumberOfBookings($this->entry->getEntryId()) > 1;
    }

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\__construct().

Here is the caller graph for this function:

◆ renderModal()

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::renderModal ( )

Definition at line 60 of file BookingCancellationGUI.php.

                                 : \ILIAS\UI\Component\Modal\RoundTrip
    {
        $modal_title = $this->getTitle();
        $components[] = $this->getConfirmationBox();
        $components[] = $this->getInfoBox();
        if (!$this->has_multiple_bookings) {
            $components[] = $this->getBookingInfo();
        }
        return $this->ui_factory->modal()->roundtrip(
            $modal_title,
            $components,
            [
                'bookings' => $this->getInputs()
            ],
            $this->ctrl->getLinkTarget(
                $this->parent_object,
                $this->type == self::TYPE_CANCEL ? 'cancelBooking' : 'deleteBooking'
            )
        )->withCancelButtonLabel($this->lng->txt('close'))
         ->withSubmitLabel($this->getSubmitLabel());
    }

References $components, ILIAS\Repository\ctrl(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getBookingInfo(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getConfirmationBox(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getInfoBox(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getInputs(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getSubmitLabel(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getTitle(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

◆ $booking

ilBookingEntry ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$booking

private

Definition at line 28 of file BookingCancellationGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\__construct().

◆ $ctrl

ilCtrlInterface ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$ctrl

private

Definition at line 38 of file BookingCancellationGUI.php.

◆ $entry

ilCalendarEntry ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$entry

private

Definition at line 26 of file BookingCancellationGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\__construct().

◆ $has_multiple_bookings

bool ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$has_multiple_bookings = false

private

Definition at line 34 of file BookingCancellationGUI.php.

◆ $lng

ilLanguage ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$lng

private

Definition at line 40 of file BookingCancellationGUI.php.

◆ $parent_object

ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$parent_object

private

Definition at line 32 of file BookingCancellationGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\__construct().

◆ $type

int ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$type

private

Definition at line 30 of file BookingCancellationGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\__construct().

◆ $ui_factory

ILIAS UI Factory ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$ui_factory

private

Definition at line 36 of file BookingCancellationGUI.php.

◆ $ui_renderer

ILIAS UI Renderer ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::$ui_renderer

private

Definition at line 37 of file BookingCancellationGUI.php.

◆ TYPE_CANCEL

const ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::TYPE_CANCEL = 1

Definition at line 23 of file BookingCancellationGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getActionButton(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getConfirmationBox(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getInfoBox(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getSubmitLabel(), and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getTitle().

◆ TYPE_DELETE

const ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::TYPE_DELETE = 2

Definition at line 24 of file BookingCancellationGUI.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getActionButton(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getConfirmationBox(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getInfoBox(), ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getSubmitLabel(), and ILIAS\Calendar\ConsultationHours\BookingCancellationGUI\getTitle().

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

components/ILIAS/Calendar/classes/ConsultationHours/BookingCancellationGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActionButton()

◆ getAppointmentTitle()

◆ getBookingInfo()

◆ getConfirmationBox()

◆ getInfoBox()

◆ getInputs()

◆ getSubmitLabel()

◆ getTitle()

◆ init()

◆ renderModal()

Field Documentation

◆ $booking

◆ $ctrl

◆ $entry

◆ $has_multiple_bookings

◆ $lng

◆ $parent_object

◆ $type

◆ $ui_factory

◆ $ui_renderer

◆ TYPE_CANCEL

◆ TYPE_DELETE