ILIAS\COPage\PC\Table\TableCommandActionHandler Class Reference

Inheritance diagram for ILIAS\COPage\PC\Table\TableCommandActionHandler:

Collaboration diagram for ILIAS\COPage\PC\Table\TableCommandActionHandler:

Public Member Functions
	__construct (\ilPageObjectGUI $page_gui)
	handle (array $query, array $body)
	sendUpdateResponse (\ilPageObjectGUI $page_gui, $updated, string $pcid)
	sendTable (\ilPageObjectGUI $page_gui, string $pcid)
	Send whole table as response. More...

Protected Member Functions
	insertCommand (array $body)
	setRowHeaderAndCharacteristic (\ilPCTable $tab, array $body)
	importSpreadsheet (array $body)
	updateDataCommand (array $body)
	updateData (string $pcid, array $content)

Protected Attributes
ILIAS DI UIServices	$ui
ilLanguage	$lng
ilPageObjectGUI	$page_gui
ilObjUser	$user
Server UIWrapper	$ui_wrapper

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\COPage\PC\Table\TableCommandActionHandler::__construct

(

\ilPageObjectGUI

$page_gui

)

Definition at line 35 of file class.TableCommandActionHandler.php.

References $DIC, ILIAS\COPage\PC\Table\TableCommandActionHandler\$page_gui, ILIAS\Repository\lng(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->ui = $DIC->ui();
        $this->lng = $DIC->language();
        $this->page_gui = $page_gui;
        $this->user = $DIC->user();

        $this->ui_wrapper = new Server\UIWrapper($this->ui, $this->lng);
    }

Here is the call graph for this function:

Member Function Documentation

handle()

ILIAS\COPage\PC\Table\TableCommandActionHandler::handle	(	array	$query,
		array	$body
	)

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

References ILIAS\COPage\PC\Table\TableCommandActionHandler\insertCommand(), and ILIAS\COPage\PC\Table\TableCommandActionHandler\updateDataCommand().

                                                     : Server\Response
    {
        switch ($body["action"]) {
            case "insert":
                return $this->insertCommand($body);

            case "update.data":
                return $this->updateDataCommand($body);

            case "modify.table":
                return $this->modifyTableCommand($body);

            case "update":
                return $this->updateCommand($body);

            case "set.properties":
                return $this->setCellProperties($body);

            case "toggle.merge":
                return $this->toggleMerge($body);

            default:
                throw new Exception("Unknown action " . $body["action"]);
        }
    }

Here is the call graph for this function:

importSpreadsheet()

ILIAS\COPage\PC\Table\TableCommandActionHandler::importSpreadsheet ( array  $body )

protected

Definition at line 133 of file class.TableCommandActionHandler.php.

