ilSingleUserShareGUI 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 ilSingleUserShareGUI:

Public Member Functions
	__construct ( $wsp_access_handler=null, ?int $wsp_node_id=null)
	executeCommand ()
	initShareForm (?ilPropertyFormGUI $form=null)
	getShareForm ()
	cancel ()

Protected Member Functions
	saveShare ()

Protected Attributes
int	$wsp_node_id
	$wsp_access_handler
ilGlobalTemplateInterface	$tpl
ilCtrl	$ctrl
ilLanguage	$lng

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

Author

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

Definition at line 22 of file class.ilSingleUserShareGUI.php.

Constructor & Destructor Documentation

__construct()

ilSingleUserShareGUI::__construct	(		$wsp_access_handler = null,
		?int	$wsp_node_id = null
	)

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

References $DIC, $wsp_access_handler, $wsp_node_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

      {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();

        // personal workspace
        $this->wsp_access_handler = $wsp_access_handler;
        $this->wsp_node_id = $wsp_node_id;
    }

Here is the call graph for this function:

Member Function Documentation

cancel()

ilSingleUserShareGUI::cancel

(

)

Definition at line 111 of file class.ilSingleUserShareGUI.php.

References ILIAS\Repository\ctrl().

                            : void
    {
        $this->ctrl->returnToParent($this);
    }

Here is the call graph for this function:

executeCommand()

ilSingleUserShareGUI::executeCommand

(

)

Definition at line 48 of file class.ilSingleUserShareGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $forward_class = $this->ctrl->getNextClass($this);

        switch ($forward_class) {
            default:
                if (!($cmd = $this->ctrl->getCmd())) {
                    $cmd = "initShareForm";
                }
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

getShareForm()

ilSingleUserShareGUI::getShareForm

(

)

Definition at line 70 of file class.ilSingleUserShareGUI.php.

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

Referenced by initShareForm(), and saveShare().

                                  : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $form->setTitle($this->lng->txt("share_content"));
        $form->setId('share_usr');

        $form->setFormAction($this->ctrl->getFormAction($this, 'saveShare'));

        $inp = new ilTextInputGUI($this->lng->txt("share_with"), 'name');
        $inp->setSize(20);
        $form->addItem($inp);

        $form->addCommandButton('saveShare', $this->lng->txt("share"));
        $form->addCommandButton('cancel', $this->lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initShareForm()

ilSingleUserShareGUI::initShareForm

(

?ilPropertyFormGUI

$form = null

)

Definition at line 62 of file class.ilSingleUserShareGUI.php.

References getShareForm().

                                                                  : void
    {
        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getShareForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

saveShare()

ilSingleUserShareGUI::saveShare ( )

protected

Definition at line 89 of file class.ilSingleUserShareGUI.php.

References $user_id, ilObjUser\_lookupId(), ILIAS\Repository\ctrl(), getShareForm(), and ILIAS\Repository\lng().

                                  : void
    {
        $form = $this->getShareForm();

        if ($form->checkInput()) {
            if ($user_id = ilObjUser::_lookupId((string) $form->getInput('name'))) {
                $existing = $this->wsp_access_handler->getPermissions($this->wsp_node_id);

                if (!in_array($user_id, $existing)) {
                    $this->wsp_access_handler->addPermission($this->wsp_node_id, $user_id);
                    $this->tpl->setOnScreenMessage('success', $this->lng->txt("element_shared"), true);
                } else {
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt("element_already_shared"), true);
                }
                $this->ctrl->returnToParent($this);
            } else {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('search_no_match'), true);
            }
        }
        $this->ctrl->redirect($this);
    }

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilSingleUserShareGUI::$ctrl

protected

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

$lng

ilLanguage ilSingleUserShareGUI::$lng

protected

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

$tpl

ilGlobalTemplateInterface ilSingleUserShareGUI::$tpl

protected

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

$wsp_access_handler

ilSingleUserShareGUI::$wsp_access_handler

protected

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

Referenced by __construct().

$wsp_node_id

int ilSingleUserShareGUI::$wsp_node_id

protected

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

Referenced by __construct().

---

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

• components/ILIAS/PersonalWorkspace/classes/class.ilSingleUserShareGUI.php