Grid element. More...

Inheritance diagram for ilPCGrid:

Collaboration diagram for ilPCGrid:

Public Member Functions
	init ()
	Init page content component. More...

	setNode ($a_node)
	Set content node. More...

	create ($a_pg_obj, $a_hier_id, $a_pc_id="")
	Create new Grid node. More...

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

	savePositions ($a_pos)
	Set attribute of grid tag. More...

	saveWidths ($a_width_s, $a_width_m, $a_width_l, $a_width_xl)
	Save widths of cells. More...

	deleteGridCell ($a_hier_id, $a_pc_id)
	Delete grid cell. More...

	addGridCell ($a_s, $a_m, $a_l, $a_xl)
	Add grid cell. More...

	addCell ()
	Add a cell. More...

	getJavascriptFiles ($a_mode)
	Get Javascript files. More...

	getCssFiles ($a_mode)
	Get Javascript files. More...

	getCellData ()

Public Member Functions inherited from ilPageContent
	__construct ($a_pg_obj)
	Constructor. More...

	setPage ($a_val)
	Set page. More...

	getPage ()
	Get page. More...

	init ()
	Init object. More...

	getType ()
	Get type of page content. More...

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

&	getNode ()
	Get xml node of page content. More...

	getJavascriptFiles ($a_mode)
	Get Javascript files. More...

	getCssFiles ($a_mode)
	Get css files. More...

	getOnloadCode ($a_mode)
	Get on load code. More...

	setHierId ($a_hier_id)
	Set hierarchical ID in xml structure. More...

	getHierId ()
	Get hierarchical id. More...

	lookupHierId ()
	Get hierarchical id from dom. More...

	readHierId ()
	Read PC Id. More...

	setPcId ($a_pcid)
	Set PC Id. More...

	getPCId ()
	Get PC Id. More...

	setFileDownloadLink ($a_download_link)
	Set file download link. More...

	getFileDownloadLink ()
	Get file download link. More...

	setProfileBackUrl ($url)

	getProfileBackUrl ()

	setFullscreenLink ($a_fullscreen_link)
	Set fullscreen link. More...

	getFullscreenLink ()
	Get fullscreen link. More...

	setSourcecodeDownloadScript ($script_name)
	Set sourcecode download script. More...

	getSourcecodeDownloadScript ()
	Get sourcecode download script. More...

	readPCId ()
	Read PC Id. More...

	writePCId ($a_pc_id)
	Write pc id. More...

	setEnabled ($value)
	Set Enabled value for page content component. More...

	enable ()
	Enable page content. More...

	disable ()
	Disable page content. More...

	isEnabled ()
	Check whether page content is enabled. More...

	createPageContentNode ($a_set_this_node=true)
	Create page content node (always use this method first when adding a new element) More...

	modifyPageContentPostXsl ($a_output, $a_mode, $a_abstract_only=false)
	Modify page content after xsl. More...

	getModel ()
	Get model. 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	incEdId ($ed_id)
	Increases an hierarchical editing id at lowest level (last number) More...

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

static	haveSameContainer ($ed_id1, $ed_id2)
	Check, if two ids are in same container. More...

static	sortHierIds ($a_array)
	Sort an array of Hier IDS in ascending order. More...

static	isGreaterHierId ($a, $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, $a_self_ass=true, $a_clone_mobs=false)
	Handle copied content. More...

static	afterPageUpdate ($a_page, DOMDocument $a_domdoc, $a_xml, $a_creation)
	After page has been updated (or created) More...

static	beforePageDelete ($a_page)
	Before page is being deleted. More...

static	afterPageHistoryEntry ($a_page, DOMDocument $a_old_domdoc, $a_old_xml, $a_old_nr)
	After page history entry has been created. More...

Protected Attributes
	$grid_node

Protected Attributes inherited from ilPageContent
	$profile_back_url

	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Additional Inherited Members
Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

	$page_lang

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

Detailed Description

Grid element.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Member Function Documentation

◆ addCell()

ilPCGrid::addCell ( )

Add a cell.

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

     {
         $new_item = $this->dom->create_element("GridCell");
         $new_item->set_attribute("WIDTH_XS", "");
         $new_item->set_attribute("WIDTH_S", "");
         $new_item->set_attribute("WIDTH_M", "");
         $new_item->set_attribute("WIDTH_L", "");
         $new_item->set_attribute("WIDTH_XL", "");
         $this->grid_node->append_child($new_item);
     }

◆ addGridCell()

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

Add grid cell.

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

Referenced by applyTemplate().

     {
         $new_item = $this->dom->create_element("GridCell");
         $new_item = $this->grid_node->append_child($new_item);
         //$new_item->set_attribute("xs", $a_xs);
         $new_item->set_attribute("WIDTH_XS", "");
         $new_item->set_attribute("WIDTH_S", $a_s);
         $new_item->set_attribute("WIDTH_M", $a_m);
         $new_item->set_attribute("WIDTH_L", $a_l);
         $new_item->set_attribute("WIDTH_XL", $a_xl);
     }

Here is the caller graph for this function:

◆ applyTemplate()

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

Parameters

$post_layout_template
$number_of_cells
$s
$m
$l
$xl

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

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

       {
         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 < (int) $number_of_cells; $i++) {
                     $this->addGridCell($s, $m, $l, $xl);
                 }
                 break;
         }
     }

Here is the call graph for this function:

◆ create()

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

Create new Grid node.

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

References ilPageContent\createPageContentNode(), and IL_INSERT_AFTER.

     {
         $this->node = $this->createPageContentNode();
         $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
         $this->grid_node = $this->dom->create_element("Grid");
         $this->grid_node = $this->node->append_child($this->grid_node);
     }

Here is the call graph for this function:

◆ deleteGridCell()

ilPCGrid::deleteGridCell	(	$a_hier_id,
		$a_pc_id
	)

Delete grid cell.

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

References $i.

     {
         $childs = $this->grid_node->child_nodes();
         for ($i = 0; $i < count($childs); $i++) {
             if ($childs[$i]->node_name() == "GridCell") {
                 if ($a_pc_id == $childs[$i]->get_attribute("PCID") &&
                     $a_hier_id == $childs[$i]->get_attribute("HierId")) {
                     $childs[$i]->unlink($childs[$i]);
                 }
             }
         }
     }

◆ getCellData()

ilPCGrid::getCellData ( )

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

References ilPageContent\$hier_id, and $i.

     {
         $cells = array();
         $cell_nodes = $this->grid_node->child_nodes();
         $k = 0;
         for ($i = 0; $i < count($cell_nodes); $i++) {
             if ($cell_nodes[$i]->node_name() == "GridCell") {
                 $pc_id = $cell_nodes[$i]->get_attribute("PCID");
                 $hier_id = $cell_nodes[$i]->get_attribute("HierId");
                 $cells[] = array("pos" => $k,
                     "xs" => $cell_nodes[$i]->get_attribute("WIDTH_XS"),
                     "s" => $cell_nodes[$i]->get_attribute("WIDTH_S"),
                     "m" => $cell_nodes[$i]->get_attribute("WIDTH_M"),
                     "l" => $cell_nodes[$i]->get_attribute("WIDTH_L"),
                     "xl" => $cell_nodes[$i]->get_attribute("WIDTH_XL"),
                     "pc_id" => $pc_id, "hier_id" => $hier_id);
                 $k++;
             }
         }
 
         return $cells;
     }

◆ getCssFiles()

ilPCGrid::getCssFiles ( $a_mode )

Get Javascript files.

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

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

◆ getJavascriptFiles()

ilPCGrid::getJavascriptFiles ( $a_mode )

Get Javascript files.

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

     {
         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 262 of file class.ilPCGrid.php.

     {
         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

Returns: array

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

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

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

Returns: array

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

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

     {
         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 40 of file class.ilPCGrid.php.

References ilPageContent\setType().

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

Here is the call graph for this function:

◆ savePositions()

ilPCGrid::savePositions ( $a_pos )

Set attribute of grid tag.

Parameters

string	$a_attr	attribute name
string	$a_value	attribute value Save positions of grid cells
array	$a_pos

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

References ilPageContent\$hier_id, and $i.

     {
         asort($a_pos);
 
         $childs = $this->grid_node->child_nodes();
         $nodes = array();
         for ($i = 0; $i < count($childs); $i++) {
             if ($childs[$i]->node_name() == "GridCell") {
                 $pc_id = $childs[$i]->get_attribute("PCID");
                 $hier_id = $childs[$i]->get_attribute("HierId");
                 $nodes[$hier_id . ":" . $pc_id] = $childs[$i];
                 $childs[$i]->unlink($childs[$i]);
             }
         }
         
         foreach ($a_pos as $k => $v) {
             if (is_object($nodes[$k])) {
                 $nodes[$k] = $this->grid_node->append_child($nodes[$k]);
             }
         }
     }

◆ saveWidths()

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

Save widths of cells.

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

References ilPageContent\$hier_id, and $i.

     {
         $cell_nodes = $this->grid_node->child_nodes();
         for ($i = 0; $i < count($cell_nodes); $i++) {
             if ($cell_nodes[$i]->node_name() == "GridCell") {
                 $pc_id = $cell_nodes[$i]->get_attribute("PCID");
                 $hier_id = $cell_nodes[$i]->get_attribute("HierId");
                 $k = $hier_id . ":" . $pc_id;
                 $cell_nodes[$i]->set_attribute("WIDTH_XS", "");
                 $cell_nodes[$i]->set_attribute("WIDTH_S", $a_width_s[$k]);
                 $cell_nodes[$i]->set_attribute("WIDTH_M", $a_width_m[$k]);
                 $cell_nodes[$i]->set_attribute("WIDTH_L", $a_width_l[$k]);
                 $cell_nodes[$i]->set_attribute("WIDTH_XL", $a_width_xl[$k]);
             }
         }
     }

◆ setNode()

ilPCGrid::setNode ( $a_node )

Set content node.

Parameters

object $a_node

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

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

Field Documentation

◆ $grid_node

ilPCGrid::$grid_node

protected

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

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

Services/COPage/classes/class.ilPCGrid.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCell()

◆ addGridCell()

◆ applyTemplate()

◆ create()

◆ deleteGridCell()

◆ getCellData()

◆ getCssFiles()

◆ getJavascriptFiles()

◆ getLangVars()

◆ getSizes()

◆ getWidths()

◆ init()

◆ savePositions()

◆ saveWidths()

◆ setNode()

Field Documentation

◆ $grid_node