ilInternalLink Class Reference

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

Collaboration diagram for ilInternalLink:

Static Public Member Functions
static	_deleteAllLinksOfSource (string $a_source_type, int $a_source_id, string $a_lang="-")
	Delete all links of a given source. More...
static	_deleteAllLinksToTarget (string $a_target_type, int $a_target_id, int $a_target_inst=0)
	Delete all links to a given target. More...
static	_saveLink (string $a_source_type, int $a_source_id, string $a_target_type, int $a_target_id, int $a_target_inst=0, string $a_source_lang="-")
	save internal link information More...
static	_getSourcesOfTarget (string $a_target_type, int $a_target_id, int $a_target_inst)
	get all sources of a link target More...
static	_getTargetsOfSource (string $a_source_type, int $a_source_id, string $a_source_lang="-")
	Get all targets of a source object (e.g., a page) More...
static	_getIdForImportId (string $a_type, string $a_target)
	Get current id for an import id. More...
static	_exists (string $a_type, string $a_target)
	Check if internal link refers to a valid target. More...
static	_extractInstOfTarget (string $a_target)
	Extract installation id out of target. More...
static	_removeInstFromTarget (string $a_target)
	Removes installation id from target string. More...
static	_extractObjIdOfTarget (string $a_target)
	Extract object id out of target. More...
static	_extractTypeOfTarget (string $a_target)
	Extract type out of target. More...
static	searchUsers (string $a_search_str)
	Search users. More...

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 ilInternalLink Some methods to handle internal links

Author

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

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

Member Function Documentation

_deleteAllLinksOfSource()

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

static

Delete all links of a given source.

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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($a_source_id, "integer") .
            $lang_where;
        $ilDB->manipulate($q);
    }

References $ilDB.

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

Here is the caller graph for this function:

_deleteAllLinksToTarget()

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

static

Delete all links to a given target.

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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, $a_target_id, $a_target_inst)
        );
    }

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

Here is the caller graph for this function:

_exists()

