ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions
ilMDKeyword Class Reference
+ Inheritance diagram for ilMDKeyword:
+ Collaboration diagram for ilMDKeyword:

Public Member Functions

 ilMDKeyword ($a_rbac_id=0, $a_obj_id=0, $a_obj_type= '')
 setKeyword ($a_keyword)
 getKeyword ()
 setKeywordLanguage (&$lng_obj)
& getKeywordLanguage ()
 getKeywordLanguageCode ()
 save ()
 update ()
 delete ()
 __getFields ()
 read ()
 toXML (&$writer)
 _getIds ($a_rbac_id, $a_obj_id, $a_parent_id, $a_parent_type)
 ilMDKeyword ($a_rbac_id=0, $a_obj_id=0, $a_obj_type= '')
 setKeyword ($a_keyword)
 getKeyword ()
 setKeywordLanguage (&$lng_obj)
& getKeywordLanguage ()
 getKeywordLanguageCode ()
 save ()
 update ()
 delete ()
 __getFields ()
 read ()
 toXML (&$writer)
 _getIds ($a_rbac_id, $a_obj_id, $a_parent_id, $a_parent_type)
- Public Member Functions inherited from ilMDBase
 ilMDBase ($a_rbac_id=0, $a_obj_id=0, $a_type=0)
 setRBACId ($a_id)
 getRBACId ()
 setObjId ($a_id)
 getObjId ()
 setObjType ($a_type)
 getObjType ()
 setMetaId ($a_meta_id, $a_read_data=true)
 getMetaId ()
 setParentType ($a_parent_type)
 getParentType ()
 setParentId ($a_id)
 getParentId ()
 setExportMode ($a_export_mode=true)
 getExportMode ()
 validate ()
 ilMDBase ($a_rbac_id=0, $a_obj_id=0, $a_type=0)
 setRBACId ($a_id)
 getRBACId ()
 setObjId ($a_id)
 getObjId ()
 setObjType ($a_type)
 getObjType ()
 setMetaId ($a_meta_id, $a_read_data=true)
 getMetaId ()
 setParentType ($a_parent_type)
 getParentType ()
 setParentId ($a_id)
 getParentId ()
 validate ()

Static Public Member Functions

static _getKeywordsByLanguage ($a_rbac_id, $a_obj_id, $a_type)
 Get keywords by language.
static _getKeywordsByLanguageAsString ($a_rbac_id, $a_obj_id, $a_type)
 Get keywords by language as string.
static _searchKeywords ($a_query, $a_type, $a_rbac_id=0)
 Search for objects by keywords.
static _getMatchingKeywords ($a_query, $a_type, $a_rbac_id=0)
 Search for keywords.
static lookupKeywords ($a_rbac_id, $a_obj_id, $a_return_ids=false)
 Lookup Keywords.
static updateKeywords (ilMDGeneral $a_md_section, array $a_keywords)
 Update keywords from input array.

Additional Inherited Members

- Data Fields inherited from ilMDBase
 $rbac_id
 $obj_id
 $obj_type
 $export_mode = false

Detailed Description

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

Member Function Documentation

ilMDKeyword::__getFields ( )

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

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

Referenced by save().

{
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:

ilMDKeyword::__getFields ( )

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

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

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

+ Here is the call graph for this function:

ilMDKeyword::_getIds (   $a_rbac_id,
  $a_obj_id,
  $a_parent_id,
  $a_parent_type 
)

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

{
global $ilDB;
$query = "SELECT meta_keyword_id FROM il_meta_keyword ".
"WHERE rbac_id = ".$ilDB->quote($a_rbac_id)." ".
"AND obj_id = ".$ilDB->quote($a_obj_id)." ".
"AND parent_id = ".$ilDB->quote($a_parent_id)." ".
"AND parent_type = ".$ilDB->quote($a_parent_type);
$res = $ilDB->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$ids[] = $row->meta_keyword_id;
}
return $ids ? $ids : array();
}
ilMDKeyword::_getIds (   $a_rbac_id,
  $a_obj_id,
  $a_parent_id,
  $a_parent_type 
)

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilMDGeneral\getKeywordIds().

{
global $ilDB;
$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);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$ids[] = $row->meta_keyword_id;
}
return $ids ? $ids : array();
}

+ Here is the caller graph for this function:

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

Get keywords by language.

public

