Class ilPCAMDPageLisdatat. More...

Inheritance diagram for ilPCAMDPageList:

Collaboration diagram for ilPCAMDPageList:

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

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

	create (&$a_pg_obj, $a_hier_id, $a_pc_id="")
	Create list node in xml. More...

	setData (array $a_fields_data, $a_mode=null)
	Set list settings. More...

	getMode ()

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

	modifyPageContentPostXsl ($a_html, $a_mode, $a_abstract_only=false)

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	getLangVars ()
	Get lang vars needed for editing. More...

static	handleCopiedContent (DOMDocument $a_domdoc, $a_self_ass=true, $a_clone_mobs=false)

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

Data Fields
	$dom

Data Fields inherited from ilPageContent
	$hier_id

	$node

	$dom

	$page_lang

Protected Member Functions
	findPages ($a_list_id)

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

Protected Attributes
	$db

	$lng

Protected Attributes inherited from ilPageContent
	$profile_back_url

	$file_download_link

	$fullscreen_link

	$sourcecode_download_script

	$log

Detailed Description

Class ilPCAMDPageLisdatat.

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

Version

Id: class.ilPCListItem.php 22210 2009-10-26 09:46:06Z akill

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

Member Function Documentation

◆ create()

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

Create list node in xml.

Parameters

object	$a_pg_obj	Page Object
string	$a_hier_id	Hierarchical ID

Definition at line 68 of file class.ilPCAMDPageList.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->amdpl_node = $this->dom->create_element("AMDPageList");
         $this->amdpl_node = $this->node->append_child($this->amdpl_node);
     }

Here is the call graph for this function:

◆ findPages()

ilPCAMDPageList::findPages ( $a_list_id )

protected

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

References $db, $ilDB, ilAdvancedMDRecord\_getSelectedRecordsByObject(), getFieldValues(), ilADTFactory\getInstance(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), and ilPageContent\getPage().

Referenced by modifyPageContentPostXsl().

     {
         $ilDB = $this->db;
         
         $list_values = $this->getFieldValues($a_list_id);
         $wiki_id = $this->getPage()->getWikiId();
 
         $found_result = array();
 
         // only search in active fields
         $found_ids = null;
         $recs = ilAdvancedMDRecord::_getSelectedRecordsByObject("wiki", $this->ref_id, "wpg");
         foreach ($recs as $record) {
             foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($record->getRecordId(), true) as $field) {
                 if (isset($list_values[$field->getFieldId()])) {
                     $field_form = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($field->getADTDefinition(), true, false);
                     $field->setSearchValueSerialized($field_form, $list_values[$field->getFieldId()]);
                     $found_pages = $field->searchSubObjects($field_form, $wiki_id, "wpg");
                     if (is_array($found_ids)) {
                         $found_ids = array_intersect($found_ids, $found_pages);
                     } else {
                         $found_ids = $found_pages;
                     }
                 }
             }
         }
         
         if (is_array($found_ids) && count($found_ids) > 0) {
             $sql = "SELECT id,title FROM il_wiki_page" .
                 " WHERE " . $ilDB->in("id", $found_ids, "", "integer") .
                 " ORDER BY title";
             $set = $ilDB->query($sql);
             while ($row = $ilDB->fetchAssoc($set)) {
                 $found_result[$row["id"]] = $row["title"];
             }
         }
             
         return $found_result;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFieldValues()

ilPCAMDPageList::getFieldValues ( $a_data_id = null )

Get filter field values.

Parameters

int $a_data_id

Returns: string

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

References $db, $ilDB, and $res.

Referenced by findPages().

     {
         $ilDB = $this->db;
             
         $res = array();
         
         if (!$a_data_id) {
             if (is_object($this->amdpl_node)) {
                 $a_data_id = $this->amdpl_node->get_attribute("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($row["sdata"]);
             }
         }
         
         return $res;
     }

Here is the caller graph for this function:

◆ getLangVars()

static ilPCAMDPageList::getLangVars ( )

static

Get lang vars needed for editing.

Returns: array array of lang var keys

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

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

◆ getMode()

ilPCAMDPageList::getMode ( )

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

     {
         if (is_object($this->amdpl_node)) {
             return (int) $this->amdpl_node->get_attribute("Mode");
         }
     }

◆ handleCopiedContent()

static ilPCAMDPageList::handleCopiedContent	(	DOMDocument	$a_domdoc,
			$a_self_ass = `true`,
			$a_clone_mobs = `false`
	)

static

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

References $DIC, $ilDB, and ilPageContent\$node.

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         // #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 page content component.

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

References $_GET, $DIC, and ilPageContent\setType().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->lng = $DIC->language();
         $this->setType("amdpl");
 
         $this->ref_id = (int) $_GET["ref_id"];
     }

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 289 of file class.ilPCAMDPageList.php.

