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

Collaboration diagram for ilPCTable:

Public Member Functions
	init ()
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
	addRow ()
	addCell (DOMNode $aRow, string $a_data="", string $a_lang="")
	getCellText (int $i, int $j)
	Get cell text of row $i and cell $j. More...
	getCellNode (int $i, int $j, bool $create_if_not_exists=false)
	Get cell paragraph node of row $i and cell $j. More...
	getTableDataNode (int $i, int $j)
	Get cell paragraph node of row $i and cell $j. More...
	addRows (int $a_nr_rows, int $a_nr_cols)
	add rows to table More...
	importSpreadsheet (string $a_lang, string $a_data)
	import from table More...
	getLanguage ()
	setLanguage (string $a_lang)
	getWidth ()
	setWidth (string $a_width)
	getBorder ()
	setBorder (string $a_border)
	getCellSpacing ()
	setCellSpacing (string $a_spacing)
	getCellPadding ()
	setCellPadding (string $a_padding)
	setHorizontalAlign (string $a_halign)
	getHorizontalAlign ()
	setTDWidth (string $a_hier_id, string $a_width, string $a_pc_id="")
	set width of table data cell More...
	setTDSpans (array $a_colspans, array $a_rowspans)
	fixHideAndSpans ()
	Fix Hide and Spans. More...
	makeEmptyCell (DomNode $td_node)
	checkCellHidden (array $colspans, array $rowspans, int $x, int $y)
	Check hidden status. More...
	getAllCellClasses ()
	Get all cell classes. More...
	getAllCellAlignments ()
	getAllCellSpans ()
	Get all cell spans. More...
	getAllCellWidths ()
	Get all cell widths. More...
	setTDClass (string $a_hier_id, string $a_class, string $a_pc_id="")
	set class of table data cell More...
	setTDAlignment (string $a_hier_id, string $a_class, string $a_pc_id="")
	set alignment of table data cell More...
	getCaption ()
	getCaptionAlign ()
	get caption alignment (Top | Bottom) More...
	setCaption (string $a_content, string $a_align)
	setFirstRowStyle (string $a_class)
	setClass (string $a_class)
	Set Style Class of table. More...
	getClass ()
	setTemplate (string $a_template)
	getTemplate ()
	setHeaderRows (int $a_nr)
	getHeaderRows ()
	setFooterRows (int $a_nr)
	getFooterRows ()
	setHeaderCols (int $a_nr)
	getHeaderCols ()
	setFooterCols (int $a_nr)
	getFooterCols ()
	getTableAttribute (string $a_attr)
	getModel ()
Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj, ?PageManagerInterface $page_manager=null, ?ObjectAdapterInterface $object_adapter=null)
	setPage (ilPageObject $a_val)
	getPage ()
	init ()
	Init object. More...
	getType ()
	getDomNode ()
	getDomDoc ()
	setDomNode (DOMNode $node)
	getChildNode ()
	getJavascriptFiles (string $a_mode)
	getCssFiles (string $a_mode)
	getOnloadCode (string $a_mode)
	setHierId (string $a_hier_id)
	getHierId ()
	lookupHierId ()
	readHierId ()
	setPcId (string $a_pcid)
	getPCId ()
	setFileDownloadLink (string $a_download_link)
	getFileDownloadLink ()
	setProfileBackUrl (string $url)
	getProfileBackUrl ()
	setFullscreenLink (string $a_fullscreen_link)
	getFullscreenLink ()
	setSourcecodeDownloadScript (string $script_name)
	getSourcecodeDownloadScript ()
	readPCId ()
	writePCId (string $a_pc_id)
	setEnabled (string $value)
	Set Enabled value for page content component. More...
	enable ()
	disable ()
	isEnabled ()
	createPageContentNode (bool $a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...
	getNewPageContentNode ()
	modifyPageContentPostXsl (string $a_output, string $a_mode, bool $a_abstract_only=false)
	Modify page content after xsl. More...
	getModel ()
	Get model as needed for the front-end editor. More...

Static Public Member Functions
static	getLangVars ()
static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
Static Public Member Functions inherited from ilPageContent
static	sortHierIds (array $a_array)
	Sort an array of Hier IDS in ascending order. More...
static	isGreaterHierId (string $a, string $b)
	Check whether Hier ID $a is greater than Hier ID $b. More...
static	getLangVars ()
	Get lang vars needed for editing. More...
static	handleCopiedContent (DOMDocument $a_domdoc, bool $a_self_ass=true, bool $a_clone_mobs=false, int $new_parent_id=0, int $obj_copy_id=0)
	Handle copied content. More...
static	afterPageUpdate (ilPageObject $a_page, DOMDocument $a_domdoc, string $a_xml, bool $a_creation)
	After page has been updated (or created) More...
static	beforePageDelete (ilPageObject $a_page)
	Before page is being deleted. More...
static	afterRepositoryCopy (ilPageObject $page, array $mapping, int $source_ref_id)
	After repository (container) copy action. More...
static	afterPageHistoryEntry (ilPageObject $a_page, DOMDocument $a_old_domdoc, string $a_old_xml, int $a_old_nr)
	After page history entry has been created. More...
static	deleteHistoryLowerEqualThan (string $parent_type, int $page_id, string $lang, int $delete_lower_than_nr)
	Overwrite in derived classes, if old history entries are being deleted. More...

Protected Member Functions
	setTableAttribute (string $a_attr, string $a_value)
	Set attribute of table tag. More...
Protected Member Functions inherited from ilPageContent
	getPageManager ()
	setType (string $a_type)
	Set Type. More...
	hasNode ()
	createInitialChildNode (string $hier_id, string $pc_id, string $child, array $child_attributes=[])

Additional Inherited Members
Data Fields inherited from ilPageContent
string	$hier_id = ""
DOMNode	$dom_node = null
string	$page_lang = ""
Protected Attributes inherited from ilPageContent
DOMDocument	$dom_doc
ILIAS COPage InternalDomainService	$domain
string	$pcid
string	$type = ""
ilPageObject	$pg_obj
string	$file_download_link
string	$fullscreen_link
string	$sourcecode_download_script
ilLogger	$log
string	$profile_back_url = ""
ILIAS COPage Dom DomUtil	$dom_util
PageManagerInterface	$page_manager = null
ObjectAdapterInterface	$object = null

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 ilPCTable Table content object (see ILIAS DTD)

Author

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

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

Member Function Documentation

addCell()

ilPCTable::addCell	(	DOMNode	$aRow,
		string	$a_data = "",
		string	$a_lang = ""
	)

Definition at line 51 of file class.ilPCTable.php.

References ilPageContent\getNewPageContentNode().

Referenced by addRows(), and importSpreadsheet().

     : DOMNode {
        $new_td = $this->dom_doc->createElement("TableData");
        $new_td = $aRow->appendChild($new_td);

        // insert data if given
        if ($a_data != "") {
            $new_pg = $this->getNewPageContentNode();
            $new_par = $this->dom_doc->createElement("Paragraph");
            $new_par = $new_pg->appendChild($new_par);
            $new_par->setAttribute("Language", $a_lang);
            $new_par->setAttribute("Characteristic", "TableContent");
            $this->dom_util->setContent($new_par, $a_data);
            $new_td->appendChild($new_pg);
        }

        return $new_td;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addRow()

ilPCTable::addRow

(

)

Definition at line 44 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by addRows(), and importSpreadsheet().

                            : DOMNode
    {
        $new_tr = $this->dom_doc->createElement("TableRow");
        $new_tr = $this->getChildNode()->appendChild($new_tr);
        return $new_tr;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addRows()

ilPCTable::addRows	(	int	$a_nr_rows,
		int	$a_nr_cols
	)

add rows to table

Definition at line 150 of file class.ilPCTable.php.

References addCell(), and addRow().

                                                           : void
    {
        for ($i = 1; $i <= $a_nr_rows; $i++) {
            $aRow = $this->addRow();
            for ($j = 1; $j <= $a_nr_cols; $j++) {
                $this->addCell($aRow);
            }
        }
    }

Here is the call graph for this function:

checkCellHidden()

ilPCTable::checkCellHidden	(	array	$colspans,
		array	$rowspans,
		int	$x,
		int	$y
	)

Check hidden status.

Definition at line 416 of file class.ilPCTable.php.

Referenced by fixHideAndSpans().

                                                                                     : bool
    {
        for ($i = 0; $i <= $x; $i++) {
            for ($j = 0; $j <= $y; $j++) {
                if ($i != $x || $j != $y) {
                    if ((($i + $colspans[$i][$j] > $x) &&
                        ($j + $rowspans[$i][$j] > $y))) {
                        return true;
                    }
                }
            }
        }
        return false;
    }

Here is the caller graph for this function:

create()

ilPCTable::create	(	ilPageObject	$a_pg_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

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

References ilPageContent\createInitialChildNode().

     : void {
        $this->createInitialChildNode(
            $a_hier_id,
            $a_pc_id,
            "Table",
            ["Language" => ""]
        );
    }

Here is the call graph for this function:

fixHideAndSpans()

ilPCTable::fixHideAndSpans

(

)

Fix Hide and Spans.

Reduces col and rowspans that are to high. Sets Hide attribute for all cells that are hidden due to other span attributes. Sets hidden cells to empty.

Definition at line 330 of file class.ilPCTable.php.

References checkCellHidden(), ilPageContent\getChildNode(), and makeEmptyCell().

Referenced by setTDSpans().

                                     : void
    {
        // first: get max x and y
        $max_x = $max_y = 0;
        $y = 0;
        $rows = $this->getChildNode()->childNodes;

        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $x = 0;
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $max_x = max($max_x, $x);
                        $max_y = max($max_y, $y);
                    }
                    $x++;
                }
                $y++;
            }
        }

        // second: fix hidden/colspans for all cells
        $y = 0;
        $colspans = [];
        $rowspans = [];
        $rows = $this->getChildNode()->childNodes;
        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $x = 0;
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $cspan = max(1, (int) $cell->getAttribute("ColSpan"));
                        $rspan = max(1, (int) $cell->getAttribute("RowSpan"));

                        // if col or rowspan is to high: reduce it to the max
                        if ($cspan > $max_x - $x + 1) {
                            $cell->setAttribute("ColSpan", $max_x - $x + 1);
                            $cspan = $max_x - $x + 1;
                        }
                        if ($rspan > $max_y - $y + 1) {
                            $cell->setAttribute("RowSpan", $max_y - $y + 1);
                            $rspan = $max_y - $y + 1;
                        }

                        // check hidden status
                        if ($this->checkCellHidden($colspans, $rowspans, $x, $y)) {
                            // hidden: set hidden flag, remove col and rowspan
                            $cell->setAttribute("Hidden", "Y");
                            $cspan = 1;
                            $rspan = 1;
                            if ($cell->hasAttribute("ColSpan")) {
                                $cell->removeAttribute("ColSpan");
                            }
                            if ($cell->hasAttribute("RowSpan")) {
                                $cell->removeAttribute("RowSpan");
                            }
                            $this->makeEmptyCell($cell);
                        } else {
                            // not hidden: remove hidden flag if existing
                            if ($cell->hasAttribute("Hidden")) {
                                $cell->removeAttribute("Hidden");
                            }
                        }

                        $colspans[$x][$y] = $cspan;
                        $rowspans[$x][$y] = $rspan;
                    }
                    $x++;
                }
                $y++;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllCellAlignments()

