ilPCGridGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. 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 ()
	saveCells ()
	Save cell properties. More...
	addCell ()
	Add cell. More...
	confirmCellDeletion ()
	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
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null

Protected Attributes
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;"
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 Responsive Grid UI class

Author

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

Definition at line 24 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 35 of file class.ilPCGridGUI.php.

      {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $ilToolbar = $DIC->toolbar();
        $ilTabs = $DIC->tabs();
 
        $this->toolbar = $ilToolbar;
        $this->tabs = $ilTabs;
        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 230 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 178 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(), 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 270 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

(

)

Confirm cell deletion.

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

                                         : void
    {
        $this->setTabs();
 
        $tid = $this->request->getStringArray("tid");
        if (count($tid) == 0) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_checkbox"), true);
            $this->ctrl->redirect($this, "edit");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($this->ctrl->getFormAction($this));
            $cgui->setHeaderText($this->lng->txt("cont_grid_cell_confirm_deletion"));
            $cgui->setCancel($this->lng->txt("cancel"), "cancelCellDeletion");
            $cgui->setConfirm($this->lng->txt("delete"), "deleteCells");
 
            foreach ($tid as $k => $i) {
                $id = explode(":", $k);
                $id = explode("_", $id[0]);
                $cgui->addItem("tid[]", $k, $this->lng->txt("cont_grid_cell") . " " . $id[count($id) - 1]);
            }
 
            $this->tpl->setContent($cgui->getHTML());
        }
    }

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

Here is the call graph for this function:

create()

ilPCGridGUI::create

(

)

Create new grid element.

Definition at line 149 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 278 of file class.ilPCGridGUI.php.

                                 : void
    {
        $ilCtrl = $this->ctrl;
 
        $tids = $this->request->getStringArray("tid");
        foreach ($tids 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.

executeCommand()

ilPCGridGUI::executeCommand

(

)

Definition at line 52 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:

initCreationForm()

ilPCGridGUI::initCreationForm

(

)

Init creation form.

Definition at line 92 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\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 67 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 309 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:

saveCells()

ilPCGridGUI::saveCells

(

)

Save cell properties.

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

                               : void
    {
        $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:

setTabs()

ilPCGridGUI::setTabs

(

)

Definition at line 292 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 confirmCellDeletion().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$tabs

ilTabsGUI ilPCGridGUI::$tabs

protected

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

$toolbar

ilToolbarGUI ilPCGridGUI::$toolbar

protected

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

TEMPLATE_MAIN_SIDE

const ilPCGridGUI::TEMPLATE_MAIN_SIDE = 3

Definition at line 29 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 26 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 28 of file class.ilPCGridGUI.php.

Referenced by ilPCGrid\applyTemplate().

TEMPLATE_TWO_BY_TWO

const ilPCGridGUI::TEMPLATE_TWO_BY_TWO = 4

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

Referenced by ilPCGrid\applyTemplate().

TEMPLATE_TWO_COLUMN

const ilPCGridGUI::TEMPLATE_TWO_COLUMN = 1

Definition at line 27 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