Inheritance diagram for ILIAS\OnScreenChat\Provider\OnScreenChatProvider:

Collaboration diagram for ILIAS\OnScreenChat\Provider\OnScreenChatProvider:

Public Member Functions
	__construct (Container $dic, ?Conversation $conversationRepo=null, ?Subscriber $subscriberRepo=null)

	getStaticTopItems ()

	getStaticSubItems ()

	getAsyncItem (string $conversationIds, bool $withAggregates)

Public Member Functions inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
	__construct (Container $dic)

	getAllIdentifications ()

	provideTypeInformation ()

Public Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	__construct (Container $dic)

	getFullyQualifiedClassName ()

	getProviderNameForPresentation ()

Private Member Functions
	getSlateMessageBox ()

Private Attributes
Conversation	$conversationRepo

Subscriber	$subscriberRepo

Additional Inherited Members
Protected Member Functions inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
	globalScreen ()

Protected Attributes inherited from ILIAS\GlobalScreen\Scope\MainMenu\Provider\AbstractStaticMainMenuProvider
Container	$dic

IdentificationProviderInterface	$if

MainMenuItemFactory	$mainmenu

Protected Attributes inherited from ILIAS\GlobalScreen\Provider\AbstractProvider
Container	$dic

Detailed Description

Class OnScreenChatProvider.

Author: Ingmar Szmais iszma.nosp@m.is@d.nosp@m.ataba.nosp@m.y.de

Definition at line 45 of file OnScreenChatProvider.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\OnScreenChat\Provider\OnScreenChatProvider::__construct	(	Container	$dic,
		?Conversation	$conversationRepo = `null`,
		?Subscriber	$subscriberRepo = `null`
	)

