ilBuddySystemGUI Class Reference

Class ilBuddySystemGUI. More...

Collaboration diagram for ilBuddySystemGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Static Public Member Functions
static	initializeFrontend (ilGlobalTemplateInterface $page)

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

Protected Attributes
ilCtrlInterface	$ctrl
ilBuddyList	$buddyList
ilBuddySystemRelationStateFactory	$stateFactory
ilObjUser	$user
ilLanguage	$lng
Services	$http

Static Protected Attributes
static bool	$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 ()

Private Attributes
const	BS_REQUEST_HTTP_GET = 1
const	BS_REQUEST_HTTP_POST = 2
readonly ilGlobalTemplateInterface	$main_tpl

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

Constructor & Destructor Documentation

__construct()

ilBuddySystemGUI::__construct

(

)

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

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

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();

        $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 ILIAS\Repository\ctrl(), and ILIAS\Repository\user().

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

        $this->{$this->ctrl->getCmd() . 'Command'}();
    }

Here is the call graph for this function:

ignoreCommand()

ilBuddySystemGUI::ignoreCommand ( )

private

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

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

References $DIC, ILIAS\UICore\GlobalTemplate\addJavaScript(), ILIAS\UICore\GlobalTemplate\addOnLoadCode(), ilBuddySystem\getInstance(), and ilBuddySystemLinkButtonType\ROOT_CSS_CLASS.

Referenced by ilGlobalPageTemplate\prepareBasicJS().

                                                                              : void
    {
        global $DIC;

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

            $page->addJavaScript('./assets/js/buddy_system.js');

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

            $btn_config = new stdClass();
            $btn_config->bnt_class = ilBuddySystemLinkButtonType::ROOT_CSS_CLASS;

            $page->addOnLoadCode('il.BuddySystemButton.setConfig(' . json_encode($btn_config, JSON_THROW_ON_ERROR) . ');');
            $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

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

References ILIAS\FileDelivery\http().

Referenced by transitionAsyncCommand(), and transitionCommand().

                                                                      : bool
    {
        switch ($type) {
            case self::BS_REQUEST_HTTP_POST:
                $body = $this->http->request()->getParsedBody();
                return (isset($body[$key]) && is_string($body[$key]) && $body[$key] !== '');

            case self::BS_REQUEST_HTTP_GET:
            default:
                $query = $this->http->request()->getQueryParams();
                return (isset($query[$key]) && is_string($query[$key]) && $query[$key] !== '');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

linkCommand()

ilBuddySystemGUI::linkCommand ( )

private

Definition at line 137 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 250 of file class.ilBuddySystemGUI.php.

References ILIAS\Repository\ctrl(), and 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 116 of file class.ilBuddySystemGUI.php.

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

                                     : void
    {
        $this->transitionCommand(
            'request',
            'buddy_relation_requested',
            static function (ilBuddySystemRelation $relation): void {
                if (
                    $relation->isUnlinked() &&
                    !ilUtil::yn2tf((string) 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 177 of file class.ilBuddySystemGUI.php.

References Vendor\Package\$e, $relation, $response, ilObjUser\_isAnonymous(), ilObjUser\_lookupLogin(), ilObjUser\_lookupPref(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), isRequestParameterGiven(), ILIAS\Repository\lng(), ilUtil\stripSlashes(), and ilUtil\yn2tf().

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

        if (!$this->isRequestParameterGiven('usr_id', self::BS_REQUEST_HTTP_POST)) {
            throw new RuntimeException('Missing "usr_id" parameter');
        }

        if (!$this->isRequestParameterGiven('action', self::BS_REQUEST_HTTP_POST)) {
            throw new RuntimeException('Missing "action" parameter');
        }

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

        try {
            $usr_id = (int) $this->http->request()->getParsedBody()['usr_id'];
            $action = ilUtil::stripSlashes($this->http->request()->getParsedBody()['action']);

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

            $login = ilObjUser::_lookupLogin($usr_id);
            if ($login === '') {
                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((string) 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|ilBuddySystemRelationStateTransitionException $e) {
                $response->message = sprintf($this->lng->txt($e->getMessage()), $login);
            } catch (Exception) {
                $response->message = $this->lng->txt('buddy_bs_action_not_possible');
            }

            $response->state = $relation->getState()::class;
            $response->state_html = $this->stateFactory->getStateButtonRendererByOwnerAndRelation(
                $this->buddyList->getOwnerId(),
                $relation
            )->getHtml();
        } catch (Exception) {
            $response->message = $this->lng->txt('buddy_bs_action_not_possible');
        }

        $this->http->saveResponse(
            $this->http->response()
                ->withAddedHeader('Content-Type', 'application/json')
                ->withBody(ILIAS\Filesystem\Stream\Streams::ofString(json_encode($response, JSON_THROW_ON_ERROR)))
        );
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

transitionCommand()

ilBuddySystemGUI::transitionCommand ( string  $cmd, string  $positiveFeedbackLanguageId, ?callable  $onBeforeExecute = null  )

private

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

References Vendor\Package\$e, $relation, ilObjUser\_lookupLogin(), ILIAS\Repository\ctrl(), ilBuddyList\getInstanceByGlobalUser(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), isRequestParameterGiven(), ILIAS\Repository\lng(), null, and redirectToReferer().

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

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

        $usrId = (int) $this->http->request()->getQueryParams()['user_id'];
        try {
            $relation = ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId($usrId);

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

            ilBuddyList::getInstanceByGlobalUser()->{$cmd}($relation);
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt($positiveFeedbackLanguageId), true);
        } catch (ilBuddySystemRelationStateAlreadyGivenException | ilBuddySystemRelationStateTransitionException $e) {
            $this->main_tpl->setOnScreenMessage('info', sprintf(
                $this->lng->txt($e->getMessage()),
                ilObjUser::_lookupLogin($usrId)
            ), true);
        } catch (Exception) {
            $this->main_tpl->setOnScreenMessage('info', $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

ilBuddyList ilBuddySystemGUI::$buddyList

protected

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

$ctrl

ilCtrlInterface ilBuddySystemGUI::$ctrl

protected

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

$http

Services ilBuddySystemGUI::$http

protected

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

$isFrontendInitialized

bool ilBuddySystemGUI::$isFrontendInitialized = false

staticprotected

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

$lng

ilLanguage ilBuddySystemGUI::$lng

protected

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

$main_tpl

readonly ilGlobalTemplateInterface ilBuddySystemGUI::$main_tpl

private

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

$stateFactory

ilBuddySystemRelationStateFactory ilBuddySystemGUI::$stateFactory

protected

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

$user

ilObjUser ilBuddySystemGUI::$user

protected

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

BS_REQUEST_HTTP_GET

const ilBuddySystemGUI::BS_REQUEST_HTTP_GET = 1

private

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

BS_REQUEST_HTTP_POST

const ilBuddySystemGUI::BS_REQUEST_HTTP_POST = 2

private

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

---

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

• components/ILIAS/Contact/BuddySystem/classes/class.ilBuddySystemGUI.php