ilUserActionGUI Class Reference

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

Collaboration diagram for ilUserActionGUI:

Public Member Functions
	init ()
	Add requried js for an action context. More...
	renderDropDown ($a_target_user_id)
	Render drop down. More...

Static Public Member Functions
static	getInstance (ilUserActionContext $a_user_action_context, ilTemplate $a_global_tpl, $a_current_user_id)
	Get instance. More...

Protected Member Functions
	__construct (ilUserActionContext $a_user_action_context, ilTemplate $a_global_tpl, $a_current_user_id)
	Constructor. More...

Protected Attributes
	$tpl
	$user_action_context
	$init_done = false
	$current_user_id

Detailed Description

A class that provides a collection of actions on users.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilUserActionGUI::__construct ( ilUserActionContext  $a_user_action_context, ilTemplate  $a_global_tpl,   $a_current_user_id  )

protected

Constructor.

Parameters

ilUserActionContext	$a_user_action_context
ilTemplate	$a_global_tpl
int	$a_current_user_id

Definition at line 41 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, ilTemplate  $a_global_tpl,   $a_current_user_id  )

static

Get instance.

Parameters

ilUserActionContext	$a_user_action_context
ilTemplate	$a_global_tpl
int	$a_current_user_id

Returns

ilUserActionGUI

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

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

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

Here is the caller graph for this function:

init()

ilUserActionGUI::init

(

)

Add requried js for an action context.

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

    {
        $tpl = $this->tpl;
 
        include_once("./Services/User/Actions/classes/class.ilUserActionAdmin.php");
        include_once("./Services/User/Actions/classes/class.ilUserActionProviderFactory.php");
        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().

Referenced by renderDropDown().

Here is the call graph for this function:

Here is the caller graph for this function:

renderDropDown()

ilUserActionGUI::renderDropDown

(

$a_target_user_id

)

Render drop down.

Parameters

int

$a_user_id

target user id

Returns

string

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

    {
        if (!$this->init_done) {
            $this->init();
        }
        include_once("./Services/User/Gallery/classes/class.ilGalleryUserActionContext.php");
        include_once("./Services/User/Actions/classes/class.ilUserActionCollector.php");
        $act_collector = ilUserActionCollector::getInstance($this->current_user_id, $this->user_action_context);
        $action_collection = $act_collector->getActionsForTargetUser($a_target_user_id);
        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
        $list = new ilAdvancedSelectionListGUI();
        $list->setListTitle("");
        foreach ($action_collection->getActions() as $action) {
            $list->addItem($action->getText(), "", $action->getHref(), "", "", "", "", false, "", "", "", "", true, $action->getData());
        }
        return $list->getHTML();
    }

References $action, $list, ilUserActionCollector\getInstance(), and init().

Here is the call graph for this function:

Field Documentation

$current_user_id

ilUserActionGUI::$current_user_id

protected

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

$init_done

ilUserActionGUI::$init_done = false

protected

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

$tpl

ilUserActionGUI::$tpl

protected

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

Referenced by init().

$user_action_context

ilUserActionGUI::$user_action_context

protected

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

---

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

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