Inheritance diagram for ilMDKeyword:

Collaboration diagram for ilMDKeyword:

Public Member Functions
	setKeyword (string $a_keyword)

	getKeyword ()

	setKeywordLanguage (ilMDLanguageItem $lng_obj)

	getKeywordLanguage ()

	getKeywordLanguageCode ()

	save ()

	update ()

	delete ()

	__getFields ()

	read ()

	toXML (ilXmlWriter $writer)

Public Member Functions inherited from ilMDBase
	__construct (int $a_rbac_id=0, int $a_obj_id=0, string $a_type='')
	constructor More...

	read ()

	setRBACId (int $a_id)

	getRBACId ()

	setObjId (int $a_id)

	getObjId ()

	setObjType (string $a_type)

	getObjType ()

	setMetaId (int $a_meta_id, bool $a_read_data=true)

	getMetaId ()

	setParentType (string $a_parent_type)

	getParentType ()

	setParentId (int $a_id)

	getParentId ()

	setExportMode (bool $a_export_mode=true)

	getExportMode ()

	validate ()

	update ()

	save ()

	delete ()

	toXML (ilXmlWriter $writer)

Static Public Member Functions
static	_getIds (int $a_rbac_id, int $a_obj_id, int $a_parent_id, string $a_parent_type)

static	_getKeywordsByLanguage (int $a_rbac_id, int $a_obj_id, string $a_type)

static	_getKeywordsByLanguageAsString (int $a_rbac_id, int $a_obj_id, string $a_type)

static	_searchKeywords (string $a_query, string $a_type, int $a_rbac_id=0)

static	_getMatchingKeywords (string $a_query, string $a_type, int $a_rbac_id=0)

static	lookupKeywords (int $a_rbac_id, int $a_obj_id, bool $a_return_ids=false)

static	updateKeywords (ilMDGeneral $a_md_section, array $a_keywords)

Private Attributes
string	$keyword = ''

ilMDLanguageItem	$keyword_language = null

Additional Inherited Members
Protected Attributes inherited from ilMDBase
ilLogger	$log

ilDBInterface	$db

Detailed Description

Definition at line 27 of file class.ilMDKeyword.php.

Member Function Documentation

◆ __getFields()

ilMDKeyword::__getFields ( )

Returns: array<string, array<string, mixed>>

Definition at line 94 of file class.ilMDKeyword.php.

References getKeyword(), getKeywordLanguageCode(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getParentId(), ilMDBase\getParentType(), and ilMDBase\getRBACId().

Referenced by save(), and update().

                                  : array
     {
         return array(
             'rbac_id' => array('integer', $this->getRBACId()),
             'obj_id' => array('integer', $this->getObjId()),
             'obj_type' => array('text', $this->getObjType()),
             'parent_type' => array('text', $this->getParentType()),
             'parent_id' => array('integer', $this->getParentId()),
             'keyword' => array('text', $this->getKeyword()),
             'keyword_language' => array('text', $this->getKeywordLanguageCode())
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getIds()

static ilMDKeyword::_getIds	(	int	$a_rbac_id,
		int	$a_obj_id,
		int	$a_parent_id,
		string	$a_parent_type
	)

static

Returns: int[]

Definition at line 143 of file class.ilMDKeyword.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilMDClassification\getKeywordIds(), and ilMDGeneral\getKeywordIds().

                                                                                                           : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT meta_keyword_id FROM il_meta_keyword " .
             "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "AND parent_id = " . $ilDB->quote($a_parent_id, 'integer') . " " .
             "AND parent_type = " . $ilDB->quote($a_parent_type, 'text') . " " .
             "ORDER BY meta_keyword_id ";
 
         $res = $ilDB->query($query);
         $ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $ids[] = (int) $row->meta_keyword_id;
         }
         return $ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getKeywordsByLanguage()

static ilMDKeyword::_getKeywordsByLanguage	(	int	$a_rbac_id,
		int	$a_obj_id,
		string	$a_type
	)

static

Returns: array<string, string[]>

Definition at line 167 of file class.ilMDKeyword.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

                                                                                                 : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilObjDataCache = $DIC['ilObjDataCache'];
 
         $query = "SELECT keyword,keyword_language " .
             "FROM il_meta_keyword " .
             "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
             "AND obj_type = " . $ilDB->quote($a_type, 'text') . " ";
         $res = $ilDB->query($query);
         $keywords = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($row->keyword) {
                 $keywords[$row->keyword_language][] = $row->keyword;
             }
         }
         return $keywords;
     }

◆ _getKeywordsByLanguageAsString()

static ilMDKeyword::_getKeywordsByLanguageAsString	(	int	$a_rbac_id,
		int	$a_obj_id,
		string	$a_type
	)

static

Returns: array<string, string>

Definition at line 192 of file class.ilMDKeyword.php.

