ILIAS\MediaObjects\Usage\UsageRetrieval Class Reference

Inheritance diagram for ILIAS\MediaObjects\Usage\UsageRetrieval:

Collaboration diagram for ILIAS\MediaObjects\Usage\UsageRetrieval:

Public Member Functions
	__construct (protected \ilObjMediaObject $media_object, protected bool $include_hist, protected InternalDomainService $domain)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter=[], array $parameters=[])
	isFieldNumeric (string $field)
	getData (array $fields, ?Range $range=null, ?Order $order=null, array $filter=[], array $parameters=[])
	count (array $filter, array $parameters)
	isFieldNumeric (string $field)

Protected Member Functions
	collectData ()
	buildRow (string $id, array $usage)
	buildVersions (array $usage)
	getFirstWritableRefId (int $object_id)

Protected Attributes
array	$data = null

Detailed Description

Definition at line 29 of file UsageRetrieval.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MediaObjects\Usage\UsageRetrieval::__construct	(	protected \ilObjMediaObject	$media_object,
		protected bool	$include_hist,
		protected InternalDomainService	$domain
	)

Definition at line 35 of file UsageRetrieval.php.

      {
    }

Member Function Documentation

buildRow()

ILIAS\MediaObjects\Usage\UsageRetrieval::buildRow ( string  $id, array  $usage  )

protected

