ilPCDataTableGUI Class Reference

Class ilPCTableGUI. More...

Inheritance diagram for ilPCDataTableGUI:

Collaboration diagram for ilPCDataTableGUI:

Public Member Functions
	__construct (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	executeCommand ()
	execute command More...
	editDataCl ()
	Edit data of table. More...
	update ($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 ($data_tab_txt_key="")
	Set tabs. More...
Public Member Functions inherited from ilPCTableGUI
	__construct (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_pc_id="")
	Constructor public. More...
	setBasicTableCellStyles ()
	Set basic table cell styles. More...
	executeCommand ()
	execute command More...
	setTabs ($data_tab_txt_key="")
	Set tabs. More...
	setCellPropertiesSubTabs ()
	Set tabs. More...
	getTemplateOptions ($a_type="")
	Get table templates. More...
	edit ()
	editProperties ()
	edit properties form More...
	initPropertiesForm ($a_mode="edit")
	Init properties form. More...
	getPropertiesFormValues ()
	Get properties form. More...
	renderTable ($a_mode="table_edit", $a_submode="")
	Render the table. More...
	editCellStyle ()
	Edit cell styles. More...
	editCellWidth ()
	Edit cell widths. More...
	editCellSpan ()
	Edit cell spans. More...
	setStyles ()
	Set cell styles and. 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 ()
	align table to right More...
	leftAlign ()
	align table to left More...
	centerAlign ()
	align table to left More...
	leftFloatAlign ()
	align table to left float More...
	rightFloatAlign ()
	align table to left More...
	insert ()
	insert new table form More...
	getNewTableObject ()
	Get new table object. More...
	create ()
	create new table in dom and update page in db More...
	afterCreation ()
	After creation processing. More...
	editCellAlignment ()
	Edit cell styles. More...
	setAlignment ()
	Set cell alignments. More...
	editData ()
	Edit data of table. More...
	getEditDataTable ($initial=false)
Public Member Functions inherited from ilPageContentGUI
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	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 ()
	display validation errors More...
	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 ($a_type)
	Get table templates. More...

Protected Member Functions
	getCellContent (int $i, int $j)
Protected Member Functions inherited from ilPCTableGUI
	setEditorToolContext ()
	Set editor tool context. More...
	getCellContent (int $i, int $j)
	renderCell ( $content, $unmask=true, $page_object=null)
	Static render table function. More...
	getColumnCaption (int $nr)
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent ($hier_id="")
	Redirect to parent. More...
	getParentReturn ($hier_id="")

Protected Attributes
	$tabs
	$main_tpl
Protected Attributes inherited from ilPCTableGUI
	$tabs
	$user
	$tool_context
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilPCTableGUI
static	_renderTable ( $content, $a_mode="table_edit", $a_submode="", $a_table_obj=null, $unmask=true, $page_object=null)
	Static render table function. More...
static	_addStyleCheckboxes ($a_output, $a_table)
	Add style checkboxes in edit mode. More...
static	_addAlignmentCheckboxes ($a_output, $a_table)
	Add alignment checkboxes in edit mode. More...
static	_addWidthInputs ($a_output, $a_table)
	Add width inputs. More...
static	_addSpanInputs ($a_output, $a_table)
	Add span inputs. More...
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$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	$common_bb_buttons

Detailed Description

Class ilPCTableGUI.

User Interface for Data Table Editing

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilPCDataTableGUI::__construct	(	&	$a_pg_obj,
		&	$a_content_obj,
			$a_hier_id,
			$a_pc_id = ""
	)

Constructor public.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilPageContentGUI\setCharacteristics().

    {
        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();
    }

Here is the call graph for this function:

Member Function Documentation

afterCreation()

ilPCDataTableGUI::afterCreation

(

)

After creation processing.

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

References ilPageContentGUI\$ctrl.

    {
        $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");
    }

editDataCl()

ilPCDataTableGUI::editDataCl

(

)

Edit data of table.

(classic version)

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

References $_POST, ilPageContentGUI\$ctrl, $i, ilPageContentGUI\$lng, $res, ilPageContentGUI\$tpl, $type, ilPageContentGUI\displayValidationError(), ilPageContentGUI\getBBMenu(), ilPageContentGUI\getHierId(), ilUtil\getImagePath(), ilYuiUtil\initConnection(), ilYuiUtil\initDragDrop(), ilYuiUtil\initPanel(), setTabs(), ilUtil\stripSlashes(), ilPCParagraph\xml2output(), xpath_eval(), and xpath_new_context().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        //var_dump($_GET);
        //var_dump($_POST);

        $this->setTabs();

        $this->displayValidationError();
        
        include_once("./Services/COPage/classes/class.ilPCParagraph.php");
        
        $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.tabledata.html", "Services/COPage");
        $dtpl = $this->tpl;
        //$dtpl = new ilTemplate("tpl.tabledata.html", true, true, "Services/COPage");
        $dtpl->setVariable("FORMACTION", $this->ctrl->getFormAction($this, "tableAction"));
        $dtpl->setVariable("BB_MENU", $this->getBBMenu("cell_0_0"));

        ilYuiUtil::initDragDrop();
        ilYuiUtil::initConnection();
        ilYuiUtil::initPanel(false);
        $this->tpl->addJavascript("./Services/COPage/phpBB/3_0_5/editor.js");
        //$this->tpl->addJavascript("./Services/COPage/js/page_editing.js");
        $this->tpl->addJavascript("./Services/COPage/js/paragraph_editing.js");

        // get all rows
        $xpc = xpath_new_context($this->dom);
        $path = "//PageContent[@HierId='" . $this->getHierId() . "']" .
            "/Table/TableRow";
        $res = xpath_eval($xpc, $path);

        for ($i = 0; $i < count($res->nodeset); $i++) {
            $xpc2 = xpath_new_context($this->dom);
            $path2 = "//PageContent[@HierId='" . $this->getHierId() . "']" .
                "/Table/TableRow[$i+1]/TableData";
            $res2 = xpath_eval($xpc2, $path2);
            
            // if this is the first row -> col icons
            if ($i == 0) {
                for ($j = 0; $j < count($res2->nodeset); $j++) {
                    if ($j == 0) {
                        $dtpl->touchBlock("empty_td");
                    }

                    if ($j == 0) {
                        if (count($res2->nodeset) == 1) {
                            $move_type = "none";
                        } else {
                            $move_type = "forward";
                        }
                    } elseif ($j == (count($res2->nodeset) - 1)) {
                        $move_type = "backward";
                    } else {
                        $move_type = "both";
                    }
                    $dtpl->setCurrentBlock("col_icon");
                    $dtpl->setVariable("COL_ICON_ALT", $lng->txt("content_column"));
                    $dtpl->setVariable("COL_ICON", ilUtil::getImagePath("col.svg"));
                    $dtpl->setVariable("COL_ONCLICK", "COL_" . $move_type);
                    $dtpl->setVariable("NR", $j);
                    $dtpl->parseCurrentBlock();
                }
                $dtpl->setCurrentBlock("row");
                $dtpl->parseCurrentBlock();
            }


            for ($j = 0; $j < count($res2->nodeset); $j++) {
                // first col: row icons
                if ($j == 0) {
                    if ($i == 0) {
                        if (count($res->nodeset) == 1) {
                            $move_type = "none";
                        } else {
                            $move_type = "forward";
                        }
                    } elseif ($i == (count($res->nodeset) - 1)) {
                        $move_type = "backward";
                    } else {
                        $move_type = "both";
                    }
                    $dtpl->setCurrentBlock("row_icon");
                    $dtpl->setVariable("ROW_ICON_ALT", $lng->txt("content_row"));
                    $dtpl->setVariable("ROW_ICON", ilUtil::getImagePath("row.svg"));
                    $dtpl->setVariable("ROW_ONCLICK", "ROW_" . $move_type);
                    $dtpl->setVariable("NR", $i);
                    $dtpl->parseCurrentBlock();
                }
                
                // cell
                if ($res2->nodeset[$j]->get_attribute("Hidden") != "Y") {
                    $dtpl->setCurrentBlock("cell");
                    
                    if (is_array($_POST["cmd"]) && key($_POST["cmd"]) == "update") {
                        $s_text = ilUtil::stripSlashes("cell_" . $i . "_" . $j, false);
                    } else {
                        $s_text = ilPCParagraph::xml2output($this->content_obj->getCellText($i, $j));
                    }
    
                    $dtpl->setVariable("PAR_TA_NAME", "cell[" . $i . "][" . $j . "]");
                    $dtpl->setVariable("PAR_TA_ID", "cell_" . $i . "_" . $j);
                    $dtpl->setVariable("PAR_TA_CONTENT", $s_text);
                    
                    $cs = $res2->nodeset[$j]->get_attribute("ColSpan");
                    $rs = $res2->nodeset[$j]->get_attribute("RowSpan");
                    //                                  $dtpl->setVariable("WIDTH", "140");
                    //                                  $dtpl->setVariable("HEIGHT", "80");
                    if ($cs > 1) {
                        $dtpl->setVariable("COLSPAN", 'colspan="' . $cs . '"');
                        $dtpl->setVariable("WIDTH", (140 + ($cs - 1) * 146));
                    }
                    if ($rs > 1) {
                        $dtpl->setVariable("ROWSPAN", 'rowspan="' . $rs . '"');
                        $dtpl->setVariable("HEIGHT", (80 + ($rs - 1) * 86));
                    }
                    $dtpl->parseCurrentBlock();
                }
            }
            $dtpl->setCurrentBlock("row");
            $dtpl->parseCurrentBlock();
        }
        
        // init menues
        $types = array("row", "col");
        $moves = array("none", "backward", "both", "forward");
        $commands = array(
            "row" => array(     "newRowAfter" => "cont_ed_new_row_after",
                            "newRowBefore" => "cont_ed_new_row_before",
                            "moveRowUp" => "cont_ed_row_up",
                            "moveRowDown" => "cont_ed_row_down",
                            "deleteRow" => "cont_ed_delete_row"),
            "col" => array(     "newColAfter" => "cont_ed_new_col_after",
                            "newColBefore" => "cont_ed_new_col_before",
                            "moveColLeft" => "cont_ed_col_left",
                            "moveColRight" => "cont_ed_col_right",
                            "deleteCol" => "cont_ed_delete_col")
        );
        foreach ($types as $type) {
            foreach ($moves as $move) {
                foreach ($commands[$type] as $command => $lang_var) {
                    if ($move == "none" && (substr($command, 0, 4) == "move" || substr($command, 0, 6) == "delete")) {
                        continue;
                    }
                    if (($move == "backward" && (in_array($command, array("movedown", "moveright")))) ||
                        ($move == "forward" && (in_array($command, array("moveup", "moveleft"))))) {
                        continue;
                    }
                    $this->tpl->setCurrentBlock("menu_item");
                    $this->tpl->setVariable("MENU_ITEM_TITLE", $lng->txt($lang_var));
                    $this->tpl->setVariable("CMD", $command);
                    $this->tpl->setVariable("TYPE", $type);
                    $this->tpl->parseCurrentBlock();
                }
                $this->tpl->setCurrentBlock("menu");
                $this->tpl->setVariable("TYPE", $type);
                $this->tpl->setVariable("MOVE", $move);
                $this->tpl->parseCurrentBlock();
            }
        }
        
        // update/cancel
        $this->tpl->setCurrentBlock("commands");
        $this->tpl->setVariable("BTN_NAME", "update");
        $this->tpl->setVariable("BTN_TEXT", $this->lng->txt("save"));
        $this->tpl->parseCurrentBlock();
        
        $this->tpl->setVariable(
            "FORMACTION2",
            $ilCtrl->getFormAction($this, "tableAction")
        );
        $this->tpl->setVariable("TXT_ACTION", $this->lng->txt("cont_table"));
    }

Here is the call graph for this function:

executeCommand()

ilPCDataTableGUI::executeCommand

(

)

execute command

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

References $ret, 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 437 of file class.ilPCDataTableGUI.php.

References $_POST, ilUtil\stripSlashes(), ilPCParagraph\xml2output(), and ilPCParagraphGUI\xml2outputJS().

                                                      : string
    {
        if (is_array($_POST["cmd"]) && key($_POST["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:

getNewTableObject()

ilPCDataTableGUI::getNewTableObject

(

)

Get new table object.

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

References ilPageContentGUI\getPage().

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

Here is the call graph for this function:

setTabs()

ilPCDataTableGUI::setTabs

(

$data_tab_txt_key = ""

)

Set tabs.

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

References ilPageContentGUI\$ctrl, and $tabs.

Referenced by editDataCl().

    {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        
        parent::setTabs("cont_ed_edit_data");
    }

Here is the caller graph for this function:

tableAction()

ilPCDataTableGUI::tableAction

(

)

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

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

References $_POST, $_SESSION, ilPageContentGUI\$ctrl, and update().

    {
        $ilCtrl = $this->ctrl;

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

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

Here is the call graph for this function:

update()

ilPCDataTableGUI::update

(

$a_redirect = true

)

Update table data in dom and update page in db.

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

References $_POST, $data, $i, ilPageContentGUI\$lng, ilPCParagraph\_input2xml(), and ilPCTableGUI\editData().

Referenced by tableAction().

    {
        $lng = $this->lng;

        // handle input data
        include_once("./Services/COPage/classes/class.ilPCParagraph.php");
        $data = array();
        //var_dump($_POST["cell"]);
        //var_dump($_GET);
        if (is_array($_POST["cell"])) {
            foreach ($_POST["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) {
            ilUtil::sendSuccess($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 297 of file class.ilPCDataTableGUI.php.

References $_POST, ilPageContentGUI\$ctrl, $data, $failed, ilPageContentGUI\$lng, $ret, ilPCParagraph\_input2xml(), ilPCTableGUI\editData(), ilPCParagraph\handleAjaxContent(), ilPCParagraph\handleAjaxContentPost(), ilUtil\sendFailure(), and ilUtil\stripSlashes().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
                
        if ($_POST["cancel_update"]) {
            //                  $this->ctrl->redirect($this, "editData");
            $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
        }

        // handle input data
        include_once("./Services/COPage/classes/class.ilPCParagraph.php");
        include_once("./Services/COPage/classes/class.ilPCParagraphGUI.php");
        $data = array();
        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();

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

        if (!$failed) {
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        }
        if ($_POST["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

$main_tpl

ilPCDataTableGUI::$main_tpl

protected

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

$tabs

ilPCDataTableGUI::$tabs

protected

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

Referenced by setTabs().

---

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

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