ilPCTable::getAllCellAlignments

(

)

Definition at line 453 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by ilPCTableGUI\_addAlignmentCheckboxes().

                                          : array
    {
        $classes = array();
        $rows = $this->getChildNode()->childNodes;
        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $classes[$cell->getAttribute("HierId") . ":" . $cell->getAttribute("PCID")]
                            = $cell->getAttribute("HorizontalAlign");
                    }
                }
            }
        }

        return $classes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllCellClasses()

ilPCTable::getAllCellClasses

(

)

Get all cell classes.

Definition at line 434 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by ilPCTableGUI\_addStyleCheckboxes().

                                       : array
    {
        $classes = array();
        $rows = $this->getChildNode()->childNodes;
        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $classes[$cell->getAttribute("HierId") . ":" . $cell->getAttribute("PCID")]
                            = $cell->getAttribute("Class");
                    }
                }
            }
        }

        return $classes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllCellSpans()

ilPCTable::getAllCellSpans

(

)

Get all cell spans.

Definition at line 475 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by ilPCTableGUI\_addSpanInputs().

                                     : array
    {
        $spans = array();
        $rows = $this->getChildNode()->childNodes;
        $y = 0;
        $max_x = 0;
        $max_y = 0;
        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $x = 0;
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $spans[$cell->getAttribute("HierId") . ":" . $cell->getAttribute("PCID")]
                            = array("x" => $x, "y" => $y, "colspan" => $cell->getAttribute("ColSpan"),
                                "rowspan" => $cell->getAttribute("RowSpan"));
                        $max_x = max($max_x, $x);
                        $max_y = max($max_y, $y);
                    }
                    $x++;
                }
                $y++;
            }
        }
        foreach ($spans as $k => $v) {
            $spans[$k]["max_x"] = $max_x;
            $spans[$k]["max_y"] = $max_y;
        }

        return $spans;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAllCellWidths()

