ILIAS  trunk Revision v11.0_alpha-1871-gde1fee8db3d
•All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
Public Member Functions | Static Public Member Functions | Private Attributes
ilMDKeyword Class Reference
+ 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().

94  : array
95  {
96  return array(
97  'rbac_id' => array('integer', $this->getRBACId()),
98  'obj_id' => array('integer', $this->getObjId()),
99  'obj_type' => array('text', $this->getObjType()),
100  'parent_type' => array('text', $this->getParentType()),
101  'parent_id' => array('integer', $this->getParentId()),
102  'keyword' => array('text', $this->getKeyword()),
103  'keyword_language' => array('text', $this->getKeywordLanguageCode())
104  );
105  }
+ 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().

143  : array
144  {
145  global $DIC;
146 
147  $ilDB = $DIC->database();
148 
149  $query = "SELECT meta_keyword_id FROM il_meta_keyword " .
150  "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
151  "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
152  "AND parent_id = " . $ilDB->quote($a_parent_id, 'integer') . " " .
153  "AND parent_type = " . $ilDB->quote($a_parent_type, 'text') . " " .
154  "ORDER BY meta_keyword_id ";
155 
156  $res = $ilDB->query($query);
157  $ids = [];
158  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
159  $ids[] = (int) $row->meta_keyword_id;
160  }
161  return $ids;
162  }
$res
$res
Definition: ltiservices.php:66
$DIC
global $DIC
Definition: shib_login.php:22
+ 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.

167  : array
168  {
169  global $DIC;
170 
171  $ilDB = $DIC->database();
172  $ilObjDataCache = $DIC['ilObjDataCache'];
173 
174  $query = "SELECT keyword,keyword_language " .
175  "FROM il_meta_keyword " .
176  "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . " " .
177  "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
178  "AND obj_type = " . $ilDB->quote($a_type, 'text') . " ";
179  $res = $ilDB->query($query);
180  $keywords = [];
181  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
182  if ($row->keyword) {
183  $keywords[$row->keyword_language][] = $row->keyword;
184  }
185  }
186  return $keywords;
187  }
$res
$res
Definition: ltiservices.php:66
$DIC
global $DIC
Definition: shib_login.php:22

◆ _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().

192  : array
193  {
194  $key_string = [];
195  foreach (self::_getKeywordsByLanguage($a_rbac_id, $a_obj_id, $a_type) as $lng_code => $keywords) {
196  $key_string[$lng_code] = implode(",", $keywords);
197  }
198  return $key_string;
199  }
+ 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.

242  : array
243  {
244  global $DIC;
245 
246  $ilDB = $DIC->database();
247 
248  $query = "SELECT DISTINCT keyword FROM il_meta_keyword " .
249  'WHERE obj_type = ' . $ilDB->quote($a_type, 'text') . ' ' .
250  'AND ' . $ilDB->like('keyword', 'text', '%' . trim($a_query) . '%') . ' ';
251 
252  if ($a_rbac_id) {
253  $query .= "AND rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . ' ';
254  }
255 
256  $res = $ilDB->query($query);
257  $kws = [];
258  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
259  $kws[] = $row->keyword;
260  }
261  return $kws;
262  }
$res
$res
Definition: ltiservices.php:66
$DIC
global $DIC
Definition: shib_login.php:22

◆ _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.

204  : array
205  {
206  global $DIC;
207 
208  $ilDB = $DIC->database();
209 
210  $qs = 'AND ';
211  $counter = 0;
212  foreach ((array) explode(' ', $a_query) as $part) {
213  if ($counter++) {
214  $qs .= 'OR ';
215  }
216  $qs .= ($ilDB->like('keyword', 'text', $part) . ' ');
217  }
218 
219  if ($a_rbac_id) {
220  $query = "SELECT obj_id FROM il_meta_keyword " .
221  "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . ' ' .
222  'AND obj_type = ' . $ilDB->quote($a_type, 'text') . ' ' .
223  $qs;
224  } else {
225  $query = "SELECT obj_id FROM il_meta_keyword " .
226  'WHERE obj_type = ' . $ilDB->quote($a_type, 'text') . ' ' .
227  $qs;
228  }
229 
230  $res = $ilDB->query($query);
231  $obj_ids = [];
232  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
233  $obj_ids[] = $row->obj_id;
234  }
235 
236  return $obj_ids;
237  }
$res
$res
Definition: ltiservices.php:66
$DIC
global $DIC
Definition: shib_login.php:22

◆ delete()

ilMDKeyword::delete ( )

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

References $res, and ilMDBase\getMetaId().

79  : bool
80  {
81  if ($this->getMetaId()) {
82  $query = "DELETE FROM il_meta_keyword " .
83  "WHERE meta_keyword_id = " . $this->db->quote($this->getMetaId(), 'integer');
84  $res = $this->db->manipulate($query);
85 
86  return true;
87  }
88  return false;
89  }
$res
$res
Definition: ltiservices.php:66
+ 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().

38  : string
39  {
40  return $this->keyword;
41  }
+ Here is the caller graph for this function:

◆ getKeywordLanguage()

ilMDKeyword::getKeywordLanguage ( )

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

References null.

48  : ?ilMDLanguageItem
49  {
50  return is_object($this->keyword_language) ? $this->keyword_language : null;
51  }
null
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
Definition: shib_logout.php:142

◆ getKeywordLanguageCode()

ilMDKeyword::getKeywordLanguageCode ( )

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

Referenced by __getFields(), and toXML().

53  : string
54  {
55  return is_object($this->keyword_language) ? $this->keyword_language->getLanguageCode() : '';
56  }
+ 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.

