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

Inheritance diagram for ilPCPlaceHolderGUI:

Collaboration diagram for ilPCPlaceHolderGUI:

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

	executeCommand ()

	edit ()

	setStyleId (int $a_styleid)

	getStyleId ()

	cancel ()

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 ()

	moveAfter ()
	move content element after another element More...

	moveBefore ()
	move content element before another element More...

	splitPage ()
	split page to new page at specified position More...

	splitPageNext ()
	split page to next page at specified position More...

	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...

Data Fields
const	TYPE_TEXT = "Text"

const	TYPE_QUESTION = "Question"

const	TYPE_MEDIA = "Media"

const	TYPE_VERIFICATION = "Verification"

Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilPageObject	$pg_obj

string	$hier_id = ""

php4DOMDocument	$dom

	$updated

string	$target_script = ""

string	$return_location = ""

ilPageConfig	$page_config = null

Protected Member Functions
	insert ()

	create ()

	edit_object ()

	saveProperties ()
	save placeholder properties in db and return to page edit screen More...

	propertyGUI (string $a_action, string $a_type, string $a_height, string $a_mode)
	Property Form. More...

	textCOSelectionGUI ()
	Text Item Selection. More...

	insertPCText ()
	Forwards Text Item Selection to GUI classes. More...

	getAvailableTypes (string $a_selected_type="")

	getTypeCaptions ()

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

	getParentReturn (string $hier_id="")

	updateAndReturn ()

	setCurrentTextLang (string $lang_key)

	getCurrentTextLang ()

Protected Attributes
ilPropertyFormGUI	$form_gui

Protected Attributes inherited from ilPageContentGUI
EditSessionRepository	$edit_repo

string	$pc_id = ""

array	$chars

ilObjStyleSheet	$style = null

ilLogger	$log

int	$styleid = 0

EditGUIRequest	$request

string	$sub_command = ""

int	$requested_ref_id = 0

Style Content CharacteristicManager	$char_manager

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

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;"

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 User Interface for Place Holder Management

Author: Hendrik Holtmann holtm.nosp@m.ann@.nosp@m.me.co.nosp@m.m ilPCPlaceHolderGUI: ilPCMediaObjectGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->pg_obj = $a_pg_obj;
         $this->content_obj = $a_content_obj;
         $this->hier_id = $a_hier_id;
         $this->pc_id = $a_pc_id;
 
         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

◆ cancel()

ilPCPlaceHolderGUI::cancel ( )

Definition at line 317 of file class.ilPCPlaceHolderGUI.php.

References ILIAS\Repository\ctrl().

                             : void
     {
         $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
     }

Here is the call graph for this function:

◆ create()

ilPCPlaceHolderGUI::create ( )

protected

