ilChatroomHistoryGUI Class Reference

Class ilChatroom Keeps methods to prepare and display the history task. More...

Inheritance diagram for ilChatroomHistoryGUI:

Collaboration diagram for ilChatroomHistoryGUI:

Public Member Functions
	byDayExport ()
	byDay (bool $export=false)
	bySessionExport ()
	bySession (bool $export=false)
	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...
	sendResponse ($response, bool $isJson=false)
	Sends a json encoded response and exits the php process. 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)

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...
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

Class ilChatroom Keeps methods to prepare and display the history task.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

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

Member Function Documentation

byDay()

ilChatroomHistoryGUI::byDay

(

bool

$export = false

)

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

References $messages, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ILIAS\FileDelivery\http(), and showMessages().

Referenced by byDayExport(), and executeDefault().

                                               : void
    {
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);

        $chat_user = new ilChatroomUser($this->ilUser, $room);
        $formFactory = new ilChatroomFormFactory();

        $durationForm = $formFactory->getPeriodForm();
        $durationForm->setTitle($this->ilLng->txt('history_byday_title'));
        $durationForm->addCommandButton('history-byDayExport', $this->ilLng->txt('export'));
        $durationForm->addCommandButton('history-byDay', $this->ilLng->txt('show'));
        $durationForm->setFormAction($this->ilCtrl->getFormAction($this->gui, 'history-byDay'));

        $messages = [];
        $submit_request = strtolower($this->http->request()->getServerParams()['REQUEST_METHOD']) === 'post';
        $from = null;
        $to = null;

        if ($submit_request) {
            if ($durationForm->checkInput()) {
                $period = $durationForm->getItemByPostVar('timeperiod');

                $messages = $room->getHistory(
                    $from = $period->getStart(),
                    $to = $period->getEnd(),
                    $chat_user->getUserId()
                );
            } else {
                $export = false;
            }

            $durationForm->setValuesByPost();
        }

        $this->showMessages($messages, $durationForm, $export, $from, $to);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

byDayExport()

ilChatroomHistoryGUI::byDayExport

(

)

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

References byDay(), and ILIAS\Repository\tabs().

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

Here is the call graph for this function:

bySession()

ilChatroomHistoryGUI::bySession

(

bool

$export = false

)

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

References $messages, $scope, ilChatroom\byObjectId(), ilChatroomGUIHandler\exitIfNoRoomExists(), ilChatroomGUIHandler\getRequestValue(), ILIAS\FileDelivery\http(), IL_CAL_UNIX, ILIAS\Repository\refinery(), and showMessages().

Referenced by bySessionExport().

                                                   : void
    {
        $room = ilChatroom::byObjectId($this->gui->getObject()->getId());
        $this->exitIfNoRoomExists($room);

        $scope = $room->getRoomId();

        $chat_user = new ilChatroomUser($this->ilUser, $room);

        $formFactory = new ilChatroomFormFactory();
        $durationForm = $formFactory->getSessionForm($room->getSessions($chat_user));
        $durationForm->setTitle($this->ilLng->txt('history_bysession_title'));
        $durationForm->addCommandButton('history-bySessionExport', $this->ilLng->txt('export'));
        $durationForm->addCommandButton('history-bySession', $this->ilLng->txt('show'));
        $durationForm->setFormAction(
            $this->ilCtrl->getFormAction($this->gui, 'history-bySession')
        );

        if (strtolower($this->http->request()->getServerParams()['REQUEST_METHOD']) === 'post') {
            $session = $this->getRequestValue('session', $this->refinery->kindlyTo()->string());
            $durationForm->checkInput();
            $postVals = explode(',', (string) $session);
            $durationForm->setValuesByArray([
                'session' => $session
            ]);

            $messages = $room->getHistory(
                $from = new ilDateTime($postVals[0], IL_CAL_UNIX),
                $to = new ilDateTime($postVals[1], IL_CAL_UNIX),
                $chat_user->getUserId()
            );
        } else {
            $last_session = $room->getLastSession($chat_user);

            if ($last_session) {
                $from = new ilDateTime($last_session['connected'], IL_CAL_UNIX);
                $to = new ilDateTime($last_session['disconnected'], IL_CAL_UNIX);
            } else {
                $from = null;
                $to = null;
            }

            $messages = $room->getHistory(
                $from,
                $to,
                $chat_user->getUserId()
            );
        }

        $from = new ilDateTime();
        $to = new ilDateTime();

        $this->showMessages($messages, $durationForm, $export, $from, $to);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

bySessionExport()

ilChatroomHistoryGUI::bySessionExport

(

)

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

References bySession(), and ILIAS\Repository\tabs().

                                     : void
    {
        $this->tabs->activateSubTab('bysession');
        $this->bySession(true);
    }

Here is the call graph for this function:

executeDefault()

ilChatroomHistoryGUI::executeDefault

(

string

$requestedMethod

)

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

References byDay().

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

Here is the call graph for this function:

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 33 of file class.ilChatroomHistoryGUI.php.

References ILIAS\LTI\ToolProvider\$key, 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  )

private

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

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

Referenced by byDay(), and bySession().

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

        $this->gui->switchToVisibleMode();

        $this->mainTpl->addCss('Modules/Chatroom/templates/default/style.css');

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

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

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

        $num_messages_shown = 0;
        $prev_date_time_presentation = null;
        $prev_date_time = null;
        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', $message['message']->content); // oops... it is a message? ^^
                    $roomTpl->setVariable('MESSAGESENDER', $message['message']->from->username);
                    $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());

        $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:

• Modules/Chatroom/classes/gui/class.ilChatroomHistoryGUI.php