ilChatroomHistoryGUI Class Reference

Inheritance diagram for ilChatroomHistoryGUI:

Collaboration diagram for ilChatroomHistoryGUI:

Public Member Functions
	byDayExport ()
	executeDefault (string $requestedMethod)
Public Member Functions inherited from ilChatroomGUIHandler
	execute (string $method)
	executeDefault (string $requestedMethod)
	redirectIfNoPermission ($permission)
	Checks for requested permissions and redirects if the permission check failed. More...
	isSuccessful ($response)
	Checks for success param in an json decoded response. More...
	hasPermission (string $permission)

Private Member Functions
	renderDateTimeInformation ( $room_tpl, ?ilDateTime &$prev_date_time, ilDateTime $message_date_time, ilDate $message_date, ?string &$prev_date_time_presentation, string $message_date_time_presentation, string $time_format)
	showMessages (array $messages, ilPropertyFormGUI $durationForm, bool $export=false, ?ilDateTime $from=null, ?ilDateTime $to=null, $room=null)

Additional Inherited Members
Protected Member Functions inherited from ilChatroomGUIHandler
	getRequestValue (string $key, Transformation $trafo, $default=null)
	hasRequestValue (string $key)
	getRoomByObjectId (int $objectId)
	exitIfNoRoomExists (?ilChatroom $room)
	Checks if a ilChatroom exists. More...
	sendJSONResponse ($response)
	Sends a json encoded response and exits the php process. More...
	sendResponse (string $content, string $type)
	Sends a response and exits the php process. More...
Protected Attributes inherited from ilChatroomGUIHandler
ilObjUser	$ilUser
ilCtrlInterface	$ilCtrl
ilLanguage	$ilLng
Filesystem	$webDirectory
ilObjectService	$obj_service
FileUpload	$upload
ilRbacSystem	$rbacsystem
ilGlobalTemplateInterface	$mainTpl
ILIAS	$ilias
ilNavigationHistory	$navigationHistory
ilTree	$tree
ilTabsGUI	$tabs
UIFactory	$uiFactory
UIRenderer	$uiRenderer
GlobalHttpState	$http
Refinery	$refinery

Detailed Description

Definition at line 21 of file class.ilChatroomHistoryGUI.php.

Member Function Documentation

byDayExport()

ilChatroomHistoryGUI::byDayExport

(

)

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

References ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ILIAS\FileDelivery\http(), showMessages(), and ILIAS\Repository\tabs().

                                 : void
    {
        $this->tabs->activateSubTab('byday');
        $this->byDay(true);
    }

Here is the call graph for this function:

executeDefault()

ilChatroomHistoryGUI::executeDefault

(

string

$requestedMethod

)

Definition at line 224 of file class.ilChatroomHistoryGUI.php.

                                                           : void
    {
        $this->byDay();
    }

renderDateTimeInformation()

ilChatroomHistoryGUI::renderDateTimeInformation (   $room_tpl, ?ilDateTime &  $prev_date_time, ilDateTime  $message_date_time, ilDate  $message_date, ?string &  $prev_date_time_presentation, string  $message_date_time_presentation, string  $time_format  )

private

Parameters

ilTemplate | ilGlobalTemplate

$room_tpl

Definition at line 26 of file class.ilChatroomHistoryGUI.php.

References ilDatePresentation\formatDate(), ilDateTime\get(), IL_CAL_FKT_DATE, IL_CAL_UNIX, and ilCalendarSettings\TIME_FORMAT_24.

