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

Inheritance diagram for ilPCAMDPageList:

Collaboration diagram for ilPCAMDPageList:

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

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

	setData (array $a_fields_data, ?int $a_mode=null)

	getMode ()

	getFieldValues (?int $a_data_id=null)
	Get filter field values. More...

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

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	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	migrateField (int $a_field_id, array $mapping)
	Migrate search/filter values on advmd change. 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...

Protected Attributes
ILIAS Wiki InternalDomainService	$wiki_domain

ilDBInterface	$db

ilLanguage	$lng

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

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

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 ilPCAMDPageList

Advanced MD page list content object (see ILIAS DTD)

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

◆ create()

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

Definition at line 47 of file class.ilPCAMDPageList.php.

     : void {
        $this->createPageContentNode();
        $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
        $amdpl_node = $this->dom_doc->createElement("AMDPageList");
        $amdpl_node = $this->getDomNode()->appendChild($amdpl_node);
    }

◆ getFieldValues()

ilPCAMDPageList::getFieldValues ( ?int $a_data_id = null )

Get filter field values.

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

     : array {
        $ilDB = $this->db;
 
        $res = array();
 
        if (!$a_data_id) {
            if (is_object($this->getChildNode())) {
                $a_data_id = $this->getChildNode()->getAttribute("Id");
            }
        }
 
        if ($a_data_id) {
            $set = $ilDB->query("SELECT * FROM pg_amd_page_list" .
                " WHERE id = " . $ilDB->quote($a_data_id, "integer"));
            while ($row = $ilDB->fetchAssoc($set)) {
                $res[$row["field_id"]] = unserialize((string) $row["sdata"], ["allowed_classes" => false]);
            }
        }
        return $res;
    }

◆ getLangVars()

static ilPCAMDPageList::getLangVars ( )

static

Get lang vars needed for editing.

Returns: string[] array of lang var keys

Reimplemented from ilPageContent.

Definition at line 42 of file class.ilPCAMDPageList.php.

                                        : array
    {
        return array("ed_insert_amd_page_list", "pc_amdpl");
    }

◆ getMode()

ilPCAMDPageList::getMode ( )

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

                             : int
    {
        if (is_object($this->getChildNode())) {
            return (int) $this->getChildNode()->getAttribute("Mode");
        }
        return 0;
    }

◆ handleCopiedContent()

static ilPCAMDPageList::handleCopiedContent	(	DOMDocument	$a_domdoc,
		bool	$a_self_ass = `true`,
		bool	$a_clone_mobs = `false`,
		int	$new_parent_id = `0`,
		int	$obj_copy_id = `0`
	)

static

Handle copied content.

This function must, e.g. create copies of objects referenced within the content (e.g. question objects)

Parameters

DOMDocument	$a_domdoc
bool	$a_self_ass
bool	$a_clone_mobs
int	$new_parent_id
int	$obj_copy_id

Reimplemented from ilPageContent.

Definition at line 118 of file class.ilPCAMDPageList.php.

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
        $old_id = 0;
        $node = null;
 
        // #15688
 
        $xpath = new DOMXPath($a_domdoc);
        $nodes = $xpath->query("//AMDPageList");
        foreach ($nodes as $node) {
            $old_id = $node->getAttribute("Id");
            break;
        }
 
        if ($old_id) {
            $new_id = $ilDB->nextId("pg_amd_page_list");
 
            $set = $ilDB->query("SELECT * FROM pg_amd_page_list" .
                    " WHERE id = " . $ilDB->quote($old_id, "integer"));
            while ($row = $ilDB->fetchAssoc($set)) {
                $fields = array(
                    "id" => array("integer", $new_id)
                    ,"field_id" => array("integer", $row["field_id"])
                    ,"sdata" => array("text", $row["sdata"])
                );
                $ilDB->insert("pg_amd_page_list", $fields);
            }
 
            $node->setAttribute("Id", $new_id);
        }
    }

◆ init()

ilPCAMDPageList::init ( )

Init object.

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

Reimplemented from ilPageContent.

Definition at line 32 of file class.ilPCAMDPageList.php.

                          : void
    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->setType("amdpl");
        $this->wiki_domain = $DIC->wiki()->internal()->domain();
    }

References $DIC, ILIAS\Repository\lng(), and ilPageContent\setType().

Here is the call graph for this function:

◆ migrateField()

static ilPCAMDPageList::migrateField	(	int	$a_field_id,
		array	$mapping
	)

static

Migrate search/filter values on advmd change.

In the mapping, keys are indices of old options, and values indices of associated new options.

Parameters

