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

Collaboration diagram for ilEditClipboardGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	setMultipleSelections (bool $a_multiple=true)

	getMultipleSelections ()

	setInsertButtonTitle (string $a_insertbuttontitle)

	getInsertButtonTitle ()

	view ()

	getObject ()

	remove ()
	remove item from clipboard More...

	insert ()

	setTabs ()

	setPageBackTitle (string $a_title)

	getTabs ($tabs_gui)

Static Public Member Functions
static	_getSelectedIDs ()

Data Fields
string	$mode = ""

Protected Attributes
ILIAS MediaPool InternalGUIService	$gui

string	$page_back_title = ""

bool	$multiple = false

ILIAS MediaPool Clipboard ClipboardGUIRequest	$request

ILIAS MediaPool Clipboard ClipboardManager	$clipboard_manager

string	$insertbuttontitle = ""

ilLanguage	$lng

ilCtrl	$ctrl

ilObjUser	$user

ilTabsGUI	$tabs

ilTree	$tree

ilGlobalTemplateInterface	$tpl

ilToolbarGUI	$toolbar

string	$requested_return_cmd = ""

int	$requested_clip_item_id = 0

string	$requested_pcid = ""

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 Clipboard for editing

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilEditClipboardGUI: ilObjMediaObjectGUI

Definition at line 25 of file class.ilEditClipboardGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilEditClipboardGUI::__construct ( )

Definition at line 46 of file class.ilEditClipboardGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->tree = $DIC->repositoryTree();
        $this->tpl = $DIC["tpl"];
        $this->toolbar = $DIC->toolbar();
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
 
        $this->request = $DIC->mediaPool()
            ->internal()
            ->gui()
            ->clipboard()
            ->request();
 
        $this->multiple = false;
        $this->page_back_title = $lng->txt("cont_back");
        $this->requested_return_cmd = $this->request->getReturnCmd();
        $this->requested_clip_item_id = $this->request->getItemId();
        $this->requested_pcid = $this->request->getPCId();
        $this->clipboard_manager = $DIC->mediaPool()
           ->internal()
           ->domain()
           ->clipboard();
 
        if ($this->requested_return_cmd !== "") {
            $this->mode = "getObject";
        } else {
            $this->mode = "";
        }
 
        $ilCtrl->setParameter(
            $this,
            "returnCommand",
            rawurlencode($this->requested_return_cmd)
        );
 
        $ilCtrl->saveParameter($this, array("clip_item_id", "pcid"));
        $this->gui = $DIC->mediaPool()->internal()->gui();
    }

References $DIC, $lng, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\UI\examples\Input\Field\File\multiple(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), ilLanguage\txt(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _getSelectedIDs()

static ilEditClipboardGUI::_getSelectedIDs ( )

static

Definition at line 236 of file class.ilEditClipboardGUI.php.

                                            : array
    {
        global $DIC;
        $clipboard_manager = $DIC->mediaPool()
            ->internal()
            ->domain()
            ->clipboard();
 
        return $clipboard_manager->getIds();
    }

References $clipboard_manager, and $DIC.

Referenced by ILIAS\MediaPool\MediaPoolManager\copySelectedFromEditClipboard(), and ilPageEditorGUI\insertFromClipboard().

Here is the caller graph for this function:

◆ executeCommand()

ilEditClipboardGUI::executeCommand ( )

Definition at line 92 of file class.ilEditClipboardGUI.php.

                                    : void
    {
        $ilUser = $this->user;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
 
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();
        switch ($next_class) {
            case "ilobjmediaobjectgui":
                $ilCtrl->setReturn($this, "view");
                $ilTabs->clearTargets();
                $ilTabs->setBackTarget(
                    $lng->txt("back"),
                    $ilCtrl->getLinkTarget($this, "view")
                );
                $mob_gui = new ilObjMediaObjectGUI("", $this->requested_clip_item_id, false, false);
                $mob_gui->setTabs();
                $ilCtrl->forwardCommand($mob_gui);
                switch ($cmd) {
                    case "save":
                        $ilUser->addObjectToClipboard(
                            $mob_gui->getObject()->getId(),
                            "mob",
                            $mob_gui->getObject()->getTitle()
                        );
                        $ilCtrl->redirect($this, "view");
                        break;
                }
                break;
 
            default:
                $this->$cmd();
                break;
        }
    }

References $ctrl, $lng, $tabs, $user, and ilLanguage\txt().

Here is the call graph for this function:

◆ getInsertButtonTitle()

ilEditClipboardGUI::getInsertButtonTitle ( )

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

                                          : string
    {
        $lng = $this->lng;
 
        if ($this->insertbuttontitle === "") {
            return $lng->txt("insert");
        }
 
        return $this->insertbuttontitle;
    }

References $insertbuttontitle, $lng, and ilLanguage\txt().

Here is the call graph for this function:

◆ getMultipleSelections()

ilEditClipboardGUI::getMultipleSelections ( )

Definition at line 135 of file class.ilEditClipboardGUI.php.

                                           : bool
    {
        return $this->multiple;
    }

References $multiple.

Referenced by insert().

Here is the caller graph for this function:

◆ getObject()

ilEditClipboardGUI::getObject ( )

Definition at line 172 of file class.ilEditClipboardGUI.php.

                               : void
    {
        $this->mode = "getObject";
        $this->view();
    }

References view().

Here is the call graph for this function:

◆ getTabs()

ilEditClipboardGUI::getTabs ( $tabs_gui )

Definition at line 262 of file class.ilEditClipboardGUI.php.

                                      : void
    {
        $ilCtrl = $this->ctrl;
 
        // back to upper context
        $tabs_gui->setBackTarget(
            $this->page_back_title,
            $ilCtrl->getParentReturn($this)
        );
    }

References $ctrl.

Referenced by setTabs().

Here is the caller graph for this function:

◆ insert()

ilEditClipboardGUI::insert ( )

Definition at line 210 of file class.ilEditClipboardGUI.php.

                            : void
    {
        $lng = $this->lng;
 
        $return = $this->requested_return_cmd;
        if ($this->requested_pcid !== "") {
            $return .= "&pc_id=" . $this->requested_pcid;
        }
 
        $ids = $this->request->getItemIds();
 
        // check number of objects
        if (count($ids) === 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            ilUtil::redirect($return);
        }
 
        if (!$this->getMultipleSelections() && count($ids) > 1) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("cont_select_max_one_item"), true);
            ilUtil::redirect($return);
        }
 
        $this->clipboard_manager->setIds($ids);
        ilUtil::redirect($return);
    }

