ilContactUserActionProvider Class Reference

Class ilContactUserActionProvider. More...

Inheritance diagram for ilContactUserActionProvider:

Collaboration diagram for ilContactUserActionProvider:

Public Member Functions
	__construct ()
	ilContactUserActionProvider constructor. More...
	getComponentId ()
	@inheritDoc More...
	getActionTypes ()
	@inheritDoc More...
	collectActionsForTargetUser ($a_target_user)
	@inheritDoc More...
Public Member Functions inherited from ilUserActionProvider
	__construct ()
	Constructor. More...
	setUserId ($a_val)
	Set user id. More...
	getUserId ()
	Get user id. More...
	collectActionsForTargetUser ($a_target_user)
	Collect actions for a target user. More...
	getComponentId ()
	getActionTypes ()
	getJsScripts ($a_action_type)
	Get js scripts. More...

Protected Attributes
	$user
Protected Attributes inherited from ilUserActionProvider
	$user_id
	$lng
	$db

Private Attributes
	$stateToPermLinkMap

Detailed Description

Class ilContactUserActionProvider.

Author

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

Definition at line 8 of file class.ilContactUserActionProvider.php.

Constructor & Destructor Documentation

__construct()

ilContactUserActionProvider::__construct

(

)

ilContactUserActionProvider constructor.

Reimplemented from ilUserActionProvider.

Definition at line 22 of file class.ilContactUserActionProvider.php.

    {
        global $DIC;
 
        parent::__construct();
 
        $this->user = $DIC['ilUser'];
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and user().

Here is the call graph for this function:

Member Function Documentation

collectActionsForTargetUser()

ilContactUserActionProvider::collectActionsForTargetUser

(

$a_target_user

)

@inheritDoc

Reimplemented from ilUserActionProvider.

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

    {
        $coll = ilUserActionCollection::getInstance();
 
        if (!ilBuddySystem::getInstance()->isEnabled()) {
            return $coll;
        }
 
        if (ilObjUser::_isAnonymous($this->getUserId()) || $this->user->isAnonymous()) {
            return $coll;
        }
 
        $buddyList = ilBuddyList::getInstanceByGlobalUser();
        $requested_contacts = $buddyList->getRequestRelationsForOwner()->getKeys();
 
        if (in_array($a_target_user, $requested_contacts)) {
            $this->lng->loadLanguageModule('buddysystem');
 
            $relation = $buddyList->getRelationByUserId($a_target_user);
            foreach ($relation->getCurrentPossibleTargetStates() as $target_state) {
                $f = new ilUserAction();
                $f->setText(
                    $this->lng->txt(
                        'buddy_bs_act_btn_txt_requested_to_' .
                        ilStr::convertUpperCamelCaseToUnderscoreCase($target_state->getName())
                    )
                );
                $f->setType('handle_req');
                $f->setHref(
                    ilLink::_getStaticLink(
                        $a_target_user,
                        'usr',
                        true,
                        $this->stateToPermLinkMap[get_class($target_state)]
                    )
                );
                $f->setData([
                    'current-state' => get_class($relation->getState()),
                    'target-state' => get_class($target_state),
                    'buddy-id' => $a_target_user,
                    'action' => $target_state->getAction()
                ]);
                $coll->addAction($f);
            }
        }
 
        return $coll;
    }

References Vendor\Package\$f, ilLink\_getStaticLink(), ilObjUser\_isAnonymous(), ilStr\convertUpperCamelCaseToUnderscoreCase(), ilBuddySystem\getInstance(), ilUserActionCollection\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ilUserActionProvider\getUserId(), and user().

Here is the call graph for this function:

getActionTypes()

ilContactUserActionProvider::getActionTypes

(

)

@inheritDoc

Reimplemented from ilUserActionProvider.

Definition at line 42 of file class.ilContactUserActionProvider.php.

    {
        $this->lng->loadLanguageModule('buddysystem');
        return [
            'handle_req' => $this->lng->txt('buddy_handle_contact_request')
        ];
    }

getComponentId()

ilContactUserActionProvider::getComponentId

(

)

@inheritDoc

Reimplemented from ilUserActionProvider.

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

    {
        return 'contact';
    }

Field Documentation

$stateToPermLinkMap

ilContactUserActionProvider::$stateToPermLinkMap

private

Initial value:

= [
        'ilBuddySystemLinkedRelationState' => '_contact_approved',
        'ilBuddySystemIgnoredRequestRelationState' => '_contact_ignored'
    ]

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

$user

ilContactUserActionProvider::$user

protected

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

---

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

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