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 ()
	Init object. More...

	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...

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

	addRow ()

	addCell (php4DOMElement $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...

	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 (php4DOMElement $td_node)
	Make cell empty. More...

	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)

	importTableAttributes (php4DOMElement $node)

	importCellAttributes (php4DOMElement $node, php4DOMElement $par)

	importRow (string $lng, php4DOMElement $node)

	importCell (string $lng, php4DOMElement $cellNode, php4DOMElement $aRow)

	extractText (php4DOMElement $node)

	importHtml (string $lng, string $htmlTable)

	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 ()
	Get model as needed for the front-end editor. More...

Public Member Functions inherited from ilPageContent
	__construct (ilPageObject $a_pg_obj)

	setPage (ilPageObject $a_val)

	getPage ()

	init ()
	Init object. More...

	getType ()

	setNode (php4DOMElement $a_node)
	Set xml node of page content. More...

	getNode ()

	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...

	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 ()
	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 Public Member Functions inherited from ilPageContent
static	incEdId (string $ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...

static	decEdId (string $ed_id)
	Decreases an hierarchical editing id at lowest level (last number) More...

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...

Data Fields
php4DOMElement	$tab_node

Data Fields inherited from ilPageContent
string	$hier_id = ""

php4DOMElement	$node = null

php4DOMDocument	$dom = null

string	$page_lang = ""

Protected Member Functions
	setTableAttribute (string $a_attr, string $a_value)
	Set attribute of table tag. More...

Protected Member Functions inherited from ilPageContent
	setType (string $a_type)
	Set Type. More...

Additional Inherited Members
Protected Attributes inherited from ilPageContent
string	$pcid

string	$type = ""

ilPageObject	$pg_obj

string	$file_download_link

string	$fullscreen_link

string	$sourcecode_download_script

ilLogger	$log

string	$profile_back_url = ""

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	(	php4DOMElement	$aRow,
		string	$a_data = `""`,
		string	$a_lang = `""`
	)

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

     : php4DOMElement {
        $new_td = $this->dom->create_element("TableData");
        $new_td = $aRow->append_child($new_td);
 
        // insert data if given
        if ($a_data != "") {
            $new_pg = $this->createPageContentNode(false);
            $new_par = $this->dom->create_element("Paragraph");
            $new_par = $new_pg->append_child($new_par);
            $new_par->set_attribute("Language", $a_lang);
            $new_par->set_attribute("Characteristic", "TableContent");
            $new_par->set_content($a_data);
            $new_td->append_child($new_pg);
        }
 
        return $new_td;
    }

◆ addRow()

ilPCTable::addRow ( )

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

                            : php4DOMElement
    {
        $new_tr = $this->dom->create_element("TableRow");
        $new_tr = $this->tab_node->append_child($new_tr);
        return $new_tr;
    }

References php4DOMNode\append_child().

Here is the call graph for this function:

◆ addRows()

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

add rows to table

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

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

References $i.

◆ checkCellHidden()

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

Check hidden status.

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

                                                                                     : 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;
    }

References $i.

◆ create()

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

Reimplemented in ilPCDataTable.

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

     : void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->tab_node = $this->dom->create_element("Table");
        $this->tab_node = $this->node->append_child($this->tab_node);
        $this->tab_node->set_attribute("Language", "");
    }

◆ extractText()

ilPCTable::extractText ( php4DOMElement $node )

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

     : string {
        $output = "";
 
        $owner_document = $node->owner_document();
        $children = $node->child_nodes();
        $total_children = count($children);
        for ($i = 0; $i < $total_children; $i++) {
            $cur_child_node = $children[$i];
            $output .= $owner_document->dump_node($cur_child_node);
        }
        return $output;
    }

