User action administration GUI class. More...

Collaboration diagram for ilUserActionAdminGUI:

Public Member Functions
	__construct (int $ref_id)

	setActionContext (ilUserActionContext $a_val=null)

	getActionContext ()

	executeCommand ()

	show ()

	save ()
	Save !!!! note in the future this must depend on the context, currently we only have one. More...

	getActions ()
	Get actions, !!!! note in the future this must depend on the context, currently we only have one. More...

Private Attributes
ilRbacSystem	$rbabsystem

int	$ref_id

UserGUIRequest	$request

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilLanguage	$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 27 of file class.ilUserActionAdminGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserActionAdminGUI::__construct ( int $ref_id )

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

References $DIC, $ref_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC["tpl"];
         $this->ref_id = $ref_id;
         $this->rbabsystem = $DIC->rbac()->system();
         $this->lng->loadLanguageModule("usr");
         $this->request = new UserGUIRequest(
             $DIC->http(),
             $DIC->refinery()
         );
         $this->user_action_admin = new ilUserActionAdmin($DIC['ilDB']);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilUserActionAdminGUI::executeCommand ( )

Definition at line 65 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 60 of file class.ilUserActionAdminGUI.php.

References $action_context.

                                       : ilUserActionContext
     {
         return $this->action_context;
     }

◆ getActions()

ilUserActionAdminGUI::getActions ( )

Get actions, !!!! note in the future this must depend on the context, currently we only have one.

Returns: array[]

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

References $data, and $id.

Referenced by save(), and show().

                                 : array
     {
         $data = [];
         $action_provider_factory = new ilUserActionProviderFactory();
         foreach ($action_provider_factory->getProviders() as $p) {
             foreach ($p->getActionTypes() as $id => $name) {
                 $data[] = [
                     "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
                     )
                 ];
             }
         }
         return $data;
     }

Here is the caller graph for this function:

◆ save()

ilUserActionAdminGUI::save ( )

Save !!!! note in the future this must depend on the context, currently we only have one.

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

References Vendor\Package\$a, ILIAS\Repository\ctrl(), getActions(), and ILIAS\Repository\lng().

                           : void
     {
         if (!$this->rbabsystem->checkAccess("write", $this->ref_id)) {
             $this->ctrl->redirect($this, "show");
         }
 
         $active = $this->request->getActionActive();
         foreach ($this->getActions() as $a) {
             $this->user_action_admin->activateAction(
                 $this->action_context->getComponentId(),
                 $this->action_context->getContextId(),
                 $a["action_comp_id"],
                 $a["action_type_id"],
                 (bool) ($active[$a["action_comp_id"] . ":" . $a["action_type_id"]] ?? false)
             );
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
         $this->ctrl->redirect($this, "show");
     }

Here is the call graph for this function:

◆ setActionContext()

ilUserActionAdminGUI::setActionContext ( ilUserActionContext $a_val = null )

Definition at line 55 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 78 of file class.ilUserActionAdminGUI.php.

References getActions(), and ILIAS\Repository\lng().

                           : void
     {
         $this->tpl->setOnScreenMessage('info', $this->lng->txt("user_actions_activation_info"));
 
         $tab = new ilUserActionAdminTableGUI(
             $this,
             "show",
             $this->getActions(),
             $this->rbabsystem->checkAccess("write", $this->ref_id)
         );
         $this->tpl->setContent($tab->getHTML());
     }