Inheritance diagram for ILIAS\Mail\Provider\MailGlobalScreenToolProvider:

Collaboration diagram for ILIAS\Mail\Provider\MailGlobalScreenToolProvider:

Public Member Functions
	__construct (Container $dic, ?UIFactory $ui_factory=null, ?UIRenderer $ui_renderer=null, ?ilObjUser $user=null, ?ilCtrlInterface $ctrl=null, ?HttpWrapper $http_wrapper=null, ?Refinery $refinery=null, ?ilLanguage $lng=null, ?IconFactory $icon_factory=null)

	isInterestedInContexts ()

	getToolsForContextStack (CalledContexts $called_contexts)

Public Member Functions inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
	__construct (Container $dic)
	@inheritDoc More...

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

	getFullyQualifiedClassName ()

	getProviderNameForPresentation ()

	getFullyQualifiedClassName ()

	getProviderNameForPresentation ()

	getToolsForContextStack (CalledContexts $called_contexts)

	isInterestedInContexts ()

Data Fields
final const string	SHOW_MAIL_FOLDERS_TOOL = 'show_mail_folders_tool'

Private Member Functions
	buildSubItems ()

	buildFolderLink (int $folderId, string\|array $class, ?string $cmd=null)

	buildItem (string $title, string $icon_name, string $link)

	buildIcon (string $title, string $type)

	filterUserFolders (array &$folders)

Private Attributes
readonly UIFactory	$ui_factory

readonly UIRenderer	$ui_renderer

readonly ilMailbox	$mbox

readonly ilObjUser	$user

readonly ilCtrlInterface	$ctrl

readonly HttpWrapper	$http_wrapper

readonly Refinery	$refinery

readonly ilLanguage	$lng

readonly IconFactory	$icon_factory

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

Protected Attributes inherited from ILIAS\GlobalScreen\Scope\Tool\Provider\AbstractDynamicToolProvider
ToolIdentificationProviderInterface	$identification_provider

ContextCollection	$context_collection

ToolFactory	$factory

Detailed Description

Definition at line 51 of file MailGlobalScreenToolProvider.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::__construct	(	Container	$dic,
		?UIFactory	$ui_factory = `null`,
		?UIRenderer	$ui_renderer = `null`,
		?ilObjUser	$user = `null`,
		?ilCtrlInterface	$ctrl = `null`,
		?HttpWrapper	$http_wrapper = `null`,
		?Refinery	$refinery = `null`,
		?ilLanguage	$lng = `null`,
		?IconFactory	$icon_factory = `null`
	)

Definition at line 65 of file MailGlobalScreenToolProvider.php.

      {
        parent::__construct($dic);
        $this->ui_factory = $ui_factory ?? $this->dic->ui()->factory();
        $this->ui_renderer = $ui_renderer ?? $this->dic->ui()->renderer();
        $this->user = $user ?? $this->dic->user();
        $this->ctrl = $ctrl ?? $this->dic->ctrl();
        $this->http_wrapper = $http_wrapper ?? $this->dic->http()->wrapper();
        $this->refinery = $refinery ?? $this->dic->refinery();
        $this->lng = $lng ?? $this->dic->language();
        $this->icon_factory = $icon_factory ?? $this->ui_factory->symbol()->icon();
 
        $this->mbox = new ilMailbox($this->user->getId());
    }

References $dic, ILIAS\Mail\Provider\MailGlobalScreenToolProvider\$http_wrapper, ILIAS\Mail\Provider\MailGlobalScreenToolProvider\$icon_factory, ILIAS\Mail\Provider\MailGlobalScreenToolProvider\$ui_factory, ILIAS\Mail\Provider\MailGlobalScreenToolProvider\$ui_renderer, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ buildFolderLink()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::buildFolderLink	(	int	$folderId,
		string\|array	$class,
		?string	$cmd = `null`
	)

private

Parameters

class-string|list<class-string> $class

Exceptions

ilCtrlException

Definition at line 206 of file MailGlobalScreenToolProvider.php.

                                                                                             : string
    {
        $this->ctrl->setParameterByClass(is_array($class) ? current($class) : $class, 'mobj_id', $folderId);
        $url = $this->ctrl->getLinkTargetByClass($class, $cmd);
        $this->ctrl->setParameterByClass(is_array($class) ? current($class) : $class, 'mob_id', null);
 
        return $url;
    }

References $url, and ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ buildIcon()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::buildIcon	(	string	$title,
		string	$type
	)

private

Definition at line 224 of file MailGlobalScreenToolProvider.php.

                                                           : CustomIcon
    {
        return $this->icon_factory->custom(
            ilUtil::getImagePath("standard/icon_$type.svg"),
            $title
        );
    }

References ilUtil\getImagePath().

Referenced by ILIAS\Mail\Provider\MailGlobalScreenToolProvider\buildItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildItem()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::buildItem	(	string	$title,
		string	$icon_name,
		string	$link
	)

private

Definition at line 215 of file MailGlobalScreenToolProvider.php.

                                                                              : BulkyButton
    {
        return $this->ui_factory->button()->bulky(
            $this->buildIcon($title, $icon_name),
            $title,
            $link
        );
    }

References ILIAS\Mail\Provider\MailGlobalScreenToolProvider\buildIcon().

Referenced by ILIAS\Mail\Provider\MailGlobalScreenToolProvider\buildSubItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildSubItems()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::buildSubItems ( )

private

Returns: Clickable[]