◆ 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 333 of file class.ilPCTable.php.

                                     : void
    {
 
        // first: get max x and y
        $max_x = $max_y = 0;
        $y = 0;
        $rows = $this->tab_node->child_nodes();
 
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $x = 0;
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "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->tab_node->child_nodes();
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $x = 0;
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $cspan = max(1, (int) $cell->get_attribute("ColSpan"));
                        $rspan = max(1, (int) $cell->get_attribute("RowSpan"));
 
                        // if col or rowspan is to high: reduce it to the max
                        if ($cspan > $max_x - $x + 1) {
                            $cell->set_attribute("ColSpan", $max_x - $x + 1);
                            $cspan = $max_x - $x + 1;
                        }
                        if ($rspan > $max_y - $y + 1) {
                            $cell->set_attribute("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->set_attribute("Hidden", "Y");
                            $cspan = 1;
                            $rspan = 1;
                            if ($cell->has_attribute("ColSpan")) {
                                $cell->remove_attribute("ColSpan");
                            }
                            if ($cell->has_attribute("RowSpan")) {
                                $cell->remove_attribute("RowSpan");
                            }
                            $this->makeEmptyCell($cell);
                        } else {
                            // not hidden: remove hidden flag if existing
                            if ($cell->has_attribute("Hidden")) {
                                $cell->remove_attribute("Hidden");
                            }
                        }
 
                        $colspans[$x][$y] = $cspan;
                        $rowspans[$x][$y] = $rspan;
                    }
                    $x++;
                }
                $y++;
            }
        }
    }

References $rows.

◆ getAllCellAlignments()

ilPCTable::getAllCellAlignments ( )

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

                                          : array
    {
        $classes = array();
        $rows = $this->tab_node->child_nodes();
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $classes[$cell->get_attribute("HierId") . ":" . $cell->get_attribute("PCID")]
                            = $cell->get_attribute("HorizontalAlign");
                    }
                }
            }
        }
 
        return $classes;
    }

References $rows.

◆ getAllCellClasses()

ilPCTable::getAllCellClasses ( )

Get all cell classes.

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

                                       : array
    {
        $classes = array();
        $rows = $this->tab_node->child_nodes();
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $classes[$cell->get_attribute("HierId") . ":" . $cell->get_attribute("PCID")]
                            = $cell->get_attribute("Class");
                    }
                }
            }
        }
 
        return $classes;
    }

References $rows.

◆ getAllCellSpans()

ilPCTable::getAllCellSpans ( )

Get all cell spans.

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

                                     : array
    {
        $spans = array();
        $rows = $this->tab_node->child_nodes();
        $y = 0;
        $max_x = 0;
        $max_y = 0;
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $x = 0;
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $spans[$cell->get_attribute("HierId") . ":" . $cell->get_attribute("PCID")]
                            = array("x" => $x, "y" => $y, "colspan" => $cell->get_attribute("ColSpan"),
                                "rowspan" => $cell->get_attribute("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;
    }

References $rows.

◆ getAllCellWidths()

ilPCTable::getAllCellWidths ( )

Get all cell widths.

Returns: array array of cell style classes

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

                                      : array
    {
        $widths = array();
        $rows = $this->tab_node->child_nodes();
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $widths[$cell->get_attribute("HierId") . ":" . $cell->get_attribute("PCID")]
                            = $cell->get_attribute("Width");
                    }
                }
            }
        }
 
        return $widths;
    }

References $rows.

◆ getBorder()

ilPCTable::getBorder ( )

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

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

◆ getCaption()

ilPCTable::getCaption ( )

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

                                : string
    {
        $hier_id = $this->getHierId();
        if (!empty($hier_id)) {
            $xpc = xpath_new_context($this->dom);
            $path = "//PageContent[@HierId = '" . $hier_id . "']/Table/Caption";
            $res = xpath_eval($xpc, $path);
 
            if (count($res->nodeset) == 1) {
                return $res->nodeset[0]->get_content();
            }
        }
        return "";
    }

References $path, $res, xpath_eval(), and xpath_new_context().

Here is the call graph for this function:

◆ getCaptionAlign()

ilPCTable::getCaptionAlign ( )

get caption alignment (Top | Bottom)

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

                                     : string
    {
        $hier_id = $this->getHierId();
        if (!empty($hier_id)) {
            $xpc = xpath_new_context($this->dom);
            $path = "//PageContent[@HierId = '" . $hier_id . "']/Table/Caption";
            $res = xpath_eval($xpc, $path);
            if (count($res->nodeset) == 1) {
                return $res->nodeset[0]->get_attribute("Align");
            }
        }
        return "";
    }

