ilBookingParticipantGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilBookingParticipantGUI:

Public Member Functions
	__construct (ilObjBookingPoolGUI $a_parent_obj)
	executeCommand ()
	render ()
	Render list of booking participants. More...
	addUserFromAutoCompleteObject ()
	addParticipantObject (array $a_user_ids)
	Add new participant. More...
	applyParticipantsFilter ()
	resetParticipantsFilter ()
	assignObjects ()

Data Fields
const	FILTER_ACTION_APPLY = 1
const	FILTER_ACTION_RESET = 2
const	PARTICIPANT_VIEW = 1

Protected Member Functions
	applyFilterAction (int $a_filter_action)

Protected Attributes
ILIAS BookingManager Access AccessManager	$access
ILIAS BookingManager StandardGUIRequest	$book_request
ilGlobalTemplateInterface	$tpl
ilTabsGUI	$tabs
ilCtrl	$ctrl
ilLanguage	$lng
ilToolbarGUI	$toolbar
int	$ref_id
int	$pool_id

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilBookingParticipantGUI

Author

Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilBookingParticipantGUI: ilRepositorySearchGUI

Definition at line 24 of file class.ilBookingParticipantGUI.php.

Constructor & Destructor Documentation

__construct()

ilBookingParticipantGUI::__construct

(

ilObjBookingPoolGUI

$a_parent_obj

)

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ilObjectGUI\getRefId(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->access = $DIC->bookingManager()->internal()->domain()->access();
        $this->toolbar = $DIC->toolbar();
        $this->book_request = $DIC->bookingManager()
                                  ->internal()
                                  ->gui()
                                  ->standardRequest();


        $this->ref_id = $a_parent_obj->getRefId();
        $this->pool_id = $a_parent_obj->getObject()->getId();

        $this->lng->loadLanguageModule("book");
    }

Here is the call graph for this function:

Member Function Documentation

addParticipantObject()

ilBookingParticipantGUI::addParticipantObject

(

array

$a_user_ids

)

Add new participant.

Parameters

int[]

$a_user_ids

Exceptions

ilCtrlException

Definition at line 145 of file class.ilBookingParticipantGUI.php.

References $user_id, ilObject\_lookupType(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by addUserFromAutoCompleteObject().

     : bool {
        foreach ($a_user_ids as $user_id) {
            if (ilObject::_lookupType($user_id) === "usr") {
                $participant_obj = new ilBookingParticipant($user_id, $this->pool_id);
                if ($participant_obj->getIsNew()) {
                    $this->tpl->setOnScreenMessage('success', $this->lng->txt("book_participant_assigned"), true);
                } else {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt("book_participant_already_assigned"));
                }
            } else {
                $this->tpl->setOnScreenMessage('failure', "dummy error message, change me");
                return false;
            }
        }

        $this->ctrl->redirect($this, "render");
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addUserFromAutoCompleteObject()

ilBookingParticipantGUI::addUserFromAutoCompleteObject

(

)

Definition at line 116 of file class.ilBookingParticipantGUI.php.

References $user_id, ilObjUser\_lookupId(), addParticipantObject(), ILIAS\Repository\lng(), and render().

                                                   : bool
    {
        if (trim($this->book_request->getUserLogin()) === '') {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_search_string'));
            $this->render();
            return false;
        }

        $users = explode(',', $this->book_request->getUserLogin());

        $user_ids = array();
        foreach ($users as $user) {
            $user_id = ilObjUser::_lookupId($user);

            if (!$user_id) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('user_not_known'));
                $this->render();
            }
            $user_ids[] = $user_id;
        }

        return $this->addParticipantObject($user_ids);
    }

Here is the call graph for this function:

applyFilterAction()

ilBookingParticipantGUI::applyFilterAction ( int  $a_filter_action )

protected

Definition at line 176 of file class.ilBookingParticipantGUI.php.

References render().

