ilContactUserActionProvider Class Reference

Adds link to contact. More...

Inheritance diagram for ilContactUserActionProvider:

Collaboration diagram for ilContactUserActionProvider:

Public Member Functions
	__construct ()
	Constructor. More...
	getComponentId ()
	Returns string component id as defined in services.xml/module.xml More...
	getActionTypes ()
	Returns array[string] keys must be unique action ids (strings), values should be the names of the actions (from ilLanguage) More...
	collectActionsForTargetUser ($a_target_user)
	{Collect actions for a target user. Parameters int $a_target_user target user Returns ilUserActionCollection collection of users } 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...
	getCssFiles ($a_action_type)
	Get css resource files. More...

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

Static Private Attributes
static	$state_to_perm_link_map

Detailed Description

Adds link to contact.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilContactUserActionProvider::__construct

(

)

Constructor.

Reimplemented from ilUserActionProvider.

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

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

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

collectActionsForTargetUser()

ilContactUserActionProvider::collectActionsForTargetUser

(

$a_target_user

)

{Collect actions for a target user.

Parameters

int

$a_target_user

target user

Returns

ilUserActionCollection collection of users

}

Reimplemented from ilUserActionProvider.

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

    {
        require_once 'Services/User/Actions/classes/class.ilUserAction.php';
        $coll = ilUserActionCollection::getInstance();
 
        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddySystem.php';
        if (!ilBuddySystem::getInstance()->isEnabled()) {
            return $coll;
        }
 
        if (ilObjUser::_isAnonymous($this->getUserId()) || $this->user->isAnonymous()) {
            return $coll;
        }
 
        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
        $buddylist = ilBuddyList::getInstanceByGlobalUser();
        $requested_contacts = $buddylist->getRequestRelationsForOwner()->getKeys();
 
        if (in_array($a_target_user, $requested_contacts)) {
            require_once 'Services/Utilities/classes/class.ilStr.php';
            require_once 'Services/Link/classes/class.ilLink.php';
 
            $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, self::$state_to_perm_link_map[get_class($target_state)]));
                $f->setData(
                    array(
                    '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 $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

(

)

Returns

array[string] keys must be unique action ids (strings), values should be the names of the actions (from ilLanguage)

Reimplemented from ilUserActionProvider.

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

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

getComponentId()

ilContactUserActionProvider::getComponentId

(

)

Returns

string component id as defined in services.xml/module.xml

Reimplemented from ilUserActionProvider.

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

    {
        return "contact";
    }

Field Documentation

$state_to_perm_link_map

ilContactUserActionProvider::$state_to_perm_link_map

staticprivate

Initial value:

= array(
        'ilBuddySystemLinkedRelationState' => '_contact_approved',
        'ilBuddySystemIgnoredRequestRelationState' => '_contact_ignored'
    )

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

$user

ilContactUserActionProvider::$user

protected

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

---

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

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