References $path, $res, xpath_eval(), and xpath_new_context().

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 102 of file class.ilPCTable.php.

                                                                                   : ?php4DOMElement
    {
        $xpc = xpath_new_context($this->dom);
        $path = "//PageContent[@HierId='" . $this->getHierId() . "']" .
            "/Table/TableRow[$i+1]/TableData[$j+1]/PageContent[1]/Paragraph[1]";
        //echo "<br>++".$path;
        //]--//PageContent[@HierId='3']/Table/TableRow[+1]/TableData[0 style=+1]/PageContent[1]/Paragraph[1]
        $res = xpath_eval($xpc, $path);
 
        if (isset($res->nodeset[0])) {
            return $res->nodeset[0];
        } else {                // no node -> delete all childs and create paragraph
            if (!$create_if_not_exists) {
                return null;
            }
            $xpc2 = xpath_new_context($this->dom);
            $path2 = "//PageContent[@HierId='" . $this->getHierId() . "']" .
                "/Table/TableRow[" . ($i + 1) . "]/TableData[" . ($j + 1) . "]";
            //$path2 = "//PageContent";
 
            $res2 = xpath_eval($xpc2, $path2);
 
            $td_node = $res2->nodeset[0];
 
            if (is_object($td_node)) {
                // delete children of paragraph node
                $children = $td_node->child_nodes();
                for ($i = 0; $i < count($children); $i++) {
                    $td_node->remove_child($children[$i]);
                }
 
                // create page content and paragraph node here.
                $pc_node = $this->createPageContentNode(false);
                $pc_node = $td_node->append_child($pc_node);
                $par_node = $this->dom->create_element("Paragraph");
                $par_node = $pc_node->append_child($par_node);
                $par_node->set_attribute("Characteristic", "TableContent");
                $par_node->set_attribute(
                    "Language",
                    $this->getLanguage()
                );
 
                return $par_node;
            }
        }
 
        return null;
    }

References $i, $path, $res, ILIAS\UI\Implementation\Component\Input\getLanguage(), xpath_eval(), and xpath_new_context().

Here is the call graph for this function:

◆ getCellPadding()

ilPCTable::getCellPadding ( )

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

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

◆ getCellSpacing()

ilPCTable::getCellSpacing ( )

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

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

◆ getCellText()

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

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

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

                                               : string
    {
        $cell_par = $this->getCellNode($i, $j, false);
 
        if (is_object($cell_par)) {
            $content = "";
            $childs = $cell_par->child_nodes();
            for ($i = 0; $i < count($childs); $i++) {
                $content .= $this->dom->dump_node($childs[$i]);
            }
            return $content;
        } else {
            return "";
        }
    }

References $i.

◆ getClass()

ilPCTable::getClass ( )

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

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

◆ getFooterCols()

ilPCTable::getFooterCols ( )

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

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

◆ getFooterRows()

ilPCTable::getFooterRows ( )

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

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

◆ getHeaderCols()

ilPCTable::getHeaderCols ( )

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

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

◆ getHeaderRows()

ilPCTable::getHeaderRows ( )

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

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

◆ getHorizontalAlign()

ilPCTable::getHorizontalAlign ( )

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

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

◆ getLanguage()

ilPCTable::getLanguage ( )

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

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

◆ getLangVars()

static ilPCTable::getLangVars ( )

static

Get lang vars needed for editing.

Returns: string[] array of lang var keys

Reimplemented from ilPageContent.

Definition at line 896 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 ( )

Get model as needed for the front-end editor.

Reimplemented from ilPageContent.

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

                              : ?stdClass
    {
        $model = new \stdClass();
 
        $rows = $this->tab_node->child_nodes();
 
        $y = 0;
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $x = 0;
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $text = ilPCParagraph::xml2output(
                            $this->getCellText($y, $x),
                            true,
                            false
                        );
                        $text = ilPCParagraphGUI::xml2outputJS($text);
                        $model->content[$y][$x] = $text;
                    }
                    $x++;
                }
                $y++;
            }
        }
 
        return $model;
    }

References $rows, ilPCParagraph\xml2output(), and ilPCParagraphGUI\xml2outputJS().

Here is the call graph for this function:

◆ getTableAttribute()

ilPCTable::getTableAttribute ( string $a_attr )

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

                                                     : string
    {
        if (is_object($this->tab_node)) {
            return  $this->tab_node->get_attribute($a_attr);
        }
        return "";
    }

◆ getTemplate()

ilPCTable::getTemplate ( )

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

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

◆ getWidth()

ilPCTable::getWidth ( )

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

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

◆ 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

Handle copied content.

This function must, e.g. create copies of objects referenced within the content (e.g. question objects)

Parameters

DOMDocument	$a_domdoc
bool	$a_self_ass
bool	$a_clone_mobs
int	$new_parent_id
int	$obj_copy_id

Reimplemented from ilPageContent.

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

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

