ilMD5295Classification Class Reference

Inheritance diagram for ilMD5295Classification:

Collaboration diagram for ilMD5295Classification:

Public Member Functions
&	getTaxonPathIds ()
&	getTaxonPath ($a_taxon_path_id)
&	addTaxonPath ()
&	getKeywordIds ()
&	getKeyword ($a_keyword_id)
&	addKeyword ()
	setPurpose ($a_purpose)
	getPurpose ()
	setDescription ($a_description)
	getDescription ()
	setDescriptionLanguage (&$lng_obj)
&	getDescriptionLanguage ()
	getDescriptionLanguageCode ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (&$writer)
Public Member Functions inherited from ilMD5295Base
	__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)

Static Public Member Functions
static	_getIds ($a_rbac_id, $a_obj_id)

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMD5295Classification::__getFields

(

)

Definition at line 202 of file class.ilMD5295Classification.php.

References getDescription(), getDescriptionLanguageCode(), ilMD5295Base\getObjId(), ilMD5295Base\getObjType(), getPurpose(), and ilMD5295Base\getRBACId().

Referenced by save().

    {
        return array('rbac_id' => array('integer',$this->getRBACId()),
                     'obj_id' => array('integer',$this->getObjId()),
                     'obj_type' => array('text',$this->getObjType()),
                     'purpose' => array('text',$this->getPurpose()),
                     'description' => array('text',$this->getDescription()),
                     'description_language' => array('text',$this->getDescriptionLanguageCode()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIds()

static ilMD5295Classification::_getIds (   $a_rbac_id,   $a_obj_id  )

static

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

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

Referenced by ilMD5295\getClassificationIds().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT meta_classification_id FROM il_meta_classification " .
            "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)) {
            $ids[] = $row->meta_classification_id;
        }
        return $ids ? $ids : array();
    }

Here is the caller graph for this function:

addKeyword()

& ilMD5295Classification::addKeyword

(

)

Definition at line 83 of file class.ilMD5295Classification.php.

References ilMD5295Base\getMetaId(), ilMD5295Base\getObjId(), ilMD5295Base\getObjType(), and ilMD5295Base\getRBACId().

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Keyword.php';

        $key = new ilMD5295Keyword($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $key->setParentId($this->getMetaId());
        $key->setParentType('meta_classification');

        return $key;
    }

Here is the call graph for this function:

addTaxonPath()

& ilMD5295Classification::addTaxonPath

(

)

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

References ilMD5295Base\getMetaId(), ilMD5295Base\getObjId(), ilMD5295Base\getObjType(), and ilMD5295Base\getRBACId().

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295TaxonPath.php';

        $tax = new ilMD5295TaxonPath($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $tax->setParentId($this->getMetaId());
        $tax->setParentType('meta_classification');

        return $tax;
    }

Here is the call graph for this function:

delete()

ilMD5295Classification::delete

(

)

Definition at line 176 of file class.ilMD5295Classification.php.

References $DIC, $ilDB, $query, $res, getKeyword(), getKeywordIds(), ilMD5295Base\getMetaId(), getTaxonPath(), and getTaxonPathIds().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_classification " .
                "WHERE meta_classification_id = " . $ilDB->quote($this->getMetaId(), 'integer');
            $res = $ilDB->manipulate($query);

            foreach ($this->getTaxonPathIds() as $id) {
                $tax = $this->getTaxonPath($id);
                $tax->delete();
            }
            foreach ($this->getKeywordIds() as $id) {
                $key = $this->getKeyword($id);
                $key->delete();
            }
            
            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDescription()

ilMD5295Classification::getDescription

(

)

Definition at line 122 of file class.ilMD5295Classification.php.

Referenced by __getFields(), and toXML().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getDescriptionLanguage()

& ilMD5295Classification::getDescriptionLanguage

(

)

Definition at line 132 of file class.ilMD5295Classification.php.

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

getDescriptionLanguageCode()

ilMD5295Classification::getDescriptionLanguageCode

(

)

Definition at line 136 of file class.ilMD5295Classification.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:

getKeyword()

& ilMD5295Classification::getKeyword

(

$a_keyword_id

)

Definition at line 71 of file class.ilMD5295Classification.php.

Referenced by delete(), and toXML().

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Keyword.php';
        
        if (!$a_keyword_id) {
            return false;
        }
        $key = new ilMD5295Keyword();
        $key->setMetaId($a_keyword_id);

        return $key;
    }

Here is the caller graph for this function:

getKeywordIds()

& ilMD5295Classification::getKeywordIds

(

)

Definition at line 65 of file class.ilMD5295Classification.php.

References ilMD5295Keyword\_getIds(), ilMD5295Base\getMetaId(), ilMD5295Base\getObjId(), and ilMD5295Base\getRBACId().