ilPCTable::getAllCellWidths

(

)

Get all cell widths.

Returns

array array of cell style classes

Definition at line 511 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by ilPCTableGUI\_addWidthInputs().

                                      : array
    {
        $widths = array();
        $rows = $this->getChildNode()->childNodes;
        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $widths[$cell->getAttribute("HierId") . ":" . $cell->getAttribute("PCID")]
                            = $cell->getAttribute("Width");
                    }
                }
            }
        }

        return $widths;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBorder()

ilPCTable::getBorder

(

)

Definition at line 223 of file class.ilPCTable.php.

References getTableAttribute().

                               : string
    {
        return $this->getTableAttribute("Border");
    }

Here is the call graph for this function:

getCaption()

ilPCTable::getCaption

(

)

Definition at line 580 of file class.ilPCTable.php.

References ilPageContent\$hier_id, $path, and ilPageContent\getHierId().

                                : string
    {
        $hier_id = $this->getHierId();
        if (!empty($hier_id)) {
            $path = "//PageContent[@HierId = '" . $hier_id . "']/Table/Caption";
            $nodes = $this->dom_util->path($this->dom_doc, $path);
            if (count($nodes) == 1) {
                return $this->dom_util->getContent($nodes->item(0));
            }
        }
        return "";
    }

Here is the call graph for this function:

