ILIAS  release_8 Revision v8.24
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 ()
 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="")
 
 makeEmptyCell (php4DOMElement $td_node)
 Make cell empty. More...
 
 setData (array $a_data)
 Set data of cells. More...
 
- Public Member Functions inherited from ilPCTable
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilPCTable
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 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 = "" 
)

Reimplemented from ilPCTable.

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

44 : void {
45 $this->node = $this->createPageContentNode();
46 $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
47 $this->tab_node = $this->dom->create_element("Table");
48 $this->tab_node = $this->node->append_child($this->tab_node);
49 $this->tab_node->set_attribute("Language", "");
50 $this->tab_node->set_attribute("DataTable", "y");
51 }
const IL_INSERT_AFTER
createPageContentNode(bool $a_set_this_node=true)
Create page content node (always use this method first when adding a new element)
insertContent(ilPageContent $a_cont_obj, string $a_pos, int $a_mode=IL_INSERT_AFTER, string $a_pcid="", bool $remove_placeholder=true)
insert a content node before/after a sibling or as first child of a parent

◆ init()

ilPCDataTable::init ( )

Init object.

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

Reimplemented from ilPCTable.

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

29 : void
30 {
31 $this->setType("dtab");
32 }
setType(string $a_type)
Set Type.

References ilPageContent\setType().

+ Here is the call graph for this function:

◆ makeEmptyCell()

ilPCDataTable::makeEmptyCell ( php4DOMElement  $td_node)

Make cell empty.

Reimplemented from ilPCTable.

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

57 : void
58 {
59 // delete children of paragraph node
60 $children = $td_node->child_nodes();
61 for ($i = 0; $i < count($children); $i++) {
62 $td_node->remove_child($children[$i]);
63 }
64
65 // create page content and paragraph node here.
66 $pc_node = $this->createPageContentNode(false);
67 $pc_node = $td_node->append_child($pc_node);
68 $par_node = $this->dom->create_element("Paragraph");
69 $par_node = $pc_node->append_child($par_node);
70 $par_node->set_attribute("Characteristic", "TableContent");
71 $par_node->set_attribute(
72 "Language",
73 $this->getLanguage()
74 );
75 }
remove_child($oldchild)
append_child($newnode)
$i
Definition: metadata.php:41

References $i, php4DOMNode\append_child(), php4DOMNode\child_nodes(), ILIAS\UI\Implementation\Component\Input\getLanguage(), and php4DOMNode\remove_child().

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

83 {
84 if (is_array($a_data)) {
85 foreach ($a_data as $i => $row) {
86 if (is_array($row)) {
87 foreach ($row as $j => $cell) {
88 $temp_dom = domxml_open_mem(
89 '<?xml version="1.0" encoding="UTF-8"?><Paragraph>' . $cell . '</Paragraph>',
91 $error
92 );
93
94 $par_node = $this->getCellNode($i, $j, true);
95 // remove all childs
96 if (empty($error) && is_object($par_node)) {
97 // delete children of paragraph node
98 $children = $par_node->child_nodes();
99 for ($k = 0; $k < count($children); $k++) {
100 $par_node->remove_child($children[$k]);
101 }
102
103 // copy new content children in paragraph node
104 $xpc = xpath_new_context($temp_dom);
105 $path = "//Paragraph";
106 $res = xpath_eval($xpc, $path);
107
108 if (count($res->nodeset) == 1) {
109 $new_par_node = $res->nodeset[0];
110 $new_childs = $new_par_node->child_nodes();
111 for ($l = 0; $l < count($new_childs); $l++) {
112 $cloned_child = $new_childs[$l]->clone_node(true);
113 $par_node->append_child($cloned_child);
114 }
115 }
116 } else {
117 if (!empty($error)) {
118 return $error;
119 }
120 }
121 }
122 }
123 }
124 }
125 return true;
126 }
getCellNode(int $i, int $j, bool $create_if_not_exists=false)
Get cell paragraph node of row $i and cell $j.
domxml_open_mem($str, $mode=0, &$error=null)
xpath_new_context($dom_document)
const DOMXML_LOAD_PARSING
xpath_eval(php4DOMXPath $xpath_context, string $eval_str, $contextnode=null)
$path
Definition: ltiservices.php:32
$res
Definition: ltiservices.php:69

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

+ Here is the call graph for this function:

◆ setNode()

ilPCDataTable::setNode ( php4DOMElement  $a_node)

Set xml node of page content.

Parameters
php4DOMElement$a_nodenode object

Reimplemented from ilPCTable.

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

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

References php4DOMNode\first_child().

+ Here is the call graph for this function:

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