Definition at line 50 of file OnScreenChatProvider.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\DI\Container\language().

       {
         parent::__construct($dic);
         $dic->language()->loadLanguageModule('chatroom');
         $this->conversationRepo = $conversationRepo ?? new Conversation($this->dic->database(), $this->dic->user());
         $this->subscriberRepo = $subscriberRepo ?? new Subscriber($this->dic->database(), $this->dic->user());
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAsyncItem()

ILIAS\OnScreenChat\Provider\OnScreenChatProvider::getAsyncItem	(	string	$conversationIds,
		bool	$withAggregates
	)

Returns: Shy[]|MessageBox[]

Exceptions

JsonException
ilDateTimeException

Definition at line 142 of file OnScreenChatProvider.php.

References $id, ILIAS\UI\Component\Symbol\Icon\Standard\CON, ilDatePresentation\formatDate(), ILIAS\UI\Component\Symbol\Icon\Standard\GCON, ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getSlateMessageBox(), IL_CAL_UNIX, and ILIAS\UI\Implementation\Component\withAdditionalOnLoadCode().

                                                                                : array
     {
         $conversationIds = array_filter(explode(',', $conversationIds));
 
         if (!$withAggregates || !$this->dic->user()->getId() || $this->dic->user()->isAnonymous()) {
             return [$this->getSlateMessageBox()];
         }
 
         $conversations = $this->conversationRepo->findByIds($conversationIds);
 
         $allUsrIds = [];
         foreach ($conversations as $conversation) {
             foreach ($conversation->getSubscriberUsrIds() as $id) {
                 if ($id !== $this->dic->user()->getId()) {
                     $allUsrIds[$id] = true;
                 }
             }
         }
         $allUsrIds = array_keys($allUsrIds);
         $user_data = $this->subscriberRepo->getDataByUserIds($allUsrIds);
 
         $items = [];
         foreach ($conversations as $conversation) {
             if ($conversation->isGroup()) {
                 $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(Standard::GCON, 'group-conversation');
             } else {
                 $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(Standard::CON, 'conversation');
             }
 
             $users = [];
             foreach ($conversation->getSubscriberUsrIds() as $id) {
                 if ($id !== $this->dic->user()->getId()) {
                     $users[] = $user_data[$id]['public_name'];
                 }
             }
 
             $cid = $conversation->getId();
 
             $items[] = $this->dic->ui()->factory()->item()->shy(implode(', ', $users))
                   ->withDescription($conversation->getLastMessage()->getMessage())
                   ->withProperties(
                       [$this->dic->language()->txt('time') . ':' =>
                           ilDatePresentation::formatDate(
                               new ilDateTime(
                                   (int) ($conversation->getLastMessage()->getCreatedTimestamp() / 1000),
                                   IL_CAL_UNIX
                               )
                           )
                       ]
                   )
                   ->withLeadIcon($icon)
                   ->withClose($this->dic->ui()->factory()->button()->close())
                   ->withAdditionalOnLoadCode(
                       function ($id) use ($cid) {
                           return "il.OnScreenChat.menuCollector.querySelector('#$id').dataset.id = '$cid';";
                       }
                   );
         }
 
         if ($items === []) {
             $items[] = $this->getSlateMessageBox();
         }
 
         return $items;
     }

Here is the call graph for this function:

◆ getSlateMessageBox()

ILIAS\OnScreenChat\Provider\OnScreenChatProvider::getSlateMessageBox ( )

private

Definition at line 69 of file OnScreenChatProvider.php.

References ilUtil\yn2tf().

Referenced by ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getAsyncItem(), and ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getStaticSubItems().

                                          : MessageBox
     {
         $acceptsMessages = ilUtil::yn2tf((string) $this->dic->user()->getPref('chat_osc_accept_msg'));
         if ($acceptsMessages) {
             return $this->dic->ui()->factory()
                 ->messageBox()
                 ->info($this->dic->language()->txt('chat_osc_accept_no_conv_info_slate'));
         }
 
         return $this->dic->ui()->factory()
             ->messageBox()
             ->info($this->dic->language()->txt('chat_osc_accept_msg_info_slate'))
             ->withLinks([
                 $this->dic->ui()->factory()
                     ->link()
                     ->standard(
                         $this->dic->language()->txt('chat_osc_accept_msg_info_slate_link_txt'),
                         $this->dic->ctrl()->getLinkTargetByClass(
                             [
                                 ilDashboardGUI::class,
                                 ilPersonalProfileGUI::class,
                                 ilUserPrivacySettingsGUI::class
                             ],
                             'showPrivacySettings'
                         )
                     )
              ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStaticSubItems()

ILIAS\OnScreenChat\Provider\OnScreenChatProvider::getStaticSubItems ( )

Implements ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider.

Definition at line 101 of file OnScreenChatProvider.php.

References $id, ILIAS\UI\Component\Symbol\Icon\Standard\CHTA, ILIAS\MainMenu\Provider\StandardTopItemsProvider\getInstance(), ILIAS\OnScreenChat\Provider\OnScreenChatProvider\getSlateMessageBox(), if, and ILIAS\GlobalScreen\Scope\MainMenu\Factory\withSymbol().

                                        : array
     {
         $icon = $this->dic->ui()->factory()->symbol()->icon()->standard(
             Standard::CHTA,
             $this->dic->language()->txt('public_room')
         );
 
         return [
             $this->mainmenu->complex($this->if->identifier('mm_chat'))
                 ->withAvailableCallable(function (): bool {
                     $isUser = 0 !== $this->dic->user()->getId() && !$this->dic->user()->isAnonymous();
                     $chatSettings = new ilSetting('chatroom');
                     $isEnabled = $chatSettings->get('chat_enabled') && $chatSettings->get('enable_osc');
 
                     return $isUser && $isEnabled;
                 })
                 ->withTitle($this->dic->language()->txt('mm_private_chats'))
                 ->withSymbol($icon)
                 ->withContentWrapper(function (): \ILIAS\UI\Component\Component {
                     $components = [
                         $this->getSlateMessageBox(),
                         $this->dic->ui()->factory()->item()->shy('')->withAdditionalOnLoadCode(
                             static function ($id): string {
                                 return "il.OnScreenChat.menuCollector = $id.parentNode;$id.remove();";
                             }
                         )
                     ];
 
                     return $this->dic->ui()->factory()->legacy($this->dic->ui()->renderer()->render($components));
                 })
                 ->withParent(StandardTopItemsProvider::getInstance()->getCommunicationIdentification())
                 ->withPosition(40)
             ,
         ];
     }

Here is the call graph for this function:

◆ getStaticTopItems()

ILIAS\OnScreenChat\Provider\OnScreenChatProvider::getStaticTopItems ( )

Implements ILIAS\GlobalScreen\Scope\MainMenu\Provider\StaticMainMenuProvider.

Definition at line 64 of file OnScreenChatProvider.php.

                                        : array
     {
         return [];
     }

Field Documentation

◆ $conversationRepo

Conversation ILIAS\OnScreenChat\Provider\OnScreenChatProvider::$conversationRepo

private

Definition at line 47 of file OnScreenChatProvider.php.

◆ $subscriberRepo

Subscriber ILIAS\OnScreenChat\Provider\OnScreenChatProvider::$subscriberRepo

private

Definition at line 48 of file OnScreenChatProvider.php.

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

Services/OnScreenChat/classes/Provider/OnScreenChatProvider.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAsyncItem()

◆ getSlateMessageBox()

◆ getStaticSubItems()

◆ getStaticTopItems()

Field Documentation

◆ $conversationRepo

◆ $subscriberRepo