References $data, $DIC, and $ilDB.

Referenced by ilAdvancedMDFieldDefinitionSelect\update().

      : 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($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]);
                 }
             }
             $fields = array(
                 "sdata" => array("text", serialize(serialize($updated_data)))
             );
             $primary = array(
                 "id" => array("integer", $row["id"]),
                 "field_id" => array("integer", $row["field_id"])
             );
             $ilDB->update("pg_amd_page_list", $fields, $primary);
         }
     }

Here is the caller graph for this function:

◆ modifyPageContentPostXsl()

ilPCAMDPageList::modifyPageContentPostXsl	(	$a_html,
		$a_mode,
		$a_abstract_only = `false`
	)

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

References $i, $lng, findPages(), ilPageContent\getPage(), and ilWikiUtil\makeLink().

     {
         $lng = $this->lng;
         
         if ($this->getPage()->getParentType() != "wpg") {
             return $a_html;
         }
                             
         include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
         include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
         include_once('Modules/Wiki/classes/class.ilWikiUtil.php');
         
         $wiki_id = $this->getPage()->getWikiId();
         
         $c_pos = 0;
         $start = strpos($a_html, "[[[[[AMDPageList;");
         if (is_int($start)) {
             $end = strpos($a_html, "]]]]]", $start);
         }
         $i = 1;
         while ($end > 0) {
             $parts = explode(";", substr($a_html, $start + 17, $end - $start - 17));
             
             $list_id = (int) $parts[0];
             $list_mode = (sizeof($parts) == 2)
                 ? (int) $parts[1]
                 : 0;
             
             $ltpl = new ilTemplate("tpl.wiki_amd_page_list.html", true, true, "Modules/Wiki");
                 
             $pages = $this->findPages($list_id);
             if (sizeof($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;
                 
                     $ltpl->setVariable("PAGE", ilWikiUtil::makeLink($frag, $wiki_id, $page_title));
                     $ltpl->parseCurrentBlock();
                 }
             } else {
                 $ltpl->touchBlock("no_hits_bl");
             }
             
             $ltpl->setVariable("LIST_MODE", $list_mode ? "ol" : "ul");
                                             
             $a_html = substr($a_html, 0, $start) .
                 $ltpl->get() .
                 substr($a_html, $end + 5);
             
             $start = strpos($a_html, "[[[[[AMDPageList;", $start + 5);
             $end = 0;
             if (is_int($start)) {
                 $end = strpos($a_html, "]]]]]", $start);
             }
         }
                 
         return $a_html;
     }

Here is the call graph for this function:

◆ setData()

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

Set list settings.

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

References $db, and $ilDB.

     {
         $ilDB = $this->db;
         
         $data_id = $this->amdpl_node->get_attribute("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->amdpl_node->set_attribute("Id", $data_id);
         };
         
         $this->amdpl_node->set_attribute("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);
         }
     }

◆ setNode()

ilPCAMDPageList::setNode ( $a_node )

Set node.

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

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

Field Documentation

◆ $db

ilPCAMDPageList::$db

protected

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

Referenced by findPages(), getFieldValues(), and setData().

◆ $dom

ilPCAMDPageList::$dom

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

◆ $lng

ilPCAMDPageList::$lng

protected

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

Referenced by modifyPageContentPostXsl().

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

Modules/Wiki/classes/class.ilPCAMDPageList.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ create()

◆ findPages()

◆ getFieldValues()

◆ getLangVars()

◆ getMode()

◆ handleCopiedContent()

◆ init()

◆ migrateField()

◆ modifyPageContentPostXsl()

◆ setData()

◆ setNode()

Field Documentation

◆ $db

◆ $dom

◆ $lng