Referenced by applyParticipantsFilter(), and resetParticipantsFilter().

     : void {
        $table = new ilBookingParticipantsTableGUI($this, 'render', $this->ref_id, $this->pool_id);
        $table->resetOffset();
        if ($a_filter_action === self::FILTER_ACTION_RESET) {
            $table->resetFilter();
        } else {
            $table->writeFilterToSession();
        }

        $this->render();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

applyParticipantsFilter()

ilBookingParticipantGUI::applyParticipantsFilter

(

)

Definition at line 166 of file class.ilBookingParticipantGUI.php.

References applyFilterAction().

                                             : void
    {
        $this->applyFilterAction(self::FILTER_ACTION_APPLY);
    }

Here is the call graph for this function:

assignObjects()

ilBookingParticipantGUI::assignObjects

(

)

Definition at line 190 of file class.ilBookingParticipantGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                   : void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget($this->lng->txt('book_back_to_list'), $this->ctrl->getLinkTarget($this, 'render'));

        $table = new ilBookingAssignObjectsTableGUI($this, 'assignObjects', $this->ref_id, $this->pool_id);

        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilBookingParticipantGUI::executeCommand

(

)

Definition at line 63 of file class.ilBookingParticipantGUI.php.

References $ctrl, $ref_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilCtrl\getNextClass(), and ILIAS\Repository\lng().

                                    : void
    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass($this);

        switch ($next_class) {
            case 'ilrepositorysearchgui':
                $rep_search = new ilRepositorySearchGUI();
                $ref_id = $this->ref_id;
                $rep_search->addUserAccessFilterCallable(function ($a_user_id) {
                    return $this->access->filterManageableParticipants(
                        $this->ref_id,
                        $a_user_id
                    );
                });
                $rep_search->setTitle($this->lng->txt("exc_add_participant"));
                $rep_search->setCallback($this, 'addParticipantObject');
                $this->ctrl->setReturn($this, 'render');
                $this->ctrl->forwardCommand($rep_search);
                break;

            default:
                $cmd = $ilCtrl->getCmd("render");
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

render()

ilBookingParticipantGUI::render

(

)

Render list of booking participants.

uses ilBookingParticipantsTableGUI

Definition at line 96 of file class.ilBookingParticipantGUI.php.

References $ref_id, ILIAS\Repository\access(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by addUserFromAutoCompleteObject(), and applyFilterAction().

                            : void
    {
        if ($this->access->canManageParticipants($this->ref_id)) {
            ilRepositorySearchGUI::fillAutoCompleteToolbar(
                $this,
                $this->toolbar,
                array(
                    'auto_complete_name' => $this->lng->txt('user'),
                    'submit_name' => $this->lng->txt('add'),
                    'add_search' => true,
                    'add_from_container' => $this->ref_id
                )
            );

            $table = new ilBookingParticipantsTableGUI($this, 'render', $this->ref_id, $this->pool_id);

            $this->tpl->setContent($table->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetParticipantsFilter()

ilBookingParticipantGUI::resetParticipantsFilter

(

)

Definition at line 171 of file class.ilBookingParticipantGUI.php.

References applyFilterAction().

                                             : void
    {
        $this->applyFilterAction(self::FILTER_ACTION_RESET);
    }

Here is the call graph for this function:

Field Documentation

$access

ILIAS BookingManager Access AccessManager ilBookingParticipantGUI::$access

protected

Definition at line 29 of file class.ilBookingParticipantGUI.php.

$book_request

ILIAS BookingManager StandardGUIRequest ilBookingParticipantGUI::$book_request

protected

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

$ctrl

ilCtrl ilBookingParticipantGUI::$ctrl

protected

Definition at line 34 of file class.ilBookingParticipantGUI.php.

Referenced by executeCommand().

$lng

ilLanguage ilBookingParticipantGUI::$lng

protected

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

$pool_id

int ilBookingParticipantGUI::$pool_id

protected

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

$ref_id

int ilBookingParticipantGUI::$ref_id

protected

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

Referenced by executeCommand(), and render().

$tabs

ilTabsGUI ilBookingParticipantGUI::$tabs

protected

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

$toolbar

ilToolbarGUI ilBookingParticipantGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilBookingParticipantGUI::$tpl

protected

Definition at line 32 of file class.ilBookingParticipantGUI.php.

FILTER_ACTION_APPLY

const ilBookingParticipantGUI::FILTER_ACTION_APPLY = 1

Definition at line 26 of file class.ilBookingParticipantGUI.php.

FILTER_ACTION_RESET

const ilBookingParticipantGUI::FILTER_ACTION_RESET = 2

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

PARTICIPANT_VIEW

const ilBookingParticipantGUI::PARTICIPANT_VIEW = 1

Definition at line 28 of file class.ilBookingParticipantGUI.php.

Referenced by ilBookingParticipantsTableGUI\fillRow(), and ilBookingAssignObjectsTableGUI\getItems().

---

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

• components/ILIAS/BookingManager/Participants/class.ilBookingParticipantGUI.php