ilUserActionProvider Class Reference

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

Inheritance diagram for ilUserActionProvider:

Collaboration diagram for ilUserActionProvider:

Public Member Functions
	__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)

Protected Attributes
int	$user_id
Language	$lng
ilDBInterface	$db

Detailed Description

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 27 of file class.ilUserActionProvider.php.

Constructor & Destructor Documentation

__construct()

ilUserActionProvider::__construct

(

)

Definition at line 33 of file class.ilUserActionProvider.php.

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

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->db = $DIC->database();
    }

Here is the call graph for this function:

Member Function Documentation

collectActionsForTargetUser()

ilUserActionProvider::collectActionsForTargetUser ( int  $a_target_user )

abstract

Collect actions for a target user.

Referenced by getUserId().

Here is the caller graph for this function:

getActionTypes()

ilUserActionProvider::getActionTypes ( )

abstract

Returns

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

Referenced by getUserId(), and ilUserActionCollector\hasProviderActiveActions().

Here is the caller graph for this function:

getComponentId()

ilUserActionProvider::getComponentId ( )

abstract

Returns

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

Referenced by getUserId(), and ilUserActionCollector\hasProviderActiveActions().

Here is the caller graph for this function:

getJsScripts()

ilUserActionProvider::getJsScripts

(

string

$a_action_type

)

Definition at line 66 of file class.ilUserActionProvider.php.

                                                       : array
    {
        return [];
    }

getUserId()

ilUserActionProvider::getUserId

(

)

Definition at line 46 of file class.ilUserActionProvider.php.

References $user_id, collectActionsForTargetUser(), getActionTypes(), and getComponentId().

Referenced by ilMailUserActionProvider\collectActionsForTargetUser(), ilContactUserActionProvider\collectActionsForTargetUser(), and ilChatUserActionProvider\collectActionsForTargetUser().

                               : int
    {
        return $this->user_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUserId()

ilUserActionProvider::setUserId

(

int

$a_val

)

Definition at line 41 of file class.ilUserActionProvider.php.

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

Field Documentation

$db

ilDBInterface ilUserActionProvider::$db

protected

Definition at line 31 of file class.ilUserActionProvider.php.

$lng

Language ilUserActionProvider::$lng

protected

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

Referenced by ilWorkspaceUserActionProvider\__construct(), and ilWorkspaceUserActionProvider\collectActionsForTargetUser().

$user_id

int ilUserActionProvider::$user_id

protected

Definition at line 29 of file class.ilUserActionProvider.php.

Referenced by getUserId().

---

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

• components/ILIAS/User/classes/Actions/class.ilUserActionProvider.php