This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCTabs:

Collaboration diagram for ilPCTabs:

Public Member Functions
	init ()
	Init object. More...

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

	setTabType (string $a_type="HorizontalTabs")

	getTabType ()

	setContentWidth (string $a_val)

	getContentWidth ()

	setContentHeight (string $a_val)

	getContentHeight ()

	setHorizontalAlign (string $a_val)

	getHorizontalAlign ()

	setBehavior (string $a_val)

	getBehavior ()

	getCaptions ()

	getCaption (string $a_hier_id, string $a_pc_id)

	savePositions (array $a_pos)
	Save positions of tabs. More...

	saveCaptions (array $a_captions)

	deleteTab (string $a_hier_id, string $a_pc_id)

	addTab (string $a_caption)

	setTemplate (string $a_template)

	getTemplate ()

	setAutoTime (?int $a_val)

	getAutoTime ()

	setRandomStart (bool $a_val)

	getRandomStart ()

	getJavascriptFiles (string $a_mode)

	getCssFiles (string $a_mode)

	saveCaption (string $pc_id, string $caption)

	addAbove (string $pc_id, string $caption="")

	addBelow (string $pc_id, string $caption="")

	moveUp (string $pc_id)

	moveDown (string $pc_id)

	moveTop (string $pc_id)

	moveBottom (string $pc_id)

	deletePanel (string $pc_id)

	getNodeXml (string $pc_id)

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

Data Fields
const	ACCORDION_HOR = "HorizontalAccordion"

const	ACCORDION_VER = "VerticalAccordion"

const	CAROUSEL = "Carousel"

Data Fields inherited from ilPageContent
string	$hier_id = ""

DOMNode	$dom_node = null

string	$page_lang = ""

Protected Member Functions
	setTabsAttribute (string $a_attr, string $a_value)

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=[])

Additional Inherited Members
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 Tabbed contents (see ILIAS DTD)

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

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

Member Function Documentation

◆ addAbove()

ilPCTabs::addAbove	(	string	$pc_id,
		string	$caption = `""`
	)

Definition at line 302 of file class.ilPCTabs.php.

                                                                 : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $new_tab = $tab->parentNode->insertBefore($new_tab, $tab);
            if ($caption !== "") {
                $dom_util = $this->domain->domUtil();
                $dom_util->setFirstOptionalElement(
                    $new_tab,
                    "TabCaption",
                    array(),
                    $caption,
                    array()
                );
            }
        }
    }

◆ addBelow()

ilPCTabs::addBelow	(	string	$pc_id,
		string	$caption = `""`
	)

Definition at line 322 of file class.ilPCTabs.php.

                                                                 : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            if ($next = $tab->nextSibling) {
                $new_tab = $next->parentNode->insertBefore($new_tab, $next);
            } else {
                $new_tab = $tab->parentNode->appendChild($new_tab);
            }
 
            if ($caption !== "") {
                $dom_util = $this->domain->domUtil();
                $dom_util->setFirstOptionalElement(
                    $new_tab,
                    "TabCaption",
                    array(),
                    $caption,
                    array()
                );
            }
        }
    }

◆ addTab()

ilPCTabs::addTab ( string $a_caption )

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

                                             : void
    {
        $new_item = $this->dom_doc->createElement("Tab");
        $new_item = $this->getChildNode()->appendChild($new_item);
        $this->dom_util->setFirstOptionalElement(
            $new_item,
            "TabCaption",
            array(),
            $a_caption,
            array()
        );
    }

◆ create()

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

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

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

◆ deletePanel()

ilPCTabs::deletePanel ( string $pc_id )

Definition at line 409 of file class.ilPCTabs.php.

                                              : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $tab->parentNode->removeChild($tab);
        }
    }

◆ deleteTab()

ilPCTabs::deleteTab	(	string	$a_hier_id,
		string	$a_pc_id
	)

Definition at line 198 of file class.ilPCTabs.php.

     : void {
        // File Item
        foreach ($this->getChildNode()->childNodes as $child) {
            if ($child->nodeName == "Tab") {
                if ($a_pc_id == $child->getAttribute("PCID") &&
                    $a_hier_id == $child->getAttribute("HierId")) {
                    $child->parentNode->removeChild($child);
                }
            }
        }
    }

◆ getAutoTime()

ilPCTabs::getAutoTime ( )

