Collaboration diagram for ilInternalLink:

Static Public Member Functions
static	_deleteAllLinksOfSource ($a_source_type, $a_source_id, $a_lang="-")
	Delete all links of a given source. More...

static	_deleteAllLinksToTarget ($a_target_type, $a_target_id, $a_target_inst=0)
	Delete all links to a given target. More...

static	_saveLink ($a_source_type, $a_source_id, $a_target_type, $a_target_id, $a_target_inst=0, $a_source_lang="-")
	save internal link information More...

static	_getSourcesOfTarget ($a_target_type, $a_target_id, $a_target_inst)
	get all sources of a link target More...

static	_getTargetsOfSource ($a_source_type, $a_source_id, $a_source_lang="-")
	Get all targets of a source object (e.g., a page) More...

static	_getIdForImportId ($a_type, $a_target)
	Get current id for an import id. More...

static	_exists ($a_type, $a_target)
	Check if internal link refers to a valid target. More...

static	_extractInstOfTarget ($a_target)
	Extract installation id out of target. More...

static	_removeInstFromTarget ($a_target)
	Removes installation id from target string. More...

static	_extractObjIdOfTarget ($a_target)
	Extract object id out of target. More...

static	_extractTypeOfTarget ($a_target)
	Extract type out of target. More...

Detailed Description

Class ilInternalLink.

Some methods to handle internal links

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilInternalLink.php.

Member Function Documentation

◆ _deleteAllLinksOfSource()

static ilInternalLink::_deleteAllLinksOfSource	(	$a_source_type,
		$a_source_id,
		$a_lang = `"-"`
	)

static

Delete all links of a given source.

Parameters

string	$a_source_type	source type
int	$a_source_if	source id
int	$a_lang	source language

Definition at line 23 of file class.ilInternalLink.php.

References $ilDB.

Referenced by SurveyQuestion\_resolveIntLinks(), assQuestion\_resolveIntLinks(), assQuestion\copySuggestedSolutionFiles(), SurveyQuestion\delete(), ilPageObject\deleteInternalLinks(), assQuestion\deleteSuggestedSolutions(), SurveyQuestion\saveMaterial(), and SurveyQuestion\syncWithOriginal().

         {
                 global $ilias, $ilDB;
 
                 $lang_where = "";
                 if ($a_lang != "")
                 {
                         $lang_where = " AND source_lang = ".$ilDB->quote($a_lang, "text");
                 }
                 
                 $q = "DELETE FROM int_link WHERE source_type = ".
                         $ilDB->quote($a_source_type, "text")." AND source_id=".
                         $ilDB->quote((int) $a_source_id, "integer").
                         $lang_where;
                 $ilDB->manipulate($q);
         }

Here is the caller graph for this function:

◆ _deleteAllLinksToTarget()

static ilInternalLink::_deleteAllLinksToTarget	(	$a_target_type,
		$a_target_id,
		$a_target_inst = `0`
	)

static

Delete all links to a given target.

Parameters

string	$a_target_type	target type
int	$a_target_id	target id
int	$a_target_inst	target installation id

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

References $ilDB, and array.

Referenced by ilPortfolioPage\delete(), and ilWikiPage\delete().

         {
                 global $ilias, $ilDB;
 
                 $ilDB->manipulateF("DELETE FROM int_link WHERE target_type = %s ".
                         " AND target_id = %s AND target_inst = %s ",
                         array("text", "integer", "integer"),
                         array($a_target_type, (int) $a_target_id, (int) $a_target_inst));
         }

Here is the caller graph for this function:

◆ _exists()

static ilInternalLink::_exists	(	$a_type,
		$a_target
	)

static

Check if internal link refers to a valid target.

Parameters

string	$a_type	target type ("PageObject" \| "StructureObject" \| "GlossaryItem" \| "MediaObject")
string	$a_target	target id, e.g. "il__pg_244")

Returns: boolean true/false

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

References $a_type, $ref_id, ilObjMediaObject\_exists(), ilGlossaryTerm\_exists(), ilPageObject\_exists(), ilLMObject\_exists(), and _extractObjIdOfTarget().

