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

                              : void
     {
         $new_item = $this->dom_doc->createElement("GridCell");
         $new_item->setAttribute("WIDTH_XS", "");
         $new_item->setAttribute("WIDTH_S", "");
         $new_item->setAttribute("WIDTH_M", "");
         $new_item->setAttribute("WIDTH_L", "");
         $new_item->setAttribute("WIDTH_XL", "");
         $this->getChildNode()->appendChild($new_item);
     }

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

      : void {
         $new_item = $this->dom_doc->createElement("GridCell");
         $new_item = $this->getChildNode()->appendChild($new_item);
         $new_item->setAttribute("WIDTH_XS", "");
         $new_item->setAttribute("WIDTH_S", $a_s);
         $new_item->setAttribute("WIDTH_M", $a_m);
         $new_item->setAttribute("WIDTH_L", $a_l);
         $new_item->setAttribute("WIDTH_XL", $a_xl);
     }

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.

      : void {
         switch ($post_layout_template) {
             case ilPCGridGUI::TEMPLATE_TWO_COLUMN:
                 $this->addGridCell(12, 6, 6, 6);
                 $this->addGridCell(12, 6, 6, 6);
                 break;
 
             case ilPCGridGUI::TEMPLATE_THREE_COLUMN:
                 $this->addGridCell(12, 4, 4, 4);
                 $this->addGridCell(12, 4, 4, 4);
                 $this->addGridCell(12, 4, 4, 4);
                 break;
 
             case ilPCGridGUI::TEMPLATE_MAIN_SIDE:
                 $this->addGridCell(12, 6, 8, 9);
                 $this->addGridCell(12, 6, 4, 3);
                 break;
 
             case ilPCGridGUI::TEMPLATE_TWO_BY_TWO:
                 $this->addGridCell(12, 6, 6, 3);
                 $this->addGridCell(12, 6, 6, 3);
                 $this->addGridCell(12, 6, 6, 3);
                 $this->addGridCell(12, 6, 6, 3);
                 break;
 
 
             case ilPCGridGUI::TEMPLATE_MANUAL:
                 for ($i = 0; $i < $number_of_cells; $i++) {
                     $this->addGridCell($s, $m, $l, $xl);
                 }
                 break;
         }
     }

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

      : void {
         $this->createInitialChildNode($a_hier_id, $a_pc_id, "Grid");
     }

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

      : void {
         foreach ($this->getChildNode()->childNodes as $c) {
             if ($c->nodeName === "GridCell") {
                 if ($a_pc_id === $c->getAttribute("PCID") &&
                     $a_hier_id === $c->getAttribute("HierId")) {
                     $c->parentNode->removeChild($c);
                 }
             }
         }
     }

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

                                  : array
     {
         $cells = array();
         $k = 0;
         foreach ($this->getChildNode()->childNodes as $c) {
             if ($c->nodeName === "GridCell") {
                 $pc_id = $c->getAttribute("PCID");
                 $hier_id = $c->getAttribute("HierId");
                 $cells[] = array("pos" => $k,
                     "xs" => $c->getAttribute("WIDTH_XS"),
                     "s" => $c->getAttribute("WIDTH_S"),
                     "m" => $c->getAttribute("WIDTH_M"),
                     "l" => $c->getAttribute("WIDTH_L"),
                     "xl" => $c->getAttribute("WIDTH_XL"),
                     "pc_id" => $pc_id, "hier_id" => $hier_id);
                 $k++;
             }
         }
 
         return $cells;
     }

Here is the call graph for this function:

◆ getCssFiles()

ilPCGrid::getCssFiles ( string $a_mode )

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

                                                : array
     {
         return parent::getCssFiles($a_mode);
     }

◆ getJavascriptFiles()

ilPCGrid::getJavascriptFiles ( string $a_mode )

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

                                                       : array
     {
         return parent::getJavascriptFiles($a_mode);
     }

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

                                         : array
     {
         return array("pc_grid", "pc_grid_cell", "ed_delete_cell", "ed_cell_left", "ed_cell_right");
     }

◆ 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().

                                      : array
     {
         return array("s" => "s", "m" => "m", "l" => "l", "xl" => "xl");
     }

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

                                       : array
     {
         return array(
             "1" => "1/12", "2" => "2/12", "3" => "3/12",
             "4" => "4/12", "5" => "5/12", "6" => "6/12",
             "7" => "7/12", "8" => "8/12", "9" => "9/12",
             "10" => "10/12", "11" => "11/12", "12" => "12/12"
         );
     }

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

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

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

                                                : void
     {
         asort($a_pos);
 
         $nodes = array();
         foreach ($this->getChildNode()->childNodes as $c) {
             if ($c->nodeName === "GridCell") {
                 $pc_id = $c->getAttribute("PCID");
                 $hier_id = $c->getAttribute("HierId");
                 $nodes[$hier_id . ":" . $pc_id] = $c;
             }
         }
         $this->dom_util->deleteAllChildsByName($this->getChildNode(), ["GridCell"]);
 
         foreach ($a_pos as $k => $v) {
             if (is_object($nodes[$k])) {
                 $nodes[$k] = $this->getChildNode()->appendChild($nodes[$k]);
             }
         }
     }

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

      : void {
         foreach ($this->getChildNode()->childNodes as $c) {
             if ($c->nodeName === "GridCell") {
                 $pc_id = $c->getAttribute("PCID");
                 $hier_id = $c->getAttribute("HierId");
                 $k = $hier_id . ":" . $pc_id;
                 $c->setAttribute("WIDTH_XS", "");
                 $c->setAttribute("WIDTH_S", $a_width_s[$k]);
                 $c->setAttribute("WIDTH_M", $a_width_m[$k]);
                 $c->setAttribute("WIDTH_L", $a_width_l[$k]);
                 $c->setAttribute("WIDTH_XL", $a_width_xl[$k]);
             }
         }
     }

Here is the call graph for this function:

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

components/ILIAS/COPage/PC/Grid/class.ilPCGrid.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCell()

◆ addGridCell()

◆ applyTemplate()

◆ create()

◆ deleteGridCell()

◆ getCellData()

◆ getCssFiles()

◆ getJavascriptFiles()

◆ getLangVars()

◆ getSizes()

◆ getWidths()

◆ init()

◆ savePositions()

◆ saveWidths()