static ilInternalLink::_exists ( string  $a_type, string  $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

bool true/false

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

     : bool {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
 
        switch ($a_type) {
            case "PageObject":
            case "StructureObject":
                return ilLMObject::_exists((int) $a_target);
 
            case "GlossaryItem":
                return ilGlossaryTerm::_exists((int) $a_target);
 
            case "MediaObject":
                return ilObjMediaObject::_exists((int) $a_target);
 
            case "WikiPage":
                return ilWikiPage::_exists("wiki", (int) $a_target);
 
            case "RepositoryItem":
                if (is_int(strpos($a_target, "_"))) {
                    $ref_id = self::_extractObjIdOfTarget($a_target);
                    return $tree->isInTree($ref_id);
                }
                break;
        }
        return false;
    }

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

Referenced by ilPageObject\resolveIntLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

_extractInstOfTarget()

static ilInternalLink::_extractInstOfTarget ( string  $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 302 of file class.ilInternalLink.php.

                                                                 : ?int
    {
        if (!is_int(strpos($a_target, "__"))) {
            $target = explode("_", $a_target);
            if (isset($target[1]) && $target[1] > 0) {
                return (int) $target[1];
            }
        }
        return null;
    }

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

Here is the caller graph for this function:

_extractObjIdOfTarget()

static ilInternalLink::_extractObjIdOfTarget ( string  $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 332 of file class.ilInternalLink.php.

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

Referenced by ilGlossaryTerm\_exists(), ilLMObject\_exists(), ilObjMediaObject\_exists(), ilPCQuestionGUI\edit(), ilQuestionExporter\exportQuestion(), ilPCQuestionGUI\feedback(), ilPageObject\getInitialOpenedContent(), ilPageObject\getQuestionIds(), exPageContentQuestions\getQuestionOfflinePresentations(), ilPageObject\moveIntLinks(), ilPageObject\newIIMCopies(), ilPageObject\newMobCopies(), ilPageObject\newQuestionCopies(), ilPCInteractiveImage\setNode(), ilPCQuestionGUI\setTabs(), ilPortfolioPage\updateInternalLinks(), and ilLMObject\updateInternalLinks().

Here is the caller graph for this function:

_extractTypeOfTarget()

static ilInternalLink::_extractTypeOfTarget ( string  $a_target )

static

Extract type out of target.

Parameters

string

$a_target

import target id (e.g. "il_2_pg_22")

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

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

Referenced by ilPortfolioPage\updateInternalLinks(), and ilLMObject\updateInternalLinks().

Here is the caller graph for this function:

_getIdForImportId()

static ilInternalLink::_getIdForImportId ( string  $a_type, string  $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 174 of file class.ilInternalLink.php.

     : ?string {
        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":
                $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 (self::_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 null;
    }

References $id, ilObject\_getAllReferences(), ilGlossaryTerm\_getIdForImportId(), ilLMObject\_getIdForImportId(), ilObject\_getIdForImportId(), and IL_INST_ID.

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

Here is the call graph for this function:

Here is the caller graph for this function:

_getSourcesOfTarget()

static ilInternalLink::_getSourcesOfTarget ( string  $a_target_type, int  $a_target_id, int  $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 106 of file class.ilInternalLink.php.

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT * FROM int_link WHERE " .
            "target_type = " . $ilDB->quote($a_target_type, "text") . " AND " .
            "target_id = " . $ilDB->quote($a_target_id, "integer") . " AND " .
            "target_inst = " . $ilDB->quote($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;
    }

Referenced by ilGlossaryTerm\getUsages(), ilQuestionPageParser\processPagesToParse(), and ilLMObject\updateInternalLinks().

Here is the caller graph for this function:

_getTargetsOfSource()

static ilInternalLink::_getTargetsOfSource ( string  $a_source_type, int  $a_source_id, string  $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
string	$a_source_lang	source language

Returns

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

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

     : array {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $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($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;
    }

References $ilDB.

Referenced by ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), and ilObjWiki\updateInternalLinksOnCopy().

Here is the caller graph for this function:

_removeInstFromTarget()

static ilInternalLink::_removeInstFromTarget ( string  $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 317 of file class.ilInternalLink.php.

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

Referenced by ilPageObject\resolveIntLinks().

Here is the caller graph for this function:

_saveLink()

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

static

save internal link information

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

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

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

Here is the caller graph for this function:

searchUsers()

static ilInternalLink::searchUsers ( string  $a_search_str )

static

Search users.

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

                                                            : array
    {
        $result = new ilSearchResult();
 
        $query_parser = new ilQueryParser($a_search_str);
        $query_parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
        $query_parser->setMinWordLength(3);
        $query_parser->parse();
 
        $user_search = ilObjectSearchFactory::_getUserSearchInstance($query_parser);
        $user_search->enableActiveCheck(true);
        $user_search->setFields(array('login'));
        $result_obj = $user_search->performSearch();
        $result->mergeEntries($result_obj);
 
        $user_search->setFields(array('firstname'));
        $result_obj = $user_search->performSearch();
        $result->mergeEntries($result_obj);
 
        $user_search->setFields(array('lastname'));
        $result_obj = $user_search->performSearch();
        $result->mergeEntries($result_obj);
 
        $result->setMaxHits(100000);
        $result->preventOverwritingMaxhits(true);
        $result->filter(ROOT_FOLDER_ID, true);
 
        // Filter users (depends on setting in user accounts)
        $users = ilUserFilter::getInstance()->filter($result->getResultIds());
 
        $p = ilObjUser::getProfileStatusOfUsers($users);
 
        $users = array_intersect($users, $p["public"]);
 
        return $users;
    }

References ilObjectSearchFactory\_getUserSearchInstance(), ilUserFilter\getInstance(), ilObjUser\getProfileStatusOfUsers(), ilQueryParser\QP_COMBINATION_AND, and ROOT_FOLDER_ID.

Referenced by ilInternalLinkGUI\getUserSearchResult().

Here is the call graph for this function:

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