getCaptionAlign()

ilPCTable::getCaptionAlign

(

)

get caption alignment (Top | Bottom)

Definition at line 596 of file class.ilPCTable.php.

References ilPageContent\$hier_id, $path, and ilPageContent\getHierId().

                                     : string
    {
        $hier_id = $this->getHierId();
        if (!empty($hier_id)) {
            $path = "//PageContent[@HierId = '" . $hier_id . "']/Table/Caption";
            $nodes = $this->dom_util->path($this->dom_doc, $path);
            if (count($nodes) == 1) {
                return $nodes->item(0)->getAttribute("Align");
            }
        }
        return "";
    }

Here is the call graph for this function:

getCellNode()

ilPCTable::getCellNode	(	int	$i,
		int	$j,
		bool	$create_if_not_exists = false
	)

Get cell paragraph node of row $i and cell $j.

Definition at line 93 of file class.ilPCTable.php.

References $path, ilPageContent\getHierId(), getLanguage(), ilPageContent\getNewPageContentNode(), and null.

Referenced by getCellText(), and ilPCDataTable\setData().

                                                                                   : ?DOMNode
    {
        $path = "//PageContent[@HierId='" . $this->getHierId() . "']" .
            "/Table/TableRow[" . ($i + 1) . "]/TableData[" . ($j + 1) . "]/PageContent[1]/Paragraph[1]";
        $nodes = $this->dom_util->path($this->dom_doc, $path);
        if (!is_null($nodes->item(0))) {
            return $nodes->item(0);
        } else {                // no node -> delete all childs and create paragraph
            if (!$create_if_not_exists) {
                return null;
            }
            $path2 = "//PageContent[@HierId='" . $this->getHierId() . "']" .
                "/Table/TableRow[" . ($i + 1) . "]/TableData[" . ($j + 1) . "]";
            $nodes2 = $this->dom_util->path($this->dom_doc, $path2);

            $td_node = $nodes2->item(0);

            if (!is_null($td_node)) {
                // delete children of paragraph node
                $this->dom_util->deleteAllChilds($td_node);

                // create page content and paragraph node here.
                $pc_node = $this->getNewPageContentNode();
                $pc_node = $td_node->appendChild($pc_node);
                $par_node = $this->dom_doc->createElement("Paragraph");
                $par_node = $pc_node->appendChild($par_node);
                $par_node->setAttribute("Characteristic", "TableContent");
                $par_node->setAttribute(
                    "Language",
                    $this->getLanguage()
                );

                return $par_node;
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCellPadding()

ilPCTable::getCellPadding

(

)

Definition at line 243 of file class.ilPCTable.php.

References getTableAttribute().

                                    : string
    {
        return $this->getTableAttribute("CellPadding");
    }

Here is the call graph for this function:

getCellSpacing()

ilPCTable::getCellSpacing

(

)

Definition at line 233 of file class.ilPCTable.php.

References getTableAttribute().

                                    : string
    {
        return $this->getTableAttribute("CellSpacing");
    }

Here is the call graph for this function:

getCellText()

ilPCTable::getCellText	(	int	$i,
		int	$j
	)

Get cell text of row $i and cell $j.

Definition at line 76 of file class.ilPCTable.php.

References $c, and getCellNode().

Referenced by getModel().

                                               : string
    {
        $cell_par = $this->getCellNode($i, $j, false);
        if (!is_null($cell_par)) {
            $content = "";
            foreach ($cell_par->childNodes as $c) {
                $content .= $this->dom_util->dump($c);
            }
            return $content;
        } else {
            return "";
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getClass()

ilPCTable::getClass

(

)

Definition at line 650 of file class.ilPCTable.php.

References getTableAttribute().

Referenced by getModel().

                              : string
    {
        return $this->getTableAttribute("Class");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFooterCols()

ilPCTable::getFooterCols

(

)

Definition at line 700 of file class.ilPCTable.php.

References getTableAttribute().

                                   : int
    {
        return (int) $this->getTableAttribute("FooterCols");
    }

Here is the call graph for this function:

getFooterRows()

ilPCTable::getFooterRows

(

)

Definition at line 680 of file class.ilPCTable.php.

References getTableAttribute().

                                   : int
    {
        return (int) $this->getTableAttribute("FooterRows");
    }

Here is the call graph for this function:

getHeaderCols()

ilPCTable::getHeaderCols

(

)

Definition at line 690 of file class.ilPCTable.php.

References getTableAttribute().

                                   : int
    {
        return (int) $this->getTableAttribute("HeaderCols");
    }

Here is the call graph for this function:

getHeaderRows()

ilPCTable::getHeaderRows

(

)

Definition at line 670 of file class.ilPCTable.php.

References getTableAttribute().

Referenced by getModel().

                                   : int
    {
        return (int) $this->getTableAttribute("HeaderRows");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getHorizontalAlign()

ilPCTable::getHorizontalAlign

(

)

Definition at line 258 of file class.ilPCTable.php.

References getTableAttribute().

                                        : string
    {
        return $this->getTableAttribute("HorizontalAlign");
    }

Here is the call graph for this function:

getLanguage()

ilPCTable::getLanguage

(

)

Definition at line 201 of file class.ilPCTable.php.

References getTableAttribute().

Referenced by getCellNode(), and ilPCDataTable\makeEmptyCell().

                                 : string
    {
        return $this->getTableAttribute("Language");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLangVars()

static ilPCTable::getLangVars ( )

static

Definition at line 729 of file class.ilPCTable.php.

                                        : array
    {
        return array("ed_insert_dtable", "ed_insert_atable","ed_new_row_after", "ed_new_row_before",
            "ed_new_col_after", "ed_new_col_before", "ed_delete_col",
            "ed_delete_row", "ed_edit_data", "ed_row_up", "ed_row_down",
            "ed_col_left", "ed_col_right");
    }

getModel()

ilPCTable::getModel

(

)

Definition at line 752 of file class.ilPCTable.php.

References getCellText(), ilPageContent\getChildNode(), getClass(), getHeaderRows(), getTemplate(), ilPCParagraph\xml2output(), and ilPCParagraphGUI\xml2outputJS().

                              : ?stdClass
    {
        $this->log->debug("Get table model start");
        $model = new \stdClass();

        $y = 0;
        foreach ($this->getChildNode()->childNodes as $row) {
            if ($row->nodeName == "TableRow") {
                $x = 0;
                foreach ($row->childNodes as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $text = ilPCParagraph::xml2output(
                            $this->getCellText($y, $x),
                            true,
                            false
                        );
                        $text = ilPCParagraphGUI::xml2outputJS($text);
                        $model->content[$y][$x] = $text;
                    }
                    $x++;
                }
                $y++;
            }
        }

        if ($this->getTemplate() != "") {
            $model->template = $this->getTemplate();
            $model->characteristic = "";
        } else {
            $model->characteristic = $this->getClass();
            $model->template = "";
        }

        $model->hasHeaderRows = ($this->getHeaderRows() > 0);
        $this->log->debug("...end");
        return $model;
    }

Here is the call graph for this function:

getTableAttribute()

ilPCTable::getTableAttribute

(

string

$a_attr

)

Definition at line 721 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by getBorder(), getCellPadding(), getCellSpacing(), getClass(), getFooterCols(), getFooterRows(), getHeaderCols(), getHeaderRows(), getHorizontalAlign(), getLanguage(), getTemplate(), and getWidth().

                                                     : string
    {
        if (!is_null($this->getChildNode())) {
            return  $this->getChildNode()->getAttribute($a_attr);
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTableDataNode()

ilPCTable::getTableDataNode	(	int	$i,
		int	$j
	)

Get cell paragraph node of row $i and cell $j.

Definition at line 135 of file class.ilPCTable.php.

References $path, ilPageContent\getHierId(), and null.

                                                    : ?DOMElement
    {
        $path = "//PageContent[@HierId='" . $this->getHierId() . "']" .
            "/Table/TableRow[$i+1]/TableData[$j+1]";
        $nodes = $this->dom_util->path($this->dom_doc, $path);

        if (count($nodes) > 0) {
            return $nodes->item(0);
        }
        return null;
    }

Here is the call graph for this function:

getTemplate()

ilPCTable::getTemplate

(

)

Definition at line 660 of file class.ilPCTable.php.

References getTableAttribute().

Referenced by getModel().

                                 : string
    {
        return $this->getTableAttribute("Template");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getWidth()

ilPCTable::getWidth

(

)

Definition at line 213 of file class.ilPCTable.php.

References getTableAttribute().

                              : string
    {
        return $this->getTableAttribute("Width");
    }

Here is the call graph for this function:

handleCopiedContent()

static ilPCTable::handleCopiedContent ( DOMDocument  $a_domdoc, bool  $a_self_ass = true, bool  $a_clone_mobs = false, int  $new_parent_id = 0, int  $obj_copy_id = 0  )

static

Definition at line 738 of file class.ilPCTable.php.

     : void {
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query("//Table");
        foreach ($nodes as $node) {
            $node->removeAttribute("Id");
        }
    }

importSpreadsheet()

ilPCTable::importSpreadsheet	(	string	$a_lang,
		string	$a_data
	)

import from table

Definition at line 163 of file class.ilPCTable.php.

References $data, addCell(), and addRow().

     : void {
        $max_cols = 0;

        str_replace($a_data, "\r", "\n");
        str_replace($a_data, "\n\n", "\n");
        $target_rows = array();
        $rows = explode("\n", $a_data);

        // get maximum of cols in a row and
        // put data in target_row arrays
        foreach ($rows as $row) {
            $cells = explode("\t", $row);
            if (count($cells) === 1) {
                $cells = explode(";", $row);
            }
            $max_cols = ($max_cols > count($cells))
                ? $max_cols
                : count($cells);
            $target_rows[] = $cells;
        }

        // iterate target row arrays and insert data
        foreach ($target_rows as $row) {
            $aRow = $this->addRow();
            for ($j = 0; $j < $max_cols; $j++) {
                // mask html
                $data = str_replace("&", "&amp;", ($row[$j] ?? ""));
                $data = str_replace("<", "&lt;", $data);
                $data = str_replace(">", "&gt;", $data);

                $this->addCell($aRow, $data, $a_lang);
            }
        }
    }

Here is the call graph for this function:

init()

ilPCTable::init

(

)

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

References ilPageContent\setType().

                          : void
    {
        $this->setType("tab");
    }

Here is the call graph for this function:

makeEmptyCell()

ilPCTable::makeEmptyCell

(

DomNode

$td_node

)

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

Referenced by fixHideAndSpans().

                                                   : void
    {
        // delete children of paragraph node
        $this->dom_util->deleteAllChilds($td_node);
    }

Here is the caller graph for this function:

setBorder()

ilPCTable::setBorder

(

string

$a_border

)

Definition at line 228 of file class.ilPCTable.php.

References setTableAttribute().

                                               : void
    {
        $this->setTableAttribute("Border", $a_border);
    }

Here is the call graph for this function:

setCaption()

ilPCTable::setCaption	(	string	$a_content,
		string	$a_align
	)

Definition at line 609 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

                                                                  : void
    {
        if ($a_content != "") {
            $this->dom_util->setFirstOptionalElement(
                $this->getChildNode(),
                "Caption",
                array("Summary", "TableRow"),
                $a_content,
                array("Align" => $a_align)
            );
        } else {
            $this->dom_util->deleteAllChildsByName(
                $this->getChildNode(),
                array("Caption")
            );
        }
    }

Here is the call graph for this function:

setCellPadding()

ilPCTable::setCellPadding

(

string

$a_padding

)

Definition at line 248 of file class.ilPCTable.php.

References setTableAttribute().

                                                     : void
    {
        $this->setTableAttribute("CellPadding", $a_padding);
    }

Here is the call graph for this function:

setCellSpacing()

ilPCTable::setCellSpacing

(

string

$a_spacing

)

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

References setTableAttribute().

                                                     : void
    {
        $this->setTableAttribute("CellSpacing", $a_spacing);
    }

Here is the call graph for this function:

setClass()

ilPCTable::setClass

(

string

$a_class

)

Set Style Class of table.

Definition at line 645 of file class.ilPCTable.php.

References setTableAttribute().

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

                                             : void
    {
        $this->setTableAttribute("Class", $a_class);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setFirstRowStyle()

ilPCTable::setFirstRowStyle

(

string

$a_class

)

Definition at line 627 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

     : void {
        foreach ($this->getChildNode()->childNodes as $child) {
            if ($child->nodeName == "TableRow") {
                foreach ($child->childNodes as $gchild) {
                    if ($gchild->nodeName == "TableData") {
                        $gchild->setAttribute("Class", $a_class);
                    }
                }
                return;
            }
        }
    }

Here is the call graph for this function:

setFooterCols()

ilPCTable::setFooterCols

(

int

$a_nr

)

Definition at line 695 of file class.ilPCTable.php.

References setTableAttribute().

                                            : void
    {
        $this->setTableAttribute("FooterCols", $a_nr);
    }

Here is the call graph for this function:

setFooterRows()

ilPCTable::setFooterRows

(

int

$a_nr

)

Definition at line 675 of file class.ilPCTable.php.

References setTableAttribute().

                                            : void
    {
        $this->setTableAttribute("FooterRows", $a_nr);
    }

Here is the call graph for this function:

setHeaderCols()

ilPCTable::setHeaderCols

(

int

$a_nr

)

Definition at line 685 of file class.ilPCTable.php.

References setTableAttribute().

                                            : void
    {
        $this->setTableAttribute("HeaderCols", $a_nr);
    }

Here is the call graph for this function:

setHeaderRows()

ilPCTable::setHeaderRows

(

int

$a_nr

)

Definition at line 665 of file class.ilPCTable.php.

References setTableAttribute().

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

                                            : void
    {
        $this->setTableAttribute("HeaderRows", $a_nr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setHorizontalAlign()

ilPCTable::setHorizontalAlign

(

string

$a_halign

)

Definition at line 253 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

                                                        : void
    {
        $this->getChildNode()->setAttribute("HorizontalAlign", $a_halign);
    }

Here is the call graph for this function:

setLanguage()

ilPCTable::setLanguage

(

string

$a_lang

)

Definition at line 206 of file class.ilPCTable.php.

References setTableAttribute().

                                               : void
    {
        if ($a_lang != "") {
            $this->setTableAttribute("Language", $a_lang);
        }
    }

Here is the call graph for this function:

setTableAttribute()

ilPCTable::setTableAttribute ( string  $a_attr, string  $a_value  )

protected

Set attribute of table tag.

Definition at line 708 of file class.ilPCTable.php.

References ilPageContent\getChildNode().

Referenced by setBorder(), setCellPadding(), setCellSpacing(), setClass(), setFooterCols(), setFooterRows(), setHeaderCols(), setHeaderRows(), setLanguage(), setTemplate(), and setWidth().

     : void {
        if (!empty($a_value)) {
            $this->getChildNode()->setAttribute($a_attr, $a_value);
        } else {
            if ($this->getChildNode()->hasAttribute($a_attr)) {
                $this->getChildNode()->removeAttribute($a_attr);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTDAlignment()

ilPCTable::setTDAlignment	(	string	$a_hier_id,
		string	$a_class,
		string	$a_pc_id = ""
	)

set alignment of table data cell

Definition at line 558 of file class.ilPCTable.php.

References $path.

     : void {
        if ($a_pc_id == "") {
            $path = "//TableData[@HierId = '" . $a_hier_id . "']";
        } else {
            $path = "//TableData[@PCID = '" . $a_pc_id . "']";
        }
        $nodes = $this->dom_util->path($this->dom_doc, $path);
        if (count($nodes) == 1) {
            if ($a_class != "") {
                $nodes->item(0)->setAttribute("HorizontalAlign", $a_class);
            } else {
                if ($nodes->item(0)->hasAttribute("HorizontalAlign")) {
                    $nodes->item(0)->removeAttribute("HorizontalAlign");
                }
            }
        }
    }

setTDClass()

ilPCTable::setTDClass	(	string	$a_hier_id,
		string	$a_class,
		string	$a_pc_id = ""
	)

set class of table data cell

Definition at line 533 of file class.ilPCTable.php.

References $path.

     : void {
        if ($a_pc_id == "") {
            $path = "//TableData[@HierId = '" . $a_hier_id . "']";
        } else {
            $path = "//TableData[@PCID = '" . $a_pc_id . "']";
        }
        $nodes = $this->dom_util->path($this->dom_doc, $path);
        if (count($nodes) == 1) {
            if ($a_class != "") {
                $nodes->item(0)->setAttribute("Class", $a_class);
            } else {
                if ($nodes->item(0)->hasAttribute("Class")) {
                    $nodes->item(0)->removeAttribute("Class");
                }
            }
        }
    }

setTDSpans()

ilPCTable::setTDSpans	(	array	$a_colspans,
		array	$a_rowspans
	)

Definition at line 289 of file class.ilPCTable.php.

References fixHideAndSpans(), and ilPageContent\getChildNode().

     : void {
        $y = 0;
        $rows = $this->getChildNode()->childNodes;
        foreach ($rows as $row) {
            if ($row->nodeName == "TableRow") {
                $x = 0;
                $cells = $row->childNodes;
                foreach ($cells as $cell) {
                    if ($cell->nodeName == "TableData") {
                        $ckey = $cell->getAttribute("HierId") . ":" . $cell->getAttribute("PCID");
                        if ((int) ($a_colspans[$ckey] ?? 0) > 1) {
                            $cell->setAttribute("ColSpan", (int) $a_colspans[$ckey]);
                        } else {
                            if ($cell->hasAttribute("ColSpan")) {
                                $cell->removeAttribute("ColSpan");
                            }
                        }
                        if ((int) ($a_rowspans[$ckey] ?? 0) > 1) {
                            $cell->setAttribute("RowSpan", (int) $a_rowspans[$ckey]);
                        } else {
                            if ($cell->hasAttribute("RowSpan")) {
                                $cell->removeAttribute("RowSpan");
                            }
                        }
                    }
                    $x++;
                }
                $y++;
            }
        }
        $this->fixHideAndSpans();
    }

Here is the call graph for this function:

setTDWidth()

ilPCTable::setTDWidth	(	string	$a_hier_id,
		string	$a_width,
		string	$a_pc_id = ""
	)

set width of table data cell

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

References $path.

     : void {
        if ($a_pc_id == "") {
            $path = "//TableData[@HierId = '" . $a_hier_id . "']";
        } else {
            $path = "//TableData[@PCID = '" . $a_pc_id . "']";
        }
        $nodes = $this->dom_util->path($this->dom_doc, $path);

        if (count($nodes) == 1) {
            if ($a_width != "") {
                $nodes->item(0)->setAttribute("Width", $a_width);
            } else {
                if ($nodes->item(0)->hasAttribute("Width")) {
                    $nodes->item(0)->removeAttribute("Width");
                }
            }
        }
    }

setTemplate()

ilPCTable::setTemplate

(

string

$a_template

)

Definition at line 655 of file class.ilPCTable.php.

References setTableAttribute().

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

                                                   : void
    {
        $this->setTableAttribute("Template", $a_template);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setWidth()

ilPCTable::setWidth

(

string

$a_width

)

Definition at line 218 of file class.ilPCTable.php.

References setTableAttribute().

                                             : void
    {
        $this->setTableAttribute("Width", $a_width);
    }

Here is the call graph for this function:

---

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

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