ilGroupUserActionProvider Class Reference

Inheritance diagram for ilGroupUserActionProvider:

Collaboration diagram for ilGroupUserActionProvider:

Public Member Functions
	getComponentId ()
	Returns string component id as defined in services.xml/module.xml More...
	getActionTypes ()
	Returns array[string] keys must be unique action ids (strings), values should be the names of the actions (from ilLanguage) More...
	collectActionsForTargetUser (int $a_target_user)
	@inheritDoc More...
	getJsScripts (string $a_action_type)
	@inheritDoc More...
Public Member Functions inherited from ilUserActionProvider
	__construct ()
	setUserId (int $a_val)
	getUserId ()
	collectActionsForTargetUser (int $a_target_user)
	Collect actions for a target user. More...
	getComponentId ()
	getActionTypes ()
	getJsScripts (string $a_action_type)

Static Public Member Functions
static	getCommandAccess (int $a_user_id)

Static Protected Attributes
static	$grp_ops = []

Additional Inherited Members
Protected Attributes inherited from ilUserActionProvider
int	$user_id
Language	$lng
ilDBInterface	$db

Detailed Description

Definition at line 21 of file class.ilGroupUserActionProvider.php.

Member Function Documentation

collectActionsForTargetUser()

ilGroupUserActionProvider::collectActionsForTargetUser

(

int

$a_target_user

)

@inheritDoc

Reimplemented from ilUserActionProvider.

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

                                                                   : ilUserActionCollection
    {
        global $DIC;
 
        $ctrl = $DIC->ctrl();
        $this->lng->loadLanguageModule("grp");
        $coll = new ilUserActionCollection();
 
        $commands = self::getCommandAccess($this->user_id);
        if (count($commands) == 0) {
            return $coll;
        }
 
        $f = new ilUserAction();
        $f->setType("add_to");
        $f->setText($this->lng->txt("grp_add_to_group"));
        $f->setHref("#");
        $ctrl->setParameterByClass("ilGroupAddToGroupActionGUI", "user_id", $a_target_user);
        $f->setData(array(
            "grp-action-add-to" => "1",
            "url" => $ctrl->getLinkTargetByClass(array("ildashboardgui", "ilGroupUserActionsGUI", "ilGroupAddToGroupActionGUI"), "", "", true, false)
        ));
        $coll->addAction($f);
 
        return $coll;
    }

References $DIC, Vendor\Package\$f, getCommandAccess(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getActionTypes()

ilGroupUserActionProvider::getActionTypes

(

)

Returns

array[string] keys must be unique action ids (strings), values should be the names of the actions (from ilLanguage)

Reimplemented from ilUserActionProvider.

Definition at line 36 of file class.ilGroupUserActionProvider.php.

                                    : array
    {
        $this->lng->loadLanguageModule("grp");
 
        return array(
            "add_to" => $this->lng->txt("grp_add_to_group")
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getCommandAccess()

static ilGroupUserActionProvider::getCommandAccess ( int  $a_user_id )

static

Definition at line 45 of file class.ilGroupUserActionProvider.php.

                                                           : array
    {
        if (!isset(self::$grp_ops[$a_user_id])) {
            $ops = array();
            $o = ilUtil::_getObjectsByOperations(array("root", "crs", "cat"), "create_grp", $a_user_id, 1);
            if (count($o) > 0) {
                $ops[] = "create_grp";
            }
            $o = ilUtil::_getObjectsByOperations("grp", "manage_members", $a_user_id, 1);
            if (count($o) > 0) {
                $ops[] = "manage_members";
            }
            self::$grp_ops[$a_user_id] = $ops;
        }
        return self::$grp_ops[$a_user_id];
    }

References ilUtil\_getObjectsByOperations().

Referenced by collectActionsForTargetUser(), and ilGroupAddToGroupActionGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

getComponentId()

ilGroupUserActionProvider::getComponentId

(

)

Returns

string component id as defined in services.xml/module.xml

Reimplemented from ilUserActionProvider.

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

                                    : string
    {
        return "grp";
    }

getJsScripts()

ilGroupUserActionProvider::getJsScripts

(

string

$a_action_type

)

@inheritDoc

Reimplemented from ilUserActionProvider.

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

                                                       : array
    {
        global $DIC;
        $gui = $DIC->repository()->internal()->gui();
        switch ($a_action_type) {
            case "add_to":
                return array(
                    "assets/js/GroupUserActions.js",
                    "assets/js/modal.min.js",
                    ilExplorerBaseGUI::getLocalExplorerJsPath(),
                    ilExplorerBaseGUI::getLocalJsTreeJsPath()
                );
        }
        return array();
    }

References $DIC, ilExplorerBaseGUI\getLocalExplorerJsPath(), and ilExplorerBaseGUI\getLocalJsTreeJsPath().

Here is the call graph for this function:

Field Documentation

$grp_ops

ilGroupUserActionProvider::$grp_ops = []

staticprotected

Definition at line 23 of file class.ilGroupUserActionProvider.php.

---

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

• components/ILIAS/Group/UserActions/classes/class.ilGroupUserActionProvider.php