Definition at line 155 of file MailGlobalScreenToolProvider.php.

                                    : array
    {
        $items = [];
 
        $folders = $this->mbox->getSubFolders();
        usort(
            $folders,
            static fn(MailFolderData $a, MailFolderData $b): int => $a->isTrash() && !$b->isUserLocalFolder() ? 1 : 0
        );
        $user_folders = $this->filterUserFolders($folders);
 
        foreach ($folders as $folder) {
            if ($folder->isUserLocalFolder() && $user_folders !== []) {
                $icon_name = $folder->getType()->value;
                $items[] = $this->ui_factory->menu()->sub(
                    $folder->getTitle(),
                    [
                        $this->buildItem(
                            $this->lng->txt('mail_main_folder'),
                            $icon_name,
                            $this->buildFolderLink($folder->getFolderId(), ilMailFolderGUI::class)
                        ),
                        ...array_map(
                            function (MailFolderData $folder) use ($icon_name): BulkyButton {
                                return $this->buildItem(
                                    $folder->getTitle(),
                                    $icon_name,
                                    $this->buildFolderLink($folder->getFolderId(), ilMailFolderGUI::class)
                                );
                            },
                            $user_folders
                        ),
                    ]
                );
                continue;
            }
 
            $items[] = $this->buildItem(
                $folder->getTitle(),
                $folder->getType()->value,
                $this->buildFolderLink($folder->getFolderId(), ilMailFolderGUI::class)
            );
        }
 
        return $items;
    }

References Vendor\Package\$a, Vendor\Package\$b, ILIAS\Mail\Provider\MailGlobalScreenToolProvider\buildItem(), ILIAS\Mail\Provider\MailGlobalScreenToolProvider\filterUserFolders(), ILIAS\Mail\Folder\MailFolderData\getFolderId(), and ILIAS\Mail\Folder\MailFolderData\getTitle().

Here is the call graph for this function:

◆ filterUserFolders()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::filterUserFolders ( array & $folders )

private

Parameters

list<MailFolderData> $folders

Returns: list<MailFolderData>

Definition at line 236 of file MailGlobalScreenToolProvider.php.

                                                       : array
    {
        $user_folders = [];
        $filtered_folders = [];
 
        foreach ($folders as $folder) {
            if ($folder->isUserFolder()) {
                $user_folders[] = $folder;
                continue;
            }
 
            $filtered_folders[] = $folder;
        }
        $folders = $filtered_folders;
 
        return $user_folders;
    }

Referenced by ILIAS\Mail\Provider\MailGlobalScreenToolProvider\buildSubItems().

Here is the caller graph for this function:

◆ getToolsForContextStack()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::getToolsForContextStack ( CalledContexts $called_contexts )

Parameters

CalledContexts $called_contexts

Returns: Tool[] These Slates can be passed to the MainMenu dynamic for a specific location/context.

See also: DynamicProvider

Implements ILIAS\GlobalScreen\Scope\Tool\Provider\DynamicToolProvider.

Definition at line 94 of file MailGlobalScreenToolProvider.php.

                                                                            : array
    {
        $identification = fn($id): IdentificationInterface => $this->identification_provider->contextAwareIdentifier($id);
 
        $tools = [];
 
        $additional_data = $called_contexts->getLast()->getAdditionalData();
        if ($additional_data->exists(self::SHOW_MAIL_FOLDERS_TOOL) &&
            $additional_data->get(self::SHOW_MAIL_FOLDERS_TOOL) === true) {
 
            $tools[] = $this->factory
                ->tool($identification('mail_folders_tree'))
                ->withTitle($this->lng->txt('mail'))
                ->withSymbol($this->icon_factory->standard('mail', $this->lng->txt('mail')))
                ->withContentWrapper(function (): LegacyContent {
                    $current_folder_id = $this->http_wrapper->query()->retrieve(
                        'mobj_id',
                        $this->refinery->kindlyTo()->int()
                    );
 
                    $this->ctrl->setParameterByClass(ilMailFormGUI::class, 'type', ilMailFormGUI::MAIL_FORM_TYPE_NEW);
 
                    $sub_items = [
                        $this->buildItem(
                            $this->lng->txt('mail_new'),
                            'mail',
                            $this->buildFolderLink($current_folder_id, ilMailFormGUI::class)
                        ),
                        ...$this->buildSubItems(),
                        $this->buildItem(
                            $this->lng->txt('mail_attachments'),
                            'attach',
                            $this->buildFolderLink($current_folder_id, [ilMailGUI::class, ilMailAttachmentGUI::class])
                        )
                    ];
 
                    if ($this->dic->settings()->get('show_mail_settings', '0')) {
                        $sub_items[] = $this->buildItem(
                            $this->lng->txt('mail_options'),
                            'adm',
                            $this->buildFolderLink($current_folder_id, ilMailOptionsGUI::class)
                        );
                    }
 
                    $item = $this->ui_factory->menu()->drilldown(
                        $this->lng->txt('mail'),
                        $sub_items
                    );
 
                    return $this->ui_factory->legacy()->content(
                        $this->ui_renderer->render($item)
                    );
                });
        }
 
        return $tools;
    }

References $id, factory(), ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\getLast(), if, ILIAS\Repository\lng(), ilMailFormGUI\MAIL_FORM_TYPE_NEW, and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ isInterestedInContexts()

ILIAS\Mail\Provider\MailGlobalScreenToolProvider::isInterestedInContexts ( )

Returns: ContextCollection

Implements ILIAS\GlobalScreen\ScreenContext\ScreenContextAwareProvider.

Definition at line 89 of file MailGlobalScreenToolProvider.php.

                                            : ContextCollection
    {
        return $this->context_collection->main()->repository()->administration();
    }

References ILIAS\GlobalScreen\ScreenContext\Stack\ContextCollection\main().

Here is the call graph for this function: