ilBuddySystemGUI Class Reference

Class ilBuddySystemGUI. More...

Collaboration diagram for ilBuddySystemGUI:

Public Member Functions
	__construct ()
	ilBuddySystemGUI constructor. More...
	executeCommand ()

Static Public Member Functions
static	initializeFrontend (ilGlobalTemplateInterface $page)

Data Fields
const	BS_REQUEST_HTTP_GET = 1
const	BS_REQUEST_HTTP_POST = 2

Protected Member Functions
	isRequestParameterGiven (string $key, int $type)

Protected Attributes
	$ctrl
	$buddyList
	$stateFactory
	$user
	$lng
	$http

Static Protected Attributes
static	$isFrontendInitialized = false

Private Member Functions
	requestCommand ()
	ignoreCommand ()
	linkCommand ()
	transitionCommand (string $cmd, string $positiveFeedbackLanguageId, 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

(

)

ilBuddySystemGUI constructor.

Definition at line 41 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'];

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

References user().

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

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

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

Here is the call graph for this function:

ignoreCommand()

ilBuddySystemGUI::ignoreCommand ( )

private

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

References transitionCommand().

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

Here is the call graph for this function:

initializeFrontend()

static ilBuddySystemGUI::initializeFrontend ( ilGlobalTemplateInterface  $page )

static

Parameters

ilGlobalTemplateInterface

$page

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

References $config, $DIC, ilGlobalTemplateInterface\addOnLoadCode(), and ilBuddySystem\getInstance().

Referenced by ilGlobalPageTemplate\prepareBasicJS().

                                                                               : void
    {
        global $DIC;

        if (
            ilBuddySystem::getInstance()->isEnabled() &&
            !$DIC->user()->isAnonymous() &&
            !self::$isFrontendInitialized
        ) {
            $DIC->language()->loadLanguageModule('buddysystem');

            $page->addJavascript('./Services/Contact/BuddySystem/js/buddy_system.js');

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

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

            $page->addOnLoadCode("il.BuddySystemButton.setConfig(" . json_encode($btn_config) . ");");
            $page->addOnLoadCode("il.BuddySystemButton.init();");

            self::$isFrontendInitialized = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isRequestParameterGiven()

ilBuddySystemGUI::isRequestParameterGiven ( string  $key, int  $type  )

protected

Parameters

string	$key
int	$type

Returns

bool

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

References $_GET, and $_POST.

Referenced by transitionCommand().

                                                                       : bool
    {
        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 155 of file class.ilBuddySystemGUI.php.

References transitionCommand().

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

Here is the call graph for this function:

redirectToReferer()

ilBuddySystemGUI::redirectToReferer ( )

private

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

References ILIAS\FileDelivery\http().

Referenced by transitionCommand().

                                         : void
    {
        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'];
                    }
                }
            }

            if ($redirectUrl !== '') {
                $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 132 of file class.ilBuddySystemGUI.php.

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

                                      : void
    {
        $this->transitionCommand('request', 'buddy_relation_requested', function (ilBuddySystemRelation $relation) {
            if (
                $relation->isUnlinked() &&
                !ilUtil::yn2tf(ilObjUser::_lookupPref($relation->getBuddyUsrId(), '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, Vendor\Package\$e, $response, ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), ilObjUser\_lookupPref(), exit, ilUtil\stripSlashes(), and ilUtil\yn2tf().

                                              : void
    {
        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->getBuddyUsrId(), '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->getStateButtonRendererByOwnerAndRelation(
                $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 ( string  $cmd, string  $positiveFeedbackLanguageId, callable  $onBeforeExecute = null  )

private

Parameters

string	$cmd
string	$positiveFeedbackLanguageId
callable | null	$onBeforeExecute

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

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

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

      : void {
        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 {
            $relation = ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId((int) $_GET['user_id']);

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

            ilBuddyList::getInstanceByGlobalUser()->{$cmd}($relation);
            ilUtil::sendSuccess($this->lng->txt($positiveFeedbackLanguageId), 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 24 of file class.ilBuddySystemGUI.php.

$ctrl

ilBuddySystemGUI::$ctrl

protected

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

$http

ilBuddySystemGUI::$http

protected

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

$isFrontendInitialized

ilBuddySystemGUI::$isFrontendInitialized = false

staticprotected

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

$lng

ilBuddySystemGUI::$lng

protected

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

$stateFactory

ilBuddySystemGUI::$stateFactory

protected

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

$user

ilBuddySystemGUI::$user

protected

Definition at line 30 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