◆ importCell()

ilPCTable::importCell	(	string	$lng,
		php4DOMElement	$cellNode,
		php4DOMElement	$aRow
	)

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

     : void {
        /*echo "add Cell";
        var_dump($cellNode);*/
        $aCell = $this->addCell($aRow);
        $par = new ilPCParagraph($this->getPage());
        $par->createAtNode($aCell);
        $par->setText($par->input2xml($this->extractText($cellNode)));
        $par->setCharacteristic("TableContent");
        $par->setLanguage($lng);
        $this->importCellAttributes($cellNode, $aCell);
    }

◆ importCellAttributes()

ilPCTable::importCellAttributes	(	php4DOMElement	$node,
		php4DOMElement	$par
	)

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

     : void {
        /*echo "importing table attributes";
        var_dump($tableNode);*/
        if ($node->has_attributes()) {
            foreach ($node->attributes() as $n) {
                switch (strtolower($n->node_name())) {
                    case "class":
                        $par->set_attribute("Class", $this->extractText($n));
                        break;
                    case "width":
                        $par->set_attribute("Width", $this->extractText($n));
                        break;
                }
            }
        }
    }

References php4DOMNode\attributes(), and php4DOMElement\set_attribute().

Here is the call graph for this function:

◆ importHtml()

ilPCTable::importHtml	(	string	$lng,
		string	$htmlTable
	)

Returns: bool|string

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

      {
        $dummy = ilUtil::stripSlashes($htmlTable, false);
        $dom = domxml_open_mem($dummy, DOMXML_LOAD_PARSING, $error);
 
        if ($dom) {
            $xpc = xpath_new_context($dom);
            // extract first table object
            $path = "//table[1] | //Table[1]";
            $res = xpath_eval($xpc, $path);
 
            if (count($res->nodeset) == 0) {
                $error = "Could not find a table root node";
            }
 
            if (empty($error)) {
                for ($i = 0; $i < count($res->nodeset); $i++) {
                    $node = $res->nodeset[$i];
 
                    $this->importTableAttributes($node);
 
                    if ($node->has_child_nodes()) {
                        foreach ($node->child_nodes() as $n) {
                            if ($n->node_type() == XML_ELEMENT_NODE &&
                            strcasecmp($n->node_name(), "tr") == 0) {
                                $this->importRow($lng, $n);
                            }
                        }
                    }
                }
            }
            $dom->free();
        }
        if (is_array($error)) {
            $errmsg = "";
            foreach ($error as $errorline) {    # Loop through all errors
                $errmsg .= "[" . $errorline['line'] . ", " . $errorline['col'] . "]: " . $errorline['errormessage'] . " at Node '" . $errorline['nodename'] . "'<br />";
            }
        } else {
            $errmsg = $error;
        }
 
        if (empty($errmsg)) {
            return true;
        }
 
        return $errmsg;
    }

References $i, $lng, $path, $res, php4DOMNode\child_nodes(), DOMXML_LOAD_PARSING, domxml_open_mem(), php4DOMNode\has_child_nodes(), ilUtil\stripSlashes(), xpath_eval(), and xpath_new_context().

Here is the call graph for this function:

◆ importRow()

ilPCTable::importRow	(	string	$lng,
		php4DOMElement	$node
	)

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

     : void {
        $aRow = $this->addRow();
 
        if ($node->has_child_nodes()) {
            foreach ($node->child_nodes() as $n) {
                if ($n->node_type() == XML_ELEMENT_NODE &&
                strcasecmp($n->node_name(), "td") == 0) {
                    $this->importCell($lng, $n, $aRow);
                }
            }
        }
    }

References $lng, and php4DOMNode\child_nodes().

Here is the call graph for this function:

◆ importSpreadsheet()

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

import from table

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

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

◆ importTableAttributes()

ilPCTable::importTableAttributes ( php4DOMElement $node )

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

     : void {
        /*echo "importing table attributes";
        var_dump($tableNode);*/
        if ($node->has_attributes()) {
            foreach ($node->attributes() as $n) {
                switch (strtolower($n->node_name())) {
                    case "border":
                        $this->setBorder($this->extractText($n));
                        break;
                    case "align":
                        $this->setHorizontalAlign(ucfirst(strtolower($this->extractText($n))));
                        break;
                    case "cellspacing":
                        $this->setCellSpacing($this->extractText($n));
                        break;
                    case "cellpadding":
                        $this->setCellPadding($this->extractText($n));
                        break;
                    case "width":
                        $this->setWidth($this->extractText($n));
                        break;
                }
            }
        }
    }