Referenced by ilMDUtils\_fillHTMLMetaTags().

                                                                                                         : array
     {
         $key_string = [];
         foreach (self::_getKeywordsByLanguage($a_rbac_id, $a_obj_id, $a_type) as $lng_code => $keywords) {
             $key_string[$lng_code] = implode(",", $keywords);
         }
         return $key_string;
     }

Here is the caller graph for this function:

◆ _getMatchingKeywords()

static ilMDKeyword::_getMatchingKeywords	(	string	$a_query,
		string	$a_type,
		int	$a_rbac_id = `0`
	)

static

Returns: string[]

Definition at line 242 of file class.ilMDKeyword.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

                                                                                                     : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT DISTINCT keyword FROM il_meta_keyword " .
             'WHERE obj_type = ' . $ilDB->quote($a_type, 'text') . ' ' .
             'AND ' . $ilDB->like('keyword', 'text', '%' . trim($a_query) . '%') . ' ';
 
         if ($a_rbac_id) {
             $query .= "AND rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . ' ';
         }
 
         $res = $ilDB->query($query);
         $kws = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $kws[] = $row->keyword;
         }
         return $kws;
     }

◆ _searchKeywords()

static ilMDKeyword::_searchKeywords	(	string	$a_query,
		string	$a_type,
		int	$a_rbac_id = `0`
	)

static

Returns: int[]

Definition at line 204 of file class.ilMDKeyword.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

                                                                                                : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $qs = 'AND ';
         $counter = 0;
         foreach ((array) explode(' ', $a_query) as $part) {
             if ($counter++) {
                 $qs .= 'OR ';
             }
             $qs .= ($ilDB->like('keyword', 'text', $part) . ' ');
         }
 
         if ($a_rbac_id) {
             $query = "SELECT obj_id FROM il_meta_keyword " .
                 "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . ' ' .
                 'AND obj_type = ' . $ilDB->quote($a_type, 'text') . ' ' .
                 $qs;
         } else {
             $query = "SELECT obj_id FROM il_meta_keyword " .
                 'WHERE obj_type = ' . $ilDB->quote($a_type, 'text') . ' ' .
                 $qs;
         }
 
         $res = $ilDB->query($query);
         $obj_ids = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $obj_ids[] = $row->obj_id;
         }
 
         return $obj_ids;
     }

◆ delete()

ilMDKeyword::delete ( )

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

References $res, and ilMDBase\getMetaId().

                             : bool
     {
         if ($this->getMetaId()) {
             $query = "DELETE FROM il_meta_keyword " .
                 "WHERE meta_keyword_id = " . $this->db->quote($this->getMetaId(), 'integer');
             $res = $this->db->manipulate($query);
 
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ getKeyword()

ilMDKeyword::getKeyword ( )

Definition at line 38 of file class.ilMDKeyword.php.

References $keyword.

Referenced by __getFields(), and toXML().

                                 : string
     {
         return $this->keyword;
     }

Here is the caller graph for this function:

◆ getKeywordLanguage()

ilMDKeyword::getKeywordLanguage ( )

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

                                         : ?ilMDLanguageItem
     {
         return is_object($this->keyword_language) ? $this->keyword_language : null;
     }

◆ getKeywordLanguageCode()

ilMDKeyword::getKeywordLanguageCode ( )

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

Referenced by __getFields(), and toXML().

                                             : string
     {
         return is_object($this->keyword_language) ? $this->keyword_language->getLanguageCode() : '';
     }

Here is the caller graph for this function:

◆ lookupKeywords()

static ilMDKeyword::lookupKeywords	(	int	$a_rbac_id,
		int	$a_obj_id,
		bool	$a_return_ids = `false`
	)

static

Definition at line 264 of file class.ilMDKeyword.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

                                                                                                     : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = "SELECT * FROM il_meta_keyword " .
             "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . ' ' .
             "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . ' ';
         $res = $ilDB->query($query);
         $kws = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if (!$a_return_ids) {
                 if (is_string($row->keyword) && $row->keyword !== '') {
                     $kws[] = $row->keyword;
                 }
             } else {
                 $kws[] = $row->meta_keyword_id;
             }
         }
         return $kws;
     }

◆ read()

ilMDKeyword::read ( )