Definition at line 246 of file class.ilPCTabs.php.

                                 : ?int
    {
        $val = $this->getChildNode()->getAttribute("AutoAnimWait");
        if ($val) {
            return (int) $val;
        }
        return null;
    }

◆ getBehavior()

ilPCTabs::getBehavior ( )

Definition at line 105 of file class.ilPCTabs.php.

                                 : string
    {
        return $this->getChildNode()->getAttribute("Behavior");
    }

◆ getCaption()

ilPCTabs::getCaption	(	string	$a_hier_id,
		string	$a_pc_id
	)

Definition at line 136 of file class.ilPCTabs.php.

     : string {
        foreach ($this->getCaptions() as $cap) {
            if ($cap["pc_id"] === $a_pc_id && $cap["hier_id"] === $a_hier_id) {
                return $cap["caption"];
            }
        }
        return "";
    }

◆ getCaptions()

ilPCTabs::getCaptions ( )

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

                                 : array
    {
        $captions = array();
        $k = 0;
        foreach ($this->getChildNode()->childNodes as $child) {
            if ($child->nodeName == "Tab") {
                $pc_id = $child->getAttribute("PCID");
                $hier_id = $child->getAttribute("HierId");
                $current_caption = "";
                foreach ($child->childNodes as $tab_child) {
                    if ($tab_child->nodeName == "TabCaption") {
                        $current_caption = $this->dom_util->getContent($tab_child);
                    }
                }
                $captions[] = array("pos" => $k,
                                    "caption" => $current_caption,
                                    "pc_id" => $pc_id,
                                    "hier_id" => $hier_id
                );
                $k++;
            }
        }
 
        return $captions;
    }

◆ getContentHeight()

ilPCTabs::getContentHeight ( )

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

                                      : string
    {
        return $this->getChildNode()->getAttribute("ContentHeight");
    }

◆ getContentWidth()

ilPCTabs::getContentWidth ( )

Definition at line 75 of file class.ilPCTabs.php.

                                     : string
    {
        return $this->getChildNode()->getAttribute("ContentWidth");
    }

◆ getCssFiles()

ilPCTabs::getCssFiles ( string $a_mode )

Reimplemented from ilPageContent.

Definition at line 274 of file class.ilPCTabs.php.

                                               : array
    {
        return ilAccordionGUI::getLocalCssFiles();
    }

References ilAccordionGUI\getLocalCssFiles().

Here is the call graph for this function:

◆ getHorizontalAlign()

ilPCTabs::getHorizontalAlign ( )

Definition at line 95 of file class.ilPCTabs.php.

                                        : string
    {
        return $this->getChildNode()->getAttribute("HorizontalAlign");
    }

◆ getJavascriptFiles()

ilPCTabs::getJavascriptFiles ( string $a_mode )

Reimplemented from ilPageContent.

Definition at line 265 of file class.ilPCTabs.php.

                                                      : array
    {
        $files = ilAccordionGUI::getLocalJavascriptFiles();
        if ($a_mode !== "edit") {
            $files[] = "./components/ILIAS/COPage/PC/Tabs/js/presentation.js";
        }
        return $files;
    }

References ilAccordionGUI\getLocalJavascriptFiles().

Here is the call graph for this function:

◆ getLangVars()

static ilPCTabs::getLangVars ( )

static

Get lang vars needed for editing.

Returns: string[] array of lang var keys

Reimplemented from ilPageContent.

Definition at line 236 of file class.ilPCTabs.php.

                                        : array
    {
        return array("pc_vacc", "pc_hacc", "pc_carousel");
    }

◆ getNodeXml()

ilPCTabs::getNodeXml ( string $pc_id )

Definition at line 419 of file class.ilPCTabs.php.

                                             : string
    {
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $xml = "";
            foreach ($tab->childNodes as $node) {
                if ($node->nodeName === "PageContent") {
                    $xml .= $node->ownerDocument->saveXml($node);
                }
            }
            return $xml;
        }
        return "";
    }

◆ getRandomStart()

ilPCTabs::getRandomStart ( )

Definition at line 260 of file class.ilPCTabs.php.

                                    : bool
    {
        return (bool) $this->getChildNode()->getAttribute("RandomStart");
    }

◆ getTabType()

ilPCTabs::getTabType ( )

Definition at line 65 of file class.ilPCTabs.php.

                                : string
    {
        return $this->getChildNode()->getAttribute("Type");
    }