Definition at line 74 of file class.ilPCPlaceHolderGUI.php.

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

                                : void
     {
         $plach_height = $this->request->getString("plach_height");
         if ($plach_height == "" ||
             !preg_match("/[0-9]+/", $plach_height)) {
             $this->insert();
             return;
         }
 
         $this->content_obj = new ilPCPlaceHolder($this->getPage());
         $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
         $this->content_obj->setHeight($plach_height . "px");
         $this->content_obj->setContentClass(
             $this->request->getString("plach_type")
         );
         $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:

◆ edit()

ilPCPlaceHolderGUI::edit ( )

Definition at line 97 of file class.ilPCPlaceHolderGUI.php.

References edit_object(), and ilPageContentGUI\getPageConfig().

Referenced by saveProperties().

                           : void
     {
         if ($this->getPageConfig()->getEnablePCType("PlaceHolder")) {
             $this->edit_object();
         } else {
             $this->forward_edit();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit_object()

ilPCPlaceHolderGUI::edit_object ( )

protected

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

References ilPageContentGUI\$content_obj, ILIAS\Repository\ctrl(), propertyGUI(), and textCOSelectionGUI().

Referenced by edit(), and saveProperties().

                                     : void
     {
         $this->propertyGUI(
             "saveProperties",
             $this->content_obj->getContentClass(),
             $this->content_obj->getHeight(),
             "save"
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilPCPlaceHolderGUI::executeCommand ( )

Definition at line 50 of file class.ilPCPlaceHolderGUI.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) {
             case 'ilpcmediaobjectgui':  //special handling
                 $media_gui = new ilPCMediaObjectGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $ret = $this->ctrl->forwardCommand($media_gui);
                 break;
 
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getAvailableTypes()

ilPCPlaceHolderGUI::getAvailableTypes ( string $a_selected_type = "" )

protected

Definition at line 322 of file class.ilPCPlaceHolderGUI.php.

References ILIAS\LTI\ToolProvider\$key, and ilPageContentGUI\getPageConfig().

Referenced by propertyGUI().

      : array {
         // custom config?
         if (method_exists($this->getPageConfig(), "getAvailablePlaceholderTypes")) {
             $types = $this->getPageConfig()->getAvailablePlaceholderTypes();
         } else {
             $types = array(self::TYPE_TEXT, self::TYPE_MEDIA, self::TYPE_QUESTION);
         }
 
         $validator = new ilCertificateActiveValidator();
         if (true === $validator->validate()) {
             // we remove type verification if certificates are deactivated and this
             // is not the currently selected value
             if (($key = array_search(self::TYPE_VERIFICATION, $types)) !== false &&
                 self::TYPE_VERIFICATION != $a_selected_type) {
                 unset($types[$key]);
             }
         }
         return $types;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStyleId()

ilPCPlaceHolderGUI::getStyleId ( )

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

References ilPageContentGUI\$styleid.

Referenced by insertPCText().

                                 : int
     {
         return $this->styleid;
     }

Here is the caller graph for this function:

◆ getTypeCaptions()

ilPCPlaceHolderGUI::getTypeCaptions ( )

protected

Definition at line 344 of file class.ilPCPlaceHolderGUI.php.

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

Referenced by propertyGUI().

                                         : array
     {
         $lng = $this->lng;
 
         return array(
                 self::TYPE_TEXT => $lng->txt("cont_ed_plachtext"),
                 self::TYPE_MEDIA => $lng->txt("cont_ed_plachmedia"),
                 self::TYPE_QUESTION => $lng->txt("cont_ed_plachquestion"),
                 self::TYPE_VERIFICATION => $lng->txt("cont_ed_plachverification")
             );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilPCPlaceHolderGUI::insert ( )

protected

Definition at line 69 of file class.ilPCPlaceHolderGUI.php.

References propertyGUI().

Referenced by create().

                                : void
     {
         $this->propertyGUI("create", self::TYPE_TEXT, "100px", "insert");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertPCText()

ilPCPlaceHolderGUI::insertPCText ( )

protected

Forwards Text Item Selection to GUI classes.

Definition at line 254 of file class.ilPCPlaceHolderGUI.php.

References ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), ilPageContentGUI\getPageConfig(), and getStyleId().

                                      : void
     {
         switch ($this->request->getString("pctext_type")) {
             case 0:  //Paragraph / Text
 
                 $ret_class = strtolower(get_class($this->getPage()) . "gui");
                 $this->ctrl->setParameterByClass($ret_class, "pl_hier_id", $this->hier_id);
                 $this->ctrl->setParameterByClass($ret_class, "pl_pc_id", $this->pc_id);
                 $this->ctrl->redirectByClass(
                     $ret_class,
                     "insertJSAtPlaceholder"
                 );
 
                 $this->ctrl->setCmdClass("ilpcparagraphgui");
                 $this->ctrl->setCmd("insert");
                 $paragraph_gui = new ilPCParagraphGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $paragraph_gui->setStyleId($this->getStyleId());
                 $paragraph_gui->setPageConfig($this->getPageConfig());
                 $this->ctrl->forwardCommand($paragraph_gui);
                 break;
 
             case 1:  //DataTable
                 $this->ctrl->setCmdClass("ilpcdatatablegui");
                 $this->ctrl->setCmd("insert");
                 $dtable_gui = new ilPCDataTableGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $this->ctrl->forwardCommand($dtable_gui);
                 break;
 
             case 2:  //Advanced Table
                 $this->ctrl->setCmdClass("ilpctablegui");
                 $this->ctrl->setCmd("insert");
                 $atable_gui = new ilPCTableGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $this->ctrl->forwardCommand($atable_gui);
                 break;
 
             case 3:  //Advanced List
                 $this->ctrl->setCmdClass("ilpclistgui");
                 $this->ctrl->setCmd("insert");
                 $list_gui = new ilPCListGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $this->ctrl->forwardCommand($list_gui);
                 break;
 
             case 4:  //File List
                 $this->ctrl->setCmdClass("ilpcfilelistgui");
                 $this->ctrl->setCmd("insert");
                 $file_list_gui = new ilPCFileListGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $file_list_gui->setStyleId($this->getStyleId());
                 $this->ctrl->forwardCommand($file_list_gui);
                 break;
 
             case 5:  //Tabs
                 $this->ctrl->setCmdClass("ilpctabsgui");
                 $this->ctrl->setCmd("insert");
                 $tabs_gui = new ilPCTabsGUI($this->pg_obj, $this->content_obj, $this->hier_id, $this->pc_id);
                 $tabs_gui->setStyleId($this->getStyleId());
                 $this->ctrl->forwardCommand($tabs_gui);
                 break;
 
             default:
                 break;
         }
     }

Here is the call graph for this function:

◆ propertyGUI()

ilPCPlaceHolderGUI::propertyGUI	(	string	$a_action,
		string	$a_type,
		string	$a_height,
		string	$a_mode
	)

protected

Property Form.

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

References ilPageContentGUI\$lng, $type, ILIAS\Repository\ctrl(), getAvailableTypes(), getTypeCaptions(), and ilLanguage\txt().

Referenced by edit_object(), and insert().

      : void {
         $lng = $this->lng;
 
         $this->form_gui = new ilPropertyFormGUI();
         $this->form_gui->setFormAction($this->ctrl->getFormAction($this));
         $this->form_gui->setTitle($lng->txt("cont_ed_plachprop"));
 
         $ttype_input = new ilRadioGroupInputGUI($lng->txt("type"), "plach_type");
         $type_captions = $this->getTypeCaptions();
         foreach ($this->getAvailableTypes($a_type) as $type) {
             $ttype_input->addOption(new ilRadioOption($type_captions[$type], $type));
         }
         $ttype_input->setRequired(true);
         $this->form_gui->addItem($ttype_input);
 
         $theight_input = new ilTextInputGUI($lng->txt("height"), "plach_height");
         $theight_input->setSize(4);
         $theight_input->setMaxLength(3);
         $theight_input->setTitle($lng->txt("height") . " (px)");
         $theight_input->setRequired(true);
         $this->form_gui->addItem($theight_input);
 
         $theight_input->setValue(preg_replace("/px/", "", $a_height));
         $ttype_input->setValue($a_type);
 
         $this->form_gui->addCommandButton($a_action, $lng->txt($a_mode));
         $this->form_gui->addCommandButton("cancelCreate", $lng->txt("cancel"));
         $this->tpl->setContent($this->form_gui->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveProperties()

ilPCPlaceHolderGUI::saveProperties ( )

protected

save placeholder properties in db and return to page edit screen

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

References ILIAS\Repository\ctrl(), edit(), and edit_object().

                                        : void
     {
         $plach_height = $this->request->getString("plach_height");
         if ($plach_height == "" ||
             !preg_match("/[0-9]+/", $plach_height)) {
             $this->edit_object();
             return;
         }
 
         $this->content_obj->setContentClass($this->request->getString("plach_type"));
         $this->content_obj->setHeight($plach_height . "px");
 
         $this->updated = $this->pg_obj->update();
         if ($this->updated === true) {
             $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
         } else {
             $this->pg_obj->addHierIDs();
             $this->edit();
         }
     }

Here is the call graph for this function:

◆ setStyleId()

ilPCPlaceHolderGUI::setStyleId ( int $a_styleid )

Definition at line 106 of file class.ilPCPlaceHolderGUI.php.

                                               : void
     {
         $this->styleid = $a_styleid;
     }

◆ textCOSelectionGUI()

ilPCPlaceHolderGUI::textCOSelectionGUI ( )

protected

Text Item Selection.

Definition at line 228 of file class.ilPCPlaceHolderGUI.php.

References ilPageContentGUI\$lng, ilRadioGroupInputGUI\addOption(), ILIAS\Repository\ctrl(), and ilLanguage\txt().

Referenced by edit_object().

                                            : void
     {
         $lng = $this->lng;
 
         $this->form_gui = new ilPropertyFormGUI();
         $this->form_gui->setFormAction($this->ctrl->getFormAction($this));
         $this->form_gui->setTitle($lng->txt("cont_ed_select_pctext"));
 
         // Select Question Type
         $ttype_input = new ilRadioGroupInputGUI($lng->txt("cont_ed_textitem"), "pctext_type");
         $ttype_input->addOption(new ilRadioOption($lng->txt("cont_ed_par"), 0));
         $ttype_input->addOption(new ilRadioOption($lng->txt("cont_ed_dtable"), 1));
         $ttype_input->addOption(new ilRadioOption($lng->txt("cont_ed_atable"), 2));
         $ttype_input->addOption(new ilRadioOption($lng->txt("cont_ed_list"), 3));
         $ttype_input->addOption(new ilRadioOption($lng->txt("cont_ed_flist"), 4));
         $ttype_input->addOption(new ilRadioOption($lng->txt("cont_tabs"), 5));
         $this->form_gui->addItem($ttype_input);
 
         $this->form_gui->addCommandButton("insertPCText", $lng->txt("insert"));
         $this->form_gui->addCommandButton("cancelCreate", $lng->txt("cancel"));
         $this->tpl->setContent($this->form_gui->getHTML());
     }