ilPCDataTableGUI 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 ilPCDataTableGUI:

Collaboration diagram for ilPCDataTableGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	execute command More...
	update (bool $a_redirect=true)
	Update table data in dom and update page in db. More...
	updateJS ()
	Update via JavaScript. More...
	getNewTableObject ()
	Get new table object. More...
	afterCreation ()
	After creation processing. More...
	tableAction ()
	Perform operation on table (adding, moving, deleting rows/cols) More...
	setTabs (string $data_tab_txt_key="")
	Set tabs. More...
Public Member Functions inherited from ilPCTableGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	setBasicTableCellStyles ()
	executeCommand ()
	setTabs (string $data_tab_txt_key="")
	setCellPropertiesSubTabs ()
	getTemplateOptions (string $a_type="")
	edit ()
	editProperties ()
	initPropertiesForm (string $a_mode="edit")
	getPropertiesFormValues ()
	editCellStyle ()
	editCellWidth ()
	editCellSpan ()
	setStyles ()
	Set cell styles. More...
	setWidths ()
	Set cell widths. More...
	setSpans ()
	Set cell spans. More...
	setProperties ()
	Set properties from input form. More...
	saveProperties ()
	save table properties in db and return to page edit screen More...
	rightAlign ()
	leftAlign ()
	centerAlign ()
	leftFloatAlign ()
	rightFloatAlign ()
	insert ()
	getNewTableObject ()
	create ()
	create new table in dom and update page in db More...
	afterCreation ()
	editCellAlignment ()
	setAlignment ()
	Set cell alignments. More...
	editData ()
	Edit data of table. More...
	getEditDataTable (bool $initial=false)
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...

Protected Member Functions
	getFormTitle (string $a_mode="edit")
	getCellContent (int $i, int $j)
Protected Member Functions inherited from ilPCTableGUI
	getFormTitle (string $a_mode="edit")
	setEditorToolContext ()
	Set editor tool context. More...
	getColumnCaption (int $nr)
	getCellContent (int $i, int $j)
	renderCell ( $content, $unmask=true, $page_object=null)
	Static render table function. More...
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()

Protected Attributes
ILIAS HTTP Services	$http
ilGlobalTemplateInterface	$main_tpl
Protected Attributes inherited from ilPCTableGUI
ilPropertyFormGUI	$form
ilTabsGUI	$tabs
ilObjUser	$user
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
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 ilPCTableGUI
static	_renderTable (string $content, string $a_mode="table_edit", string $a_submode="", ilPCTable $a_table_obj=null, bool $unmask=true, ilPageObject $page_object=null)
static	_addStyleCheckboxes (string $a_output, ilPCTable $a_table)
	Add style checkboxes in edit mode. More...
static	_addAlignmentCheckboxes (string $a_output, ilPCTable $a_table)
	Add alignment checkboxes in edit mode. More...
static	_addWidthInputs (string $a_output, ilPCTable $a_table)
	Add width inputs. More...
static	_addSpanInputs (string $a_output, ilPCTable $a_table)
	Add span inputs. More...
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 = ""
php4DOMDocument	$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;"
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 ilPCTableGUI User Interface for Data Table Editing

Author

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

Definition at line 24 of file class.ilPCDataTableGUI.php.

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilPageContentGUI\setCharacteristics(), and ILIAS\Repository\tabs().

      {
        global $DIC;

        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->tabs = $DIC->tabs();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->setCharacteristics(array("StandardTable" => $this->lng->txt("cont_StandardTable")));
        $this->tool_context = $DIC->globalScreen()->tool()->context();
        $this->http = $DIC->http();
    }

Here is the call graph for this function:

Member Function Documentation

afterCreation()

ilPCDataTableGUI::afterCreation

(

)

After creation processing.

Definition at line 222 of file class.ilPCDataTableGUI.php.

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

                                   : void
    {
        $ilCtrl = $this->ctrl;

        $this->pg_obj->stripHierIDs();
        $this->pg_obj->addHierIDs();
        $ilCtrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
        $ilCtrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
        $ilCtrl->redirect($this, "editData");
    }