264  : array
265  {
266  global $DIC;
267 
268  $ilDB = $DIC->database();
269 
270  $query = "SELECT * FROM il_meta_keyword " .
271  "WHERE rbac_id = " . $ilDB->quote($a_rbac_id, 'integer') . ' ' .
272  "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer') . ' ';
273  $res = $ilDB->query($query);
274  $kws = [];
275  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
276  if (!$a_return_ids) {
277  if (is_string($row->keyword) && $row->keyword !== '') {
278  $kws[] = $row->keyword;
279  }
280  } else {
281  $kws[] = $row->meta_keyword_id;
282  }
283  }
284  return $kws;
285  }
$res
$res
Definition: ltiservices.php:66
$DIC
global $DIC
Definition: shib_login.php:22

◆ 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().

107  : bool
108  {
109  if ($this->getMetaId()) {
110  $query = "SELECT * FROM il_meta_keyword " .
111  "WHERE meta_keyword_id = " . $this->db->quote($this->getMetaId(), 'integer');
112 
113  $res = $this->db->query($query);
114  while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
115  $this->setRBACId((int) $row->rbac_id);
116  $this->setObjId((int) $row->obj_id);
117  $this->setObjType($row->obj_type ?? '');
118  $this->setParentId((int) $row->parent_id);
119  $this->setParentType($row->parent_type ?? '');
120  $this->setKeyword($row->keyword ?? '');
121  $this->setKeywordLanguage(new ilMDLanguageItem($row->keyword_language ?? ''));
122  }
123  }
124  return true;
125  }
$res
$res
Definition: ltiservices.php:66
ilMDKeyword\setKeyword
setKeyword(string $a_keyword)
Definition: class.ilMDKeyword.php:33
ilMDBase\setRBACId
setRBACId(int $a_id)
Definition: class.ilMDBase.php:97
ilMDBase\setObjId
setObjId(int $a_id)
Definition: class.ilMDBase.php:107
ilMDBase\setParentId
setParentId(int $a_id)
Definition: class.ilMDBase.php:151
ilMDBase\setParentType
setParentType(string $a_parent_type)
Definition: class.ilMDBase.php:141
ilMDKeyword\setKeywordLanguage
setKeywordLanguage(ilMDLanguageItem $lng_obj)
Definition: class.ilMDKeyword.php:43
ilMDBase\setObjType
setObjType(string $a_type)
Definition: class.ilMDBase.php:117
+ 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().

58  : int
59  {
60  $fields = $this->__getFields();
61  $fields['meta_keyword_id'] = array('integer', $next_id = $this->db->nextId('il_meta_keyword'));
62 
63  if ($this->db->insert('il_meta_keyword', $fields)) {
64  $this->setMetaId($next_id);
65  return $this->getMetaId();
66  }
67  return 0;
68  }
ilMDBase\setMetaId
setMetaId(int $a_meta_id, bool $a_read_data=true)
Definition: class.ilMDBase.php:127
+ 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().

33  : void
34  {
35  $this->keyword = $a_keyword;
36  }
+ 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().

43  : void
44  {
45  $this->keyword_language = $lng_obj;
46  }
+ 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().

127  : void
128  {
129  $writer->xmlElement(
130  'Keyword',
131  array(
132  'Language' => $this->getKeywordLanguageCode() ?: 'en'
133  ),
134  $this->getKeyword()
135  );
136  }
ilXmlWriter\xmlElement
xmlElement(string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
Writes a basic element (no children, just textual content)
Definition: class.ilXmlWriter.php:318
+ 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().

70  : bool
71  {
72  return $this->getMetaId() && $this->db->update(
73  'il_meta_keyword',
74  $this->__getFields(),
75  array("meta_keyword_id" => array('integer', $this->getMetaId()))
76  );
77  }
+ 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, $lang, ilMDGeneral\addKeyword(), ilMDGeneral\getKeyword(), ilMDGeneral\getKeywordIds(), and ilUtil\stripSlashes().

287  : void
288  {
289  // trim keywords
290  $new_keywords = array();
291  foreach ($a_keywords as $lang => $keywords) {
292  foreach ((array) $keywords as $keyword) {
293  $keyword = trim($keyword);
294  if ($keyword !== "" && !(isset($new_keywords[$lang]) && in_array($keyword, $new_keywords[$lang], true))) {
295  $new_keywords[$lang][] = $keyword;
296  }
297  }
298  }
299 
300  // update existing author entries (delete if not entered)
301  foreach ($ids = $a_md_section->getKeywordIds() as $id) {
302  $md_key = $a_md_section->getKeyword($id);
303  $lang = $md_key->getKeywordLanguageCode();
304 
305  // entered keyword already exists
306  if (is_array($new_keywords[$lang] ?? false) && in_array($md_key->getKeyword(), $new_keywords[$lang], true)) {
307  unset($new_keywords[$lang][array_search($md_key->getKeyword(), $new_keywords[$lang], true)]);
308  } else { // existing keyword has not been entered again -> delete
309  $md_key->delete();
310  }
311  }
312 
313  // insert entered, but not existing keywords
314  foreach ($new_keywords as $lang => $key_arr) {
315  foreach ($key_arr as $keyword) {
316  if ($keyword !== "") {
317  $md_key = $a_md_section->addKeyword();
318  $md_key->setKeyword(ilUtil::stripSlashes($keyword));
319  $md_key->setKeywordLanguage(new ilMDLanguageItem($lang));
320  $md_key->save();
321  }
322  }
323  }
324  }
ilUtil\stripSlashes
static stripSlashes(string $a_str, bool $a_strip_html=true, string $a_allow="")
Definition: class.ilUtil.php:391
$lang
$lang
Definition: xapiexit.php:25
$id
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
ilMDGeneral\getKeyword
getKeyword(int $a_keyword_id)
Definition: class.ilMDGeneral.php:160
+ 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: