ilMD5295General Class Reference

Inheritance diagram for ilMD5295General:

Collaboration diagram for ilMD5295General:

Public Member Functions
	getPossibleSubelements ()
&	getIdentifierIds ()
&	getIdentifier ($a_identifier_id)
&	addIdentifier ()
&	getLanguageIds ()
&	getLanguage ($a_language_id)
&	addLanguage ()
&	getDescriptionIds ()
&	getDescription ($a_description_id)
&	addDescription ()
&	getKeywordIds ()
&	getKeyword ($a_keyword_id)
&	addKeyword ()
	setStructure ($a_structure)
	getStructure ()
	setTitle ($a_title)
	getTitle ()
	setTitleLanguage (&$lng_obj)
&	getTitleLanguage ()
	getTitleLanguageCode ()
	setCoverage ($a_coverage)
	getCoverage ()
	setCoverageLanguage (&$lng_obj)
&	getCoverageLanguage ()
	getCoverageLanguageCode ()
	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	_getId ($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 34 of file class.ilMD5295General.php.

Member Function Documentation

__getFields()

ilMD5295General::__getFields

(

)

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

References getCoverage(), getCoverageLanguageCode(), ilMD5295Base\getObjId(), ilMD5295Base\getObjType(), ilMD5295Base\getRBACId(), getStructure(), getTitle(), and getTitleLanguageCode().

Referenced by save().

    {
        return array('rbac_id' => array('integer',$this->getRBACId()),
                     'obj_id' => array('integer',$this->getObjId()),
                     'obj_type' => array('text',$this->getObjType()),
                     'general_structure' => array('text',$this->getStructure()),
                     'title' => array('text',$this->getTitle()),
                     'title_language' => array('text',$this->getTitleLanguageCode()),
                     'coverage' => array('text',$this->getCoverage()),
                     'coverage_language' => array('text',$this->getCoverageLanguageCode()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getId()

static ilMD5295General::_getId (   $a_rbac_id,   $a_obj_id  )

static

Definition at line 451 of file class.ilMD5295General.php.

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

Referenced by ilMD5295\getGeneral().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT meta_general_id FROM il_meta_general " .
            "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)) {
            return $row->meta_general_id;
        }
        return false;
    }

Here is the caller graph for this function:

addDescription()

& ilMD5295General::addDescription

(

)

Definition at line 123 of file class.ilMD5295General.php.

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

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

        $des = new ilMD5295Description($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $des->setParentId($this->getMetaId());
        $des->setParentType('meta_general');

        return $des;
    }

Here is the call graph for this function:

addIdentifier()

& ilMD5295General::addIdentifier

(

)

Definition at line 66 of file class.ilMD5295General.php.

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

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

        $ide = new ilMD5295Identifier($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $ide->setParentId($this->getMetaId());
        $ide->setParentType('meta_general');

        return $ide;
    }

Here is the call graph for this function:

addKeyword()

& ilMD5295General::addKeyword

(

)

Definition at line 151 of file class.ilMD5295General.php.

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

Referenced by ilMD5295Keyword\updateKeywords().

    {
        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_general');

        return $key;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLanguage()

& ilMD5295General::addLanguage

(

)

Definition at line 94 of file class.ilMD5295General.php.

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

    {
        include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Language.php';
        
        $lan = new ilMD5295Language($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $lan->setParentId($this->getMetaId());
        $lan->setParentType('meta_general');

        return $lan;
    }

Here is the call graph for this function:

delete()

ilMD5295General::delete

(

)

Definition at line 269 of file class.ilMD5295General.php.

References $DIC, $ilDB, $query, $res, getDescription(), getDescriptionIds(), getIdentifier(), getIdentifierIds(), getKeyword(), getKeywordIds(), getLanguage(), getLanguageIds(), and ilMD5295Base\getMetaId().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$this->getMetaId()) {
            return false;
        }
        // Identifier
        foreach ($this->getIdentifierIds() as $id) {
            $ide = $this->getIdentifier($id);
            $ide->delete();
        }

        // Language
        foreach ($this->getLanguageIds() as $id) {
            $lan = $this->getLanguage($id);
            $lan->delete();
        }

        // Description
        foreach ($this->getDescriptionIds() as $id) {
            $des = $this->getDescription($id);
            $des->delete();
        }

        // Keyword
        foreach ($this->getKeywordIds() as $id) {
            $key = $this->getKeyword($id);
            $key->delete();
        }
        
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_general " .
                "WHERE meta_general_id = " . $ilDB->quote($this->getMetaId(), 'integer');
            $res = $ilDB->manipulate($query);
            return true;
        }


        return false;
    }

Here is the call graph for this function:

getCoverage()

ilMD5295General::getCoverage

(

)

Definition at line 211 of file class.ilMD5295General.php.

Referenced by __getFields(), and toXML().

    {
        return $this->coverage;
    }

Here is the caller graph for this function:

getCoverageLanguage()

& ilMD5295General::getCoverageLanguage

(

)

Definition at line 222 of file class.ilMD5295General.php.

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

getCoverageLanguageCode()

ilMD5295General::getCoverageLanguageCode

(

)

Definition at line 226 of file class.ilMD5295General.php.

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

getDescription()

& ilMD5295General::getDescription

(

$a_description_id

)

Definition at line 110 of file class.ilMD5295General.php.

Referenced by delete(), and toXML().

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


        if (!$a_description_id) {
            return false;
        }
        $des = new ilMD5295Description();
        $des->setMetaId($a_description_id);

        return $des;
    }

Here is the caller graph for this function:

getDescriptionIds()

& ilMD5295General::getDescriptionIds

(

)

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

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

Referenced by delete(), and toXML().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getIdentifier()

& ilMD5295General::getIdentifier

(

$a_identifier_id

)

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

Referenced by delete(), and toXML().

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

Here is the caller graph for this function:

getIdentifierIds()

& ilMD5295General::getIdentifierIds

(

)

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

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

Referenced by delete(), and toXML().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getKeyword()

& ilMD5295General::getKeyword

(

$a_keyword_id

)

Definition at line 139 of file class.ilMD5295General.php.

Referenced by delete(), toXML(), and ilMD5295Keyword\updateKeywords().

    {
        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()

& ilMD5295General::getKeywordIds

(

)

Definition at line 133 of file class.ilMD5295General.php.

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

Referenced by delete(), toXML(), and ilMD5295Keyword\updateKeywords().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getLanguage()

& ilMD5295General::getLanguage

(

$a_language_id

)

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

Referenced by delete(), and toXML().

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

        if (!$a_language_id) {
            return false;
        }
        $lan = new ilMD5295Language();
        $lan->setMetaId($a_language_id);

        return $lan;
    }

Here is the caller graph for this function:

getLanguageIds()

& ilMD5295General::getLanguageIds

(

)

Definition at line 76 of file class.ilMD5295General.php.

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

Referenced by delete(), and toXML().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPossibleSubelements()

ilMD5295General::getPossibleSubelements

(

)

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

    {
        $subs['Keyword'] = 'meta_keyword';
        $subs['Language'] = 'meta_language';
        $subs['Identifier'] = 'meta_identifier';
        $subs['Description'] = 'meta_description';

        return $subs;
    }

getStructure()

ilMD5295General::getStructure

(

)

Definition at line 180 of file class.ilMD5295General.php.

Referenced by __getFields(), and toXML().

    {
        return $this->structure;
    }

Here is the caller graph for this function:

getTitle()

ilMD5295General::getTitle

(

)

Definition at line 188 of file class.ilMD5295General.php.

Referenced by __getFields(), and toXML().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getTitleLanguage()

& ilMD5295General::getTitleLanguage

(

)

Definition at line 198 of file class.ilMD5295General.php.

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

getTitleLanguageCode()

ilMD5295General::getTitleLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

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

Here is the caller graph for this function:

read()

ilMD5295General::read

(

)

Definition at line 326 of file class.ilMD5295General.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilMD5295Base\getMetaId(), setCoverage(), setCoverageLanguage(), ilMD5295Base\setObjId(), ilMD5295Base\setObjType(), ilMD5295Base\setRBACId(), setStructure(), setTitle(), and setTitleLanguage().

    {
        global $DIC;

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

        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_general " .
                "WHERE meta_general_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->setStructure($row->general_structure);
                $this->setTitle($row->title);
                $this->setTitleLanguage(new ilMD5295LanguageItem($row->title_language));
                $this->setCoverage($row->coverage);
                $this->setCoverageLanguage(new ilMD5295LanguageItem($row->coverage_language));
            }
        }
        return true;
    }

Here is the call graph for this function:

save()

ilMD5295General::save

(

)

Definition at line 232 of file class.ilMD5295General.php.

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $fields = $this->__getFields();
        $fields['meta_general_id'] = array('integer',$next_id = $ilDB->nextId('il_meta_general'));

        //$this->log->debug("Insert General ".print_r($fields, true));
        //ilUtil::printBacktrace(10);

        if ($this->db->insert('il_meta_general', $fields)) {
            $this->setMetaId($next_id);
            return $this->getMetaId();
        }
        return false;
    }

