Media pool repository. More...

Collaboration diagram for ILIAS\MediaPool\MediaPoolRepository:

Public Member Functions
	__construct (?\ilDBInterface $db=null)

	getItems (int $pool_id, string $title_filter="", string $format_filter="", string $keyword_filter="", string $caption_filter="")

Protected Member Functions
	getMediaObjects (int $pool_id, string $title_filter="", string $format_filter="", string $keyword_filter='', string $caption_filter="")

	getContentSnippets (int $pool_id, string $title_filter="", string $format_filter="", string $keyword_filter='', string $caption_filter="")

	filterSubIDsByLOMKeywords (string $keywords, int $pool_id, string $type, int ... $sub_ids)

Protected Attributes
ilDBInterface	$db

LOMServices	$lom_services

Detailed Description

Media pool repository.

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

Definition at line 31 of file class.MediaPoolRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MediaPool\MediaPoolRepository::__construct ( ?\ilDBInterface $db = null )

Definition at line 36 of file class.MediaPoolRepository.php.

References ILIAS\MediaPool\MediaPoolRepository\$db, and $DIC.

     {
         global $DIC;
         $this->db = ($db) ?: $DIC->database();
         $this->lom_services = $DIC->learningObjectMetadata();
     }

Member Function Documentation

◆ filterSubIDsByLOMKeywords()

ILIAS\MediaPool\MediaPoolRepository::filterSubIDsByLOMKeywords	(	string	$keywords,
		int	$pool_id,
		string	$type,
		int ...	$sub_ids
	)

protected

Returns: int[]

Definition at line 198 of file class.MediaPoolRepository.php.

References null, and ILIAS\MetaData\Search\Clauses\OR.

Referenced by ILIAS\MediaPool\MediaPoolRepository\getContentSnippets(), and ILIAS\MediaPool\MediaPoolRepository\getMediaObjects().

      : array {
         if (trim($keywords) === "" || empty($sub_ids)) {
             return $sub_ids;
         }
 
         $searcher = $this->lom_services->search();
         $paths = $this->lom_services->paths();
 
         $basic_clauses = [];
         foreach (explode(' ', $keywords) as $keyword) {
             $basic_clauses[] = $searcher->getClauseFactory()->getBasicClause(
                 $paths->keywords(),
                 Mode::CONTAINS,
                 $keyword
             );
         }
         $search_clause = $searcher->getClauseFactory()->getJoinedClauses(
             Operator::OR,
             ...$basic_clauses
         );
 
         $filters = [];
         foreach ($sub_ids as $sub_id) {
             $filters[] = $searcher->getFilter($pool_id, $sub_id, $type);
         }
 
         $search_results = $searcher->execute($search_clause, null, null, ...$filters);
         $filtered_sub_ids = [];
         foreach ($search_results as $result) {
             $filtered_sub_ids[] = $result->subID();
         }
         return $filtered_sub_ids;
     }

Here is the caller graph for this function:

◆ getContentSnippets()

ILIAS\MediaPool\MediaPoolRepository::getContentSnippets	(	int	$pool_id,
		string	$title_filter = `""`,
		string	$format_filter = `""`,
		string	$keyword_filter = `''`,
		string	$caption_filter = `""`
	)

protected

Returns: array[]

Definition at line 111 of file class.MediaPoolRepository.php.

References ILIAS\MediaPool\MediaPoolRepository\$db, $res, ILIAS\MediaPool\MediaPoolRepository\filterSubIDsByLOMKeywords(), and ilDBInterface\quote().