References php4DOMNode\attributes().

Here is the call graph for this function:

◆ init()

ilPCTable::init ( )

Init object.

This function must be overwritten and at least set the content type.

Reimplemented from ilPageContent.

Reimplemented in ilPCDataTable.

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

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

References ilPageContent\setType().

Here is the call graph for this function:

◆ makeEmptyCell()

ilPCTable::makeEmptyCell ( php4DOMElement $td_node )

Make cell empty.

Reimplemented in ilPCDataTable.

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

                                                          : void
    {
        // delete children of paragraph node
        $children = $td_node->child_nodes();
        for ($i = 0; $i < count($children); $i++) {
            $td_node->remove_child($children[$i]);
        }
    }

References $i, php4DOMNode\child_nodes(), and php4DOMNode\remove_child().

Here is the call graph for this function:

◆ setBorder()

ilPCTable::setBorder ( string $a_border )

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

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

◆ setCaption()

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

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

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

References ilDOMUtil\deleteAllChildsByName(), and ilDOMUtil\setFirstOptionalElement().

Here is the call graph for this function:

◆ setCellPadding()

ilPCTable::setCellPadding ( string $a_padding )

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

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

◆ setCellSpacing()

ilPCTable::setCellSpacing ( string $a_spacing )

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

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

◆ setClass()

ilPCTable::setClass ( string $a_class )

Set Style Class of table.

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

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

◆ setFirstRowStyle()

ilPCTable::setFirstRowStyle ( string $a_class )

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

     : void {
        $childs = $this->tab_node->child_nodes();
        foreach ($childs as $child) {
            if ($child->node_name() == "TableRow") {
                $gchilds = $child->child_nodes();
                foreach ($gchilds as $gchild) {
                    if ($gchild->node_name() == "TableData") {
                        $gchild->set_attribute("Class", $a_class);
                    }
                }
                return;
            }
        }
    }

◆ setFooterCols()

ilPCTable::setFooterCols ( int $a_nr )

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

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

◆ setFooterRows()

ilPCTable::setFooterRows ( int $a_nr )

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

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

◆ setHeaderCols()

ilPCTable::setHeaderCols ( int $a_nr )

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

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

◆ setHeaderRows()

ilPCTable::setHeaderRows ( int $a_nr )

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

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

◆ setHorizontalAlign()

ilPCTable::setHorizontalAlign ( string $a_halign )

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

                                                        : void
    {
        $this->tab_node->set_attribute("HorizontalAlign", $a_halign);
    }

◆ setLanguage()

ilPCTable::setLanguage ( string $a_lang )

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

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

◆ setNode()

ilPCTable::setNode ( php4DOMElement $a_node )

Set xml node of page content.

Parameters

php4DOMElement $a_node node object

Reimplemented from ilPageContent.

Reimplemented in ilPCDataTable.

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

                                                   : void
    {
        parent::setNode($a_node);               // this is the PageContent node
        $this->tab_node = $a_node->first_child();               // this is the Table node
    }

References php4DOMNode\first_child().

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 875 of file class.ilPCTable.php.

     : void {
        if (!empty($a_value)) {
            $this->tab_node->set_attribute($a_attr, $a_value);
        } else {
            if ($this->tab_node->has_attribute($a_attr)) {
                $this->tab_node->remove_attribute($a_attr);
            }
        }
    }

◆ setTDAlignment()

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

set alignment of table data cell

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

     : void {
        $xpc = xpath_new_context($this->dom);
        if ($a_pc_id == "") {
            $path = "//TableData[@HierId = '" . $a_hier_id . "']";
        } else {
            $path = "//TableData[@PCID = '" . $a_pc_id . "']";
        }
        $res = xpath_eval($xpc, $path);
        if (count($res->nodeset) == 1) {
            if ($a_class != "") {
                $res->nodeset[0]->set_attribute("HorizontalAlign", $a_class);
            } else {
                if ($res->nodeset[0]->has_attribute("HorizontalAlign")) {
                    $res->nodeset[0]->remove_attribute("HorizontalAlign");
                }
            }
        }
    }

References $path.

◆ setTDClass()

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

