ilBuddySystemLinkButton Class Reference

Inheritance diagram for ilBuddySystemLinkButton:

Collaboration diagram for ilBuddySystemLinkButton:

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

Static Public Member Functions
static	getInstanceByUserId (int $usrId)

Protected Member Functions
	__construct (protected int $usrId)

Protected Attributes
ilBuddyList	$buddyList
ilLanguage	$lng
ilObjUser	$user

Additional Inherited Members
Data Fields inherited from ilBuddySystemLinkButtonType
const	ROOT_CSS_CLASS = 'ilBuddySystemLinkWidget'

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBuddySystemLinkButton::__construct ( protected int  $usrId )

protected

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

References $DIC, ilBuddyList\getInstanceByGlobalUser(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

    {
        global $DIC;
        $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

(

)

Implements ilBuddySystemLinkButtonType.

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

References $buddyList.

                                  : ilBuddyList
    {
        return $this->buddyList;
    }

getHtml()

ilBuddySystemLinkButton::getHtml

(

)

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

References $relation, ilObjUser\_lookupPref(), ilBuddySystemRelationStateFactory\getInstance(), ilBuddySystem\getInstance(), getUsrId(), ILIAS\Repository\lng(), ilBuddySystemLinkButtonType\ROOT_CSS_CLASS, ILIAS\Repository\user(), and ilUtil\yn2tf().

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

        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((string) ilObjUser::_lookupPref($this->getUsrId(), 'bs_allow_to_contact_me'))) {
            return '';
        }

        $buttonTemplate = new ilTemplate(
            'tpl.buddy_system_link_button.html',
            true,
            true,
            'components/ILIAS/Contact/BuddySystem'
        );
        $buttonTemplate->setVariable(
            'BUTTON_HTML',
            ilBuddySystemRelationStateFactory::getInstance()->getStateButtonRendererByOwnerAndRelation(
                $this->user->getId(),
                $relation
            )->getHtml()
        );
        $buttonTemplate->setVariable('BUTTON_BUDDY_ID', $this->getUsrId());
        $buttonTemplate->setVariable('BUTTON_CSS_CLASS', ilBuddySystemLinkButtonType::ROOT_CSS_CLASS);
        $buttonTemplate->setVariable('BUTTON_CURRENT_STATE', $relation->getState()::class);

        return $buttonTemplate->get();
    }

Here is the call graph for this function:

getInstanceByUserId()

static ilBuddySystemLinkButton::getInstanceByUserId ( int  $usrId )

static

Exceptions

ilBuddySystemException

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

Referenced by ilTutorialSupportBlockGUI\createTutorItem(), ilRepositoryUserResultTableGUI\fillRow(), ilUsersGalleryGUI\getActionsSection(), and ilPublicUserProfileGUI\getEmbeddable().

                                                          : self
    {
        return new self($usrId);
    }

Here is the caller graph for this function:

getUsrId()

ilBuddySystemLinkButton::getUsrId

(

)

Implements ilBuddySystemLinkButtonType.

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

Referenced by getHtml().

                              : int
    {
        return $this->usrId;
    }

Here is the caller graph for this function:

Field Documentation

$buddyList

ilBuddyList ilBuddySystemLinkButton::$buddyList

protected

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

Referenced by getBuddyList().

$lng

ilLanguage ilBuddySystemLinkButton::$lng

protected

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

$user

ilObjUser ilBuddySystemLinkButton::$user

protected

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

---

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

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