ilAwarenessUserProviderApprovedContacts Class Reference

Class ilAwarenessUserProviderApprovedContacts. More...

Inheritance diagram for ilAwarenessUserProviderApprovedContacts:

Collaboration diagram for ilAwarenessUserProviderApprovedContacts:

Public Member Functions
	__construct (Container $DIC)
	getProviderId ()
	@inheritDoc More...
	getTitle ()
	@inheritDoc More...
	getInfo ()
	@inheritDoc More...
	getInitialUserSet (?array $user_ids=null)
	Get initial set of users. More...
	isHighlighted ()
	Is highlighted. More...
	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...

Protected Attributes
ilLanguage	$lng
ilObjUser	$user

Detailed Description

Class ilAwarenessUserProviderApprovedContacts.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilAwarenessUserProviderApprovedContacts::__construct

(

Container

$DIC

)

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

    {
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
    }

References ILIAS\DI\Container\language(), ILIAS\Repository\lng(), ILIAS\DI\Container\user(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

getInfo()

ilAwarenessUserProviderApprovedContacts::getInfo

(

)

@inheritDoc

Implements ILIAS\Awareness\User\Provider.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

getInitialUserSet()

ilAwarenessUserProviderApprovedContacts::getInitialUserSet

(

?array

$user_ids = null

)

Get initial set of users.

Parameters

?int[]

$user_ids

Returns

int[] array of user IDs

Implements ILIAS\Awareness\User\Provider.

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

                                                              : array
    {
        if ($this->user->isAnonymous()) {
            return [];
        }
 
        if (!ilBuddySystem::getInstance()->isEnabled()) {
            return [];
        }
 
        return ilBuddyList::getInstanceByGlobalUser()->getLinkedRelations()->getKeys();
    }

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

Here is the call graph for this function:

getProviderId()

ilAwarenessUserProviderApprovedContacts::getProviderId

(

)

@inheritDoc

Implements ILIAS\Awareness\User\Provider.

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

                                   : string
    {
        return 'contact_requests';
    }

getTitle()

ilAwarenessUserProviderApprovedContacts::getTitle

(

)

@inheritDoc

Implements ILIAS\Awareness\User\Provider.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

isHighlighted()

ilAwarenessUserProviderApprovedContacts::isHighlighted

(

)

Is highlighted.

Returns

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

Implements ILIAS\Awareness\User\Provider.

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

                                   : bool
    {
        return false;
    }

Field Documentation

$lng

ilLanguage ilAwarenessUserProviderApprovedContacts::$lng

protected

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

$user

ilObjUser ilAwarenessUserProviderApprovedContacts::$user

protected

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

---

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

• components/ILIAS/Contact/BuddySystem/classes/class.ilAwarenessUserProviderApprovedContacts.php