ILIAS\Awareness\User\Provider Interface Reference

User provider. More...

Inheritance diagram for ILIAS\Awareness\User\Provider:

Collaboration diagram for ILIAS\Awareness\User\Provider:

Public Member Functions
	getProviderId ()
	getTitle ()
	Provider title (used in awareness overlay and in administration settings) More...
	getInfo ()
	Provider info (used in administration settings) More...
	getInitialUserSet (?array $user_ids=null)
	Get initial set of users. More...
	isHighlighted ()
	Is highlighted. More...

Detailed Description

User provider.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file interface.Provider.php.

Member Function Documentation

getInfo()

ILIAS\Awareness\User\Provider::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Implemented in ILIAS\Awareness\User\ProviderCurrentCourse, ILIAS\Awareness\User\ProviderCourseContacts, ILIAS\Awareness\User\ProviderMemberships, ilAwarenessUserProviderApprovedContacts, ilAwarenessUserProviderContactRequests, ILIAS\Awareness\User\ProviderAllUsers, and ILIAS\Awareness\User\ProviderSystemContacts.

getInitialUserSet()

ILIAS\Awareness\User\Provider::getInitialUserSet

(

?array

$user_ids = null

)

Get initial set of users.

Parameters

?int[]

$user_ids if not null, only a subset of these IDs should be retrieved

Returns

int[] array of user IDs

Implemented in ILIAS\Awareness\User\ProviderCurrentCourse, ILIAS\Awareness\User\ProviderCourseContacts, ILIAS\Awareness\User\ProviderMemberships, ilAwarenessUserProviderApprovedContacts, ilAwarenessUserProviderContactRequests, ILIAS\Awareness\User\ProviderAllUsers, and ILIAS\Awareness\User\ProviderSystemContacts.

Referenced by ILIAS\Awareness\User\Collector\collectUsersFromProvider().

Here is the caller graph for this function:

getProviderId()

ILIAS\Awareness\User\Provider::getProviderId

(

)

Implemented in ILIAS\Awareness\User\ProviderCurrentCourse, ILIAS\Awareness\User\ProviderCourseContacts, ILIAS\Awareness\User\ProviderMemberships, ilAwarenessUserProviderApprovedContacts, ilAwarenessUserProviderContactRequests, ILIAS\Awareness\User\ProviderAllUsers, and ILIAS\Awareness\User\ProviderSystemContacts.

getTitle()

ILIAS\Awareness\User\Provider::getTitle

(

)

Provider title (used in awareness overlay and in administration settings)

Returns

string provider title

Implemented in ILIAS\Awareness\User\ProviderCurrentCourse, ILIAS\Awareness\User\ProviderCourseContacts, ILIAS\Awareness\User\ProviderMemberships, ilAwarenessUserProviderApprovedContacts, ilAwarenessUserProviderContactRequests, ILIAS\Awareness\User\ProviderAllUsers, and ILIAS\Awareness\User\ProviderSystemContacts.

isHighlighted()

ILIAS\Awareness\User\Provider::isHighlighted

(

)

Is highlighted.

Returns

bool return true, if user group should be highlighted (using extra highlighted number)

Implemented in ILIAS\Awareness\User\ProviderCurrentCourse, ILIAS\Awareness\User\ProviderMemberships, ilAwarenessUserProviderContactRequests, ILIAS\Awareness\User\ProviderAllUsers, ILIAS\Awareness\User\ProviderCourseContacts, ilAwarenessUserProviderApprovedContacts, and ILIAS\Awareness\User\ProviderSystemContacts.

---

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

• Services/Awareness/User/interface.Provider.php