ilBuddySystemGUI Class Reference

Class ilBuddySystemGUI. More...

Collaboration diagram for ilBuddySystemGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Static Public Member Functions
static	initializeFrontend ()

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
	$http

Static Protected Attributes
static	$frontend_initialized = false

Private Member Functions
	requestCommand ()
	ignoreCommand ()
	linkCommand ()
	transitionCommand ($cmd, $positive_feedback_lng_id, callable $onBeforeExecute=null)
	transitionAsyncCommand ()
	Performs a state transition based on the request action. More...
	redirectToReferer ()

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.

Constructor & Destructor Documentation

__construct()

ilBuddySystemGUI::__construct

(

)

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

References $DIC, ilBuddySystemRelationStateFactory\getInstance(), ilBuddyList\getInstanceByGlobalUser(), ILIAS\FileDelivery\http(), and user().

    {
        global $DIC;

        $this->http = $DIC->http();
        $this->ctrl = $DIC['ilCtrl'];
        $this->user = $DIC['ilUser'];
        $this->lng = $DIC['lng'];

        require_once 'Services/Contact/BuddySystem/classes/class.ilBuddyList.php';
        require_once 'Services/Contact/BuddySystem/classes/states/class.ilBuddySystemRelationStateFactory.php';
        $this->buddylist = ilBuddyList::getInstanceByGlobalUser();
        $this->statefactory = ilBuddySystemRelationStateFactory::getInstance();

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

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilBuddySystemGUI::executeCommand

(

)

Exceptions

RuntimeException

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

References user().

    {
        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;
        }
    }

Here is the call graph for this function:

ignoreCommand()

ilBuddySystemGUI::ignoreCommand ( )

private

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

References transitionCommand().

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

Here is the call graph for this function:

initializeFrontend()

static ilBuddySystemGUI::initializeFrontend ( )

static

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

References $config, $DIC, and ilJsonUtil\encode().

Referenced by ilBuddySystemLinkButton\getHtml(), and ilMainMenuGUI\populateWithBuddySystem().

    {
        global $DIC;

        if (!self::$frontend_initialized) {
            $DIC->language()->loadLanguageModule('buddysystem');

            require_once 'Services/JSON/classes/class.ilJsonUtil.php';

            $DIC['tpl']->addJavascript('./Services/Contact/BuddySystem/js/buddy_system.js');

            $config = new stdClass();
            $config->http_post_url = $DIC->ctrl()->getFormActionByClass(array('ilUIPluginRouterGUI', 'ilBuddySystemGUI'), '', '', true, false);
            $config->transition_state_cmd = 'transitionAsync';
            $DIC['tpl']->addOnLoadCode("il.BuddySystem.setConfig(" . ilJsonUtil::encode($config) . ");");

            $btn_config = new stdClass();
            $btn_config->bnt_class = 'ilBuddySystemLinkWidget';

            $DIC['tpl']->addOnLoadCode("il.BuddySystemButton.setConfig(" . ilJsonUtil::encode($btn_config) . ");");
            $DIC['tpl']->addOnLoadCode("il.BuddySystemButton.init();");

            self::$frontend_initialized = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRequestParameterGiven()

ilBuddySystemGUI::isRequestParameterGiven (   $key,   $type  )

protected

Parameters

string	$key
int	$type

Returns

bool

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

References $_GET, $_POST, $key, and $type.

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 163 of file class.ilBuddySystemGUI.php.

References transitionCommand().

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

Here is the call graph for this function:

redirectToReferer()

ilBuddySystemGUI::redirectToReferer ( )

private

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

References ILIAS\FileDelivery\http().

Referenced by transitionCommand().

    {
        if (isset($this->http->request()->getServerParams()['HTTP_REFERER'])) {
            $redirectUrl = $this->http->request()->getServerParams()['HTTP_REFERER'];
            $urlParts = parse_url($redirectUrl);

            if (isset($urlParts['path'])) {
                $script = basename($urlParts['path'], '.php');
                if ($script === 'login') {
                    $this->ctrl->returnToParent($this);
                } else {
                    $redirectUrl = ltrim(basename($urlParts['path']), '/');
                    if (isset($urlParts['query'])) {
                        $redirectUrl .= '?' . $urlParts['query'];
                    }
                }
            }
            $this->ctrl->redirectToURL($redirectUrl);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

requestCommand()

ilBuddySystemGUI::requestCommand ( )

private

Definition at line 143 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:

transitionAsyncCommand()

ilBuddySystemGUI::transitionAsyncCommand ( )

private

Performs a state transition based on the request action.

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

References $_POST, $action, $response, ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), ilObjUser\_lookupPref(), exit, ilUtil\stripSlashes(), and ilUtil\yn2tf().

    {
        if (!$this->ctrl->isAsynch()) {
            throw new RuntimeException('This action only supports AJAX http requests');
        }

        if (!isset($_POST['usr_id']) || !is_numeric($_POST['usr_id'])) {
            throw new RuntimeException('Missing "usr_id" parameter');
        }

        if (!isset($_POST['action']) || !strlen($_POST['action'])) {
            throw new RuntimeException('Missing "action" parameter');
        }

        $response = new stdClass();
        $response->success = false;

        try {
            $usr_id = (int) $_POST['usr_id'];
            $action = ilUtil::stripSlashes($_POST['action']);

            if (ilObjUser::_isAnonymous($usr_id)) {
                throw new ilBuddySystemException(sprintf("You cannot perform a state transition for the anonymous user (id: %s)", $usr_id));
            }

            if (!strlen(ilObjUser::_lookupLogin($usr_id))) {
                throw new ilBuddySystemException(sprintf("You cannot perform a state transition for a non existing user (id: %s)", $usr_id));
            }

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

            // The ILIAS JF decided to add a new personal setting
            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");
            }

            try {
                $this->buddylist->{$action}($relation);
                $response->success = true;
            } catch (ilBuddySystemRelationStateAlreadyGivenException $e) {
                $response->message = sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int) $usr_id));
            } catch (ilBuddySystemRelationStateTransitionException $e) {
                $response->message = sprintf($this->lng->txt($e->getMessage()), ilObjUser::_lookupLogin((int) $usr_id));
            } catch (Exception $e) {
                $response->message = $this->lng->txt('buddy_bs_action_not_possible');
            }

            $response->state = get_class($relation->getState());
            $response->state_html = $this->statefactory->getRendererByOwnerAndRelation($this->buddylist->getOwnerId(), $relation)->getHtml();
        } catch (Exception $e) {
            $response->message = $this->lng->txt('buddy_bs_action_not_possible');
        }

        echo json_encode($response);
        exit();
    }

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 173 of file class.ilBuddySystemGUI.php.

References $_GET, ilObjUser\_lookupLogin(), ilBuddyList\getInstanceByGlobalUser(), isRequestParameterGiven(), redirectToReferer(), and ilUtil\sendInfo().

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->redirectToReferer();
    }

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.

$http

ilBuddySystemGUI::$http

protected

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

$lng

ilBuddySystemGUI::$lng

protected

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

$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