Definition at line 107 of file class.ilMDKeyword.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setKeyword(), setKeywordLanguage(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setParentId(), ilMDBase\setParentType(), and ilMDBase\setRBACId().

                           : bool
     {
         if ($this->getMetaId()) {
             $query = "SELECT * FROM il_meta_keyword " .
                 "WHERE meta_keyword_id = " . $this->db->quote($this->getMetaId(), 'integer');
 
             $res = $this->db->query($query);
             while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                 $this->setRBACId((int) $row->rbac_id);
                 $this->setObjId((int) $row->obj_id);
                 $this->setObjType($row->obj_type ?? '');
                 $this->setParentId((int) $row->parent_id);
                 $this->setParentType($row->parent_type ?? '');
                 $this->setKeyword($row->keyword ?? '');
                 $this->setKeywordLanguage(new ilMDLanguageItem($row->keyword_language ?? ''));
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ save()

ilMDKeyword::save ( )

Definition at line 58 of file class.ilMDKeyword.php.

References __getFields(), ilMDBase\getMetaId(), and ilMDBase\setMetaId().

                           : int
     {
         $fields = $this->__getFields();
         $fields['meta_keyword_id'] = array('integer', $next_id = $this->db->nextId('il_meta_keyword'));
 
         if ($this->db->insert('il_meta_keyword', $fields)) {
             $this->setMetaId($next_id);
             return $this->getMetaId();
         }
         return 0;
     }

Here is the call graph for this function:

◆ setKeyword()

ilMDKeyword::setKeyword ( string $a_keyword )

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

Referenced by read().

                                                  : void
     {
         $this->keyword = $a_keyword;
     }

Here is the caller graph for this function:

◆ setKeywordLanguage()

ilMDKeyword::setKeywordLanguage ( ilMDLanguageItem $lng_obj )

Definition at line 43 of file class.ilMDKeyword.php.

Referenced by read().

                                                                  : void
     {
         $this->keyword_language = $lng_obj;
     }

Here is the caller graph for this function:

◆ toXML()

ilMDKeyword::toXML ( ilXmlWriter $writer )

Definition at line 127 of file class.ilMDKeyword.php.

References getKeyword(), getKeywordLanguageCode(), and ilXmlWriter\xmlElement().

                                               : void
     {
         $writer->xmlElement(
             'Keyword',
             array(
                 'Language' => $this->getKeywordLanguageCode() ?: 'en'
             ),
             $this->getKeyword()
         );
     }

Here is the call graph for this function:

◆ update()

ilMDKeyword::update ( )

Definition at line 70 of file class.ilMDKeyword.php.

References __getFields(), and ilMDBase\getMetaId().

                             : bool
     {
         return $this->getMetaId() && $this->db->update(
             'il_meta_keyword',
             $this->__getFields(),
             array("meta_keyword_id" => array('integer', $this->getMetaId()))
         );
     }

Here is the call graph for this function:

◆ updateKeywords()

static ilMDKeyword::updateKeywords	(	ilMDGeneral	$a_md_section,
		array	$a_keywords
	)

static

Definition at line 287 of file class.ilMDKeyword.php.

References $id, $keyword, ilMDGeneral\addKeyword(), ilMDGeneral\getKeyword(), ilMDGeneral\getKeywordIds(), and ilUtil\stripSlashes().

                                                                                        : void
     {
         // trim keywords
         $new_keywords = array();
         foreach ($a_keywords as $lang => $keywords) {
             foreach ((array) $keywords as $keyword) {
                 $keyword = trim($keyword);
                 if ($keyword !== "" && !(isset($new_keywords[$lang]) && in_array($keyword, $new_keywords[$lang], true))) {
                     $new_keywords[$lang][] = $keyword;
                 }
             }
         }
 
         // update existing author entries (delete if not entered)
         foreach ($ids = $a_md_section->getKeywordIds() as $id) {
             $md_key = $a_md_section->getKeyword($id);
             $lang = $md_key->getKeywordLanguageCode();
 
             // entered keyword already exists
             if (is_array($new_keywords[$lang] ?? false) && in_array($md_key->getKeyword(), $new_keywords[$lang], true)) {
                 unset($new_keywords[$lang][array_search($md_key->getKeyword(), $new_keywords[$lang], true)]);
             } else {  // existing keyword has not been entered again -> delete
                 $md_key->delete();
             }
         }
 
         // insert entered, but not existing keywords
         foreach ($new_keywords as $lang => $key_arr) {
             foreach ($key_arr as $keyword) {
                 if ($keyword !== "") {
                     $md_key = $a_md_section->addKeyword();
                     $md_key->setKeyword(ilUtil::stripSlashes($keyword));
                     $md_key->setKeywordLanguage(new ilMDLanguageItem($lang));
                     $md_key->save();
                 }
             }
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $keyword

string ilMDKeyword::$keyword = ''

private

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

Referenced by getKeyword(), and updateKeywords().

◆ $keyword_language

ilMDLanguageItem ilMDKeyword::$keyword_language = null

private

Definition at line 30 of file class.ilMDKeyword.php.

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

components/ILIAS/MetaData/classes/class.ilMDKeyword.php

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __getFields()

◆ _getIds()

◆ _getKeywordsByLanguage()

◆ _getKeywordsByLanguageAsString()

◆ _getMatchingKeywords()

◆ _searchKeywords()

◆ delete()

◆ getKeyword()

◆ getKeywordLanguage()

◆ getKeywordLanguageCode()

◆ lookupKeywords()

◆ read()

◆ save()

◆ setKeyword()

◆ setKeywordLanguage()

◆ toXML()

◆ update()

◆ updateKeywords()

Field Documentation

◆ $keyword

◆ $keyword_language