Here is the call graph for this function:

executeCommand()

ilPCDataTableGUI::executeCommand

(

)

execute command

Returns

mixed

Definition at line 59 of file class.ilPCDataTableGUI.php.

References ILIAS\Repository\ctrl(), and ilPageContentGUI\getCharacteristicsOfCurrentStyle().

    {
        $this->getCharacteristicsOfCurrentStyle(["table"]);     // scorm-2004

        // 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:
                $ret = $this->$cmd();
                break;
        }

        return $ret;
    }

Here is the call graph for this function:

getCellContent()

ilPCDataTableGUI::getCellContent ( int  $i, int  $j  )

protected

Definition at line 266 of file class.ilPCDataTableGUI.php.

References ILIAS\Repository\ctrl(), ilUtil\stripSlashes(), ilPCParagraph\xml2output(), and ilPCParagraphGUI\xml2outputJS().

                                                     : string
    {
        $cmd = $this->ctrl->getCmd();
        if ($cmd == "update") {
            $s_text = ilUtil::stripSlashes("cell_" . $i . "_" . $j, false);
        } else {
            $s_text = ilPCParagraph::xml2output(
                $this->content_obj->getCellText($i, $j),
                true,
                false
            );
            include_once("./Services/COPage/classes/class.ilPCParagraphGUI.php");
            $s_text = ilPCParagraphGUI::xml2outputJS(
                $s_text,
                "TableContent",
                $this->content_obj->readPCId() . "_" . $i . "_" . $j
            );
        }

        // #20628
        $s_text = str_replace("{", "{", $s_text);
        $s_text = str_replace("}", "}", $s_text);
        return $s_text;
    }

Here is the call graph for this function:

getFormTitle()

ilPCDataTableGUI::getFormTitle ( string  $a_mode = "edit" )

protected

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

References ILIAS\Repository\lng().

                                                            : string
    {
        if ($a_mode === "create") {
            return $this->lng->txt("cont_ed_insert_dtab");
        }
        return $this->lng->txt("cont_table_properties");
    }

Here is the call graph for this function:

getNewTableObject()

ilPCDataTableGUI::getNewTableObject

(

)

Get new table object.

Definition at line 214 of file class.ilPCDataTableGUI.php.

References ilPageContentGUI\getPage().

                                       : ilPCDataTable
    {
        return new ilPCDataTable($this->getPage());
    }

Here is the call graph for this function:

setTabs()

ilPCDataTableGUI::setTabs

(

string

$data_tab_txt_key = ""

)

Set tabs.

Definition at line 261 of file class.ilPCDataTableGUI.php.

                                                          : void
    {
        parent::setTabs("cont_ed_edit_data");
    }

tableAction()

ilPCDataTableGUI::tableAction

(

)

Perform operation on table (adding, moving, deleting rows/cols)

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

References ilPageContentGUI\$ctrl, $id, $type, and update().

                                 : void
    {
        $ilCtrl = $this->ctrl;

        $this->update(false);
        $this->pg_obj->addHierIDs();

        $type = $this->request->getString("type");
        $action = $this->request->getString("action");
        $id = $this->request->getInt("id");

        $cell_hier_id = ($type == "col")
            ? $this->hier_id . "_1_" . ($id + 1)
            : $this->hier_id . "_" . ($id + 1) . "_1";
        $cell_obj = $this->pg_obj->getContentObject($cell_hier_id);
        if (is_object($cell_obj)) {
            $cell_obj->$action();
            $this->edit_repo->setPageError($this->pg_obj->update());
        }
        $ilCtrl->redirect($this, "editData");
    }

Here is the call graph for this function:

update()

ilPCDataTableGUI::update

(

bool

$a_redirect = true

)

Update table data in dom and update page in db.

Definition at line 86 of file class.ilPCDataTableGUI.php.

References $data, $i, ilPageContentGUI\$lng, ilPCParagraph\_input2xml(), ILIAS\Repository\ctrl(), ilPCTableGUI\editData(), and ilLanguage\txt().

