ILIAS  release_10 Revision v10.1-43-ga1241a92c2f
Public Member Functions | Static Public Member Functions
ilPCGrid 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 ilPCGrid:
+ Collaboration diagram for ilPCGrid:

Public Member Functions

 init ()
 Init page content component. More...
 
 create (ilPageObject $a_pg_obj, string $a_hier_id, string $a_pc_id="")
 
 applyTemplate (int $post_layout_template, int $number_of_cells, int $s, int $m, int $l, int $xl)
 
 savePositions (array $a_pos)
 Save positions of grid cells. More...
 
 saveWidths (array $a_width_s, array $a_width_m, array $a_width_l, array $a_width_xl)
 Save widths of cells. More...
 
 deleteGridCell (string $a_hier_id, string $a_pc_id)
 Delete grid cell. More...
 
 addGridCell (int $a_s, int $a_m, int $a_l, int $a_xl)
 Add grid cell. More...
 
 addCell ()
 Add a cell. More...
 
 getJavascriptFiles (string $a_mode)
 
 getCssFiles (string $a_mode)
 
 getCellData ()
 
- 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 getSizes ()
 Get sizes. More...
 
static getWidths ()
 Get widths. More...
 
static getLangVars ()
 Get lang vars needed for editing. More...
 
- 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...
 

Additional Inherited Members

- Data Fields inherited from ilPageContent
string $hier_id = ""
 
DOMNode $dom_node = null
 
string $page_lang = ""
 
- 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=[])
 
- 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 Grid element

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

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

Member Function Documentation

◆ addCell()

ilPCGrid::addCell ( )

Add a cell.

Definition at line 193 of file class.ilPCGrid.php.

References ilPageContent\getChildNode().

193  : void
194  {
195  $new_item = $this->dom_doc->createElement("GridCell");
196  $new_item->setAttribute("WIDTH_XS", "");
197  $new_item->setAttribute("WIDTH_S", "");
198  $new_item->setAttribute("WIDTH_M", "");
199  $new_item->setAttribute("WIDTH_L", "");
200  $new_item->setAttribute("WIDTH_XL", "");
201  $this->getChildNode()->appendChild($new_item);
202  }
+ Here is the call graph for this function:

◆ addGridCell()

ilPCGrid::addGridCell ( int  $a_s,
int  $a_m,
int  $a_l,
int  $a_xl 
)

Add grid cell.

Definition at line 175 of file class.ilPCGrid.php.

References ilPageContent\getChildNode().

Referenced by applyTemplate().

