ilMDKeyword Class Reference

Inheritance diagram for ilMDKeyword:

Collaboration diagram for ilMDKeyword:

Public Member Functions
	setKeyword ($a_keyword)
	getKeyword ()
	setKeywordLanguage (&$lng_obj)
&	getKeywordLanguage ()
	getKeywordLanguageCode ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (&$writer)
	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
	__construct ( $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 ()
	update ()
	save ()
	delete ()
	toXML (&$writer)
	__construct ( $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 ()
	update ()
	save ()
	delete ()
	toXML (&$writer)

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

Additional Inherited Members
Data Fields inherited from ilMDBase
	$rbac_id
	$obj_id
	$obj_type
	$export_mode = false
Protected Attributes inherited from ilMDBase
	$log

Detailed Description

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

Member Function Documentation

__getFields() [1/2]

ilMDKeyword::__getFields

(

)

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

References array, 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:

__getFields() [2/2]

ilMDKeyword::__getFields

(

)

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

References array, 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:

_getIds() [1/2]

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

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

References $ilDB, $query, $res, $row, array, and ilDBConstants\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(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = $row->meta_keyword_id;
        }
        return $ids ? $ids : array();
    }

_getIds() [2/2]

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

static

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

References $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMDClassification\getKeywordIds(), and 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(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = $row->meta_keyword_id;
        }
        return $ids ? $ids : array();
    }

Here is the caller graph for this function:

_getKeywordsByLanguage()

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

static

Get keywords by language.

public

Parameters

int	rbac_id
int	obj_id
string	obj type

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

References $a_type, $ilDB, $query, $res, $row, array, and ilDBConstants\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(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($row->keyword) {
                $keywords[$row->keyword_language][] = $row->keyword;
            }
        }
        return $keywords ? $keywords : array();
    }

Here is the caller graph for this function:

_getKeywordsByLanguageAsString()

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

static

Get keywords by language as string.

public

Parameters

int	rbac_id
int	obj_id
string	obj type

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

References $a_type, _getKeywordsByLanguage(), and array.

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:

_getMatchingKeywords()

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 267 of file class.ilMDKeyword.php.

References $a_type, $ilDB, $query, $res, $row, array, and ilDBConstants\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(ilDBConstants::FETCHMODE_OBJECT)) {
            $kws[] = $row->keyword;
        }
        return (array) $kws;
    }

Here is the caller graph for this function:

_searchKeywords()

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 227 of file class.ilMDKeyword.php.

References $a_type, $counter, $ilDB, $query, $res, $row, array, and ilDBConstants\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(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_ids[] = $row->obj_id;
        }
        
        return (array) $obj_ids;
    }

Here is the caller graph for this function:

delete() [1/2]

ilMDKeyword::delete

(

)

Definition at line 89 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:

delete() [2/2]

ilMDKeyword::delete

(

)

Definition at line 90 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:

getKeyword() [1/2]

ilMDKeyword::getKeyword

(

)

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

Referenced by __getFields(), and toXML().

    {
        return $this->keyword;
    }

Here is the caller graph for this function:

getKeyword() [2/2]

ilMDKeyword::getKeyword

(

)

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

    {
        return $this->keyword;
    }

getKeywordLanguage() [1/2]

& ilMDKeyword::getKeywordLanguage

(

)

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

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

getKeywordLanguage() [2/2]

& ilMDKeyword::getKeywordLanguage

(

)

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

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

getKeywordLanguageCode() [1/2]

ilMDKeyword::getKeywordLanguageCode

(

)

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

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

getKeywordLanguageCode() [2/2]

ilMDKeyword::getKeywordLanguageCode

(

)

Definition at line 54 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:

lookupKeywords()

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 293 of file class.ilMDKeyword.php.

References $ilDB, $query, $res, $row, array, and ilDBConstants\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(ilDBConstants::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:

read() [1/2]

ilMDKeyword::read

(

)

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

References $ilDB, $query, $res, $row, ilDBConstants\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(ilDBConstants::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:

read() [2/2]

ilMDKeyword::read

(

)

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

References $ilDB, $query, $res, $row, ilDBConstants\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(ilDBConstants::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:

save() [1/2]

ilMDKeyword::save

(

)

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

References $ilDB, __getFields(), array, 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:

save() [2/2]

ilMDKeyword::save

(

)

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

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

    {
        if ($this->db->autoExecute(
            'il_meta_keyword',
            $this->__getFields(),
            ilDBConstants::MDB2_AUTOQUERY_INSERT
        )) {
            $this->setMetaId($this->db->getLastInsertId());

            return $this->getMetaId();
        }
        return false;
    }

Here is the call graph for this function:

setKeyword() [1/2]

ilMDKeyword::setKeyword

(

$a_keyword

)

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

Referenced by read().

    {
        $this->keyword = $a_keyword;
    }

Here is the caller graph for this function:

setKeyword() [2/2]

ilMDKeyword::setKeyword

(

$a_keyword

)

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

    {
        $this->keyword = $a_keyword;
    }

setKeywordLanguage() [1/2]

ilMDKeyword::setKeywordLanguage

(

&

$lng_obj

)

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

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

setKeywordLanguage() [2/2]

ilMDKeyword::setKeywordLanguage

(

&

$lng_obj

)

Definition at line 44 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:

toXML() [1/2]

ilMDKeyword::toXML

(

&

$writer

)

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

References array, getKeyword(), and getKeywordLanguageCode().

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

Here is the call graph for this function:

toXML() [2/2]

ilMDKeyword::toXML

(

&

$writer

)

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

References array, getKeyword(), and getKeywordLanguageCode().

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

Here is the call graph for this function:

update() [1/2]

ilMDKeyword::update

(

)

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

References $ilDB, array, 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:

update() [2/2]

ilMDKeyword::update

(

)

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

References $ilDB, ilMDBase\getMetaId(), and ilDBConstants\MDB2_AUTOQUERY_UPDATE.

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

Here is the call graph for this function:

updateKeywords()

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

static

Update keywords from input array.

Parameters

ilMDGeneral	$a_md_section
array	$a_keywords	lang => keywords

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

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

Referenced by ilBlogPosting\updateKeywords(), and ilMDEditorGUI\updateQuickEdit().

    {
        // trim keywords
        $new_keywords = array();
        foreach ($a_keywords as $lang => $keywords) {
            foreach ((array) $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 file:

• Services/MetaData/classes/class.ilMDKeyword.php