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 ()
	Constructor. More...
	setUserId ($a_val)
	Set user id. More...
	getUserId ()
	Get user id. More...
	collectActionsForTargetUser ($a_target_user)
	Collect actions for a target user. More...
	getComponentId ()
	getActionTypes ()

Protected Attributes
	$user_id
	$lng
	$db

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

Constructor & Destructor Documentation

__construct()

ilUserActionProvider::__construct

(

)

Constructor.

Reimplemented in ilContactUserActionProvider, ilChatUserActionProvider, and ilWorkspaceUserActionProvider.

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

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

References $DIC.

Member Function Documentation

collectActionsForTargetUser()

ilUserActionProvider::collectActionsForTargetUser (   $a_target_user )

abstract

Collect actions for a target user.

Parameters

int

$a_target_user

target user

Returns

ilUserActionCollection collection of users

Reimplemented in 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 ilContactUserActionProvider, ilChatUserActionProvider, ilMailUserActionProvider, ilUserUserActionProvider, and ilWorkspaceUserActionProvider.

getComponentId()

ilUserActionProvider::getComponentId ( )

abstract

Returns

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

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

getUserId()

ilUserActionProvider::getUserId

(

)

Get user id.

Returns

int user id

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

        {
                return $this->user_id;
        }

References $user_id.

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

Here is the caller graph for this function:

setUserId()

ilUserActionProvider::setUserId

(

$a_val

)

Set user id.

Parameters

int

$a_val

user id

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

        {
                $this->user_id = $a_val;
        }

Field Documentation

$db

ilUserActionProvider::$db

protected

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

$lng

ilUserActionProvider::$lng

protected

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

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

$user_id

ilUserActionProvider::$user_id

protected

Definition at line 17 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