ilBuddySystemLinkButton Class Reference

Class ilBuddySystemLinkButton. More...

Inheritance diagram for ilBuddySystemLinkButton:

Collaboration diagram for ilBuddySystemLinkButton:

Public Member Functions
	getUsrId ()
	setUsrId ($usr_id)
	getBuddyList ()
	getHtml ()
Public Member Functions inherited from ilBuddySystemLinkButtonType
	getHTML ()

Static Public Member Functions
static	getInstanceByUserId ($usr_id)

Protected Member Functions
	__construct ($usr_id)

Protected Attributes
	$usr_id
	$buddylist
	$lng
	$user

Detailed Description

Class ilBuddySystemLinkButton.

Author

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

Definition at line 14 of file class.ilBuddySystemLinkButton.php.

Constructor & Destructor Documentation

__construct()

ilBuddySystemLinkButton::__construct (   $usr_id )

protected

Parameters

$usr_id

Definition at line 39 of file class.ilBuddySystemLinkButton.php.

References $DIC, $usr_id, ilBuddyList\getInstanceByGlobalUser(), and user().

    {
        global $DIC;

        $this->usr_id    = $usr_id;
        $this->buddylist = ilBuddyList::getInstanceByGlobalUser();
        
        $this->user = $DIC['ilUser'];
        $this->lng  = $DIC['lng'];
    }

Here is the call graph for this function:

Member Function Documentation

getBuddyList()

ilBuddySystemLinkButton::getBuddyList

(

)

Returns

ilBuddyList

Implements ilBuddySystemLinkButtonType.

Definition at line 78 of file class.ilBuddySystemLinkButton.php.

References $buddylist.

    {
        return $this->buddylist;
    }

getHtml()

ilBuddySystemLinkButton::getHtml

(

)

Returns

string

Definition at line 86 of file class.ilBuddySystemLinkButton.php.

References ilObjUser\_lookupPref(), ilBuddySystem\getInstance(), ilBuddySystemRelationStateFactory\getInstance(), getUsrId(), ilBuddySystemGUI\initializeFrontend(), user(), and ilUtil\yn2tf().

    {
        $this->lng->loadLanguageModule('buddysystem');

        ilBuddySystemGUI::initializeFrontend();

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

        $relation = $this->buddylist->getRelationByUserId($this->getUsrId());

        // The ILIAS JF decided to add a new personal setting
        if ($relation->isUnlinked() && !ilUtil::yn2tf(ilObjUser::_lookupPref($this->getUsrId(), 'bs_allow_to_contact_me'))) {
            return '';
        }

        $button_tpl = new ilTemplate('tpl.buddy_system_link_button.html', true, true, 'Services/Contact/BuddySystem');
        $button_tpl->setVariable('BUTTON_HTML', ilBuddySystemRelationStateFactory::getInstance()->getRendererByOwnerAndRelation($this->user->getId(), $relation)->getHtml());
        $button_tpl->setVariable('BUTTON_BUDDY_ID', $this->getUsrId());
        $button_tpl->setVariable('BUTTON_CSS_CLASS', 'ilBuddySystemLinkWidget');
        $button_tpl->setVariable('BUTTON_CURRENT_STATE', get_class($relation->getState()));
        return $button_tpl->get();
    }

Here is the call graph for this function:

getInstanceByUserId()

static ilBuddySystemLinkButton::getInstanceByUserId (   $usr_id )

static

Parameters

int

$usr_id

Returns

ilBuddySystemLinkButton

Definition at line 54 of file class.ilBuddySystemLinkButton.php.

References $usr_id.

Referenced by ilUsersGalleryGUI\addActionSection(), ilBuddySystemRelationsTableGUI\fillRow(), ilPublicUserProfileGUI\getEmbeddable(), and ilRepositoryUserResultTableGUI\initMultiCommands().

    {
        return new self($usr_id);
    }

Here is the caller graph for this function:

getUsrId()

ilBuddySystemLinkButton::getUsrId

(

)

Returns

int

Implements ilBuddySystemLinkButtonType.

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

References $usr_id.

Referenced by getHtml().

    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

setUsrId()

ilBuddySystemLinkButton::setUsrId

(

$usr_id

)

Parameters

int

$usr_id

Definition at line 70 of file class.ilBuddySystemLinkButton.php.

References $usr_id.

    {
        $this->usr_id = $usr_id;
    }

Field Documentation

$buddylist

ilBuddySystemLinkButton::$buddylist

protected

Definition at line 24 of file class.ilBuddySystemLinkButton.php.

Referenced by getBuddyList().

$lng

ilBuddySystemLinkButton::$lng

protected

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

$user

ilBuddySystemLinkButton::$user

protected

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

$usr_id

ilBuddySystemLinkButton::$usr_id

protected

Definition at line 19 of file class.ilBuddySystemLinkButton.php.

Referenced by __construct(), getInstanceByUserId(), getUsrId(), and setUsrId().

---

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

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