Referenced by delete(), and toXML().

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Keyword.php';

        return ilMD5295Keyword::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_classification');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPurpose()

ilMD5295Classification::getPurpose

(

)

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

Referenced by __getFields(), and toXML().

    {
        return $this->purpose;
    }

Here is the caller graph for this function:

getTaxonPath()

& ilMD5295Classification::getTaxonPath

(

$a_taxon_path_id

)

Definition at line 42 of file class.ilMD5295Classification.php.

Referenced by delete(), and toXML().

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295TaxonPath.php';

        if (!$a_taxon_path_id) {
            return false;
        }
        $tax = new ilMD5295TaxonPath();
        $tax->setMetaId($a_taxon_path_id);

        return $tax;
    }

Here is the caller graph for this function:

getTaxonPathIds()

& ilMD5295Classification::getTaxonPathIds

(

)

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

References ilMD5295TaxonPath\_getIds(), ilMD5295Base\getMetaId(), ilMD5295Base\getObjId(), and ilMD5295Base\getRBACId().

Referenced by delete(), and toXML().

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295TaxonPath.php';

        return ilMD5295TaxonPath::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_classification');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilMD5295Classification::read

(

)

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMD5295Base\getMetaId(), setDescription(), ilMD5295Base\setObjId(), ilMD5295Base\setObjType(), setPurpose(), and ilMD5295Base\setRBACId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295LanguageItem.php';

        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_classification " .
                "WHERE meta_classification_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->setPurpose($row->purpose);
                $this->setDescription($row->description);
                $this->description_language = new ilMD5295LanguageItem($row->description_language);
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMD5295Classification::save

(

)

Definition at line 142 of file class.ilMD5295Classification.php.

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

    {
        global $DIC;

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

Here is the call graph for this function:

setDescription()

ilMD5295Classification::setDescription

(

$a_description

)

Definition at line 118 of file class.ilMD5295Classification.php.

Referenced by read().

    {
        $this->description = $a_description;
    }

Here is the caller graph for this function:

setDescriptionLanguage()

ilMD5295Classification::setDescriptionLanguage

(

&

$lng_obj

)

Definition at line 126 of file class.ilMD5295Classification.php.

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

setPurpose()

ilMD5295Classification::setPurpose

(

$a_purpose

)

Definition at line 95 of file class.ilMD5295Classification.php.

Referenced by read().

    {
        switch ($a_purpose) {
            case 'Discipline':
            case 'Idea':
            case 'Prerequisite':
            case 'EducationalObjective':
            case 'AccessibilityRestrictions':
            case 'EducationalLevel':
            case 'SkillLevel':
            case 'SecurityLevel':
            case 'Competency':
                $this->purpose = $a_purpose;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

toXML()

ilMD5295Classification::toXML

(

&

$writer

)

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

References $keys, getDescription(), getDescriptionLanguageCode(), getKeyword(), getKeywordIds(), ilMD5295Base\getObjId(), getPurpose(), ilMD5295Base\getRBACId(), getTaxonPath(), and getTaxonPathIds().

    {
        $writer->xmlStartTag('Classification', array('Purpose' => $this->getPurpose()
                                                    ? $this->getPurpose()
                                                    : 'Idea'));

        // Taxon Path
        $taxs = $this->getTaxonPathIds();
        foreach ($taxs as $id) {
            $tax = &$this->getTaxonPath($id);
            $tax->toXML($writer);
        }
        if (!count($taxs)) {
            include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295TaxonPath.php';
            $tax = new ilMD5295TaxonPath($this->getRBACId(), $this->getObjId());
            $tax->toXML($writer);
        }

        // Description
        $writer->xmlElement(
            'Description',
            array('Language' => $this->getDescriptionLanguageCode()
                                                ? $this->getDescriptionLanguageCode()
                                                : 'en'),
            $this->getDescription()
        );
        
        // Keyword
        $keys = $this->getKeywordIds();
        foreach ($keys as $id) {
            $key = &$this->getKeyword($id);
            $key->toXML($writer);
        }
        if (!count($keys)) {
            include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Keyword.php';
            $key = new ilMD5295Keyword($this->getRBACId(), $this->getObjId());
            $key->toXML($writer);
        }
        $writer->xmlEndTag('Classification');
    }

Here is the call graph for this function:

update()

ilMD5295Classification::update

(

)

Definition at line 158 of file class.ilMD5295Classification.php.

References $DIC, $ilDB, and ilMD5295Base\getMetaId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getMetaId()) {
            if ($this->db->update(
                'il_meta_classification',
                $this->__getFields(),
                array("meta_classification_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/Migration/DBUpdate_5295/classes/class.ilMD5295Classification.php