ilAwarenessUserProviderApprovedContacts Class Reference

Inheritance diagram for ilAwarenessUserProviderApprovedContacts:

Collaboration diagram for ilAwarenessUserProviderApprovedContacts:

Public Member Functions
	__construct ()
	ilAwarenessUserProviderApprovedContacts constructor. More...
	getProviderId ()
	Get provider id. More...
	getTitle ()
	Provider title (used in awareness overlay and in administration settings) More...
	getInfo ()
	Provider info (used in administration settings) More...
	getInitialUserSet ()
	Get initial set of users. More...
Public Member Functions inherited from ilAwarenessUserProvider
	__construct ()
	Constructor. More...
	setActivationMode ($a_val)
	Activate provider. More...
	getActivationMode ()
	Get Activate provider. More...
	setUserId ($a_val)
	Set user id. More...
	getUserId ()
	Get user id. More...
	setRefId ($a_val)
	Set ref id. More...
	getRefId ()
	Get ref id. More...
	setOnlineUserFilter ($a_val)
	Set online user filter. More...
	getOnlineUserFilter ()
	Get online user filter. More...
	getProviderId ()
	This should return a unique id for the provider The ID should start with the service/module id, separated by "_" and a second part that is unique within the module/service, e.g. More...
	getTitle ()
	Provider title (used in awareness overlay and in administration settings) More...
	getInfo ()
	Provider info (used in administration settings) More...
	getInitialUserSet ()
	Get initial set of users. More...
	collectUsers ()
	Collect all users. More...
	isHighlighted ()
	Is highlighted. More...

Protected Attributes
	$user
Protected Attributes inherited from ilAwarenessUserProvider
	$user_id
	$ref_id
	$lng
	$db
	$online_user_filter = false
	$log

Additional Inherited Members
Data Fields inherited from ilAwarenessUserProvider
const	MODE_INACTIVE = 0
const	MODE_ONLINE_ONLY = 1
const	MODE_INCL_OFFLINE = 2
Protected Member Functions inherited from ilAwarenessUserProvider
	addUserToCollection ($a_user_id, ilAwarenessUserCollection $a_collection)
	Add user to collection. More...

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 11 of file class.ilAwarenessUserProviderApprovedContacts.php.

Constructor & Destructor Documentation

__construct()

ilAwarenessUserProviderApprovedContacts::__construct

(

)

ilAwarenessUserProviderApprovedContacts constructor.

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

References $DIC, and user().

    {
        global $DIC;

        parent::__construct();

        $this->user = $DIC['ilUser'];
    }

Here is the call graph for this function:

Member Function Documentation

getInfo()

ilAwarenessUserProviderApprovedContacts::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Definition at line 53 of file class.ilAwarenessUserProviderApprovedContacts.php.

    {
        $this->lng->loadLanguageModule('contact');
        return $this->lng->txt('contact_awrn_ap_contacts_info');
    }

getInitialUserSet()

ilAwarenessUserProviderApprovedContacts::getInitialUserSet

(

)

Get initial set of users.

Returns

array array of user IDs

Definition at line 63 of file class.ilAwarenessUserProviderApprovedContacts.php.

References ilBuddySystem\getInstance(), ilBuddyList\getInstanceByGlobalUser(), and user().

    {
        if ($this->user->isAnonymous()) {
            return array();
        }

        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddySystem.php';
        if (!ilBuddySystem::getInstance()->isEnabled()) {
            return array();
        }

        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
        $buddylist = ilBuddyList::getInstanceByGlobalUser();
        return $buddylist->getLinkedRelations()->getKeys();
    }

Here is the call graph for this function:

getProviderId()

ilAwarenessUserProviderApprovedContacts::getProviderId

(

)

Get provider id.

Returns

string provider id

Definition at line 34 of file class.ilAwarenessUserProviderApprovedContacts.php.

    {
        return 'contact_requests';
    }

getTitle()

ilAwarenessUserProviderApprovedContacts::getTitle

(

)

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

Returns

string provider title

Definition at line 43 of file class.ilAwarenessUserProviderApprovedContacts.php.

    {
        $this->lng->loadLanguageModule('contact');
        return $this->lng->txt('contact_awrn_ap_contacts');
    }

Field Documentation

$user

ilAwarenessUserProviderApprovedContacts::$user

protected

Definition at line 16 of file class.ilAwarenessUserProviderApprovedContacts.php.

---

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

• Services/Contact/BuddySystem/classes/class.ilAwarenessUserProviderApprovedContacts.php