Definition at line 133 of file UsageRetrieval.php.

                                                         : array
    {
        $usage_type = (string) ($usage["type"] ?? "");
        $container_type = "";
        if (str_contains($usage_type, ":")) {
            [$container_type, $usage_type] = explode(":", $usage_type, 2);
        }
 
        $item = [
            "type" => "",
            "title" => "",
            "sub_txt" => "",
            "sub_title" => "",
            "link" => ""
        ];
 
        switch ($usage_type) {
            case "pg":
                $page = $usage["page"] ?? null;
                if (!$page instanceof \ilPageObject) {
                    break;
                }
                switch ($container_type) {
                    case "lm":
                        if (\ilObject::_lookupType($page->getParentId()) === "lm") {
                            $learning_module = new \ilObjLearningModule($page->getParentId(), false);
                            $item["type"] = $this->domain->lng()->txt("obj_" . $container_type);
                            $item["title"] = $learning_module->getTitle();
                            $item["sub_txt"] = $this->domain->lng()->txt("pg");
                            $item["sub_title"] = \ilLMObject::_lookupTitle($page->getId());
                            $ref_id = $this->getFirstWritableRefId($learning_module->getId());
                            if ($ref_id > 0) {
                                $item["link"] = \ilLink::_getStaticLink(
                                    null,
                                    "pg",
                                    true,
                                    $page->getId() . "_" . $ref_id
                                );
                            }
                        }
                        break;
 
                    case "wpg":
                        $item["type"] = $this->domain->lng()->txt("obj_wiki");
                        $item["title"] = \ilObject::_lookupTitle($page->getParentId());
                        $item["sub_txt"] = $this->domain->lng()->txt("pg");
                        $item["sub_title"] = \ilWikiPage::lookupTitle($page->getId());
                        $ref_id = $this->getFirstWritableRefId($page->getParentId());
                        if ($ref_id > 0) {
                            $item["link"] = \ilLink::_getStaticLink($ref_id, "wiki");
                        }
                        break;
 
                    case "term":
                        $term_id = $page->getId();
                        $glossary_id = \ilGlossaryTerm::_lookGlossaryID($term_id);
                        $item["type"] = $this->domain->lng()->txt("obj_glo");
                        $item["title"] = \ilObject::_lookupTitle($glossary_id);
                        $item["sub_txt"] = $this->domain->lng()->txt("cont_term");
                        $item["sub_title"] = \ilGlossaryTerm::_lookGlossaryTerm($term_id);
                        $ref_id = $this->getFirstWritableRefId($page->getParentId());
                        if ($ref_id > 0) {
                            $item["link"] = \ilLink::_getStaticLink($ref_id, "glo");
                        }
                        break;
 
                    case "cont":
                        $object_type = \ilObject::_lookupType($page->getId());
                        $item["type"] = $this->domain->lng()->txt("obj_" . $object_type);
                        $item["title"] = \ilObject::_lookupTitle($page->getId());
                        $ref_id = $this->getFirstWritableRefId($page->getId());
                        if ($ref_id > 0) {
                            $item["link"] = \ilLink::_getStaticLink($ref_id, $object_type);
                        }
                        break;
 
                    case "mep":
                        $item["type"] = $this->domain->lng()->txt("mep_page_type_mep");
                        $item["sub_txt"] = $this->domain->lng()->txt("mep_page_type_mep");
                        $item["sub_title"] = \ilMediaPoolItem::lookupTitle((int) $usage["id"]);
                        foreach (\ilMediaPoolItem::getPoolForItemId((int) $usage["id"]) as $media_pool_id) {
                            $ref_ids = \ilObject::_getAllReferences($media_pool_id);
                            $item["title"] = \ilObject::_lookupTitle($media_pool_id);
                            foreach ($ref_ids as $ref_id) {
                                $item["link"] = \ilLink::_getStaticLink($ref_id, "mep");
                                break;
                            }
                            break;
                        }
                        break;
 
                    default:
                        $object_id = \ilObjMediaObject::getParentObjectIdForUsage($usage);
                        if ($object_id > 0) {
                            $object_type = \ilObject::_lookupType($object_id);
                            $item["type"] = $this->domain->lng()->txt("obj_" . $object_type);
                            $item["title"] = \ilObject::_lookupTitle($object_id);
                            $ref_id = $this->getFirstWritableRefId($object_id);
                            if ($ref_id > 0) {
                                $item["link"] = \ilLink::_getStaticLink($ref_id, $object_type);
                            }
                        }
                        break;
                }
 
                if (($usage["trash"] ?? false) === true) {
                    $item["title"] .= " (" . $this->domain->lng()->txt("trash") . ")";
                }
                break;
 
            case "mep":
                $item["type"] = $this->domain->lng()->txt("obj_mep");
                $item["title"] = \ilObject::_lookupTitle((int) $usage["id"]);
                $ref_id = $this->getFirstWritableRefId((int) $usage["id"]);
                if ($ref_id > 0) {
                    $item["link"] = \ilLink::_getStaticLink($ref_id, "mep");
                }
                break;
 
            case "map":
                $item["type"] = $this->domain->lng()->txt("obj_mob");
                $item["title"] = \ilObject::_lookupTitle((int) $usage["id"]);
                $item["sub_txt"] = $this->domain->lng()->txt("cont_link_area");
                break;
 
            case "news":
                $object_id = \ilNewsItem::_lookupContextObjId((int) $usage["id"]);
                $object_type = \ilObject::_lookupType($object_id);
                $item["type"] = $this->domain->lng()->txt("obj_" . $object_type);
                $item["title"] = \ilObject::_lookupTitle($object_id);
                $item["sub_txt"] = $this->domain->lng()->txt("news");
                $ref_id = $this->getFirstWritableRefId($object_id);
                if ($ref_id > 0) {
                    $item["link"] = \ilLink::_getStaticLink($ref_id, $object_type);
                }
                break;
        }
 
        $title = $item["title"];
        if ($item["sub_txt"] !== "") {
            $title .= ", " . $item["sub_txt"];
            if ($item["sub_title"] !== "") {
                $title .= ": " . $item["sub_title"];
            }
        }
 
        if ($usage_type === "clip") {
            $title = $this->domain->lng()->txt("cont_users_have_mob_in_clip1") .
                " " . (int) ($usage["cnt"] ?? 0) . " " .
                $this->domain->lng()->txt("cont_users_have_mob_in_clip2");
        }
 
        return [
            "id" => $id,
            "object" => $title,
            "object_link" => $item["link"],
            "type" => $item["type"],
            "versions" => $this->buildVersions($usage)
        ];
    }

