ilMDDescription Class Reference

Inheritance diagram for ilMDDescription:

Collaboration diagram for ilMDDescription:

Public Member Functions
	setDescription ($a_description)
	getDescription ()
	setDescriptionLanguage (&$lng_obj)
&	getDescriptionLanguage ()
	getDescriptionLanguageCode ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (&$writer)
	setDescription ($a_description)
	getDescription ()
	setDescriptionLanguage (&$lng_obj)
&	getDescriptionLanguage ()
	getDescriptionLanguageCode ()
	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)

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.ilMDDescription.php.

Member Function Documentation

__getFields() [1/2]

ilMDDescription::__getFields

(

)

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

References array, getDescription(), getDescriptionLanguageCode(), 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()),
                     'description'      => array('clob',$this->getDescription()),
                     'description_language' => array('text',$this->getDescriptionLanguageCode()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__getFields() [2/2]

ilMDDescription::__getFields

(

)

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

References array, getDescription(), getDescriptionLanguageCode(), 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(),
                     'description'      => ilUtil::prepareDBString($this->getDescription()),
                     'description_language' => ilUtil::prepareDBString($this->getDescriptionLanguageCode()));
    }

Here is the call graph for this function:

_getIds() [1/2]

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

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

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

    {
        global $ilDB;

        $query = "SELECT meta_description_id FROM il_meta_description " .
            "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) . " " .
            "ORDER BY meta_description_id";

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = $row->meta_description_id;
        }
        return $ids ? $ids : array();
    }

_getIds() [2/2]

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

static

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

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

Referenced by ilMDEducational\getDescriptionIds(), and ilMDGeneral\getDescriptionIds().

    {
        global $ilDB;

        $query = "SELECT meta_description_id FROM il_meta_description " .
            "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) . " " .
            "ORDER BY meta_description_id";

        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $ids[] = $row->meta_description_id;
        }
        return $ids ? $ids : array();
    }

Here is the caller graph for this function:

delete() [1/2]

ilMDDescription::delete

(

)

Definition at line 89 of file class.ilMDDescription.php.

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

    {
        global $ilDB;
        
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_description " .
                "WHERE meta_description_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]

ilMDDescription::delete

(

)

Definition at line 90 of file class.ilMDDescription.php.

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

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

Here is the call graph for this function:

getDescription() [1/2]

ilMDDescription::getDescription

(

)

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

References $description.

Referenced by __getFields(), and toXML().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getDescription() [2/2]

ilMDDescription::getDescription

(

)

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

References $description.

    {
        return $this->description;
    }

getDescriptionLanguage() [1/2]

& ilMDDescription::getDescriptionLanguage

(

)

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

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

getDescriptionLanguage() [2/2]

& ilMDDescription::getDescriptionLanguage

(

)

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

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

getDescriptionLanguageCode() [1/2]

ilMDDescription::getDescriptionLanguageCode

(

)

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

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

getDescriptionLanguageCode() [2/2]

ilMDDescription::getDescriptionLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

read() [1/2]

ilMDDescription::read

(

)

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

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setDescription(), setDescriptionLanguage(), 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_description " .
                "WHERE meta_description_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->setDescription($row->description);
                $this->setDescriptionLanguage(new ilMDLanguageItem($row->description_language));
            }
        }
        return true;
    }

Here is the call graph for this function:

read() [2/2]

ilMDDescription::read

(

)

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

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setDescription(), setDescriptionLanguage(), 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_description " .
                "WHERE meta_description_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->setDescription(ilUtil::stripSlashes($row->description));
                $this->setDescriptionLanguage(new ilMDLanguageItem($row->description_language));
            }
        }
        return true;
    }

Here is the call graph for this function:

save() [1/2]

ilMDDescription::save

(

)

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

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

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

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

Here is the call graph for this function:

save() [2/2]

ilMDDescription::save

(

)

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

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

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

Here is the call graph for this function:

setDescription() [1/2]

ilMDDescription::setDescription

(

$a_description

)

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

Referenced by read().

    {
        $this->description = $a_description;
    }

Here is the caller graph for this function:

setDescription() [2/2]

ilMDDescription::setDescription

(

$a_description

)

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

    {
        $this->description = $a_description;
    }

setDescriptionLanguage() [1/2]

ilMDDescription::setDescriptionLanguage

(

&

$lng_obj

)

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

Referenced by read().

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

Here is the caller graph for this function:

setDescriptionLanguage() [2/2]

ilMDDescription::setDescriptionLanguage

(

&

$lng_obj

)

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

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

toXML() [1/2]

ilMDDescription::toXML

(

&

$writer

)

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

References array, getDescription(), and getDescriptionLanguageCode().

    {
        $writer->xmlElement(
            'Description',
            array('Language' => $this->getDescriptionLanguageCode() ?
                                                $this->getDescriptionLanguageCode() :
                                                'en'),
            $this->getDescription()
        );
    }

Here is the call graph for this function:

toXML() [2/2]

ilMDDescription::toXML

(

&

$writer

)

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

References array, getDescription(), and getDescriptionLanguageCode().

    {
        $writer->xmlElement('Description', array('Language' => $this->getDescriptionLanguageCode()), $this->getDescription());
    }

Here is the call graph for this function:

update() [1/2]

ilMDDescription::update

(

)

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

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

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

Here is the call graph for this function:

update() [2/2]

ilMDDescription::update

(

)

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

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

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

Here is the call graph for this function:

---

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

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