Parameters
intrbac_id
intobj_id
stringobj type

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by _getKeywordsByLanguageAsString().

{
global $ilDB,$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);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
if($row->keyword)
{
$keywords[$row->keyword_language][] = $row->keyword;
}
}
return $keywords ? $keywords : array();
}

+ Here is the caller graph for this function:

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

Get keywords by language as string.

public

Parameters
intrbac_id
intobj_id
stringobj type

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

References _getKeywordsByLanguage().

Referenced by ilMDUtils\_fillHTMLMetaTags().

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Search for keywords.

Parameters
string$a_query
string$a_type
int$a_rbac_id[optional]
Returns

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilMDEditorGUI\keywordAutocomplete(), and ilBlogPostingGUI\keywordAutocomplete().

{
global $ilDB;
$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);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$kws[] = $row->keyword;
}
return (array) $kws;
}

+ Here is the caller graph for this function:

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

Search for objects by keywords.

Parameters
string$a_query
string$a_type
int$a_rbac_id[optional]
Returns

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjMediaPool\getMediaObjects().

{
global $ilDB;
$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);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$obj_ids[] = $row->obj_id;
}
return (array) $obj_ids;
}

+ Here is the caller graph for this function:

ilMDKeyword::delete ( )

Reimplemented from ilMDBase.

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

References $ilDB, $query, and ilMDBase\getMetaId().

{
global $ilDB;
if($this->getMetaId())
{
$query = "DELETE FROM il_meta_keyword ".
"WHERE meta_keyword_id = ".$ilDB->quote($this->getMetaId());
$this->db->query($query);
return true;
}
return false;
}

+ Here is the call graph for this function:

ilMDKeyword::delete ( )

Reimplemented from ilMDBase.

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

References $ilDB, $query, $res, and ilMDBase\getMetaId().

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

+ Here is the call graph for this function:

ilMDKeyword::getKeyword ( )

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

Referenced by __getFields(), and toXML().

{
return $this->keyword;
}

+ Here is the caller graph for this function:

ilMDKeyword::getKeyword ( )

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

{
return $this->keyword;
}
& ilMDKeyword::getKeywordLanguage ( )

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

{
return is_object($this->keyword_language) ? $this->keyword_language : false;
}
& ilMDKeyword::getKeywordLanguage ( )

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

{
return is_object($this->keyword_language) ? $this->keyword_language : false;
}
ilMDKeyword::getKeywordLanguageCode ( )

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

{
return is_object($this->keyword_language) ? $this->keyword_language->getLanguageCode() : false;
}
ilMDKeyword::getKeywordLanguageCode ( )

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

Referenced by __getFields(), and toXML().

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

+ Here is the caller graph for this function:

ilMDKeyword::ilMDKeyword (   $a_rbac_id = 0,
  $a_obj_id = 0,
  $a_obj_type = '' 
)

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

References ilMDBase\ilMDBase().

{
parent::ilMDBase($a_rbac_id,
$a_obj_id,
$a_obj_type);
}

+ Here is the call graph for this function:

ilMDKeyword::ilMDKeyword (   $a_rbac_id = 0,
  $a_obj_id = 0,
  $a_obj_type = '' 
)

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

References ilMDBase\ilMDBase().

{
parent::ilMDBase($a_rbac_id,
$a_obj_id,
$a_obj_type);
}

+ Here is the call graph for this function:

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

Lookup Keywords.

Parameters
object$a_rbac_id
object$a_obj_id
bool$a_return_kw
Returns

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjMediaObjectGUI\_getMediaInfoHTML(), and ilBlogPosting\getKeywords().

{
global $ilDB;
$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);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
if(!$a_return_ids)
{
if(strlen($row->keyword))
{
$kws[] = $row->keyword;
}
}
else
{
$kws[] = $row->meta_keyword_id;
}
}
return (array) $kws;
}

+ Here is the caller graph for this function:

ilMDKeyword::read ( )

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, ilMDBase\getMetaId(), setKeyword(), setKeywordLanguage(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setParentId(), ilMDBase\setParentType(), and ilMDBase\setRBACId().

{
global $ilDB;
include_once 'Services/MetaData/classes/class.ilMDLanguageItem.php';
if($this->getMetaId())
{
$query = "SELECT * FROM il_meta_keyword ".
"WHERE meta_keyword_id = ".$ilDB->quote($this->getMetaId() ,'integer');
$res = $this->db->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$this->setRBACId($row->rbac_id);
$this->setObjId($row->obj_id);
$this->setObjType($row->obj_type);
$this->setParentId($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:

ilMDKeyword::read ( )

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, ilMDBase\getMetaId(), setKeyword(), setKeywordLanguage(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setParentId(), ilMDBase\setParentType(), ilMDBase\setRBACId(), and ilUtil\stripSlashes().

{
global $ilDB;
include_once 'Services/Migration/DBUpdate_426/classes/class.ilMDLanguageItem.php';
if($this->getMetaId())
{
$query = "SELECT * FROM il_meta_keyword ".
"WHERE meta_keyword_id = ".$ilDB->quote($this->getMetaId());
$res = $this->db->query($query);
while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
{
$this->setRBACId($row->rbac_id);
$this->setObjId($row->obj_id);
$this->setObjType($row->obj_type);
$this->setParentId($row->parent_id);
$this->setParentType($row->parent_type);
$this->setKeyword(ilUtil::stripSlashes($row->keyword));
$this->setKeywordLanguage( new ilMDLanguageItem($row->keyword_language));
}
}
return true;
}

+ Here is the call graph for this function:

ilMDKeyword::save ( )

Reimplemented from ilMDBase.

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

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

{
if($this->db->autoExecute('il_meta_keyword',
$this->__getFields(),
DB_AUTOQUERY_INSERT))
{
$this->setMetaId($this->db->getLastInsertId());
return $this->getMetaId();
}
return false;
}

+ Here is the call graph for this function:

ilMDKeyword::save ( )

Reimplemented from ilMDBase.

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

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

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

+ Here is the call graph for this function:

ilMDKeyword::setKeyword (   $a_keyword)

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

Referenced by read().

{
$this->keyword = $a_keyword;
}

+ Here is the caller graph for this function:

ilMDKeyword::setKeyword (   $a_keyword)

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

{
$this->keyword = $a_keyword;
}
ilMDKeyword::setKeywordLanguage ( &  $lng_obj)

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

Referenced by read().

{
if(is_object($lng_obj))
{
$this->keyword_language = $lng_obj;
}
}

+ Here is the caller graph for this function:

ilMDKeyword::setKeywordLanguage ( &  $lng_obj)

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

{
if(is_object($lng_obj))
{
$this->keyword_language = $lng_obj;
}
}
ilMDKeyword::toXML ( &  $writer)

Reimplemented from ilMDBase.

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

References getKeyword(), and getKeywordLanguageCode().

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

+ Here is the call graph for this function:

ilMDKeyword::toXML ( &  $writer)

Reimplemented from ilMDBase.

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

References getKeyword(), and getKeywordLanguageCode().

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

+ Here is the call graph for this function:

ilMDKeyword::update ( )

Reimplemented from ilMDBase.

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

References $ilDB, and ilMDBase\getMetaId().

{
global $ilDB;
if($this->getMetaId())
{
if($this->db->autoExecute('il_meta_keyword',
$this->__getFields(),
DB_AUTOQUERY_UPDATE,
"meta_keyword_id = ".$ilDB->quote($this->getMetaId())))
{
return true;
}
}
return false;
}

+ Here is the call graph for this function:

ilMDKeyword::update ( )

Reimplemented from ilMDBase.

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

References $ilDB, and ilMDBase\getMetaId().

{
global $ilDB;
if($this->getMetaId())
{
if($this->db->update('il_meta_keyword',
$this->__getFields(),
array("meta_keyword_id" => array('integer',$this->getMetaId()))))
{
return true;
}
}
return false;
}

+ Here is the call graph for this function:

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

Update keywords from input array.

Parameters
ilMDGeneral$a_md_section
array$a_keywordslang => keywords

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

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

Referenced by ilMDEditorGUI\updateQuickEdit().

{
// trim keywords
$new_keywords = array();
foreach($a_keywords as $lang => $keywords)
{
foreach($keywords as $keyword)
{
$keyword = trim($keyword);
if ($keyword != "" &&
!(is_array($new_keywords[$lang]) && in_array($keyword, $new_keywords[$lang])))
{
$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]) &&
in_array($md_key->getKeyword(), $new_keywords[$lang]))
{
unset($new_keywords[$lang]
[array_search($md_key->getKeyword(), $new_keywords[$lang])]);
}
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:

+ Here is the caller graph for this function:

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