◆ getTemplate()

ilPCTabs::getTemplate ( )

Definition at line 231 of file class.ilPCTabs.php.

                                 : string
    {
        return $this->getChildNode()->getAttribute("Template");
    }

◆ init()

ilPCTabs::init ( )

Init object.

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

Reimplemented from ilPageContent.

Definition at line 30 of file class.ilPCTabs.php.

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

References ilPageContent\setType().

Here is the call graph for this function:

◆ moveBottom()

ilPCTabs::moveBottom ( string $pc_id )

Definition at line 395 of file class.ilPCTabs.php.

                                             : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $next = $tab->nextSibling;
            if ($next) {
                $tab->parentNode->removeChild($tab);
                $tab = $next->parentNode->appendChild($tab);
            }
        }
    }

◆ moveDown()

ilPCTabs::moveDown ( string $pc_id )

Definition at line 361 of file class.ilPCTabs.php.

                                           : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $next = $tab->nextSibling;
            if ($next) {
                $next2 = $next->nextSibling;
                $tab->parentNode->removeChild($tab);
                if ($next2) {
                    $tab = $next2->parentNode->insertBefore($tab, $next2);
                } else {
                    $tab = $next->parentNode->appendChild($tab);
                }
            }
        }
    }

◆ moveTop()

ilPCTabs::moveTop ( string $pc_id )

Definition at line 380 of file class.ilPCTabs.php.

                                          : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $prev = $tab->previousSibling;
            if ($prev) {
                $tab->parentNode->removeChild($tab);
                $first = $prev->parentNode->childNodes->item(0);
                $tab = $prev->parentNode->insertBefore($tab, $first);
            }
        }
    }

◆ moveUp()

ilPCTabs::moveUp ( string $pc_id )

Definition at line 347 of file class.ilPCTabs.php.

                                         : void
    {
        $dom = $this->getPage()->getDomDoc();
        $new_tab = $dom->createElement("Tab");
        $tab = $this->getPage()->getDomNodeForPCId($pc_id);
        if (!is_null($tab)) {
            $prev = $tab->previousSibling;
            if ($prev) {
                $tab->parentNode->removeChild($tab);
                $tab = $prev->parentNode->insertBefore($tab, $prev);
            }
        }
    }

◆ saveCaption()

ilPCTabs::saveCaption	(	string	$pc_id,
		string	$caption
	)

Definition at line 279 of file class.ilPCTabs.php.

                                                               : void
    {
        $tab_nodes = $this->getChildNode()->childNodes;
        foreach ($tab_nodes as $tab_node) {
            if ($tab_node->nodeName === "Tab") {
                $current_pc_id = $tab_node->getAttribute("PCID");
                if ($current_pc_id === $pc_id) {
                    if ($caption !== "") {
                        $this->dom_util->setFirstOptionalElement(
                            $tab_node,
                            "TabCaption",
                            [],
                            $caption,
                            []
                        );
                    } else {
                        $this->dom_util->deleteAllChildsByName($tab_node, ["TabCaption"]);
                    }
                }
            }
        }
    }

◆ saveCaptions()

ilPCTabs::saveCaptions ( array $a_captions )

Definition at line 174 of file class.ilPCTabs.php.

                                                   : void
    {
        // iterate all tab nodes
        foreach ($this->getChildNode()->childNodes as $child) {
            if ($child->nodeName == "Tab") {
                $pc_id = $child->getAttribute("PCID");
                $hier_id = $child->getAttribute("HierId");
                $k = $hier_id . ":" . $pc_id;
                // if caption given, set it, otherwise delete caption subitem
                if ($a_captions[$k] != "") {
                    $this->dom_util->setFirstOptionalElement(
                        $child,
                        "TabCaption",
                        array(),
                        $a_captions[$k],
                        array()
                    );
                } else {
                    $this->dom_util->deleteAllChildsByName($child, array("TabCaption"));
                }
            }
        }
    }

◆ savePositions()

ilPCTabs::savePositions ( array $a_pos )

Save positions of tabs.

Definition at line 151 of file class.ilPCTabs.php.

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

◆ setAutoTime()

ilPCTabs::setAutoTime ( ?int $a_val )

Definition at line 241 of file class.ilPCTabs.php.

                                            : void
    {
        $this->setTabsAttribute("AutoAnimWait", (string) $a_val);
    }

