Responsive Grid UI class. More...

Inheritance diagram for ilPCGridGUI:

Collaboration diagram for ilPCGridGUI:

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

	executeCommand ()

	insert ()

	initCreationForm ()
	Init creation form. More...

	create ()
	Create new grid element. More...

	afterCreation ()

	edit ()
	List all cells. More...

	savePositions ()
	Save positions. More...

	editWidths (string $id)

	addCell ()
	Add cell. More...

	confirmCellDeletion (array $tids)
	Confirm cell deletion. More...

	cancelCellDeletion ()
	Cancel cell deletion. More...

	deleteCells ()
	Delete Cells. More...

	setTabs ()

	saveCellData ()
	Save tabs properties in db and return to page edit screen. 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...

Data Fields
const	TEMPLATE_MANUAL = 0

const	TEMPLATE_TWO_COLUMN = 1

const	TEMPLATE_THREE_COLUMN = 2

const	TEMPLATE_MAIN_SIDE = 3

const	TEMPLATE_TWO_BY_TWO = 4

Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilPageObject	$pg_obj

string	$hier_id = ""

DOMDocument	$dom

array bool null	$updated = null

string	$target_script = ""

string	$return_location = ""

ilPageConfig	$page_config = null

Protected Member Functions
	getGridTable ()

	getEditWidthsForm (string $id)

	saveWidths ()

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="")

Protected Attributes
ILIAS COPage InternalDomainService	$domain

ilToolbarGUI	$toolbar

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

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

Responsive Grid UI class.

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilPageContentGUI.

Definition at line 39 of file class.ilPCGridGUI.php.

      {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $ilToolbar = $DIC->toolbar();
        $ilTabs = $DIC->tabs();
 
        $this->toolbar = $ilToolbar;
        $this->tabs = $ilTabs;
        $this->domain = $DIC->copage()->internal()->domain();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addCell()

ilPCGridGUI::addCell ( )

Add cell.

Definition at line 308 of file class.ilPCGridGUI.php.

                             : void
    {
        $this->content_obj->addCell();
        $this->updated = $this->pg_obj->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("cont_added_cell"), true);
        $this->ctrl->redirect($this, "edit");
    }

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

Here is the call graph for this function:

◆ afterCreation()

ilPCGridGUI::afterCreation ( )

Definition at line 183 of file class.ilPCGridGUI.php.

                                   : void
    {
        $this->pg_obj->stripHierIDs();
        $this->pg_obj->addHierIDs();
        $this->ctrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
        $this->ctrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
        $this->content_obj->setHierId($this->content_obj->readHierId());
        $this->setHierId($this->content_obj->readHierId());
        $this->content_obj->setPcId($this->content_obj->readPCId());
        $this->edit();
    }

References ILIAS\Repository\ctrl(), edit(), and ilPageContentGUI\setHierId().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancelCellDeletion()

ilPCGridGUI::cancelCellDeletion ( )

Cancel cell deletion.

