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

Collaboration diagram for ilPCDataTable:

Public Member Functions
	init ()
	setNode (php4DOMElement $a_node)
	create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
	makeEmptyCell (php4DOMElement $td_node)
	Make cell empty. More...
	setData (array $a_data)
	Set data of cells. More...
Public Member Functions inherited from ilPCTable
	init ()
	setNode (php4DOMElement $a_node)
	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 ()
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...

Additional Inherited Members
Static Public Member Functions inherited from ilPCTable
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	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 inherited from ilPCTable
php4DOMElement	$tab_node
Data Fields inherited from ilPageContent
string	$hier_id = ""
php4DOMElement	$node = null
php4DOMDocument	$dom = null
string	$page_lang = ""
Protected Member Functions inherited from ilPCTable
	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...
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 ilPCDataTable

Data table content object (see ILIAS DTD). This type of table can only hold one paragraph content item per cell.

Author

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

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

Member Function Documentation

create()

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

Definition at line 40 of file class.ilPCDataTable.php.

References ilPageContent\createPageContentNode(), IL_INSERT_AFTER, and ilPageObject\insertContent().

     : 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", "");
        $this->tab_node->set_attribute("DataTable", "y");
    }

Here is the call graph for this function:

init()

ilPCDataTable::init

(

)

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

References ilPageContent\setType().

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

Here is the call graph for this function:

makeEmptyCell()

ilPCDataTable::makeEmptyCell

(

php4DOMElement

$td_node

)

Make cell empty.

Definition at line 57 of file class.ilPCDataTable.php.

References $i, php4DOMNode\append_child(), php4DOMNode\child_nodes(), ilPageContent\createPageContentNode(), ilPCTable\getLanguage(), and php4DOMNode\remove_child().

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

Here is the call graph for this function:

setData()

ilPCDataTable::setData

(

array

$a_data

)

Set data of cells.

Returns

bool|array

Definition at line 82 of file class.ilPCDataTable.php.

References $i, $path, $res, DOMXML_LOAD_PARSING, domxml_open_mem(), ilPCTable\getCellNode(), xpath_eval(), and xpath_new_context().

    {
        if (is_array($a_data)) {
            foreach ($a_data as $i => $row) {
                if (is_array($row)) {
                    foreach ($row as $j => $cell) {
                        $temp_dom = domxml_open_mem(
                            '<?xml version="1.0" encoding="UTF-8"?><Paragraph>' . $cell . '</Paragraph>',
                            DOMXML_LOAD_PARSING,
                            $error
                        );

                        $par_node = $this->getCellNode($i, $j, true);
                        // remove all childs
                        if (empty($error) && is_object($par_node)) {
                            // delete children of paragraph node
                            $children = $par_node->child_nodes();
                            for ($k = 0; $k < count($children); $k++) {
                                $par_node->remove_child($children[$k]);
                            }

                            // copy new content children in paragraph node
                            $xpc = xpath_new_context($temp_dom);
                            $path = "//Paragraph";
                            $res = xpath_eval($xpc, $path);

                            if (count($res->nodeset) == 1) {
                                $new_par_node = $res->nodeset[0];
                                $new_childs = $new_par_node->child_nodes();
                                for ($l = 0; $l < count($new_childs); $l++) {
                                    $cloned_child = $new_childs[$l]->clone_node(true);
                                    $par_node->append_child($cloned_child);
                                }
                            }
                        } else {
                            if (!empty($error)) {
                                return $error;
                            }
                        }
                    }
                }
            }
        }
        return true;
    }

Here is the call graph for this function:

setNode()

ilPCDataTable::setNode

(

php4DOMElement

$a_node

)

Definition at line 34 of file class.ilPCDataTable.php.

References php4DOMNode\first_child().

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

Here is the call graph for this function:

---

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

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