Referenced by ILIAS\MediaPool\MediaPoolRepository\getItems().

      : array {
         // format filter snippets come with internal "pg" format
         if (!in_array($format_filter, ["pg", ""])) {
             return [];
         }
 
         // snippets do not have no caption
         if ($caption_filter != "") {
             return [];
         }
 
         $db = $this->db;
 
         $query = "SELECT DISTINCT mep_tree.*, mep_item.* " .
             "FROM mep_tree JOIN mep_item ON (mep_tree.child = mep_item.obj_id) ";
 
         $query .=
             " WHERE mep_tree.mep_id = " . $db->quote($pool_id, "integer") .
             " AND mep_item.type = " . $db->quote("pg", "text");
 
         // filter
         if (trim($title_filter) != "") {    // title
             $query .= " AND " . $db->like("mep_item.title", "text", "%" . trim($title_filter) . "%");
         }
 
         $objs = [];
         $obj_ids = [];
         $set = $db->query($query);
         while ($rec = $db->fetchAssoc($set)) {
             //$rec["foreign_id"] = $rec["obj_id"];
             //$rec["obj_id"] = "";
             $objs[] = $rec;
             $obj_ids[] = $rec['obj_id'];
         }
 
         // Keyword filter
         if ($keyword_filter) {
             $res = $this->filterSubIDsByLOMKeywords($keyword_filter, $pool_id, 'mpg', ...$obj_ids);
             $filtered = [];
             foreach ($objs as $obj) {
                 if (in_array($obj['obj_id'], $res)) {
                     $filtered[] = $obj;
                 }
             }
             return $filtered;
         }
         return $objs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getItems()

ILIAS\MediaPool\MediaPoolRepository::getItems	(	int	$pool_id,
		string	$title_filter = `""`,
		string	$format_filter = `""`,
		string	$keyword_filter = `""`,
		string	$caption_filter = `""`
	)

Returns: array[]

Definition at line 169 of file class.MediaPoolRepository.php.

References ILIAS\MediaPool\MediaPoolRepository\getContentSnippets(), and ILIAS\MediaPool\MediaPoolRepository\getMediaObjects().

      : array {
         $mobs = $this->getMediaObjects(
             $pool_id,
             $title_filter,
             $format_filter,
             $keyword_filter,
             $caption_filter
         );
 
         $snippets = $this->getContentSnippets(
             $pool_id,
             $title_filter,
             $format_filter,
             $keyword_filter,
             $caption_filter
         );
 
         return \ilArrayUtil::sortArray(array_merge($mobs, $snippets), "title", "asc");
     }

Here is the call graph for this function:

◆ getMediaObjects()

ILIAS\MediaPool\MediaPoolRepository::getMediaObjects	(	int	$pool_id,
		string	$title_filter = `""`,
		string	$format_filter = `""`,
		string	$keyword_filter = `''`,
		string	$caption_filter = `""`
	)

protected

Returns: array[]

Definition at line 46 of file class.MediaPoolRepository.php.

References ILIAS\MediaPool\MediaPoolRepository\$db, $res, ILIAS\MediaPool\MediaPoolRepository\filterSubIDsByLOMKeywords(), and ilDBInterface\quote().

Referenced by ILIAS\MediaPool\MediaPoolRepository\getItems().

      : array {
         $db = $this->db;
 
         $query = "SELECT DISTINCT mep_tree.*, object_data.* " .
             "FROM mep_tree JOIN mep_item ON (mep_tree.child = mep_item.obj_id) " .
             " JOIN object_data ON (mep_item.foreign_id = object_data.obj_id) ";
 
         if ($format_filter != "" or $caption_filter != '') {
             $query .= " JOIN media_item ON (media_item.mob_id = object_data.obj_id) ";
         }
 
         $query .=
             " WHERE mep_tree.mep_id = " . $db->quote($pool_id, "integer") .
             " AND object_data.type = " . $db->quote("mob", "text");
 
         // filter
         if (trim($title_filter) != "") {    // title
             $query .= " AND " . $db->like("object_data.title", "text", "%" . trim($title_filter) . "%");
         }
         if (!in_array($format_filter, ["", "mob"])) {            // format
             $filter = ($format_filter === "unknown")
                 ? ""
                 : $format_filter;
             $query .= " AND " . $db->equals("media_item.format", $filter, "text", true);
         }
         if (trim($caption_filter)) {
             $query .= 'AND ' . $db->like('media_item.caption', 'text', '%' . trim($caption_filter) . '%');
         }
 
         $query .=
             " ORDER BY object_data.title";
 
         $objs = [];
         $obj_ids = [];
         $set = $db->query($query);
         while ($rec = $db->fetchAssoc($set)) {
             $obj_ids[] = $rec['obj_id'];
             $rec["foreign_id"] = $rec["obj_id"];
             $rec["obj_id"] = "";
             $objs[] = $rec;
         }
 
         // Keyword filter
         if ($keyword_filter) {
             $res = $this->filterSubIDsByLOMKeywords($keyword_filter, 0, 'mob', ...$obj_ids);
             $filtered = [];
             foreach ($objs as $obj) {
                 if (in_array($obj['foreign_id'], $res)) {
                     $filtered[] = $obj;
                 }
             }
             return (array) $filtered;
         }
         return $objs;
     }