set class of table data cell

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

     : void {
        $xpc = xpath_new_context($this->dom);
        if ($a_pc_id == "") {
            $path = "//TableData[@HierId = '" . $a_hier_id . "']";
        } else {
            $path = "//TableData[@PCID = '" . $a_pc_id . "']";
        }
        $res = xpath_eval($xpc, $path);
        if (count($res->nodeset) == 1) {
            if ($a_class != "") {
                $res->nodeset[0]->set_attribute("Class", $a_class);
            } else {
                if ($res->nodeset[0]->has_attribute("Class")) {
                    $res->nodeset[0]->remove_attribute("Class");
                }
            }
        }
    }

References $path.

◆ setTDSpans()

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

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

     : void {
        $y = 0;
        $rows = $this->tab_node->child_nodes();
        foreach ($rows as $row) {
            if ($row->node_name() == "TableRow") {
                $x = 0;
                $cells = $row->child_nodes();
                foreach ($cells as $cell) {
                    if ($cell->node_name() == "TableData") {
                        $ckey = $cell->get_attribute("HierId") . ":" . $cell->get_attribute("PCID");
                        if ((int) ($a_colspans[$ckey] ?? 0) > 1) {
                            $cell->set_attribute("ColSpan", (int) $a_colspans[$ckey]);
                        } else {
                            if ($cell->has_attribute("ColSpan")) {
                                $cell->remove_attribute("ColSpan");
                            }
                        }
                        if ((int) ($a_rowspans[$ckey] ?? 0) > 1) {
                            $cell->set_attribute("RowSpan", (int) $a_rowspans[$ckey]);
                        } else {
                            if ($cell->has_attribute("RowSpan")) {
                                $cell->remove_attribute("RowSpan");
                            }
                        }
                    }
                    $x++;
                }
                $y++;
            }
        }
        $this->fixHideAndSpans();
    }

◆ setTDWidth()

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

set width of table data cell

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

     : void {
        $xpc = xpath_new_context($this->dom);
 
        if ($a_pc_id == "") {
            $path = "//TableData[@HierId = '" . $a_hier_id . "']";
        } else {
            $path = "//TableData[@PCID = '" . $a_pc_id . "']";
        }
        $res = xpath_eval($xpc, $path);
 
        if (count($res->nodeset) == 1) {
            if ($a_width != "") {
                $res->nodeset[0]->set_attribute("Width", $a_width);
            } else {
                if ($res->nodeset[0]->has_attribute("Width")) {
                    $res->nodeset[0]->remove_attribute("Width");
                }
            }
        }
    }

References $path.

◆ setTemplate()

ilPCTable::setTemplate ( string $a_template )

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

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

◆ setWidth()

ilPCTable::setWidth ( string $a_width )

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

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

Field Documentation

◆ $tab_node

php4DOMElement ilPCTable::$tab_node

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

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

Services/COPage/classes/class.ilPCTable.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCell()

◆ addRow()

◆ addRows()

◆ checkCellHidden()

◆ create()

◆ extractText()

◆ fixHideAndSpans()

◆ getAllCellAlignments()

◆ getAllCellClasses()

◆ getAllCellSpans()

◆ getAllCellWidths()

◆ getBorder()

◆ getCaption()

◆ getCaptionAlign()

◆ getCellNode()

◆ getCellPadding()

◆ getCellSpacing()

◆ getCellText()

◆ getClass()

◆ getFooterCols()

◆ getFooterRows()

◆ getHeaderCols()

◆ getHeaderRows()

◆ getHorizontalAlign()

◆ getLanguage()

◆ getLangVars()

◆ getModel()

◆ getTableAttribute()

◆ getTemplate()

◆ getWidth()

◆ handleCopiedContent()

◆ importCell()

◆ importCellAttributes()

◆ importHtml()

◆ importRow()

◆ importSpreadsheet()

◆ importTableAttributes()

◆ init()

◆ makeEmptyCell()

◆ setBorder()

◆ setCaption()

◆ setCellPadding()

◆ setCellSpacing()

◆ setClass()

◆ setFirstRowStyle()

◆ setFooterCols()

◆ setFooterRows()

◆ setHeaderCols()

◆ setHeaderRows()

◆ setHorizontalAlign()

◆ setLanguage()

◆ setNode()

◆ setTableAttribute()

◆ setTDAlignment()

◆ setTDClass()

◆ setTDSpans()

◆ setTDWidth()

◆ setTemplate()

◆ setWidth()

Field Documentation

◆ $tab_node