References $lng, $requested_pcid, $requested_return_cmd, getMultipleSelections(), ilUtil\redirect(), and ilLanguage\txt().

Here is the call graph for this function:

◆ remove()

ilEditClipboardGUI::remove ( )

remove item from clipboard

Definition at line 182 of file class.ilEditClipboardGUI.php.

                            : void
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        // check number of objects
        $ids = $this->request->getItemIds();
 
        if (count($ids) === 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "view");
        }
 
        foreach ($ids as $obj_id) {
            $id = explode(":", $obj_id);
            if ($id[0] === "mob") {
                $ilUser->removeObjectFromClipboard($id[1], "mob");
                $mob = new ilObjMediaObject($id[1]);
                $mob->delete();                 // this method don't delete, if mob is used elsewhere
            }
            if ($id[0] === "incl") {
                $ilUser->removeObjectFromClipboard($id[1], "incl");
            }
        }
        $ilCtrl->redirect($this, "view");
    }

References $ctrl, $id, $lng, $user, ilCtrl\redirect(), and ilLanguage\txt().

Here is the call graph for this function:

◆ setInsertButtonTitle()

ilEditClipboardGUI::setInsertButtonTitle ( string $a_insertbuttontitle )

Definition at line 140 of file class.ilEditClipboardGUI.php.

                                                                     : void
    {
        $this->insertbuttontitle = $a_insertbuttontitle;
    }

◆ setMultipleSelections()

ilEditClipboardGUI::setMultipleSelections ( bool $a_multiple = true )

Definition at line 130 of file class.ilEditClipboardGUI.php.

                                                                  : void
    {
        $this->multiple = $a_multiple;
    }

References ILIAS\UI\examples\Input\Field\File\multiple().

Here is the call graph for this function:

◆ setPageBackTitle()

ilEditClipboardGUI::setPageBackTitle ( string $a_title )

Definition at line 257 of file class.ilEditClipboardGUI.php.

                                                     : void
    {
        $this->page_back_title = $a_title;
    }

◆ setTabs()

ilEditClipboardGUI::setTabs ( )

Definition at line 247 of file class.ilEditClipboardGUI.php.

                             : void
    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $tpl = $this->tpl;
 
        $tpl->setTitle($lng->txt("clipboard"));
        $this->getTabs($ilTabs);
    }

References $lng, $tabs, $tpl, getTabs(), ILIAS\UICore\GlobalTemplate\setTitle(), and ilLanguage\txt().

Here is the call graph for this function:

◆ view()

ilEditClipboardGUI::view ( )

Definition at line 156 of file class.ilEditClipboardGUI.php.

                          : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
 
        $this->gui->button(
            $this->lng->txt("cont_create_mob"),
            $ilCtrl->getLinkTargetByClass("ilobjmediaobjectgui", "create")
        )->toToolbar();
 
        $table_gui = new ilClipboardTableGUI($this, "view");
        $tpl->setContent($table_gui->getHTML());
    }