Referenced by ilPageObject\resolveIntLinks().

         {
                 global $tree;
                 
                 switch($a_type)
                 {
                         case "PageObject":
                         case "StructureObject":
                                 include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                 return ilLMObject::_exists($a_target);
                                 break;
 
                         case "GlossaryItem":
                                 include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
                                 return ilGlossaryTerm::_exists($a_target);
                                 break;
 
                         case "MediaObject":
                                 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                                 return ilObjMediaObject::_exists($a_target);
                                 break;
                                 
                         case "WikiPage":
                                 include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
                                 return ilWikiPage::_exists("wiki", (int)$a_target);
                                 break;
                                 
                         case "RepositoryItem":
                                 if (is_int(strpos($a_target, "_")))
                                 {
                                         $ref_id = ilInternalLink::_extractObjIdOfTarget($a_target);
                                         return $tree->isInTree($ref_id);
                                 }
                                 break;
                 }
                 return false;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _extractInstOfTarget()

static ilInternalLink::_extractInstOfTarget ( $a_target )

static

Extract installation id out of target.

Parameters

string $a_target import target id (e.g. "il_2_pg_22")

Definition at line 304 of file class.ilInternalLink.php.

References $target.

Referenced by _getIdForImportId(), ilPageObject\_handleImportRepositoryLinks(), ilPCQuestion\afterPageUpdate(), ilPCQuestionGUI\edit(), ilQuestionExporter\exportQuestion(), ilPCQuestionGUI\feedback(), ilPageObject\getQuestionIds(), ilPageObject\newIIMCopies(), ilPageObject\newMobCopies(), ilPageObject\newQuestionCopies(), ilPageObject\resolveIntLinks(), ilPCQuestionGUI\setTabs(), and ilLMObject\updateInternalLinks().

         {
                 if (!is_int(strpos($a_target, "__")))
                 {
                         $target = explode("_", $a_target);
                         if ($target[1] > 0)
                         {
                                 return $target[1]; 
                         }
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ _extractObjIdOfTarget()

static ilInternalLink::_extractObjIdOfTarget ( $a_target )

static

Extract object id out of target.

Parameters

string $a_target import target id (e.g. "il_2_pg_22")

Definition at line 340 of file class.ilInternalLink.php.

References $target.

Referenced by ilObjMediaObject\_exists(), ilGlossaryTerm\_exists(), _exists(), ilSCORM2004Node\_exists(), ilLMObject\_exists(), ilPageObject\_handleImportRepositoryLinks(), ilPCQuestion\afterPageUpdate(), ilPCQuestionGUI\edit(), ilSCORM2004Asset\exportHTMLPageObjects(), ilQuestionExporter\exportQuestion(), ilPCQuestionGUI\feedback(), ilPageObject\getInitialOpenedContent(), ilObjMediaObject\getLinkedMediaObjects(), ilPageObject\getQuestionIds(), ilPageObject\moveIntLinks(), ilPageObject\newIIMCopies(), ilPageObject\newMobCopies(), ilPageObject\newQuestionCopies(), ilPCInteractiveImage\setNode(), ilPCQuestionGUI\setTabs(), and ilLMObject\updateInternalLinks().

         {
                 $target = explode("_", $a_target);
                 return $target[count($target) - 1];
         }

Here is the caller graph for this function:

◆ _extractTypeOfTarget()

static ilInternalLink::_extractTypeOfTarget ( $a_target )

static

Extract type out of target.

Parameters

string $a_target import target id (e.g. "il_2_pg_22")

Definition at line 351 of file class.ilInternalLink.php.

References $target.

Referenced by ilLMObject\updateInternalLinks().

         {
                 $target = explode("_", $a_target);
                 return $target[count($target) - 2];
         }

Here is the caller graph for this function:

◆ _getIdForImportId()

static ilInternalLink::_getIdForImportId	(	$a_type,
		$a_target
	)

static

Get current id for an import id.

Parameters

string	$a_type	target type ("PageObject" \| "StructureObject" \| "GlossaryItem" \| "MediaObject")
string	$a_target	import target id (e.g. "il_2_pg_22")

Returns: string current target id (e.g. "il__pg_244")

Definition at line 157 of file class.ilInternalLink.php.

References $a_type, _extractInstOfTarget(), ilObject\_getAllReferences(), ilGlossaryTerm\_getIdForImportId(), ilLMObject\_getIdForImportId(), and ilObject\_getIdForImportId().

Referenced by SurveyQuestion\_resolveInternalLink(), assQuestion\_resolveInternalLink(), ilMapArea\_resolveIntLinks(), and ilPageObject\resolveIntLinks().

         {
                 include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                 switch($a_type)
                 {
                         case "PageObject":
                                 $id = ilLMObject::_getIdForImportId($a_target);
                                 if($id > 0)
                                 {
                                         return "il__pg_".$id;
                                 }
                                 break;
 
                         case "StructureObject":
                                 $id = ilLMObject::_getIdForImportId($a_target);
                                 if($id > 0)
                                 {
                                         return "il__st_".$id;
                                 }
                                 break;
 
                         case "GlossaryItem":
                                 include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
                                 $id = ilGlossaryTerm::_getIdForImportId($a_target);
                                 //echo "+".$id."+".$a_target."+";
                                 if($id > 0)
                                 {
                                         return "il__git_".$id;
                                 }
                                 break;
 
                         case "WikiPage":
                                 // no import IDs for wiki pages (yet)
                                 //$id = ilGlossaryTerm::_getIdForImportId($a_target);
                                 $id = 0;
                                 if($id > 0)
                                 {
                                         return "il__wpage_".$id;
                                 }
                                 break;
 
                         case "MediaObject":
                                 $id = ilObjMediaObject::_getIdForImportId($a_target);
                                 if($id > 0)
                                 {
                                         return "il__mob_".$id;
                                 }
                                 break;
                                 
                         case "RepositoryItem":
                                 
                                 $tarr = explode("_", $a_target);
                                 $import_id = $a_target;
                                 
                                 // if a ref id part is given, strip this
                                 // since this will not be part of an import id
                                 // see also bug #6685
                                 if ($tarr[4] != "")
                                 {
                                         $import_id = $tarr[0]."_".$tarr[1]."_".$tarr[2]."_".$tarr[3]; 
                                 }
 
                                 $id = ilObject::_getIdForImportId($import_id);
 
                                 // get ref id for object id
                                 // (see ilPageObject::insertInstIntoIDs for the export procedure)
                                 if($id > 0)
                                 {
                                         $refs = ilObject::_getAllReferences($id);
                                         foreach ($refs as $ref)
                                         {
                                                 return "il__obj_".$ref;
                                         }
                                 }
 
                                 // 26 Sep 2018: moved this under the import id handling above
                                 // If an imported object is found, this is always preferred.
                                 // see also bug #23324
                                 if (ilInternalLink::_extractInstOfTarget($a_target) == IL_INST_ID
                                         && IL_INST_ID > 0)
                                 {
                                         // does it have a ref id part?
                                         if ($tarr[4] != "")
                                         {
                                                 return "il__obj_".$tarr[4];
                                         }
                                 }
 
                                 break;
 
                 }
                 return false;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getSourcesOfTarget()

static ilInternalLink::_getSourcesOfTarget	(	$a_target_type,
		$a_target_id,
		$a_target_inst
	)

static

get all sources of a link target

Parameters

string	$a_target_type	target type
int	$a_target_id	target id
int	$a_target_inst	target installation id

Returns: array sources (array of array("type", "id"))

Definition at line 93 of file class.ilInternalLink.php.

References $ilDB, and array.

Referenced by ilPageObject\_handleImportRepositoryLinks(), ilObjMediaObjectAccess\checkAccessGlossaryTerm(), ilWikiPage\getLinksToPage(), ilWikiPage\getOrphanedPages(), ilGlossaryTerm\getUsages(), ilGlossaryPresentationGUI\listDefinitions(), ilContObjParser\processPagesToParse(), ilWikiPage\rename(), and ilLMObject\updateInternalLinks().

         {
                 global $ilias, $ilDB;
 
                 $q = "SELECT * FROM int_link WHERE ".
                         "target_type = ".$ilDB->quote($a_target_type, "text")." AND ".
                         "target_id = ".$ilDB->quote((int) $a_target_id, "integer")." AND ".
                         "target_inst = ".$ilDB->quote((int) $a_target_inst, "integer");
                 $source_set = $ilDB->query($q);
                 $sources = array();
                 while ($source_rec = $ilDB->fetchAssoc($source_set))
                 {
                         $sources[$source_rec["source_type"].":".$source_rec["source_id"].":".$source_rec["source_lang"]] =
                                 array("type" => $source_rec["source_type"], "id" => $source_rec["source_id"],
                                         "lang" => $source_rec["source_lang"]);
                 }
 
                 return $sources;
         }

Here is the caller graph for this function:

◆ _getTargetsOfSource()

static ilInternalLink::_getTargetsOfSource	(	$a_source_type,
		$a_source_id,
		$a_source_lang = `"-"`
	)

static

Get all targets of a source object (e.g., a page)

Parameters

string	$a_source_type	source type (e.g. "lm:pg" \| "dbk:pg")
int	$a_source_id	source id

Returns: array targets (array of array("type", "id", "inst"))

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

References $ilDB, and array.

Referenced by ilObjContentObject\exportHTMLPages(), ilSCORM2004Asset\getGlossaryTermIds(), ilPageObjectGUI\showPage(), and ilLMPresentationGUI\showPrintView().

         {
                 global $ilDB;
 
                 $lang_where = "";
                 if ($a_source_lang != "")
                 {
                         $lang_where = " AND source_lang = ".$ilDB->quote($a_source_lang, "text");
                 }
 
                 $q = "SELECT * FROM int_link WHERE ".
                         "source_type = ".$ilDB->quote($a_source_type, "text")." AND ".
                         "source_id = ".$ilDB->quote((int) $a_source_id, "integer").
                         $lang_where;
 
                 $target_set = $ilDB->query($q);
                 $targets = array();
                 while ($target_rec = $ilDB->fetchAssoc($target_set))
                 {
                         $targets[$target_rec["target_type"].":".$target_rec["target_id"].":".$target_rec["target_inst"]] =
                                 array("type" => $target_rec["target_type"], "id" => $target_rec["target_id"],
                                 "inst" => $target_rec["target_inst"]);
                 }
 
                 return $targets;
         }

Here is the caller graph for this function:

◆ _removeInstFromTarget()

static ilInternalLink::_removeInstFromTarget ( $a_target )

static

Removes installation id from target string.

Parameters

string $a_target import target id (e.g. "il_2_pg_22")

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

References $target.

Referenced by ilPageObject\resolveIntLinks().

         {
                 if (!is_int(strpos($a_target, "__")))
                 {
                         $target = explode("_", $a_target);
                         if ($target[1] > 0)
                         {
                                 return "il__".$target[2]."_".$target[3]; 
                         }
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ _saveLink()

static ilInternalLink::_saveLink	(	$a_source_type,
		$a_source_id,
		$a_target_type,
		$a_target_id,
		$a_target_inst = `0`,
		$a_source_lang = `"-"`
	)

static

save internal link information

Parameters

string	$a_source_type	source type
int	$a_source_if	source id
string	$a_target_type	target type
int	$a_target_id	target id
int	$a_target_inst	target installation id

Definition at line 66 of file class.ilInternalLink.php.

References $ilDB, and array.

Referenced by SurveyQuestion\_resolveIntLinks(), assQuestion\_resolveIntLinks(), assQuestion\copySuggestedSolutionFiles(), ilWikiPage\saveInternalLinks(), ilPageObject\saveInternalLinks(), SurveyQuestion\saveMaterial(), and SurveyQuestion\syncWithOriginal().

         {
                 global $ilDB;
 
                 $ilDB->replace("int_link",
                         array(
                                 "source_type" => array("text", $a_source_type),
                                 "source_id" => array("integer", (int) $a_source_id),
                                 "source_lang" => array("text", $a_source_lang),
                                 "target_type" => array("text", $a_target_type),
                                 "target_id" => array("integer", (int) $a_target_id),
                                 "target_inst" => array("integer", (int) $a_target_inst)
                         ),
                         array()
                 );
         }

Here is the caller graph for this function:

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

Services/Link/classes/class.ilInternalLink.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ _deleteAllLinksOfSource()

◆ _deleteAllLinksToTarget()

◆ _exists()

◆ _extractInstOfTarget()

◆ _extractObjIdOfTarget()

◆ _extractTypeOfTarget()

◆ _getIdForImportId()

◆ _getSourcesOfTarget()

◆ _getTargetsOfSource()

◆ _removeInstFromTarget()

◆ _saveLink()