Definition at line 351 of file class.ilPCGridGUI.php.

                                        : void
    {
        $this->ctrl->redirect($this, "edit");
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ confirmCellDeletion()

ilPCGridGUI::confirmCellDeletion ( array $tids )

Confirm cell deletion.

Definition at line 320 of file class.ilPCGridGUI.php.

                                                    : void
    {
        $table = $this->getGridTable();
        $ids = $table->getItemIds();
 
        if (count($ids) === 0) {
            $this->ctrl->redirect($this, "edit");
        }
 
        $retrieval = $this->domain->pc()->gridCellRetrieval($this->content_obj);
        $data = $retrieval->getData([]);
        $items = [];
        $cnt = 1;
        foreach ($data as $row) {
            if (in_array($row["id"], $ids)) {
                $items[$row["id"]] = $this->lng->txt("cont_grid_cell") . " " . $cnt;
            }
            $cnt++;
        }
 
        $table->renderDeletionConfirmation(
            $this->lng->txt("delete"),
            $this->lng->txt("cont_grid_cell_confirm_deletion"),
            "deleteCells",
            $items
        );
    }

References $data, ILIAS\Repository\ctrl(), getGridTable(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ create()

ilPCGridGUI::create ( )

Create new grid element.

Definition at line 154 of file class.ilPCGridGUI.php.

                            : void
    {
        $form = $this->initCreationForm();
        if ($form->checkInput()) {
            $post_layout_template = (int) $form->getInput("layout_template");
            $this->content_obj = new ilPCGrid($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->applyTemplate(
                $post_layout_template,
                (int) $form->getInput("number_of_cells"),
                (int) $form->getInput("s"),
                (int) $form->getInput("m"),
                (int) $form->getInput("l"),
                (int) $form->getInput("xl")
            );
            $this->updated = $this->pg_obj->update();
 
            if ($this->updated === true) {
                $this->afterCreation();
                //$this->ctrl->returnToParent($this, "jump".$this->hier_id);
            } else {
                $this->insert();
            }
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }

References afterCreation(), ilPageContentGUI\getPage(), initCreationForm(), insert(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ deleteCells()

ilPCGridGUI::deleteCells ( )

Delete Cells.

Definition at line 359 of file class.ilPCGridGUI.php.

                                 : void
    {
        $ilCtrl = $this->ctrl;
 
        $table = $this->getGridTable();
        $ids = $table->getItemIds();
 
        foreach ($ids as $tid) {
            $ids = explode(":", $tid);
            $this->content_obj->deleteGridCell($ids[0], $ids[1]);
        }
        $this->updated = $this->pg_obj->update();
 
        $ilCtrl->redirect($this, "edit");
    }

References ilPageContentGUI\$ctrl, and getGridTable().

Here is the call graph for this function:

◆ edit()

ilPCGridGUI::edit ( )

List all cells.

Definition at line 203 of file class.ilPCGridGUI.php.

                          : void
    {
        $this->toolbar->addButton(
            $this->lng->txt("cont_add_cell"),
            $this->ctrl->getLinkTarget($this, "addCell")
        );
 
        $this->setTabs();
        $this->tabs->activateTab("settings");
 
        $table = $this->gui->pc()->gridCellTableBuilder(
            $this->content_obj,
            $this,
            "edit"
        )->getTable();
 
        if ($table->handleCommand()) {
            return;
        }
 
        $this->tpl->setContent($table->render());
    }

References ILIAS\Repository\lng(), setTabs(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Referenced by afterCreation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editWidths()

ilPCGridGUI::editWidths ( string $id )

Definition at line 252 of file class.ilPCGridGUI.php.

                                          : void
    {
        $form = $this->getEditWidthsForm($id);
        $this->gui->modal($this->lng->txt("cont_ed_grid_col_widths"))
            ->form($form)
            ->send();
    }

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

Here is the call graph for this function:

◆ executeCommand()

ilPCGridGUI::executeCommand ( )

Definition at line 57 of file class.ilPCGridGUI.php.

                                    : 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;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getEditWidthsForm()

ilPCGridGUI::getEditWidthsForm ( string $id )

protected

Definition at line 260 of file class.ilPCGridGUI.php.

                                                    : FormAdapterGUI
    {
        $this->ctrl->setParameter($this, "tid", $id);
        $options = ["" => ""] + ilPCGrid::getWidths();
 
        $data = $this->content_obj->getCellData();
        $row_data = [];
        foreach ($data as $row) {
            if ($row["hier_id"] . ":" . $row["pc_id"] === $id) {
                $row_data = $row;
                break;
            }
        }
 
        $form = $this->gui->form([self::class], "saveWidths");
        foreach (ilPCGrid::getSizes() as $s) {
            $form->select(
                "width_" . $s,
                $this->lng->txt("cont_grid_width_" . $s),
                $options,
                "",
                $row_data[$s] ?? ""
            );
        }
 
        return $form;
    }

References $data, $id, ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Repository\ctrl(), ilPCGrid\getSizes(), ilPCGrid\getWidths(), and ILIAS\Repository\lng().

Referenced by editWidths(), and saveWidths().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGridTable()

ilPCGridGUI::getGridTable ( )

protected

Definition at line 226 of file class.ilPCGridGUI.php.

                                     : TableAdapterGUI
    {
        return $this->gui->pc()->gridCellTableBuilder(
            $this->content_obj,
            $this,
            "edit"
        )->getTable();
    }

References ILIAS\Repository\Table\TableAdapterGUI\getTable().

Referenced by confirmCellDeletion(), deleteCells(), and savePositions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCreationForm()

ilPCGridGUI::initCreationForm ( )

Init creation form.

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

                                      : ilPropertyFormGUI
    {
        $lng = $this->lng;
 
        // edit form
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt("cont_ed_insert_grid"));
        $form->setDescription($this->lng->txt("cont_ed_insert_grid_info"));
 
        //
        $radg = new ilRadioGroupInputGUI($lng->txt("cont_pc_grid"), "layout_template");
        $radg->setValue(self::TEMPLATE_TWO_COLUMN);
        $op1 = new ilRadioOption($lng->txt("cont_grid_t_two_column"), self::TEMPLATE_TWO_COLUMN, $lng->txt("cont_grid_t_two_column_info"));
        $radg->addOption($op1);
        $op2 = new ilRadioOption($lng->txt("cont_grid_t_three_column"), self::TEMPLATE_THREE_COLUMN, $lng->txt("cont_grid_t_three_column_info"));
        $radg->addOption($op2);
        $op3 = new ilRadioOption($lng->txt("cont_grid_t_main_side"), self::TEMPLATE_MAIN_SIDE, $lng->txt("cont_grid_t_main_side_info"));
        $radg->addOption($op3);
        $op4 = new ilRadioOption($lng->txt("cont_grid_t_two_by_two"), self::TEMPLATE_TWO_BY_TWO, $lng->txt("cont_grid_t_two_by_two_info"));
        $radg->addOption($op4);
        $op5 = new ilRadioOption($lng->txt("cont_grid_t_manual"), self::TEMPLATE_MANUAL, $lng->txt("cont_grid_t_manual_info"));
        $radg->addOption($op5);
        $form->addItem($radg);
 
 
        // number of cells
        $ni = new ilNumberInputGUI($this->lng->txt("cont_grid_nr_cells"), "number_of_cells");
        $ni->setMaxLength(2);
        $ni->setSize(2);
        $op5->addSubItem($ni);
 
        /*$sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt("cont_ed_grid_col_width"));
        $sh->setInfo($this->lng->txt("cont_ed_grid_col_width_info"));
        $form->addItem($sh);*/
 
        $options = array("" => "") + ilPCGrid::getWidths();
 
        // widths
        foreach (ilPCGrid::getSizes() as $s) {
            $si = new ilSelectInputGUI($this->lng->txt("cont_grid_width_" . $s), $s);
            $si->setInfo($this->lng->txt("cont_grid_width_" . $s . "_info"));
            $si->setOptions($options);
            $op5->addSubItem($si);
        }
 
        // save/cancel buttons
        $form->addCommandButton("create", $this->lng->txt("save"));
        $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
 
        return $form;
    }

References ilPageContentGUI\$lng, ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Repository\ctrl(), ilPCGrid\getSizes(), ilPCGrid\getWidths(), ILIAS\Repository\lng(), and ilLanguage\txt().

Referenced by create(), and insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

ilPCGridGUI::insert ( )

Definition at line 72 of file class.ilPCGridGUI.php.

                            : void
    {
        $this->displayValidationError();
        $form = $this->initCreationForm();
        if ($this->ctrl->getCmd() == "create") {
            $form->setValuesByPost();
        }
        $this->tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), and initCreationForm().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveCellData()

ilPCGridGUI::saveCellData ( )

Save tabs properties in db and return to page edit screen.

Definition at line 392 of file class.ilPCGridGUI.php.

                                  : void
    {
        $width_s = $this->request->getStringArray("width_s");
        $width_m = $this->request->getStringArray("width_m");
        $width_l = $this->request->getStringArray("width_l");
        $width_xl = $this->request->getStringArray("width_xl");
        $this->content_obj->saveWidths($width_s, $width_m, $width_l, $width_xl);
 
        $pos = $this->request->getStringArray("position");
        if (count($pos) > 0) {
            $this->content_obj->savePositions($pos);
        }
        $this->updated = $this->pg_obj->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "edit");
    }

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

Here is the call graph for this function:

◆ savePositions()

ilPCGridGUI::savePositions ( )

Save positions.

Definition at line 238 of file class.ilPCGridGUI.php.

                                   : void
    {
        $table = $this->getGridTable();
 
        $ordered_ids = $table->getData();
 
        if (is_array($ordered_ids) && count($ordered_ids) > 0) {
            $this->content_obj->savePositions($ordered_ids);
        }
        $this->updated = $this->pg_obj->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "edit");
    }

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

Here is the call graph for this function:

◆ saveWidths()

ilPCGridGUI::saveWidths ( )

protected

Definition at line 288 of file class.ilPCGridGUI.php.

                                   : void
    {
        $id = $this->request->getString("tid");
        $form = $this->getEditWidthsForm($id);
        if ($form->isValid()) {
            $w_s = [$id => $form->getData("width_s")];
            $w_m = [$id => $form->getData("width_m")];
            $w_l = [$id => $form->getData("width_l")];
            $w_xl = [$id => $form->getData("width_xl")];
            $this->content_obj->saveWidths($w_s, $w_m, $w_l, $w_xl);
            $this->updated = $this->pg_obj->update();
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "edit");
        }
    }

References $id, ILIAS\Repository\ctrl(), getEditWidthsForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setTabs()

ilPCGridGUI::setTabs ( )

Definition at line 375 of file class.ilPCGridGUI.php.

                             : void
    {
        $this->tabs->setBackTarget(
            $this->lng->txt("pg"),
            $this->ctrl->getParentReturn($this)
        );
 
        $this->tabs->addTab(
            "settings",
            $this->lng->txt("settings"),
            $this->ctrl->getLinkTarget($this, "edit")
        );
    }

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

Referenced by edit().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $domain

ILIAS COPage InternalDomainService ilPCGridGUI::$domain

protected

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

◆ $tabs

ilTabsGUI ilPCGridGUI::$tabs

protected

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

◆ $toolbar

ilToolbarGUI ilPCGridGUI::$toolbar

protected

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

◆ TEMPLATE_MAIN_SIDE

const ilPCGridGUI::TEMPLATE_MAIN_SIDE = 3

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

Referenced by ilPCGrid\applyTemplate(), PCGridTest\getPageWithGrid(), PCGridTest\testCellData(), PCGridTest\testDelete(), PCGridTest\testPositions(), and PCGridTest\testWidths().

◆ TEMPLATE_MANUAL

const ilPCGridGUI::TEMPLATE_MANUAL = 0

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

Referenced by ilPCGrid\applyTemplate(), PCGridTest\testAddCell(), PCGridTest\testAddGridCell(), and PCGridTest\testApplyTemplateManual().

◆ TEMPLATE_THREE_COLUMN

const ilPCGridGUI::TEMPLATE_THREE_COLUMN = 2

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

Referenced by ilPCGrid\applyTemplate().

◆ TEMPLATE_TWO_BY_TWO

const ilPCGridGUI::TEMPLATE_TWO_BY_TWO = 4

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

Referenced by ilPCGrid\applyTemplate().

◆ TEMPLATE_TWO_COLUMN

const ilPCGridGUI::TEMPLATE_TWO_COLUMN = 1

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

Referenced by ilPCGrid\applyTemplate(), PageObjectTest\testAddHierIdsWithContent(), PCGridTest\testApplyTemplateTwoColumn(), and ILIAS\COPage\Test\ID\ContentIdManagerTest\testInsertPCIds().

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

components/ILIAS/COPage/PC/Grid/class.ilPCGridGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCell()

◆ afterCreation()

◆ cancelCellDeletion()

◆ confirmCellDeletion()

◆ create()

◆ deleteCells()

◆ edit()

◆ editWidths()

◆ executeCommand()

◆ getEditWidthsForm()

◆ getGridTable()

◆ initCreationForm()

◆ insert()

◆ saveCellData()

◆ savePositions()

◆ saveWidths()

◆ setTabs()

Field Documentation

◆ $domain

◆ $tabs

◆ $toolbar

◆ TEMPLATE_MAIN_SIDE

◆ TEMPLATE_MANUAL

◆ TEMPLATE_THREE_COLUMN

◆ TEMPLATE_TWO_BY_TWO

◆ TEMPLATE_TWO_COLUMN