References ILIAS\COPage\PC\Table\TableCommandActionHandler\setRowHeaderAndCharacteristic(), and ILIAS\Repository\user().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\insertCommand().

                                                     : Server\Response
    {
        $page = $this->page_gui->getPageObject();

        $hier_id = "pg";
        $pc_id = "";
        if (!in_array($body["after_pcid"], ["", "pg"])) {
            $hier_ids = $page->getHierIdsForPCIds([$body["after_pcid"]]);
            $hier_id = $hier_ids[$body["after_pcid"]];
            $pc_id = $body["after_pcid"];
        }

        $tab = new \ilPCDataTable($page);
        $tab->create($page, $hier_id, $pc_id);
        $tab->setLanguage($this->user->getLanguage());

        $this->setRowHeaderAndCharacteristic($tab, $body);

        $table_data = $body["import_table"] ?? "";

        $tab->importSpreadsheet($this->user->getLanguage(), trim($table_data));

        $updated = $page->update();

        return $this->ui_wrapper->sendPage($this->page_gui, $updated);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insertCommand()

ILIAS\COPage\PC\Table\TableCommandActionHandler::insertCommand ( array  $body )

protected

Definition at line 73 of file class.TableCommandActionHandler.php.

References $lang, ILIAS\COPage\PC\Table\TableCommandActionHandler\importSpreadsheet(), ILIAS\COPage\PC\Table\TableCommandActionHandler\setRowHeaderAndCharacteristic(), and ILIAS\Repository\user().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\handle().

                                                 : Server\Response
    {
        if (($body["import"] ?? "") === "1") {
            return $this->importSpreadsheet($body);
        }

        $page = $this->page_gui->getPageObject();

        $hier_id = "pg";
        $pc_id = "";
        if (!in_array($body["after_pcid"], ["", "pg"])) {
            $hier_ids = $page->getHierIdsForPCIds([$body["after_pcid"]]);
            $hier_id = $hier_ids[$body["after_pcid"]];
            $pc_id = $body["after_pcid"];
        }

        $tab = new \ilPCDataTable($page);
        $tab->create($page, $hier_id, $pc_id);
        $lang = $this->user->getLanguage();
        if ($lang === "") {
            $lang = "en";
        }
        $tab->setLanguage($lang);


        $tab->addRows(
            (int) ($body["nr_rows"] ?? 1),
            (int) ($body["nr_cols"] ?? 1)
        );


        $this->setRowHeaderAndCharacteristic($tab, $body);

        $updated = $page->update();

        return $this->ui_wrapper->sendPage($this->page_gui, $updated);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendTable()

ILIAS\COPage\PC\Table\TableCommandActionHandler::sendTable	(	\ilPageObjectGUI	$page_gui,
		string	$pcid
	)

Send whole table as response.

Definition at line 319 of file class.TableCommandActionHandler.php.

References $data, ilPageObjectGUI\getPageObject(), ilPageObjectGUI\getStyleId(), ILIAS\Repository\int(), and ILIAS\COPage\PC\Table\TableCommandActionHandler\setRowHeaderAndCharacteristic().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\updateData().

     : Server\Response {
        $page = $page_gui->getPageObject();
        $page->addHierIDs();
        $table = $page->getContentObjectForPcId($pcid);
        if ($table->getType() == "dtab") {
            $table_gui = new \ilPCDataTableGUI(
                $page_gui->getPageObject(),
                $table,
                $page->getHierIdForPcId($pcid),
                $pcid
            );
        } else {
            $table_gui = new \ilPCTableGUI(
                $page_gui->getPageObject(),
                $table,
                $page->getHierIdForPcId($pcid),
                $pcid
            );
        }
        $table_gui->setStyleId($page_gui->getStyleId());
        $data = new \stdClass();
        $data->renderedContent = $table_gui->getEditDataTable();
        $data->pcModel = $page_gui->getPageObject()->getPCModel();
        return new Server\Response($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendUpdateResponse()

ILIAS\COPage\PC\Table\TableCommandActionHandler::sendUpdateResponse	(	\ilPageObjectGUI	$page_gui,
			$updated,
		string	$pcid
	)

Parameters

string | bool | array

$updated

Exceptions

Definition at line 174 of file class.TableCommandActionHandler.php.

References $data, ILIAS\$error, ilDatePresentation\formatDate(), ilPageObjectGUI\getPageObject(), IL_CAL_DATETIME, null, and ilDatePresentation\setUseRelativeDates().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\updateDataCommand().

     : Server\Response {
        $error = null;

        $last_change = null;
        if ($updated !== true) {
            if (is_array($updated)) {
                $error = implode("<br />", $updated);
            } elseif (is_string($updated)) {
                $error = $updated;
            } else {
                $error = print_r($updated, true);
            }
        } else {
            $last_change = $page_gui->getPageObject()->getLastChange();
        }

        $data = new \stdClass();
        $data->error = $error;
        if ($last_change) {
            $lu = new \ilDateTime($last_change, IL_CAL_DATETIME);
            \ilDatePresentation::setUseRelativeDates(false);
            $data->last_update = \ilDatePresentation::formatDate($lu, true);
        }

        return new Server\Response($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setRowHeaderAndCharacteristic()

ILIAS\COPage\PC\Table\TableCommandActionHandler::setRowHeaderAndCharacteristic ( \ilPCTable  $tab, array  $body  )

protected

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

References ilPCTable\setClass(), ilPCTable\setHeaderRows(), and ilPCTable\setTemplate().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\importSpreadsheet(), ILIAS\COPage\PC\Table\TableCommandActionHandler\insertCommand(), and ILIAS\COPage\PC\Table\TableCommandActionHandler\sendTable().

                                                                                  : void
    {
        if ($body["has_row_header"] ?? false) {
            $tab->setHeaderRows(1);
        }
        $characteristic = ($body["characteristic"] ?? "");
        if ($characteristic === "" && isset($body["import_characteristic"])) {
            $characteristic = $body["import_characteristic"];
        }
        if ($characteristic === "") {
            $characteristic = "StandardTable";
        }
        if (strpos($characteristic, ":") > 0) {
            $t = explode(":", $characteristic);
            $tab->setTemplate($t[2]);
            $tab->setClass("");
        } else {
            $tab->setClass($characteristic);
            $tab->setTemplate("");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateData()

ILIAS\COPage\PC\Table\TableCommandActionHandler::updateData ( string  $pcid, array  $content  )

protected

Returns

array|bool

Exceptions

Definition at line 210 of file class.TableCommandActionHandler.php.

References $data, ilPCParagraph\_input2xml(), ilPCParagraph\handleAjaxContent(), ilPCParagraph\handleAjaxContentPost(), and ILIAS\COPage\PC\Table\TableCommandActionHandler\sendTable().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\updateDataCommand().

      {
        $page = $this->page_gui->getPageObject();
        $table = $page->getContentObjectForPcId($pcid);

        $data = [];
        $updated = true;
        foreach ($content as $i => $row) {
            if (is_array($row)) {
                foreach ($row as $j => $cell) {
                    $text = "<div>" . $cell . "</div>";
                    if ($updated) {
                        // determine cell content
                        $text = \ilPCParagraph::handleAjaxContent($text);
                        $data[$i][$j] = $text;
                        $updated = (!is_null($text));
                        $text = $text["text"];
                    }
                    if ($updated) {
                        $text = \ilPCParagraph::_input2xml(
                            $text,
                            $table->getLanguage(),
                            true,
                            false
                        );
                        $text = \ilPCParagraph::handleAjaxContentPost($text);

                        $data[$i][$j] = $text;
                    }
                }
            }
        }

        if ($updated) {
            $table->setData($data);
            $updated = $page->update();
        }

        return $updated;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateDataCommand()

ILIAS\COPage\PC\Table\TableCommandActionHandler::updateDataCommand ( array  $body )

protected

Definition at line 160 of file class.TableCommandActionHandler.php.

References ILIAS\COPage\PC\Table\TableCommandActionHandler\sendUpdateResponse(), and ILIAS\COPage\PC\Table\TableCommandActionHandler\updateData().

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\handle().

                                                     : Server\Response
    {
        $updated = $this->updateData($body["data"]["pcid"], $body["data"]["content"]);
        if ($body["data"]["redirect"]) {
            return $this->ui_wrapper->sendPage($this->page_gui, $updated);
        } else {
            return $this->sendUpdateResponse($this->page_gui, $updated, $body["data"]["pcid"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lng

ilLanguage ILIAS\COPage\PC\Table\TableCommandActionHandler::$lng

protected

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

$page_gui

ilPageObjectGUI ILIAS\COPage\PC\Table\TableCommandActionHandler::$page_gui

protected

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

Referenced by ILIAS\COPage\PC\Table\TableCommandActionHandler\__construct().

$ui

ILIAS DI UIServices ILIAS\COPage\PC\Table\TableCommandActionHandler::$ui

protected

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

$ui_wrapper

Server UIWrapper ILIAS\COPage\PC\Table\TableCommandActionHandler::$ui_wrapper

protected

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

$user

ilObjUser ILIAS\COPage\PC\Table\TableCommandActionHandler::$user

protected

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

---

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

• components/ILIAS/COPage/PC/Table/class.TableCommandActionHandler.php