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

Inheritance diagram for ilPCList:

Collaboration diagram for ilPCList:

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="")

	addItems (int $a_nr)
	Add a number of items to list. More...

	getOrderType ()
	Get order type. More...

	getListType ()

	setListType (string $a_val)

	getNumberingType ()
	Get numbering type. More...

	setNumberingType (string $a_val)

	setStartValue (int $a_val)

	getStartValue ()

	setStyleClass (string $a_val)

	getStyleClass ()

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

Data Fields
php4DOMElement	$list_node

Data Fields inherited from ilPageContent
string	$hier_id = ""

php4DOMElement	$node = null

php4DOMDocument	$dom = null

string	$page_lang = ""

Additional Inherited Members
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...

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 ilPCList

List content object (see ILIAS DTD)

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

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

Member Function Documentation

◆ addItems()

ilPCList::addItems ( int $a_nr )

Add a number of items to list.

Definition at line 55 of file class.ilPCList.php.

                                       : void
    {
        for ($i = 1; $i <= $a_nr; $i++) {
            $new_item = $this->dom->create_element("ListItem");
            $new_item = $this->list_node->append_child($new_item);
        }
    }

References $i.

◆ create()

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

Definition at line 41 of file class.ilPCList.php.

     : void {
        $this->node = $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $this->list_node = $this->dom->create_element("List");
        $this->list_node = $this->node->append_child($this->list_node);
    }

◆ getListType()

ilPCList::getListType ( )

Definition at line 88 of file class.ilPCList.php.

                                 : string
    {
        if ($this->list_node->get_attribute("Type") == "Unordered") {
            return "Unordered";
        }
        return "Ordered";
    }

◆ getNumberingType()

ilPCList::getNumberingType ( )

Get numbering type.

Definition at line 104 of file class.ilPCList.php.

                                      : string
    {
        $nt = $this->list_node->get_attribute("NumberingType");
        switch ($nt) {
            case "Number":
            case "Roman":
            case "roman":
            case "Alphabetic":
            case "alphabetic":
            case "Decimal":
                return $nt;
 
            default:
                return "Number";
        }
    }

◆ getOrderType()

ilPCList::getOrderType ( )

Get order type.

Definition at line 67 of file class.ilPCList.php.

                                  : string
    {
        if ($this->list_node->get_attribute("Type") == "Unordered") {
            return "Unordered";
        }
 
        $nt = $this->list_node->get_attribute("NumberingType");
        switch ($nt) {
            case "Number":
            case "Roman":
            case "roman":
            case "Alphabetic":
            case "alphabetic":
            case "Decimal":
                return $nt;
 
            default:
                return "Number";
        }
    }

◆ getStartValue()

ilPCList::getStartValue ( )

Definition at line 143 of file class.ilPCList.php.

                                   : int
    {
        return (int) $this->list_node->get_attribute("StartValue");
    }

◆ getStyleClass()

ilPCList::getStyleClass ( )

Definition at line 159 of file class.ilPCList.php.

                                   : string
    {
        return $this->list_node->get_attribute("Class");
    }

◆ init()

ilPCList::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.ilPCList.php.

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

References ilPageContent\setType().

Here is the call graph for this function:

◆ setListType()

ilPCList::setListType ( string $a_val )

Definition at line 96 of file class.ilPCList.php.

                                              : void
    {
        $this->list_node->set_attribute("Type", $a_val);
    }

◆ setNode()

ilPCList::setNode ( php4DOMElement $a_node )

Set xml node of page content.

Parameters

php4DOMElement $a_node node object

Reimplemented from ilPageContent.

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

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

References php4DOMNode\first_child().

Here is the call graph for this function:

◆ setNumberingType()

ilPCList::setNumberingType ( string $a_val )

Definition at line 121 of file class.ilPCList.php.

                                                   : void
    {
        if ($a_val != "") {
            $this->list_node->set_attribute("NumberingType", $a_val);
        } else {
            if ($this->list_node->has_attribute("NumberingType")) {
                $this->list_node->remove_attribute("NumberingType");
            }
        }
    }

◆ setStartValue()

ilPCList::setStartValue ( int $a_val )

Definition at line 132 of file class.ilPCList.php.

                                             : void
    {
        if ($a_val != "") {
            $this->list_node->set_attribute("StartValue", $a_val);
        } else {
            if ($this->list_node->has_attribute("StartValue")) {
                $this->list_node->remove_attribute("StartValue");
            }
        }
    }

◆ setStyleClass()

ilPCList::setStyleClass ( string $a_val )

Definition at line 148 of file class.ilPCList.php.

                                                : void
    {
        if (!in_array($a_val, array("", "BulletedList", "NumberedList"))) {
            $this->list_node->set_attribute("Class", $a_val);
        } else {
            if ($this->list_node->has_attribute("Class")) {
                $this->list_node->remove_attribute("Class");
            }
        }
    }

Field Documentation

◆ $list_node

php4DOMElement ilPCList::$list_node

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

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

Services/COPage/classes/class.ilPCList.php

Public Member Functions

Data Fields

Additional Inherited Members