ilUserActionGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilUserActionGUI:

Public Member Functions
	init ()
	renderDropDown (int $a_target_user_id)

Static Public Member Functions
static	getInstance (ilUserActionContext $a_user_action_context, ilGlobalTemplateInterface $a_global_tpl, int $a_current_user_id)

Protected Member Functions
	__construct (ilUserActionContext $a_user_action_context, ilGlobalTemplateInterface $a_global_tpl, int $a_current_user_id)

Protected Attributes
ilGlobalTemplateInterface	$tpl
ilUserActionContext	$user_action_context
bool	$init_done = false
int	$current_user_id

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 23 of file class.ilUserActionGUI.php.

Constructor & Destructor Documentation

__construct()

ilUserActionGUI::__construct ( ilUserActionContext  $a_user_action_context, ilGlobalTemplateInterface  $a_global_tpl, int  $a_current_user_id  )

protected

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

      {
        $this->tpl = $a_global_tpl;
        $this->user_action_context = $a_user_action_context;
        $this->current_user_id = $a_current_user_id;
    }

Member Function Documentation

getInstance()

static ilUserActionGUI::getInstance ( ilUserActionContext  $a_user_action_context, ilGlobalTemplateInterface  $a_global_tpl, int  $a_current_user_id  )

static

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

     : ilUserActionGUI {
        return new ilUserActionGUI($a_user_action_context, $a_global_tpl, $a_current_user_id);
    }

Referenced by ilUsersGalleryGUI\addActionSection(), and ilAwarenessGUI\initJS().

Here is the caller graph for this function:

init()

ilUserActionGUI::init

(

)

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

                          : void
    {
        $tpl = $this->tpl;
 
        foreach (ilUserActionProviderFactory::getAllProviders() as $prov) {
            foreach ($prov->getActionTypes() as $act_type => $txt) {
                if (ilUserActionAdmin::lookupActive(
                    $this->user_action_context->getComponentId(),
                    $this->user_action_context->getContextId(),
                    $prov->getComponentId(),
                    $act_type
                )) {
                    foreach ($prov->getJsScripts($act_type) as $script) {
                        $tpl->addJavaScript($script);
                    }
                }
            }
        }
    }

References $tpl, $txt, ilUserActionProviderFactory\getAllProviders(), and ilUserActionAdmin\lookupActive().

Here is the call graph for this function:

renderDropDown()

ilUserActionGUI::renderDropDown

(

int

$a_target_user_id

)

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

                                                         : string
    {
        if (!$this->init_done) {
            $this->init();
        }
        $act_collector = ilUserActionCollector::getInstance($this->current_user_id, $this->user_action_context);
        $action_collection = $act_collector->getActionsForTargetUser($a_target_user_id);
        $list = new ilAdvancedSelectionListGUI();
        $list->setListTitle("");
        $list->setPullRight(false);
        foreach ($action_collection->getActions() as $action) {
            $list->addItem($action->getText(), "", $action->getHref(), "", "", "", "", false, "", "", "", "", true, $action->getData());
        }
        return $list->getHTML();
    }

References ilUserActionCollector\getInstance().

Here is the call graph for this function:

Field Documentation

$current_user_id

int ilUserActionGUI::$current_user_id

protected

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

$init_done

bool ilUserActionGUI::$init_done = false

protected

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

$tpl

ilGlobalTemplateInterface ilUserActionGUI::$tpl

protected

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

$user_action_context

ilUserActionContext ilUserActionGUI::$user_action_context

protected

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

---

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

• Services/User/Actions/classes/class.ilUserActionGUI.php