References $id, $page, $usage, ilObject\_getAllReferences(), ilLink\_getStaticLink(), ilGlossaryTerm\_lookGlossaryID(), ilGlossaryTerm\_lookGlossaryTerm(), ilNewsItem\_lookupContextObjId(), ilLMObject\_lookupTitle(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilObjMediaObject\getParentObjectIdForUsage(), ilMediaPoolItem\getPoolForItemId(), ILIAS\Repository\int(), ilMediaPoolItem\lookupTitle(), and ilWikiPage\lookupTitle().

Here is the call graph for this function:

buildVersions()

ILIAS\MediaObjects\Usage\UsageRetrieval::buildVersions ( array  $usage )

protected

Definition at line 294 of file UsageRetrieval.php.

                                                  : string
    {
        if (!is_array($usage["versions"] ?? null) || !isset($usage["page"])) {
            return " ";
        }
 
        $versions = $usage["versions"];
        $version_text = "";
        if (count($versions) > 5) {
            $version_text = "..., ";
            $versions = array_slice($versions, -5);
        }
 
        $separator = "";
        foreach ($versions as $version) {
            $history_number = $version["hist_nr"] ?? 0;
            if ($history_number == 0) {
                $history_number = $this->domain->lng()->txt("cont_current_version");
            }
            $version_text .= $separator . $history_number;
            if (($version["lang"] ?? "") !== "") {
                $version_text .= "/" . $version["lang"];
            }
            $separator = ", ";
        }
 
        return $version_text;
    }

References $usage, and $version.

collectData()

ILIAS\MediaObjects\Usage\UsageRetrieval::collectData ( )

protected

Definition at line 70 of file UsageRetrieval.php.

                                    : array
    {
        if ($this->data !== null) {
            return $this->data;
        }
 
        $usages = $this->media_object->getUsages($this->include_hist);
        $clip_count = 0;
        $aggregated_usages = [];
 
        foreach ($usages as $usage) {
            $usage["trash"] = false;
            if (str_contains((string) ($usage["type"] ?? ""), ":")) {
                [$container_type, $usage_type] = explode(":", (string) $usage["type"], 2);
 
                if ($usage_type === "pg") {
                    $page = \ilPageObjectFactory::getInstance($container_type, (int) $usage["id"]);
                    $usage["page"] = $page;
                    $repo_tree = $this->domain->repositoryTree();
                    $ref_ids = array_filter(
                        \ilObject::_getAllReferences($page->getRepoObjId()),
                        static fn($ref_id): bool => $repo_tree->isInTree($ref_id)
                    );
                    if ($ref_ids === []) {
                        $usage["trash"] = true;
                    }
                }
            }
 
            if (($usage["type"] ?? "") === "clip") {
                $clip_count++;
                continue;
            }
 
            if (!$this->include_hist && ($usage["trash"] ?? false)) {
                continue;
            }
 
            $key = (string) $usage["type"] . ":" . (string) $usage["id"];
            if (!isset($aggregated_usages[$key])) {
                $aggregated_usages[$key] = $usage;
            }
            $aggregated_usages[$key]["versions"][] = [
                "hist_nr" => $usage["hist_nr"] ?? 0,
                "lang" => $usage["lang"] ?? ""
            ];
        }
 
        if ($clip_count > 0) {
            $aggregated_usages["clip"] = [
                "type" => "clip",
                "cnt" => $clip_count
            ];
        }
 
        $this->data = [];
        foreach ($aggregated_usages as $id => $usage) {
            $this->data[] = $this->buildRow((string) $id, $usage);
        }
 
        return $this->data;
    }

References $data, $id, $page, $usage, ilObject\_getAllReferences(), and ilPageObjectFactory\getInstance().

Here is the call graph for this function:

count()

ILIAS\MediaObjects\Usage\UsageRetrieval::count	(	array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 58 of file UsageRetrieval.php.

     : int {
        return count($this->collectData());
    }

getData()

ILIAS\MediaObjects\Usage\UsageRetrieval::getData	(	array	$fields,
		?Range	$range = null,
		?Order	$order = null,
		array	$filter = [],
		array	$parameters = []
	)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 42 of file UsageRetrieval.php.

     : \Generator {
        $data = $this->collectData();
        $data = $this->applyOrder($data, $order);
        $data = $this->applyRange($data, $range);
 
        foreach ($data as $row) {
            yield $row;
        }
    }

getFirstWritableRefId()

ILIAS\MediaObjects\Usage\UsageRetrieval::getFirstWritableRefId ( int  $object_id )

protected

Definition at line 323 of file UsageRetrieval.php.

                                                            : int
    {
        foreach (\ilObject::_getAllReferences($object_id) as $ref_id) {
            if ($this->domain->access()->checkAccess("write", "", $ref_id)) {
                return (int) $ref_id;
            }
        }
        return 0;
    }

References ilObject\_getAllReferences().

Here is the call graph for this function:

isFieldNumeric()

ILIAS\MediaObjects\Usage\UsageRetrieval::isFieldNumeric

(

string

$field

)

Implements ILIAS\Repository\RetrievalInterface.

Definition at line 65 of file UsageRetrieval.php.

                                                 : bool
    {
        return false;
    }

Field Documentation

$data

array ILIAS\MediaObjects\Usage\UsageRetrieval::$data = null

protected

Definition at line 33 of file UsageRetrieval.php.

---

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

• components/ILIAS/MediaObjects/Usage/UsageRetrieval.php