ilBuddySystemGUI Class Reference

Class ilBuddySystemGUI. More...

Collaboration diagram for ilBuddySystemGUI:

Public Member Functions
	executeCommand ()

Data Fields
const	BS_REQUEST_HTTP_GET = 1
const	BS_REQUEST_HTTP_POST = 2

Protected Member Functions
	isRequestParameterGiven ($key, $type)

Protected Attributes
	$ctrl
	$buddylist
	$statefactory
	$user
	$lng

Static Protected Attributes
static	$frontend_initialized = false

Private Member Functions
	requestCommand ()
	ignoreCommand ()
	linkCommand ()
	transitionCommand ($cmd, $positive_feedback_lng_id, callable $onBeforeExecute=null)

Detailed Description

Class ilBuddySystemGUI.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de ilBuddySystemGUI: ilUIPluginRouterGUI, ilPublicUserProfileGUI

Definition at line 12 of file class.ilBuddySystemGUI.php.

Member Function Documentation

executeCommand()

ilBuddySystemGUI::executeCommand

(

)

Exceptions

RuntimeException

Definition at line 109 of file class.ilBuddySystemGUI.php.

References $cmd.

        {
                if($this->user->isAnonymous())
                {
                        throw new RuntimeException('This controller only accepts requests of logged in users');
                }

                $next_class = $this->ctrl->getNextClass($this);
                $cmd        = $this->ctrl->getCmd();

                switch($next_class)
                {
                        default:
                                $cmd .= 'Command';
                                $this->$cmd();
                                break;
                }
        }

ignoreCommand()

ilBuddySystemGUI::ignoreCommand ( )

private

Definition at line 164 of file class.ilBuddySystemGUI.php.

References transitionCommand().

        {
                $this->transitionCommand('ignore', 'buddy_request_ignored');
        }

Here is the call graph for this function:

isRequestParameterGiven()

ilBuddySystemGUI::isRequestParameterGiven (   $key,   $type  )

protected

Parameters

string	$key
int	$type

Returns

bool

Definition at line 133 of file class.ilBuddySystemGUI.php.

References $_GET, and $_POST.

Referenced by transitionCommand().

        {
                switch($type)
                {
                        case self::BS_REQUEST_HTTP_POST:
                                return isset($_POST[$key]) && strlen($_POST[$key]);
                                break;

                        case self::BS_REQUEST_HTTP_GET:
                        default:
                                return isset($_GET[$key]) && strlen($_GET[$key]);
                                break;
                }
        }

Here is the caller graph for this function:

linkCommand()

ilBuddySystemGUI::linkCommand ( )

private

Definition at line 172 of file class.ilBuddySystemGUI.php.

References transitionCommand().

        {
                $this->transitionCommand('link', 'buddy_request_approved');
        }

Here is the call graph for this function:

requestCommand()

ilBuddySystemGUI::requestCommand ( )

private

Definition at line 151 of file class.ilBuddySystemGUI.php.

References ilObjUser\_lookupPref(), ilBuddySystemRelation\getBuddyUserId(), ilBuddySystemRelation\isUnlinked(), transitionCommand(), and ilUtil\yn2tf().

        {
                $this->transitionCommand('request', 'buddy_relation_requested', function(ilBuddySystemRelation $relation) {
                        if($relation->isUnlinked() && !ilUtil::yn2tf(ilObjUser::_lookupPref($relation->getBuddyUserId(), 'bs_allow_to_contact_me')))
                        {
                                throw new ilException("The requested user does not want to get contact requests");
                        }
                });
        }

Here is the call graph for this function:

transitionCommand()

ilBuddySystemGUI::transitionCommand (   $cmd,   $positive_feedback_lng_id, callable  $onBeforeExecute = null  )

private

Parameters

string	$cmd
string	$positive_feedback_lng_id
callable | null	$onBeforeExecute

Definition at line 182 of file class.ilBuddySystemGUI.php.

References $_GET, $_POST, $lng, ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), ilObjUser\_lookupPref(), exit, isRequestParameterGiven(), ilUtil\sendInfo(), ilUtil\sendSuccess(), ilUtil\stripSlashes(), and ilUtil\yn2tf().

Referenced by ignoreCommand(), linkCommand(), and requestCommand().

        {
                if(!$this->isRequestParameterGiven('user_id', self::BS_REQUEST_HTTP_GET))
                {
                        ilUtil::sendInfo($this->lng->txt('buddy_bs_action_not_possible'), true);
                        $this->ctrl->returnToParent($this);
                }

                try
                {
                        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
                        $relation = ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId((int)$_GET['user_id']);

                        if(null !== $onBeforeExecute)
                        {
                                $onBeforeExecute($relation);
                        }

                        ilBuddyList::getInstanceByGlobalUser()->$cmd($relation);
                        ilUtil::sendSuccess($this->lng->txt($positive_feedback_lng_id), true);

                }
                catch(ilBuddySystemRelationStateAlreadyGivenException $e)
                {
                        ilUtil::sendInfo(sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int)$_GET['user_id'])), true);
                }
                catch(ilBuddySystemRelationStateTransitionException $e)
                {
                        ilUtil::sendInfo(sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int)$_GET['user_id'])), true);
                }
                catch(ilException $e)
                {
                        ilUtil::sendInfo($this->lng->txt('buddy_bs_action_not_possible'), true);
                }

                $this->ctrl->returnToParent($this);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$buddylist

ilBuddySystemGUI::$buddylist

protected

Definition at line 30 of file class.ilBuddySystemGUI.php.

$ctrl

ilBuddySystemGUI::$ctrl

protected

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

$frontend_initialized

ilBuddySystemGUI::$frontend_initialized = false

staticprotected

Definition at line 20 of file class.ilBuddySystemGUI.php.

$lng

ilBuddySystemGUI::$lng

protected

Definition at line 45 of file class.ilBuddySystemGUI.php.

Referenced by transitionCommand().

$statefactory

ilBuddySystemGUI::$statefactory

protected

Definition at line 35 of file class.ilBuddySystemGUI.php.

$user

ilBuddySystemGUI::$user

protected

Definition at line 40 of file class.ilBuddySystemGUI.php.

BS_REQUEST_HTTP_GET

const ilBuddySystemGUI::BS_REQUEST_HTTP_GET = 1

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

BS_REQUEST_HTTP_POST

const ilBuddySystemGUI::BS_REQUEST_HTTP_POST = 2

Definition at line 15 of file class.ilBuddySystemGUI.php.

---

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

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