int	$a_field_id
string[]	$mapping

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        // this does only work for select and select multi
 
        $set = $ilDB->query("SELECT * FROM pg_amd_page_list" .
            " WHERE field_id = " . $ilDB->quote($a_field_id, "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $data = unserialize(unserialize((string) $row["sdata"], ["allowed_classes" => false]), ["allowed_classes" => false]);
            if (!is_array($data)) {
                continue;
            }
            $updated_data = $data;
            foreach ($mapping as $old_option => $new_option) {
                if (!in_array($old_option, $data)) {
                    continue;
                }
                $idx = array_search($old_option, $data);
                if ($new_option !== '') {
                    $updated_data[$idx] = $new_option;
                } else {
                    unset($updated_data[$idx]);
                }
            }
 
            $serialized_updated_data = serialize(empty($updated_data) ? '' : serialize($updated_data));
 
            $fields = array(
                "sdata" => array("text", $serialized_updated_data)
            );
            $primary = array(
                "id" => array("integer", $row["id"]),
                "field_id" => array("integer", $row["field_id"])
            );
            $ilDB->update("pg_amd_page_list", $fields, $primary);
        }
    }

References $data, and $ilDB.

Referenced by ilAdvancedMDFieldDefinitionSelect\update().

Here is the caller graph for this function:

◆ modifyPageContentPostXsl()

ilPCAMDPageList::modifyPageContentPostXsl	(	string	$a_output,
		string	$a_mode,
		bool	$a_abstract_only = `false`
	)

Modify page content after xsl.

Reimplemented from ilPageContent.

Definition at line 209 of file class.ilPCAMDPageList.php.

     : string {
        if ($this->getPage()->getParentType() !== "wpg") {
            return $a_output;
        }
        $end = 0;
        $wiki_id = $this->getPage()->getWikiId();
        $pm = $this->wiki_domain->page()->page($this->getPage()->getWikiRefId());
 
        $start = strpos($a_output, "[[[[[AMDPageList;");
        if (is_int($start)) {
            $end = strpos($a_output, "]]]]]", $start);
        }
        while ($end > 0) {
            $parts = explode(";", substr($a_output, $start + 17, $end - $start - 17));
 
            $list_id = (int) $parts[0];
            $list_mode = (count($parts) === 2)
                ? (int) $parts[1]
                : 0;
 
            $ltpl = new ilTemplate("tpl.wiki_amd_page_list.html", true, true, "components/ILIAS/Wiki");
 
            $pages = $this->findPages($list_id);
            if (count($pages)) {
                $ltpl->setCurrentBlock("page_bl");
                foreach ($pages as $page_id => $page_title) {
                    // see ilWikiUtil::makeLink()
                    $frag = new stdClass();
                    $frag->mFragment = null;
                    $frag->mTextform = $page_title;
 
                    $href = $pm->getPermaLink($page_id, $this->getPage()->getLanguage());
                    $ltpl->setVariable("PAGE", "<a href='" . $href . "'>" . $page_title . "</a>");
                    $ltpl->parseCurrentBlock();
                }
            } else {
                $ltpl->touchBlock("no_hits_bl");
            }
 
            $ltpl->setVariable("LIST_MODE", $list_mode ? "ol" : "ul");
 
            $a_output = substr($a_output, 0, $start) .
                $ltpl->get() .
                substr($a_output, $end + 5);
 
            $start = strpos($a_output, "[[[[[AMDPageList;", $start + 5);
            $end = 0;
            if (is_int($start)) {
                $end = strpos($a_output, "]]]]]", $start);
            }
        }
 
        return $a_output;
    }

◆ setData()

ilPCAMDPageList::setData	(	array	$a_fields_data,
		?int	$a_mode = `null`
	)

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

     : void {
        $ilDB = $this->db;
 
        $data_id = $this->getChildNode()->getAttribute("Id");
        if ($data_id) {
            $ilDB->manipulate("DELETE FROM pg_amd_page_list" .
                " WHERE id = " . $ilDB->quote($data_id, "integer"));
        } else {
            $data_id = $ilDB->nextId("pg_amd_page_list");
            $this->getChildNode()->setAttribute("Id", $data_id);
        }
 
        $this->getChildNode()->setAttribute("Mode", (int) $a_mode);
 
        foreach ($a_fields_data as $field_id => $field_data) {
            $fields = array(
                "id" => array("integer", $data_id)
                ,"field_id" => array("integer", $field_id)
                ,"sdata" => array("text", serialize($field_data))
            );
            $ilDB->insert("pg_amd_page_list", $fields);
        }
    }

References $ilDB.

Field Documentation

◆ $db

ilDBInterface ilPCAMDPageList::$db

protected

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

◆ $lng

ilLanguage ilPCAMDPageList::$lng

protected

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

◆ $wiki_domain

ILIAS Wiki InternalDomainService ilPCAMDPageList::$wiki_domain

protected

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

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

components/ILIAS/Wiki/classes/class.ilPCAMDPageList.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ create()

◆ getFieldValues()

◆ getLangVars()

◆ getMode()

◆ handleCopiedContent()

◆ init()

◆ migrateField()

◆ modifyPageContentPostXsl()

◆ setData()

Field Documentation

◆ $db

◆ $lng

◆ $wiki_domain