User action administration GUI class. More...

Collaboration diagram for ilUserActionAdminGUI:

Public Member Functions
	setActionContext (?ilUserActionContext $a_val=null)

	getActionContext ()

	executeCommand ()

	show ()

	save ()

Private Member Functions
	buildForm ()

	getActions ()

Private Attributes
ilRbacSystem	$rbabsystem

int	$ref_id

ServerRequestInterface	$request

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Language	$lng

ilUserActionContext	$action_context

ilUserActionAdmin	$user_action_admin

Detailed Description

User action administration GUI class.

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

Definition at line 32 of file class.ilUserActionAdminGUI.php.

Member Function Documentation

◆ buildForm()

ilUserActionAdminGUI::buildForm ( )

private

Definition at line 111 of file class.ilUserActionAdminGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), and getActions().

Referenced by save().

                                 : StandardForm
     {
         $inputs = [];
 
         foreach($this->getActions() as $action) {
             $inputs["{$action['action_comp_id']}:{$action['action_type_id']}"] =
                 $this->ui_factory->input()->field()->checkbox($action["action_type_name"])
                     ->withValue($action['active']);
         }
 
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormActionByClass(self::class, 'save'),
             $inputs
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilUserActionAdminGUI::executeCommand ( )

Definition at line 75 of file class.ilUserActionAdminGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd('show');
 
         switch ($next_class) {
             default:
                 if (in_array($cmd, ['show', 'save'])) {
                     $this->$cmd();
                 }
         }
     }

Here is the call graph for this function:

◆ getActionContext()

ilUserActionAdminGUI::getActionContext ( )

Definition at line 70 of file class.ilUserActionAdminGUI.php.

References $action_context.

                                       : ilUserActionContext
     {
         return $this->action_context;
     }

◆ getActions()

ilUserActionAdminGUI::getActions ( )

private

Definition at line 153 of file class.ilUserActionAdminGUI.php.

References $id.

Referenced by buildForm(), save(), and show().

                                  : \Generator
     {
         foreach ((new ilUserActionProviderFactory())->getProviders() as $p) {
             foreach ($p->getActionTypes() as $id => $name) {
                 yield [
                     'action_comp_id' => $p->getComponentId(),
                     'action_type_id' => $id,
                     'action_type_name' => $name,
                     'active' => $this->user_action_admin->isActionActive(
                         $this->action_context->getComponentId(),
                         $this->action_context->getContextId(),
                         $p->getComponentId(),
                         $id
                     )
                 ];
             }
         }
     }

Here is the caller graph for this function:

◆ save()

ilUserActionAdminGUI::save ( )

Definition at line 127 of file class.ilUserActionAdminGUI.php.

References $data, buildForm(), ILIAS\Repository\ctrl(), getActions(), ILIAS\Repository\lng(), null, and show().

                           : void
     {
         if (!$this->rbabsystem->checkAccess('write', $this->ref_id)) {
             $this->ctrl->redirect($this, 'show');
         }
 
         $form = $this->buildForm()->withRequest($this->request);
         $data = $form->getData();
         if ($data === null) {
             $this->tpl->setContent($this->ui_renderer->render($form));
             return;
         }
 
         foreach ($this->getActions() as $action) {
             $this->user_action_admin->activateAction(
                 $this->action_context->getComponentId(),
                 $this->action_context->getContextId(),
                 $action['action_comp_id'],
                 $action['action_type_id'],
                 $data["{$action['action_comp_id']}:{$action['action_type_id']}"] ?? false
             );
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
         $this->show();
     }

Here is the call graph for this function:

◆ setActionContext()

ilUserActionAdminGUI::setActionContext ( ?ilUserActionContext $a_val = null )

Definition at line 65 of file class.ilUserActionAdminGUI.php.

Referenced by ilMembershipAdministrationGUI\executeCommand().

                                                                         : void
     {
         $this->action_context = $a_val;
     }

Here is the caller graph for this function:

◆ show()

ilUserActionAdminGUI::show ( )

Definition at line 88 of file class.ilUserActionAdminGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), getActions(), and ILIAS\Repository\lng().

Referenced by save().

                           : void
     {
         if (!$this->rbabsystem->checkAccess('write', $this->ref_id)) {
             $this->ctrl->redirect($this, 'show');
         }
 
         $this->tpl->setOnScreenMessage('info', $this->lng->txt('user_actions_activation_info'));
 
         $inputs = [];
 
         foreach($this->getActions() as $action) {
             $inputs["{$action['action_comp_id']}:{$action['action_type_id']}"] =
                 $this->ui_factory->input()->field()->checkbox($action["action_type_name"])
                     ->withValue($action['active']);
         }
 
         $this->tpl->setContent(
             $this->ui_renderer->render(
                 $this->buildForm()
             )
         );
     }