Referenced by tableAction().

                                                   : void
    {
        $lng = $this->lng;

        // handle input data
        $data = array();
        $cell = $this->request->getArrayArray("cell");
        if (is_array($cell)) {
            foreach ($cell as $i => $row) {
                if (is_array($row)) {
                    foreach ($row as $j => $cell) {
                        $data[$i][$j] =
                            ilPCParagraph::_input2xml(
                                $cell,
                                $this->content_obj->getLanguage()
                            );
                    }
                }
            }
        }

        $this->updated = $this->content_obj->setData($data);

        if ($this->updated !== true) {
            $this->editData();
            return;
        }

        $this->updated = $this->pg_obj->update();

        if ($a_redirect) {
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
            $this->ctrl->redirect($this, "editData");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateJS()

ilPCDataTableGUI::updateJS

(

)

Update via JavaScript.

Definition at line 125 of file class.ilPCDataTableGUI.php.

References ilPageContentGUI\$ctrl, $data, $id, ilPageContentGUI\$lng, $post, ilPCParagraph\_input2xml(), ILIAS\Repository\ctrl(), ilPCTableGUI\editData(), ilPCParagraph\handleAjaxContent(), ilPCParagraph\handleAjaxContentPost(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ilUtil\stripSlashes(), and ilLanguage\txt().

                              : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        if ($this->request->getString("cancel_update") != "") {
            //                  $this->ctrl->redirect($this, "editData");
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        }

        // handle input data
        $data = array();
        $post = $this->http->request()->getParsedBody();
        foreach ($post as $k => $content) {
            if (substr($k, 0, 5) != "cell_") {
                continue;
            }

            // determine cell content
            $div = ilUtil::stripSlashes($content, false);
            $p1 = strpos($div, '>');
            $div = substr($div, $p1 + 1);
            $div = "<div class='ilc_text_block_TableContent'>" . $div;
            $text = ilPCParagraph::handleAjaxContent($div);
            if ($text === false) {
                $ilCtrl->returnToParent($this, "jump" . $this->hier_id);
            }
            $text = $text["text"];

            $text = ilPCParagraph::_input2xml(
                $text,
                $this->content_obj->getLanguage(),
                true,
                false
            );
            $text = ilPCParagraph::handleAjaxContentPost($text);

            // set content in data array
            $id = explode("_", $k);
            $data[(int) $id[1]][(int) $id[2]] = $text;
        }

        // update data
        $this->updated = $this->content_obj->setData($data);

        if ($this->updated !== true) {
            $this->editData();
            return;
        }

        $this->updated = $this->pg_obj->update();

        $tab_cmd_id = $this->request->getInt("tab_cmd_id");
        $tab_cmd_type = $this->request->getString("tab_cmd_type");
        $tab_cmd = $this->request->getString("tab_cmd");

        // perform table action? (move...?)
        //$this->update(false);
        $this->pg_obj->addHierIDs();
        $failed = false;
        if ($tab_cmd != "") {
            $cell_hier_id = ($tab_cmd_type == "col")
                ? $this->hier_id . "_1_" . ($tab_cmd_id + 1)
                : $this->hier_id . "_" . ($tab_cmd_id + 1) . "_1";
            $cell_obj = $this->pg_obj->getContentObject($cell_hier_id);
            if (is_object($cell_obj)) {
                $cell_obj->$tab_cmd();
                $ret = $this->pg_obj->update();
                if ($ret !== true) {
                    $this->main_tpl->setOnScreenMessage('failure', $ret[0][1], true);
                    $failed = true;
                }
            }
        }

        if (!$failed) {
            $this->main_tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }
        if ($this->request->getString("save_return") != "") {
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        } else {
            $this->ctrl->redirect($this, "editData");
        }
    }

Here is the call graph for this function:

Field Documentation

$http

ILIAS HTTP Services ilPCDataTableGUI::$http

protected

Definition at line 26 of file class.ilPCDataTableGUI.php.

$main_tpl

ilGlobalTemplateInterface ilPCDataTableGUI::$main_tpl

protected

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

---

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

• Services/COPage/classes/class.ilPCDataTableGUI.php