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

Inheritance diagram for ilPCContentIncludeGUI:

Collaboration diagram for ilPCContentIncludeGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")

	executeCommand ()

	insert ()
	Insert new resources component form. More...

	insertFromPool ()
	Insert page snippet from media pool. More...

	poolSelection ()
	Pool Selection. More...

	create ()
	create new content include in dom and update page in db More...

	selectPool ()
	Select concrete pool. More...

Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")

	setContentObject (ilPageContent $a_val)

	getContentObject ()

	setPage (ilPageObject $a_val)

	getPage ()

	setPageConfig (ilPageConfig $a_val)

	getPageConfig ()

	setStyleId (int $a_styleid)

	getStyleId ()

	getStyle ()

	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...

	setCharacteristics (array $a_chars)

	getCharacteristics ()

	getHierId ()

	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...

	delete ()

	displayValidationError ()

	cancelCreate ()
	cancel creating page content More...

	cancelUpdate ()
	cancel update More...

	cancel ()
	Cancel. More...

	deactivate ()
	gui function set enabled if is not enabled and vice versa More...

	cut ()
	Cut single element. More...

	copy ()
	Copy single element. More...

	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Attributes
ilAccessHandler	$access

ilTabsGUI	$tabs

Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui

ILIAS COPage InternalGUIService	$gui

EditSessionRepository	$edit_repo

string	$pc_id = ""

array	$chars

ilObjStyleSheet	$style = null

LOMServices	$lom_services

ilLogger	$log

int	$styleid = 0

EditGUIRequest	$request

string	$sub_command = ""

int	$requested_ref_id = 0

ILIAS GlobalScreen ScreenContext ContextServices	$tool_context

Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilPageObject	$pg_obj

string	$hier_id = ""

DOMDocument	$dom

	$updated

string	$target_script = ""

string	$return_location = ""

ilPageConfig	$page_config = null

Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"

Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")

	getParentReturn (string $hier_id="")

	updateAndReturn ()

	setCurrentTextLang (string $lang_key)

	getCurrentTextLang ()

	setEditorToolContext ()

	initEditor ()

	getEditorScriptTag (string $form_pc_id="", string $form_cname="")

Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

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 ilPCContentIncludeGUI User Interface for Content Includes (Snippets) Editing

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

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

Constructor & Destructor Documentation

◆ __construct()

ilPCContentIncludeGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = `""`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

       {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->access = $DIC->access();
         $this->tabs = $DIC->tabs();
         $this->tpl = $DIC["tpl"];
         $this->lng = $DIC->language();
         parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilPCContentIncludeGUI::create ( )

create new content include in dom and update page in db

Definition at line 149 of file class.ilPCContentIncludeGUI.php.

References ilPageContentGUI\$pc_id, ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), and insert().

                             : void
     {
         $ids = $this->request->getIntArray("id");
         if (count($ids) > 0) {
             for ($i = count($ids) - 1; $i >= 0; $i--) {
                 // similar code in ilpageeditorgui::insertFromClipboard
                 $this->content_obj = new ilPCContentInclude($this->getPage());
                 $this->content_obj->create(
                     $this->pg_obj,
                     $this->request->getHierId(),
                     $this->pc_id
                 );
                 $this->content_obj->setContentType("mep");
                 $this->content_obj->setContentId($ids[$i]);
             }
             $this->updated = $this->pg_obj->update();
         }
         if ($this->updated === true) {
             $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
         } else {
             $this->insert();
         }
     }

Here is the call graph for this function:

◆ executeCommand()

ilPCContentIncludeGUI::executeCommand ( )

Definition at line 47 of file class.ilPCContentIncludeGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         // get next class that processes or forwards current command
         $next_class = $this->ctrl->getNextClass($this);
 
         // get current command
         $cmd = $this->ctrl->getCmd();
 
         switch ($next_class) {
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ insert()

ilPCContentIncludeGUI::insert ( )

Insert new resources component form.

Definition at line 65 of file class.ilPCContentIncludeGUI.php.

References insertFromPool(), poolSelection(), and selectPool().

Referenced by create().

                             : void
     {
         switch ($this->sub_command) {
             case "selectPool":
                 $this->selectPool();
                 break;
 
             case "poolSelection":
                 $this->poolSelection();
                 break;
 
             default:
                 $this->insertFromPool();
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertFromPool()

ilPCContentIncludeGUI::insertFromPool ( )

Insert page snippet from media pool.

Definition at line 85 of file class.ilPCContentIncludeGUI.php.

References $access, ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ilPageContentGUI\$tpl, ilObject\_lookupObjId(), ilObject\_lookupType(), ilMediaPoolTableGUI\IL_MEP_SELECT_CONTENT, poolSelection(), ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

Referenced by insert().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $ilAccess = $this->access;
         $tpl = $this->tpl;
         $lng = $this->lng;
 
         if ($this->edit_repo->getMediaPool() > 0 &&
             $ilAccess->checkAccess("write", "", $this->edit_repo->getMediaPool())
             && ilObject::_lookupType(ilObject::_lookupObjId($this->edit_repo->getMediaPool())) == "mep") {
             $tb = new ilToolbarGUI();
 
             $ilCtrl->setParameter($this, "subCmd", "poolSelection");
 
             $tb->addButton(
                 $lng->txt("cont_select_media_pool"),
                 $ilCtrl->getLinkTarget($this, "insert")
             );
             $html = $tb->getHTML();
 
             $ilCtrl->setParameter($this, "subCmd", "");
 
             $pool = new ilObjMediaPool($this->edit_repo->getMediaPool());
             $ilCtrl->setParameter($this, "subCmd", "insertFromPool");
             $mpool_table = new ilMediaPoolTableGUI(
                 $this,
                 "insert",
                 $pool,
                 "mep_folder",
                 ilMediaPoolTableGUI::IL_MEP_SELECT_CONTENT
             );
             $mpool_table->setInsertCommand("create");
 
             $html .= $mpool_table->getHTML();
 
             $tpl->setContent($html);
         } else {
             $this->poolSelection();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ poolSelection()

ilPCContentIncludeGUI::poolSelection ( )

Pool Selection.

Definition at line 129 of file class.ilPCContentIncludeGUI.php.

References ilPageContentGUI\$ctrl, ilPageContentGUI\$tpl, ILIAS\UICore\GlobalTemplate\setContent(), and ilCtrl\setParameter().

Referenced by insert(), and insertFromPool().

                                    : void
     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
 
         $ilCtrl->setParameter($this, "subCmd", "poolSelection");
         $exp = new ilPoolSelectorGUI($this, "insert");
 
         // filter
         $exp->setTypeWhiteList(array("root", "cat", "grp", "fold", "crs", "mep"));
         $exp->setClickableTypes(array('mep'));
 
         if (!$exp->handleCommand()) {
             $tpl->setContent($exp->getHTML());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectPool()

ilPCContentIncludeGUI::selectPool ( )

Select concrete pool.

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

References ilPageContentGUI\$ctrl, and ilCtrl\setParameter().

Referenced by insert().

                                 : void
     {
         $ilCtrl = $this->ctrl;
 
         $this->edit_repo->setMediaPool($this->request->getInt("pool_ref_id"));
         $ilCtrl->setParameter($this, "subCmd", "insertFromPool");
         $ilCtrl->redirect($this, "insert");
     }