◆ setBehavior()

ilPCTabs::setBehavior ( string $a_val )

Definition at line 100 of file class.ilPCTabs.php.

                                              : void
    {
        $this->setTabsAttribute("Behavior", $a_val);
    }

◆ setContentHeight()

ilPCTabs::setContentHeight ( string $a_val )

Definition at line 80 of file class.ilPCTabs.php.

                                                   : void
    {
        $this->setTabsAttribute("ContentHeight", $a_val);
    }

◆ setContentWidth()

ilPCTabs::setContentWidth ( string $a_val )

Definition at line 70 of file class.ilPCTabs.php.

                                                  : void
    {
        $this->setTabsAttribute("ContentWidth", $a_val);
    }

◆ setHorizontalAlign()

ilPCTabs::setHorizontalAlign ( string $a_val )

Definition at line 90 of file class.ilPCTabs.php.

                                                     : void
    {
        $this->setTabsAttribute("HorizontalAlign", $a_val);
    }

◆ setRandomStart()

ilPCTabs::setRandomStart ( bool $a_val )

Definition at line 255 of file class.ilPCTabs.php.

                                               : void
    {
        $this->setTabsAttribute("RandomStart", $a_val);
    }

◆ setTabsAttribute()

ilPCTabs::setTabsAttribute	(	string	$a_attr,
		string	$a_value
	)

protected

Definition at line 43 of file class.ilPCTabs.php.

     : void {
        $this->dom_util->setAttribute($this->getChildNode(), $a_attr, $a_value);
    }

◆ setTabType()

ilPCTabs::setTabType ( string $a_type = "HorizontalTabs" )

Parameters

string $a_type ("HorizontalTabs" | "Accordion")

Definition at line 53 of file class.ilPCTabs.php.

     : void {
        switch ($a_type) {
            case ilPCTabs::ACCORDION_VER:
            case ilPCTabs::ACCORDION_HOR:
            case ilPCTabs::CAROUSEL:
                $this->setTabsAttribute("Type", $a_type);
                break;
        }
    }

References ACCORDION_HOR, ACCORDION_VER, and CAROUSEL.

◆ setTemplate()

ilPCTabs::setTemplate ( string $a_template )

Definition at line 226 of file class.ilPCTabs.php.

                                                   : void
    {
        $this->setTabsAttribute("Template", $a_template);
    }

Field Documentation

◆ ACCORDION_HOR

const ilPCTabs::ACCORDION_HOR = "HorizontalAccordion"

Definition at line 26 of file class.ilPCTabs.php.

Referenced by ilPCTabsGUI\checkWidthHeight(), ilPCTabsGUI\setPropertiesByForm(), and setTabType().

◆ ACCORDION_VER

const ilPCTabs::ACCORDION_VER = "VerticalAccordion"

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

Referenced by ilPCTabsGUI\getFormValues(), ilPCTabsGUI\setPropertiesByForm(), and setTabType().

◆ CAROUSEL

const ilPCTabs::CAROUSEL = "Carousel"

Definition at line 28 of file class.ilPCTabs.php.

Referenced by ilPCTabsGUI\getFormValues(), ilPCTabsGUI\setPropertiesByForm(), and setTabType().

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

components/ILIAS/COPage/PC/Tabs/class.ilPCTabs.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addAbove()

◆ addBelow()

◆ addTab()

◆ create()

◆ deletePanel()

◆ deleteTab()

◆ getAutoTime()

◆ getBehavior()

◆ getCaption()

◆ getCaptions()

◆ getContentHeight()

◆ getContentWidth()

◆ getCssFiles()

◆ getHorizontalAlign()

◆ getJavascriptFiles()

◆ getLangVars()

◆ getNodeXml()

◆ getRandomStart()

◆ getTabType()

◆ getTemplate()

◆ init()

◆ moveBottom()

◆ moveDown()

◆ moveTop()

◆ moveUp()

◆ saveCaption()

◆ saveCaptions()

◆ savePositions()

◆ setAutoTime()

◆ setBehavior()

◆ setContentHeight()

◆ setContentWidth()

◆ setHorizontalAlign()

◆ setRandomStart()

◆ setTabsAttribute()

◆ setTabType()

◆ setTemplate()

Field Documentation

◆ ACCORDION_HOR

◆ ACCORDION_VER

◆ CAROUSEL