ILIAS\Calendar\ConsultationHours\BookingDataProvider Class Reference

Collaboration diagram for ILIAS\Calendar\ConsultationHours\BookingDataProvider:

Public Member Functions
	__construct (int $user_id, string $vm_period, string $vm_status)
	getUserId ()
	isFiltered (ilCalendarEntry $entry, ilBookingEntry $booking, array $booked_users)
	getData ()
	sortData (Order $order)
	limitData (Range $range, Order $order)

Protected Member Functions
	read ()

Private Attributes
int	$user_id
array	$data = []
StaticURL Services	$static_url_service
ILIAS UI Factory	$ui_factory
string	$vm_period = ilConsultationHoursGUI::VIEW_MODE_PERIOD_ALL
string	$vm_status = ilConsultationHoursGUI::VIEW_MODE_STATUS_ALL

Detailed Description

Definition at line 41 of file BookingDataProvider.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::__construct	(	int	$user_id,
		string	$vm_period,
		string	$vm_status
	)

Definition at line 52 of file BookingDataProvider.php.

References $DIC, ILIAS\Calendar\ConsultationHours\BookingDataProvider\$user_id, ILIAS\Calendar\ConsultationHours\BookingDataProvider\$vm_period, ILIAS\Calendar\ConsultationHours\BookingDataProvider\$vm_status, and ILIAS\Calendar\ConsultationHours\BookingDataProvider\read().

    {
        global $DIC;

        $this->user_id = $user_id;
        $this->vm_status = $vm_status;
        $this->vm_period = $vm_period;
        $this->static_url_service = $DIC['static_url'];
        $this->ui_factory = $DIC->ui()->factory();
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

getData()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::getData

(

)

Definition at line 179 of file BookingDataProvider.php.

References ILIAS\Calendar\ConsultationHours\BookingDataProvider\$data.

Referenced by ILIAS\Calendar\ConsultationHours\BookingDataProvider\sortData().

                             : array
    {
        return $this->data;
    }

Here is the caller graph for this function:

getUserId()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::getUserId

(

)

Definition at line 64 of file BookingDataProvider.php.

References ILIAS\Calendar\ConsultationHours\BookingDataProvider\$user_id.

Referenced by ILIAS\Calendar\ConsultationHours\BookingDataProvider\read().

                               : int
    {
        return $this->user_id;
    }

Here is the caller graph for this function:

isFiltered()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::isFiltered	(	ilCalendarEntry	$entry,
		ilBookingEntry	$booking,
		array	$booked_users
	)

Definition at line 147 of file BookingDataProvider.php.

References ilDateTime\_after(), ilDateTime\_before(), ilBookingEntry\getNumberOfBookings(), ilCalendarEntry\getStart(), IL_CAL_DAY, IL_CAL_UNIX, ilConsultationHoursGUI\VIEW_MODE_PERIOD_ALL, ilConsultationHoursGUI\VIEW_MODE_PERIOD_PAST, ilConsultationHoursGUI\VIEW_MODE_PERIOD_UPCOMING, ilConsultationHoursGUI\VIEW_MODE_STATUS_ALL, ilConsultationHoursGUI\VIEW_MODE_STATUS_BOOKED, and ilConsultationHoursGUI\VIEW_MODE_STATUS_OPEN.

Referenced by ILIAS\Calendar\ConsultationHours\BookingDataProvider\read().

                                                                                                    : bool
    {
        if (
            $this->vm_status == ilConsultationHoursGUI::VIEW_MODE_STATUS_ALL &&
            $this->vm_period == ilConsultationHoursGUI::VIEW_MODE_PERIOD_ALL
        ) {
            return false;
        }
        $now = new ilDate(time(), IL_CAL_UNIX);
        if ($this->vm_period === ilConsultationHoursGUI::VIEW_MODE_PERIOD_UPCOMING) {
            if (ilDateTime::_before($entry->getStart(), $now, IL_CAL_DAY)) {
                return true;
            }
        }
        if ($this->vm_period === ilConsultationHoursGUI::VIEW_MODE_PERIOD_PAST) {
            if (ilDateTime::_after($entry->getStart(), $now, IL_CAL_DAY)) {
                return true;
            }
        }
        if ($this->vm_status === ilConsultationHoursGUI::VIEW_MODE_STATUS_OPEN) {
            if (count($booked_users) >= $booking->getNumberOfBookings()) {
                return true;
            }
        }
        if ($this->vm_status === ilConsultationHoursGUI::VIEW_MODE_STATUS_BOOKED) {
            if (count($booked_users) < $booking->getNumberOfBookings()) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

limitData()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::limitData	(	Range	$range,
		Order	$order
	)

Definition at line 195 of file BookingDataProvider.php.

References ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), and ILIAS\Calendar\ConsultationHours\BookingDataProvider\sortData().

                                                         : array
    {
        return array_slice($this->sortData($order), $range->getStart(), $range->getLength());
    }

Here is the call graph for this function:

read()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::read ( )

protected

Definition at line 69 of file BookingDataProvider.php.

References $comment, $comments, ILIAS\Calendar\ConsultationHours\BookingDataProvider\$data, $ref_id, ilObject\_getAllReferences(), ilObjUser\_lookupFullname(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilUtil\_sortIds(), ilConsultationHourAppointments\getAppointments(), ilUserUtil\getProfileLink(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\getUserId(), ILIAS\Repository\int(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\isFiltered(), and ilBookingEntry\lookupBookingMessage().

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

                             : void
    {
        $data = [];
        $counter = 0;
        foreach (ilConsultationHourAppointments::getAppointments($this->getUserId()) as $appointment) {
            $booking = new ilBookingEntry($appointment->getContextId());
            $booked_user_ids = $booking->getCurrentBookings($appointment->getEntryId());
            if ($this->isFiltered($appointment, $booking, $booked_user_ids)) {
                continue;
            }

            $row = [];
            $row['id'] = (string) $appointment->getEntryId();
            $row['booking_start'] = (new \DateTimeImmutable())->setTimestamp($appointment->getStart()->getUnixTime());
            $row['booking_duration'] =
                (int) ($appointment->getEnd()->getUnixTime() - $appointment->getStart()->getUnixTime()) / 60;
            $row['booking_title'] = $appointment->getTitle();

            $obj_ids = array_map(
                'intval',
                ilUtil::_sortIds($booking->getTargetObjIds(), 'object_data', 'title', 'obj_id')
            );
            // locations
            $locations = [];
            foreach ($obj_ids as $obj_id) {
                $link = null;
                foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
                    $link = $this->static_url_service->builder()->build(
                        ilObject::_lookupType($obj_id),
                        new ReferenceId($ref_id)
                    );
                    $locations[] = $this->ui_factory->link()->standard(
                        ilObject::_lookupTitle($obj_id),
                        (string) $link
                    );
                    break;
                }
            }
            $row['booking_location'] = $this->ui_factory->listing()->unordered($locations);

            // booking users
            $booked_user_ids = array_map('intval', ilUtil::_sortIds($booked_user_ids, 'usr_data', 'lastname', 'usr_id'));
            $bookings = [];
            $comments = [];
            foreach ($booked_user_ids as $booked_user_id) {
                $fullname = ilObjUser::_lookupFullname($booked_user_id);
                $link = \ilUserUtil::getProfileLink($booked_user_id);
                $ui_link = $this->ui_factory->link()->standard(
                    $fullname,
                    $link ? $link : '#'
                );
                if ($link === '') {
                    $ui_link = $ui_link->withDisabled(true);
                }
                $bookings[] = $ui_link;

                $comment = ilBookingEntry::lookupBookingMessage(
                    $appointment->getEntryId(),
                    $booked_user_id
                );
                if (trim($comment) !== '') {
                    $ui_link = $this->ui_factory->link()
                        ->standard(
                            $fullname . ': "' . $comment . '"',
                            '#'
                        )
                        ->withDisabled(true);
                    $comments[] = $ui_link;
                }

            }
            $row['booking_participant'] = $this->ui_factory->listing()->unordered($bookings);
            $row['booking_comment'] = $this->ui_factory->listing()->unordered($comments);
            $data[$counter++] = $row;
        }
        $this->data = $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sortData()

ILIAS\Calendar\ConsultationHours\BookingDataProvider::sortData

(

Order

$order

)

Definition at line 184 of file BookingDataProvider.php.

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\Calendar\ConsultationHours\BookingDataProvider\$data, ILIAS\Calendar\ConsultationHours\BookingDataProvider\getData(), and ILIAS\Data\Order\join().

Referenced by ILIAS\Calendar\ConsultationHours\BookingDataProvider\limitData().

                                          : array
    {
        $data = $this->getData();
        [$order_field, $order_direction] = $order->join([], fn($ret, $key, $value) => [$key, $value]);
        usort($data, fn($a, $b) => $a[$order_field] <=> $b[$order_field]);
        if ($order_direction === 'DESC') {
            $data = array_reverse($data);
        }
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$data

array ILIAS\Calendar\ConsultationHours\BookingDataProvider::$data = []

private

Definition at line 45 of file BookingDataProvider.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingDataProvider\getData(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\read(), and ILIAS\Calendar\ConsultationHours\BookingDataProvider\sortData().

$static_url_service

StaticURL Services ILIAS\Calendar\ConsultationHours\BookingDataProvider::$static_url_service

private

Definition at line 46 of file BookingDataProvider.php.

$ui_factory

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

private

Definition at line 47 of file BookingDataProvider.php.

$user_id

int ILIAS\Calendar\ConsultationHours\BookingDataProvider::$user_id

private

Definition at line 43 of file BookingDataProvider.php.

Referenced by ILIAS\Calendar\ConsultationHours\BookingDataProvider\__construct(), and ILIAS\Calendar\ConsultationHours\BookingDataProvider\getUserId().

$vm_period

string ILIAS\Calendar\ConsultationHours\BookingDataProvider::$vm_period = ilConsultationHoursGUI::VIEW_MODE_PERIOD_ALL

private

Definition at line 49 of file BookingDataProvider.php.

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

$vm_status

string ILIAS\Calendar\ConsultationHours\BookingDataProvider::$vm_status = ilConsultationHoursGUI::VIEW_MODE_STATUS_ALL

private

Definition at line 50 of file BookingDataProvider.php.

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

---

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

• components/ILIAS/Calendar/classes/ConsultationHours/BookingDataProvider.php