Here is the call graph for this function:

setCoverage()

ilMD5295General::setCoverage

(

$a_coverage

)

Definition at line 207 of file class.ilMD5295General.php.

Referenced by read().

    {
        $this->coverage = $a_coverage;
    }

Here is the caller graph for this function:

setCoverageLanguage()

ilMD5295General::setCoverageLanguage

(

&

$lng_obj

)

Definition at line 216 of file class.ilMD5295General.php.

Referenced by read().

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

Here is the caller graph for this function:

setStructure()

ilMD5295General::setStructure

(

$a_structure

)

Definition at line 165 of file class.ilMD5295General.php.

Referenced by read().

    {
        switch ($a_structure) {
            case 'Atomic':
            case 'Collection':
            case 'Networked':
            case 'Hierarchical':
            case 'Linear':
                $this->structure = $a_structure;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setTitle()

ilMD5295General::setTitle

(

$a_title

)

Definition at line 184 of file class.ilMD5295General.php.

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setTitleLanguage()

ilMD5295General::setTitleLanguage

(

&

$lng_obj

)

Definition at line 192 of file class.ilMD5295General.php.

Referenced by read().

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

Here is the caller graph for this function:

toXML()

ilMD5295General::toXML

(

&

$writer

)

Definition at line 358 of file class.ilMD5295General.php.

References getCoverage(), getCoverageLanguageCode(), getDescription(), getDescriptionIds(), ilMD5295Base\getExportMode(), getIdentifier(), getIdentifierIds(), getKeyword(), getKeywordIds(), getLanguage(), getLanguageIds(), ilMD5295Base\getObjId(), ilMD5295Base\getObjType(), ilMD5295Base\getRBACId(), getStructure(), getTitle(), and getTitleLanguageCode().

    {
        $writer->xmlStartTag('General', array('Structure' => $this->getStructure() ?
                                             $this->getStructure() :
                                             'Atomic'));
                                             

        // Identifier
        $first = true;
        $identifiers = array();
        $identifiers = $this->getIdentifierIds();
        foreach ($identifiers as $id) {
            $ide = &$this->getIdentifier($id);
            $ide->setExportMode($this->getExportMode());
            $ide->toXML($writer);
            $first = false;
        }
        if (!count($identifiers)) {
            include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Identifier.php';
            $ide = new ilMD5295Identifier(
                $this->getRBACId(),
                $this->getObjId(),
                $this->getObjType()
            );          // added type, alex, 31 Oct 2007
            $ide->setExportMode(true);
            $ide->toXML($writer, true);
        }
        
        // Title
        $writer->xmlElement(
            'Title',
            array('Language' => $this->getTitleLanguageCode() ?
                                          $this->getTitleLanguageCode() :
                                          'en'),
            $this->getTitle()
        );

        // Language
        $languages = $this->getLanguageIds();
        foreach ($languages as $id) {
            $lan = &$this->getLanguage($id);
            $lan->toXML($writer);
        }
        if (!count($languages)) {
            // Default
            include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Language.php';
            $lan = new ilMD5295Language($this->getRBACId(), $this->getObjId());
            $lan->toXML($writer);
        }

        // Description
        $descriptions = $this->getDescriptionIds();
        foreach ($descriptions as $id) {
            $des = &$this->getDescription($id);
            $des->toXML($writer);
        }
        if (!count($descriptions)) {
            // Default
            include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Description.php';
            $des = new ilMD5295Description($this->getRBACId(), $this->getObjId());
            $des->toXML($writer);
        }
            

        // Keyword
        $keywords = $this->getKeywordIds();
        foreach ($keywords as $id) {
            $key = &$this->getKeyword($id);
            $key->toXML($writer);
        }
        if (!count($keywords)) {
            // Default
            include_once 'Services/Migration/DBUpdate_5295/classes/class.ilMD5295Keyword.php';
            $key = new ilMD5295Keyword($this->getRBACId(), $this->getObjId());
            $key->toXML($writer);
        }
        
        // Copverage
        if (strlen($this->getCoverage())) {
            $writer->xmlElement(
                'Coverage',
                array('Language' => $this->getCoverageLanguageCode() ?
                                                 $this->getCoverageLanguageCode() :
                                                 'en'),
                $this->getCoverage()
            );
        }
        $writer->xmlEndTag('General');
    }

Here is the call graph for this function:

update()

ilMD5295General::update

(

)

Definition at line 251 of file class.ilMD5295General.php.

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if ($this->getMetaId()) {
            if ($this->db->update(
                'il_meta_general',
                $this->__getFields(),
                array("meta_general_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.ilMD5295General.php