A class that provides a collection of actions on users. More...

Collaboration diagram for ilUserActionGUI:

Public Member Functions
	__construct (private ilUserActionProviderFactory $user_action_provider_factory, private ilUserActionContext $user_action_context, private ilGlobalTemplateInterface $tpl, private UIFactory $ui_factory, private Renderer $ui_renderer, private Language $lng, ilDBInterface $db, int $user_id)

	init ()

	renderDropDown (int $target_user_id)

Private Attributes
ilUserActionAdmin	$user_action_admin

ilUserActionCollector	$user_action_collector

Detailed Description

A class that provides a collection of actions on users.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 29 of file class.ilUserActionGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserActionGUI::__construct	(	private ilUserActionProviderFactory	$user_action_provider_factory,
		private ilUserActionContext	$user_action_context,
		private ilGlobalTemplateInterface	$tpl,
		private UIFactory	$ui_factory,
		private Renderer	$ui_renderer,
		private Language	$lng,
		ilDBInterface	$db,
		int	$user_id
	)

Definition at line 34 of file class.ilUserActionGUI.php.

References ILIAS\Repository\lng().

       {
         $this->lng->loadLanguageModule('usr');
         $this->user_action_admin = new ilUserActionAdmin($db);
         $this->user_action_collector = new ilUserActionCollector(
             $user_id,
             new ilGalleryUserActionContext(),
             new ilUserActionProviderFactory(),
             new ilUserActionAdmin($db)
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ init()

ilUserActionGUI::init ( )

Definition at line 54 of file class.ilUserActionGUI.php.

                           : void
     {
         foreach ($this->user_action_provider_factory->getProviders() as $prov) {
             foreach (array_keys($prov->getActionTypes()) as $act_type) {
                 if ($this->user_action_admin->isActionActive(
                     $this->user_action_context->getComponentId(),
                     $this->user_action_context->getContextId(),
                     $prov->getComponentId(),
                     $act_type
                 )) {
                     foreach ($prov->getJsScripts($act_type) as $script) {
                         $this->tpl->addJavaScript($script);
                     }
                 }
             }
         }
     }

◆ renderDropDown()

ilUserActionGUI::renderDropDown ( int $target_user_id )

Definition at line 72 of file class.ilUserActionGUI.php.

References $data, $id, and ILIAS\Repository\lng().

                                                        : string
     {
         $action_collection = $this->user_action_collector->getActionsForTargetUser($target_user_id);
         $actions = [];
         foreach ($action_collection->getActions() as $action) {
             $action_link = $this->ui_factory->link()->standard($action->getText(), $action->getHref());
             if ($action->getData() !== []) {
                 $data = $action->getData();
                 $action_link = $action_link->withAdditionalOnLoadCode(
                     static function ($id) use ($data): string {
                         $js = '';
                         foreach ($data as $key => $datum) {
                             $js .= "{$id}.setAttribute('data-{$key}', '{$datum}');";
                         }
                         return $js;
                     }
                 );
             }
 
             $actions[] = $action_link;
         }
         $action_list = $this->ui_factory->dropdown()->standard($actions)
             ->withAriaLabel($this->lng->txt('user_actions'));
         return $this->ui_renderer->render($action_list);
     }

Here is the call graph for this function:

Field Documentation

◆ $user_action_admin

ilUserActionAdmin ilUserActionGUI::$user_action_admin

private

Definition at line 31 of file class.ilUserActionGUI.php.

◆ $user_action_collector

ilUserActionCollector ilUserActionGUI::$user_action_collector