Referenced by showMessages().

     : void {
        $render_parts = [];

        if (null === $prev_date_time ||
            date('d', $prev_date_time->get(IL_CAL_UNIX)) !== date('d', $message_date_time->get(IL_CAL_UNIX)) ||
            date('m', $prev_date_time->get(IL_CAL_UNIX)) !== date('m', $message_date_time->get(IL_CAL_UNIX)) ||
            date('Y', $prev_date_time->get(IL_CAL_UNIX)) !== date('Y', $message_date_time->get(IL_CAL_UNIX))
        ) {
            $render_parts['MESSAGEDATE'] = ilDatePresentation::formatDate($message_date);
            $prev_date_time = $message_date_time;
        }

        if ($prev_date_time_presentation !== $message_date_time_presentation) {
            $date_string = match ($time_format) {
                (string) ilCalendarSettings::TIME_FORMAT_24 => $message_date_time->get(
                    IL_CAL_FKT_DATE,
                    'H:i',
                    $this->ilUser->getTimeZone()
                ),
                default => $message_date_time->get(IL_CAL_FKT_DATE, 'g:ia', $this->ilUser->getTimeZone()),
            };

            $render_parts['MESSAGETIME'] = $date_string;
            $prev_date_time_presentation = $message_date_time_presentation;
        }

        if ($render_parts !== []) {
            $room_tpl->setCurrentBlock('datetime_line');
            foreach ($render_parts as $key => $value) {
                $room_tpl->setVariable($key, $value);
            }
            $room_tpl->parseCurrentBlock();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showMessages()

ilChatroomHistoryGUI::showMessages ( array  $messages, ilPropertyFormGUI  $durationForm, bool  $export = false, ?ilDateTime  $from = null, ?ilDateTime  $to = null,   $room = null  )

private

Definition at line 114 of file class.ilChatroomHistoryGUI.php.

References $scope, ilUtil\deliverData(), ilDatePresentation\formatDate(), ilDatePresentation\formatPeriod(), ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ilFileUtils\getASCIIFilename(), ilPropertyFormGUI\getHTML(), IL_CAL_UNIX, ilLinkifyUtil\initLinkify(), ilChatroomGUIHandler\redirectIfNoPermission(), renderDateTimeInformation(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by byDayExport().

     : void {
        $this->redirectIfNoPermission('read');

        $this->gui->switchToVisibleMode();

        // should be able to grep templates
        if ($export) {
            $roomTpl = new ilGlobalTemplate('tpl.history_export.html', true, true, 'components/ILIAS/Chatroom');
        } else {
            $roomTpl = new ilTemplate('tpl.history.html', true, true, 'components/ILIAS/Chatroom');
        }

        if ($export) {
            ilDatePresentation::setUseRelativeDates(false);
        }

        $time_format = $this->ilUser->getTimeFormat();

        $num_messages_shown = 0;
        $prev_date_time_presentation = null;
        $prev_date_time = null;
        if ($export) {
            foreach ($messages as $message) {
                switch ($message['message']->type) {
                    case 'message':
                        $message_date = new ilDate($message['timestamp'], IL_CAL_UNIX);
                        $message_date_time = new ilDateTime($message['timestamp'], IL_CAL_UNIX);
                        $message_date_time_presentation = ilDatePresentation::formatDate($message_date_time);

                        $this->renderDateTimeInformation(
                            $roomTpl,
                            $prev_date_time,
                            $message_date_time,
                            $message_date,
                            $prev_date_time_presentation,
                            $message_date_time_presentation,
                            $time_format
                        );

                        $roomTpl->setCurrentBlock('message_line');
                        $roomTpl->setVariable('MESSAGECONTENT', htmlspecialchars($message['message']->content, ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8')); // oops... it is a message? ^^
                        $roomTpl->setVariable('MESSAGESENDER', htmlspecialchars($message['message']->from->username, ENT_QUOTES | ENT_SUBSTITUTE, 'utf-8'));
                        $roomTpl->parseCurrentBlock();

                        $roomTpl->setCurrentBlock('row');
                        $roomTpl->parseCurrentBlock();

                        ++$num_messages_shown;
                        break;
                }
            }
        }

        if (!$num_messages_shown) {
            $roomTpl->setVariable('LBL_NO_MESSAGES', $this->ilLng->txt('no_messages'));
        }

        $scope = $this->ilLng->txt('main');

        $prevUseRelDates = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);

        if ($from instanceof ilDateTime && $to instanceof ilDateTime) {
            $unixFrom = $from->getUnixTime();
            $unixTo = $to->getUnixTime();

            if ($unixFrom === $unixTo) {
                $message_date = new ilDate($unixFrom, IL_CAL_UNIX);
                $date_sub = ilDatePresentation::formatDate($message_date);
            } else {
                $date1 = new ilDate($unixFrom, IL_CAL_UNIX);
                $date2 = new ilDate($unixTo, IL_CAL_UNIX);
                $date_sub = ilDatePresentation::formatPeriod($date1, $date2);
            }
            ilDatePresentation::setUseRelativeDates($prevUseRelDates);

            $roomTpl->setVariable(
                'ROOM_TITLE',
                sprintf($this->ilLng->txt('history_title_general'), $this->gui->getObject()->getTitle()) . ' (' . $date_sub . ')'
            );
        }

        if ($export) {
            ilUtil::deliverData(
                $roomTpl->get(),
                ilFileUtils::getASCIIFilename($scope . '.html'),
                'text/html'
            );
        }

        $roomTpl->setVariable('PERIOD_FORM', $durationForm->getHTML());

        if ($room && $messages !== []) {
            ilLinkifyUtil::initLinkify($this->mainTpl);
            $this->mainTpl->addJavaScript('assets/js/socket.io.min.js');
            $this->mainTpl->addJavaScript('assets/js/Chatroom.min.js');
            $roomTpl->setVariable('CHAT', (new ilChatroomViewGUI($this->gui))->readOnlyChatWindow($room, array_column($messages, 'message'))->get());
        } else {
            $roomTpl->setVariable('CHAT', '');
        }
        $this->mainTpl->setVariable('ADM_CONTENT', $roomTpl->get());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Chatroom/classes/gui/class.ilChatroomHistoryGUI.php