180  : void {
181  $new_item = $this->dom_doc->createElement("GridCell");
182  $new_item = $this->getChildNode()->appendChild($new_item);
183  $new_item->setAttribute("WIDTH_XS", "");
184  $new_item->setAttribute("WIDTH_S", $a_s);
185  $new_item->setAttribute("WIDTH_M", $a_m);
186  $new_item->setAttribute("WIDTH_L", $a_l);
187  $new_item->setAttribute("WIDTH_XL", $a_xl);
188  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ applyTemplate()

ilPCGrid::applyTemplate ( int  $post_layout_template,
int  $number_of_cells,
int  $s,
int  $m,
int  $l,
int  $xl 
)

Definition at line 66 of file class.ilPCGrid.php.

References addGridCell(), ilPCGridGUI\TEMPLATE_MAIN_SIDE, ilPCGridGUI\TEMPLATE_MANUAL, ilPCGridGUI\TEMPLATE_THREE_COLUMN, ilPCGridGUI\TEMPLATE_TWO_BY_TWO, and ilPCGridGUI\TEMPLATE_TWO_COLUMN.

73  : void {
74  switch ($post_layout_template) {
75  case ilPCGridGUI::TEMPLATE_TWO_COLUMN:
76  $this->addGridCell(12, 6, 6, 6);
77  $this->addGridCell(12, 6, 6, 6);
78  break;
79 
80  case ilPCGridGUI::TEMPLATE_THREE_COLUMN:
81  $this->addGridCell(12, 4, 4, 4);
82  $this->addGridCell(12, 4, 4, 4);
83  $this->addGridCell(12, 4, 4, 4);
84  break;
85 
86  case ilPCGridGUI::TEMPLATE_MAIN_SIDE:
87  $this->addGridCell(12, 6, 8, 9);
88  $this->addGridCell(12, 6, 4, 3);
89  break;
90 
91  case ilPCGridGUI::TEMPLATE_TWO_BY_TWO:
92  $this->addGridCell(12, 6, 6, 3);
93  $this->addGridCell(12, 6, 6, 3);
94  $this->addGridCell(12, 6, 6, 3);
95  $this->addGridCell(12, 6, 6, 3);
96  break;
97 
98 
99  case ilPCGridGUI::TEMPLATE_MANUAL:
100  for ($i = 0; $i < $number_of_cells; $i++) {
101  $this->addGridCell($s, $m, $l, $xl);
102  }
103  break;
104  }
105  }
ilPCGridGUI\TEMPLATE_TWO_BY_TWO
const TEMPLATE_TWO_BY_TWO
Definition: class.ilPCGridGUI.php:30
ilPCGridGUI\TEMPLATE_TWO_COLUMN
const TEMPLATE_TWO_COLUMN
Definition: class.ilPCGridGUI.php:27
ilPCGridGUI\TEMPLATE_MAIN_SIDE
const TEMPLATE_MAIN_SIDE
Definition: class.ilPCGridGUI.php:29
ilPCGridGUI\TEMPLATE_THREE_COLUMN
const TEMPLATE_THREE_COLUMN
Definition: class.ilPCGridGUI.php:28
ilPCGrid\addGridCell
addGridCell(int $a_s, int $a_m, int $a_l, int $a_xl)
Add grid cell.
Definition: class.ilPCGrid.php:175
+ Here is the call graph for this function:

◆ create()

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

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

References ilPageContent\createInitialChildNode().

62  : void {
63  $this->createInitialChildNode($a_hier_id, $a_pc_id, "Grid");
64  }
ilPageContent\createInitialChildNode
createInitialChildNode(string $hier_id, string $pc_id, string $child, array $child_attributes=[])
Definition: class.ilPageContent.php:317
+ Here is the call graph for this function:

◆ deleteGridCell()

ilPCGrid::deleteGridCell ( string  $a_hier_id,
string  $a_pc_id 
)

Delete grid cell.

Definition at line 158 of file class.ilPCGrid.php.

References $c, and ilPageContent\getChildNode().

161  : void {
162  foreach ($this->getChildNode()->childNodes as $c) {
163  if ($c->nodeName === "GridCell") {
164  if ($a_pc_id === $c->getAttribute("PCID") &&
165  $a_hier_id === $c->getAttribute("HierId")) {
166  $c->parentNode->removeChild($c);
167  }
168  }
169  }
170  }
$c
$c
Definition: deliver.php:9
+ Here is the call graph for this function:

◆ getCellData()

ilPCGrid::getCellData ( )

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

References $c, ilPageContent\$hier_id, and ilPageContent\getChildNode().

223  : array
224  {
225  $cells = array();
226  $k = 0;
227  foreach ($this->getChildNode()->childNodes as $c) {
228  if ($c->nodeName === "GridCell") {
229  $pc_id = $c->getAttribute("PCID");
230  $hier_id = $c->getAttribute("HierId");
231  $cells[] = array("pos" => $k,
232  "xs" => $c->getAttribute("WIDTH_XS"),
233  "s" => $c->getAttribute("WIDTH_S"),
234  "m" => $c->getAttribute("WIDTH_M"),
235  "l" => $c->getAttribute("WIDTH_L"),
236  "xl" => $c->getAttribute("WIDTH_XL"),
237  "pc_id" => $pc_id, "hier_id" => $hier_id);
238  $k++;
239  }
240  }
241 
242  return $cells;
243  }
$c
$c
Definition: deliver.php:9
+ Here is the call graph for this function:

◆ getCssFiles()

ilPCGrid::getCssFiles ( string  $a_mode)

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

218  : array
219  {
220  return parent::getCssFiles($a_mode);
221  }

◆ getJavascriptFiles()

ilPCGrid::getJavascriptFiles ( string  $a_mode)

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

213  : array
214  {
215  return parent::getJavascriptFiles($a_mode);
216  }

◆ getLangVars()

static ilPCGrid::getLangVars ( )
static

Get lang vars needed for editing.

Returns
array array of lang var keys

Definition at line 208 of file class.ilPCGrid.php.

208  : array
209  {
210  return array("pc_grid", "pc_grid_cell", "ed_delete_cell", "ed_cell_left", "ed_cell_right");
211  }

◆ getSizes()

static ilPCGrid::getSizes ( )
static

Get sizes.

Note that these are mapped to (BS3): s > .col-xs, m > .col-sm, l > .col-md, xl > .col-lg

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

Referenced by ilPCGridCellTableGUI\fillRow(), and ilPCGridGUI\initCreationForm().

40  : array
41  {
42  return array("s" => "s", "m" => "m", "l" => "l", "xl" => "xl");
43  }
+ Here is the caller graph for this function:

◆ getWidths()

static ilPCGrid::getWidths ( )
static

Get widths.

Definition at line 48 of file class.ilPCGrid.php.

Referenced by ilPCGridCellTableGUI\fillRow(), and ilPCGridGUI\initCreationForm().

48  : array
49  {
50  return array(
51  "1" => "1/12", "2" => "2/12", "3" => "3/12",
52  "4" => "4/12", "5" => "5/12", "6" => "6/12",
53  "7" => "7/12", "8" => "8/12", "9" => "9/12",
54  "10" => "10/12", "11" => "11/12", "12" => "12/12"
55  );
56  }
+ Here is the caller graph for this function:

◆ init()

ilPCGrid::init ( )

Init page content component.

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

References ilPageContent\setType().

29  : void
30  {
31  $this->setType("grid");
32  }
ilPageContent\setType
setType(string $a_type)
Set Type.
Definition: class.ilPageContent.php:103
+ Here is the call graph for this function:

◆ savePositions()

ilPCGrid::savePositions ( array  $a_pos)

Save positions of grid cells.

Definition at line 110 of file class.ilPCGrid.php.

References $c, ilPageContent\$hier_id, and ilPageContent\getChildNode().

110  : void
111  {
112  asort($a_pos);
113 
114  $nodes = array();
115  foreach ($this->getChildNode()->childNodes as $c) {
116  if ($c->nodeName === "GridCell") {
117  $pc_id = $c->getAttribute("PCID");
118  $hier_id = $c->getAttribute("HierId");
119  $nodes[$hier_id . ":" . $pc_id] = $c;
120  }
121  }
122  $this->dom_util->deleteAllChildsByName($this->getChildNode(), ["GridCell"]);
123 
124  foreach ($a_pos as $k => $v) {
125  if (is_object($nodes[$k])) {
126  $nodes[$k] = $this->getChildNode()->appendChild($nodes[$k]);
127  }
128  }
129  }
$c
$c
Definition: deliver.php:9
+ Here is the call graph for this function:

◆ saveWidths()

ilPCGrid::saveWidths ( array  $a_width_s,
array  $a_width_m,
array  $a_width_l,
array  $a_width_xl 
)

Save widths of cells.

Definition at line 134 of file class.ilPCGrid.php.

References $c, ilPageContent\$hier_id, and ilPageContent\getChildNode().

139  : void {
140  foreach ($this->getChildNode()->childNodes as $c) {
141  if ($c->nodeName === "GridCell") {
142  $pc_id = $c->getAttribute("PCID");
143  $hier_id = $c->getAttribute("HierId");
144  $k = $hier_id . ":" . $pc_id;
145  $c->setAttribute("WIDTH_XS", "");
146  $c->setAttribute("WIDTH_S", $a_width_s[$k]);
147  $c->setAttribute("WIDTH_M", $a_width_m[$k]);
148  $c->setAttribute("WIDTH_L", $a_width_l[$k]);
149  $c->setAttribute("WIDTH_XL", $a_width_xl[$k]);
150  }
151  }
152  }
$c
$c
Definition: deliver.php:9
+ Here is the call graph for this function:
The documentation for this class was generated from the following file: