ilUserActionProvider Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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
ilLanguage	$lng
ilDBInterface	$db

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.ilUserActionProvider.php.

Constructor & Destructor Documentation

__construct()

ilUserActionProvider::__construct

(

)

Reimplemented in ilContactUserActionProvider, ilChatUserActionProvider, and ilWorkspaceUserActionProvider.

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

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

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

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.

Reimplemented in EmployeeTalkUserActionProvider, ilGroupUserActionProvider, ilContactUserActionProvider, ilChatUserActionProvider, ilMailUserActionProvider, ilUserUserActionProvider, and ilWorkspaceUserActionProvider.

getActionTypes()

ilUserActionProvider::getActionTypes ( )

abstract

Returns

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

Reimplemented in EmployeeTalkUserActionProvider, ilGroupUserActionProvider, ilContactUserActionProvider, ilChatUserActionProvider, ilMailUserActionProvider, ilUserUserActionProvider, and ilWorkspaceUserActionProvider.

Referenced by 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

Reimplemented in EmployeeTalkUserActionProvider, ilGroupUserActionProvider, ilContactUserActionProvider, ilChatUserActionProvider, ilMailUserActionProvider, ilUserUserActionProvider, and ilWorkspaceUserActionProvider.

Referenced by ilUserActionCollector\hasProviderActiveActions().

Here is the caller graph for this function:

getJsScripts()

ilUserActionProvider::getJsScripts

(

string

$a_action_type

)

Reimplemented in ilGroupUserActionProvider.

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

                                                       : array
    {
        return array();
    }

getUserId()

ilUserActionProvider::getUserId

(

)

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

                               : int
    {
        return $this->user_id;
    }

References $user_id.

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

Here is the caller graph for this function:

setUserId()

ilUserActionProvider::setUserId

(

int

$a_val

)

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

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

Field Documentation

$db

ilDBInterface ilUserActionProvider::$db

protected

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

$lng

ilLanguage ilUserActionProvider::$lng

protected

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

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

$user_id

int ilUserActionProvider::$user_id

protected

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

Referenced by getUserId().

---

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

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