ilMDEducational Class Reference

Inheritance diagram for ilMDEducational:

Collaboration diagram for ilMDEducational:

Public Member Functions
	getTypicalAgeRangeIds ()
	getTypicalAgeRange (int $a_typical_age_range_id)
	addTypicalAgeRange ()
	getDescriptionIds ()
	getDescription (int $a_description_id)
	addDescription ()
	getLanguageIds ()
	getLanguage (int $a_language_id)
	addLanguage ()
	setInteractivityType (string $a_iat)
	getInteractivityType ()
	setLearningResourceType (string $a_lrt)
	getLearningResourceType ()
	setInteractivityLevel (string $a_iat)
	getInteractivityLevel ()
	setSemanticDensity (string $a_sd)
	getSemanticDensity ()
	setIntendedEndUserRole (string $a_ieur)
	getIntendedEndUserRole ()
	setContext (string $a_context)
	getContext ()
	setDifficulty (string $a_difficulty)
	getDifficulty ()
	setPhysicalTypicalLearningTime (int $months, int $days, int $hours, int $minutes, int $seconds)
	setTypicalLearningTime (string $a_tlt)
	getTypicalLearningTime ()
	getTypicalLearningTimeSeconds ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (ilXmlWriter $writer)
	setMetaId (int $a_meta_id, bool $a_read_data=true)
	Compatibility fix for legacy MD classes for new db tables. More...
Public Member Functions inherited from ilMDBase
	__construct (int $a_rbac_id=0, int $a_obj_id=0, string $a_type='')
	constructor More...
	read ()
	setRBACId (int $a_id)
	getRBACId ()
	setObjId (int $a_id)
	getObjId ()
	setObjType (string $a_type)
	getObjType ()
	setMetaId (int $a_meta_id, bool $a_read_data=true)
	getMetaId ()
	setParentType (string $a_parent_type)
	getParentType ()
	setParentId (int $a_id)
	getParentId ()
	setExportMode (bool $a_export_mode=true)
	getExportMode ()
	validate ()
	update ()
	save ()
	delete ()
	toXML (ilXmlWriter $writer)

Static Public Member Functions
static	_getId (int $a_rbac_id, int $a_obj_id)
static	_getTypicalLearningTimeSeconds (int $a_rbac_id, int $a_obj_id=0)

Protected Member Functions
	createOrUpdateLearningResourceType ()
	Compatibility fix for legacy MD classes for new db tables. More...
	createOrUpdateIntendedEndUserRole ()
	Compatibility fix for legacy MD classes for new db tables. More...
	createOrUpdateContext ()
	Compatibility fix for legacy MD classes for new db tables. More...
	createOrUpdateInNewTable (string $table, string $id_field, int $id, string $data_field, string $data_value)
	Compatibility fix for legacy MD classes for new db tables. More...
	readFirstLearningResourceType ()
	Compatibility fix for legacy MD classes for new db tables. More...
	readFirstIntendedEndUserRole ()
	Compatibility fix for legacy MD classes for new db tables. More...
	readFirstContext ()
	Compatibility fix for legacy MD classes for new db tables. More...
	deleteAllLearningResourceTypes ()
	Compatibility fix for legacy MD classes for new db tables. More...
	deleteAllIntendedEndUserRoles ()
	Compatibility fix for legacy MD classes for new db tables. More...
	deleteAllContexts ()
	Compatibility fix for legacy MD classes for new db tables. More...
	getLearningResourceTypeId ()
	Compatibility fix for legacy MD classes for new db tables. More...
	getIntendedEndUserRoleId ()
	Compatibility fix for legacy MD classes for new db tables. More...
	getContextId ()
	Compatibility fix for legacy MD classes for new db tables. More...
	readLearningResourceTypeId (int $parent_id)
	Compatibility fix for legacy MD classes for new db tables. More...
	readIntendedEndUserRoleId (int $parent_id)
	Compatibility fix for legacy MD classes for new db tables. More...
	readContextId (int $parent_id)
	Compatibility fix for legacy MD classes for new db tables. More...

Private Attributes
const	INTERACTIVITY_TYPE_TRANSLATION
	Compatibility fix for legacy MD classes for new db tables. More...
const const	LEARNING_RESOURCE_TYPE_TRANSLATION
const const const	INTERACTIVITY_LEVEL_TRANSLATION
const const const const	SEMANTIC_DENSITY_TRANSLATION
const const const const const	INTENDED_END_USER_ROLE_TRANSLATION
const const const const const const	CONTEXT_TRANSLATION
const const const const const const const	DIFFICULTY_TRANSLATION
const const const const const const const string	$interactivity_type = ''
string	$learning_resource_type = ''
string	$interactivity_level = ''
string	$semantic_density = ''
string	$intended_end_user_role = ''
string	$context = ''
string	$difficulty = ''
string	$typical_learning_time = ''
int	$learning_resource_type_id = 0
	Compatibility fix for legacy MD classes for new db tables. More...
int	$intended_end_user_role_id = 0
int	$context_id = 0

Additional Inherited Members
Protected Attributes inherited from ilMDBase
ilLogger	$log
ilDBInterface	$db

Detailed Description

Definition at line 27 of file class.ilMDEducational.php.

Member Function Documentation

__getFields()

ilMDEducational::__getFields

(

)

Returns

array<string, array<string, mixed>>

Compatibility fix for legacy MD classes for new db tables

Definition at line 471 of file class.ilMDEducational.php.

References getDifficulty(), getInteractivityLevel(), getInteractivityType(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getRBACId(), getSemanticDensity(), and getTypicalLearningTime().

Referenced by save(), and update().

                                 : array
    {
        $interactivity_type = (string) array_search(
            $this->getInteractivityType(),
            self::INTERACTIVITY_TYPE_TRANSLATION
        );
        $interactivity_level = (string) array_search(
            $this->getInteractivityLevel(),
            self::INTERACTIVITY_LEVEL_TRANSLATION
        );
        $semantic_density = (string) array_search(
            $this->getSemanticDensity(),
            self::SEMANTIC_DENSITY_TRANSLATION
        );
        $difficulty = (string) array_search(
            $this->getDifficulty(),
            self::DIFFICULTY_TRANSLATION
        );

        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            'interactivity_type' => array('text', $interactivity_type),
            //'learning_resource_type' => array('text', $this->getLearningResourceType()),
            'interactivity_level' => array('text', $interactivity_level),
            'semantic_density' => array('text', $semantic_density),
            //'intended_end_user_role' => array('text', $this->getIntendedEndUserRole()),
            //'context' => array('text', $this->getContext()),
            'difficulty' => array('text', $difficulty),
            'typical_learning_time' => array('text', $this->getTypicalLearningTime())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getId()

static ilMDEducational::_getId ( int  $a_rbac_id, int  $a_obj_id  )

static

Definition at line 600 of file class.ilMDEducational.php.

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

Referenced by ilMD\getEducational().

                                                                : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_educational_id FROM il_meta_educational " .
            "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 (int) $row->meta_educational_id;
        }
        return 0;
    }

Here is the caller graph for this function:

_getTypicalLearningTimeSeconds()

static ilMDEducational::_getTypicalLearningTimeSeconds ( int  $a_rbac_id, int  $a_obj_id = 0  )

static

Definition at line 617 of file class.ilMDEducational.php.

References $DIC, $ilDB, $res, ilMDUtils\_LOMDurationToArray(), and ilDBConstants\FETCHMODE_OBJECT.

                                                                                            : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $a_obj_id = $a_obj_id ?: $a_rbac_id;

        $query = "SELECT typical_learning_time FROM il_meta_educational " .
            "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)) {
            $time_arr = ilMDUtils::_LOMDurationToArray((string) $row->typical_learning_time);
            if (!count($time_arr)) {
                return 0;
            }
            return 60 * 60 * 24 * 30 * $time_arr[0] +
                60 * 60 * 24 * $time_arr[1] +
                60 * 60 * $time_arr[2] +
                60 * $time_arr[3] +
                $time_arr[4];
        }
        return 0;
    }

Here is the call graph for this function:

addDescription()

ilMDEducational::addDescription

(

)

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

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

                                    : ilMDDescription
    {
        $des = new ilMDDescription($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $des->setParentId($this->getMetaId());
        $des->setParentType('meta_educational');

        return $des;
    }

Here is the call graph for this function:

addLanguage()

ilMDEducational::addLanguage

(

)

Definition at line 191 of file class.ilMDEducational.php.

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

                                 : ilMDLanguage
    {
        $lan = new ilMDLanguage($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $lan->setParentId($this->getMetaId());
        $lan->setParentType('meta_educational');

        return $lan;
    }

Here is the call graph for this function:

addTypicalAgeRange()

ilMDEducational::addTypicalAgeRange

(

)

Definition at line 135 of file class.ilMDEducational.php.

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

                                        : ilMDTypicalAgeRange
    {
        $typ = new ilMDTypicalAgeRange($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $typ->setParentId($this->getMetaId());
        $typ->setParentType('meta_educational');

        return $typ;
    }

Here is the call graph for this function:

createOrUpdateContext()

ilMDEducational::createOrUpdateContext ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 684 of file class.ilMDEducational.php.

References createOrUpdateInNewTable(), getContext(), and getContextId().

Referenced by save(), and update().

                                              : void
    {
        $context = (string) array_search(
            $this->getContext(),
            self::CONTEXT_TRANSLATION
        );

        $this->context_id = $this->createOrUpdateInNewTable(
            'il_meta_context',
            'meta_context_id',
            $this->getContextId(),
            'context',
            $context
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createOrUpdateInNewTable()

ilMDEducational::createOrUpdateInNewTable ( string  $table, string  $id_field, int  $id, string  $data_field, string  $data_value  )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 703 of file class.ilMDEducational.php.

References $id, ilMDBase\getMetaId(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

Referenced by createOrUpdateContext(), createOrUpdateIntendedEndUserRole(), and createOrUpdateLearningResourceType().

     : int {
        if ($data_value === '') {
            return 0;
        }

        if (!$id) {
            $this->db->insert(
                $table,
                [
                    $id_field => ['integer', $next_id = $this->db->nextId($table)],
                    'rbac_id' => ['integer', $this->getRBACId()],
                    'obj_id' => ['integer', $this->getObjId()],
                    'obj_type' => ['text', $this->getObjType()],
                    'parent_type' => ['text', 'meta_educational'],
                    'parent_id' => ['integer', $this->getMetaId()],
                    $data_field => ['text', $data_value]
                ]
            );
            return $next_id;
        }

        $this->db->update(
            $table,
            [$data_field => ['text', $data_value]],
            [$id_field => ['integer', $id]]
        );
        return $id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createOrUpdateIntendedEndUserRole()

ilMDEducational::createOrUpdateIntendedEndUserRole ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 665 of file class.ilMDEducational.php.

References createOrUpdateInNewTable(), getIntendedEndUserRole(), and getIntendedEndUserRoleId().

Referenced by save(), and update().

                                                          : void
    {
        $intended_end_user_role = (string) array_search(
            $this->getIntendedEndUserRole(),
            self::INTENDED_END_USER_ROLE_TRANSLATION
        );

        $this->intended_end_user_role_id = $this->createOrUpdateInNewTable(
            'il_meta_end_usr_role',
            'meta_end_usr_role_id',
            $this->getIntendedEndUserRoleId(),
            'intended_end_user_role',
            $intended_end_user_role
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createOrUpdateLearningResourceType()

ilMDEducational::createOrUpdateLearningResourceType ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 646 of file class.ilMDEducational.php.

References createOrUpdateInNewTable(), getLearningResourceType(), and getLearningResourceTypeId().

Referenced by save(), and update().

                                                           : void
    {
        $learning_resource_type = (string) array_search(
            $this->getLearningResourceType(),
            self::LEARNING_RESOURCE_TYPE_TRANSLATION
        );

        $this->learning_resource_type_id = $this->createOrUpdateInNewTable(
            'il_meta_lr_type',
            'meta_lr_type_id',
            $this->getLearningResourceTypeId(),
            'learning_resource_type',
            $learning_resource_type
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilMDEducational::delete

(

)

Definition at line 439 of file class.ilMDEducational.php.

References $id, $res, deleteAllContexts(), deleteAllIntendedEndUserRoles(), deleteAllLearningResourceTypes(), getDescription(), getDescriptionIds(), getLanguage(), getLanguageIds(), ilMDBase\getMetaId(), getTypicalAgeRange(), getTypicalAgeRangeIds(), and ilDBConstants\T_INTEGER.

                            : bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_educational " .
                "WHERE meta_educational_id = " . $this->db->quote($this->getMetaId(), ilDBConstants::T_INTEGER);
            $res = $this->db->manipulate($query);

            $this->deleteAllLearningResourceTypes();
            $this->deleteAllIntendedEndUserRoles();
            $this->deleteAllContexts();

            foreach ($this->getTypicalAgeRangeIds() as $id) {
                $typ = $this->getTypicalAgeRange($id);
                $typ->delete();
            }
            foreach ($this->getDescriptionIds() as $id) {
                $des = $this->getDescription($id);
                $des->delete();
            }
            foreach ($this->getLanguageIds() as $id) {
                $lan = $this->getLanguage($id);
                $lan->delete();
            }

            return true;
        }
        return false;
    }

Here is the call graph for this function:

deleteAllContexts()

ilMDEducational::deleteAllContexts ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 812 of file class.ilMDEducational.php.

References $res, and ilMDBase\getMetaId().

Referenced by delete().

                                          : void
    {
        $query = "DELETE FROM il_meta_context WHERE parent_type = 'meta_educational'
                AND parent_id = " . $this->db->quote($this->getMetaId(), 'integer');
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAllIntendedEndUserRoles()

ilMDEducational::deleteAllIntendedEndUserRoles ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 802 of file class.ilMDEducational.php.

References $res, and ilMDBase\getMetaId().

Referenced by delete().

                                                      : void
    {
        $query = "DELETE FROM il_meta_end_usr_role WHERE parent_type = 'meta_educational'
                AND parent_id = " . $this->db->quote($this->getMetaId(), 'integer');
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAllLearningResourceTypes()

ilMDEducational::deleteAllLearningResourceTypes ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 792 of file class.ilMDEducational.php.

References $res, and ilMDBase\getMetaId().

Referenced by delete().

                                                       : void
    {
        $query = "DELETE FROM il_meta_lr_type WHERE parent_type = 'meta_educational'
                AND parent_id = " . $this->db->quote($this->getMetaId(), 'integer');
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContext()

ilMDEducational::getContext

(

)

Definition at line 328 of file class.ilMDEducational.php.

References $context.

Referenced by createOrUpdateContext(), and toXML().

                                : string
    {
        return $this->context;
    }

Here is the caller graph for this function:

getContextId()

ilMDEducational::getContextId ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 838 of file class.ilMDEducational.php.

References $context_id.

Referenced by createOrUpdateContext(), and readFirstContext().

                                     : int
    {
        return $this->context_id;
    }

Here is the caller graph for this function:

getDescription()

ilMDEducational::getDescription

(

int

$a_description_id

)

Definition at line 152 of file class.ilMDEducational.php.

Referenced by delete(), and toXML().

                                                         : ?ilMDDescription
    {
        if (!$a_description_id) {
            return null;
        }
        $des = new ilMDDescription();
        $des->setMetaId($a_description_id);

        return $des;
    }

Here is the caller graph for this function:

getDescriptionIds()

ilMDEducational::getDescriptionIds

(

)

Returns

int[]

Definition at line 147 of file class.ilMDEducational.php.

References ilMDDescription\_getIds(), ilMDBase\getMetaId(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                       : array
    {
        return ilMDDescription::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_educational');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDifficulty()

ilMDEducational::getDifficulty

(

)

Definition at line 349 of file class.ilMDEducational.php.

References $difficulty.

Referenced by __getFields(), and toXML().

                                   : string
    {
        return $this->difficulty;
    }

Here is the caller graph for this function:

getIntendedEndUserRole()

ilMDEducational::getIntendedEndUserRole

(

)

Definition at line 308 of file class.ilMDEducational.php.

References $intended_end_user_role.

Referenced by createOrUpdateIntendedEndUserRole(), and toXML().

                                            : string
    {
        return $this->intended_end_user_role;
    }

Here is the caller graph for this function:

getIntendedEndUserRoleId()

ilMDEducational::getIntendedEndUserRoleId ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 830 of file class.ilMDEducational.php.

References $intended_end_user_role_id.

Referenced by createOrUpdateIntendedEndUserRole(), and readFirstIntendedEndUserRole().

                                                 : int
    {
        return $this->intended_end_user_role_id;
    }

Here is the caller graph for this function:

getInteractivityLevel()

ilMDEducational::getInteractivityLevel

(

)

Definition at line 267 of file class.ilMDEducational.php.

References $interactivity_level.

Referenced by __getFields(), and toXML().

                                           : string
    {
        return $this->interactivity_level;
    }

Here is the caller graph for this function:

getInteractivityType()

ilMDEducational::getInteractivityType

(

)

Definition at line 215 of file class.ilMDEducational.php.

References $interactivity_type.

Referenced by __getFields(), and toXML().

                                          : string
    {
        return $this->interactivity_type;
    }

Here is the caller graph for this function:

getLanguage()

ilMDEducational::getLanguage

(

int

$a_language_id

)

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

Referenced by delete(), and toXML().

                                                   : ?ilMDLanguage
    {
        if (!$a_language_id) {
            return null;
        }
        $lan = new ilMDLanguage();
        $lan->setMetaId($a_language_id);

        return $lan;
    }

Here is the caller graph for this function:

getLanguageIds()

ilMDEducational::getLanguageIds

(

)

Returns

int[]

Definition at line 175 of file class.ilMDEducational.php.

References ilMDLanguage\_getIds(), ilMDBase\getMetaId(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                    : array
    {
        return ilMDLanguage::_getIds($this->getRBACId(), $this->getObjId(), $this->getMetaId(), 'meta_educational');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLearningResourceType()

ilMDEducational::getLearningResourceType

(

)

Definition at line 246 of file class.ilMDEducational.php.

References $learning_resource_type.

Referenced by createOrUpdateLearningResourceType(), and toXML().

                                             : string
    {
        return $this->learning_resource_type;
    }

Here is the caller graph for this function:

getLearningResourceTypeId()

ilMDEducational::getLearningResourceTypeId ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 822 of file class.ilMDEducational.php.

References $learning_resource_type_id.

Referenced by createOrUpdateLearningResourceType(), and readFirstLearningResourceType().

                                                  : int
    {
        return $this->learning_resource_type_id;
    }

Here is the caller graph for this function:

getSemanticDensity()

ilMDEducational::getSemanticDensity

(

)

Definition at line 288 of file class.ilMDEducational.php.

References $semantic_density.

Referenced by __getFields(), and toXML().

                                        : string
    {
        return $this->semantic_density;
    }

Here is the caller graph for this function:

getTypicalAgeRange()

ilMDEducational::getTypicalAgeRange

(

int

$a_typical_age_range_id

)

Definition at line 124 of file class.ilMDEducational.php.

Referenced by delete(), and toXML().

                                                                   : ?ilMDTypicalAgeRange
    {
        if (!$a_typical_age_range_id) {
            return null;
        }
        $typ = new ilMDTypicalAgeRange();
        $typ->setMetaId($a_typical_age_range_id);

        return $typ;
    }

Here is the caller graph for this function:

getTypicalAgeRangeIds()

ilMDEducational::getTypicalAgeRangeIds

(

)

Returns

int[]

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

References ilMDTypicalAgeRange\_getIds(), ilMDBase\getMetaId(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                           : array
    {
        return ilMDTypicalAgeRange::_getIds(
            $this->getRBACId(),
            $this->getObjId(),
            $this->getMetaId(),
            'meta_educational'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypicalLearningTime()

ilMDEducational::getTypicalLearningTime

(

)

Definition at line 393 of file class.ilMDEducational.php.

References $typical_learning_time.

Referenced by __getFields(), getTypicalLearningTimeSeconds(), and toXML().

                                            : string
    {
        return $this->typical_learning_time;
    }

Here is the caller graph for this function:

getTypicalLearningTimeSeconds()

ilMDEducational::getTypicalLearningTimeSeconds

(

)

Definition at line 398 of file class.ilMDEducational.php.

References ilMDUtils\_LOMDurationToArray(), and getTypicalLearningTime().

                                                   : int
    {
        $time_arr = ilMDUtils::_LOMDurationToArray($this->getTypicalLearningTime());
        if ($time_arr === []) {
            return 0;
        }
        return 60 * 60 * 24 * 30 * $time_arr[0] + 60 * 60 * 24 * $time_arr[1] + 60 * 60 * $time_arr[2] + 60 * $time_arr[3] + $time_arr[4];
    }

Here is the call graph for this function:

read()

ilMDEducational::read

(

)

Compatibility fix for legacy MD classes for new db tables

Definition at line 508 of file class.ilMDEducational.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), readFirstContext(), readFirstIntendedEndUserRole(), readFirstLearningResourceType(), setDifficulty(), setInteractivityLevel(), setInteractivityType(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setRBACId(), setSemanticDensity(), and setTypicalLearningTime().

                          : bool
    {
        if ($this->getMetaId()) {
            $query = "SELECT * FROM il_meta_educational " .
                "WHERE meta_educational_id = " . $this->db->quote($this->getMetaId(), 'integer');

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                if (key_exists($row->interactivity_type ?? '', self::INTERACTIVITY_TYPE_TRANSLATION)) {
                    $row->interactivity_type = self::INTERACTIVITY_TYPE_TRANSLATION[$row->interactivity_type ?? ''];
                }
                if (key_exists($row->interactivity_level ?? '', self::INTERACTIVITY_LEVEL_TRANSLATION)) {
                    $row->interactivity_level = self::INTERACTIVITY_LEVEL_TRANSLATION[$row->interactivity_level ?? ''];
                }
                if (key_exists($row->semantic_density ?? '', self::SEMANTIC_DENSITY_TRANSLATION)) {
                    $row->semantic_density = self::SEMANTIC_DENSITY_TRANSLATION[$row->semantic_density ?? ''];
                }
                if (key_exists($row->difficulty ?? '', self::DIFFICULTY_TRANSLATION)) {
                    $row->difficulty = self::DIFFICULTY_TRANSLATION[$row->difficulty ?? ''];
                }

                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type ?? '');
                $this->setInteractivityType($row->interactivity_type ?? '');
                //$this->setLearningResourceType($row->learning_resource_type ?? '');
                $this->setInteractivityLevel($row->interactivity_level ?? '');
                $this->setSemanticDensity($row->semantic_density ?? '');
                //$this->setIntendedEndUserRole($row->intended_end_user_role ?? '');
                //$this->setContext($row->context ?? '');
                $this->setDifficulty($row->difficulty ?? '');
                $this->setTypicalLearningTime($row->typical_learning_time ?? '');
            }

            $this->readFirstLearningResourceType();
            $this->readFirstIntendedEndUserRole();
            $this->readFirstContext();
            return true;
        }
        return false;
    }

Here is the call graph for this function:

readContextId()

ilMDEducational::readContextId ( int  $parent_id )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 876 of file class.ilMDEducational.php.

References $res, and ILIAS\Repository\int().

Referenced by setMetaId().

                                                    : void
    {
        $query = "SELECT meta_context_id FROM il_meta_context WHERE parent_type = 'meta_educational'
                AND parent_id = " . $this->db->quote($parent_id, 'integer') .
            " ORDER BY meta_context_id";

        $res = $this->db->query($query);
        if ($row = $this->db->fetchAssoc($res)) {
            $this->context_id = (int) $row['meta_context_id'];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readFirstContext()

ilMDEducational::readFirstContext ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 775 of file class.ilMDEducational.php.

References $res, getContextId(), and setContext().

Referenced by read().

                                         : void
    {
        $query = "SELECT * FROM il_meta_context WHERE meta_context_id = " .
            $this->db->quote($this->getContextId(), 'integer');

        $res = $this->db->query($query);
        if ($row = $this->db->fetchAssoc($res)) {
            if (key_exists($row['context'], self::CONTEXT_TRANSLATION)) {
                $row['context'] = self::CONTEXT_TRANSLATION[$row['context']];
            }
            $this->setContext((string) $row['context']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readFirstIntendedEndUserRole()

ilMDEducational::readFirstIntendedEndUserRole ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 758 of file class.ilMDEducational.php.

References $res, getIntendedEndUserRoleId(), and setIntendedEndUserRole().

Referenced by read().

                                                     : void
    {
        $query = "SELECT * FROM il_meta_end_usr_role WHERE meta_end_usr_role_id = " .
            $this->db->quote($this->getIntendedEndUserRoleId(), 'integer');

        $res = $this->db->query($query);
        if ($row = $this->db->fetchAssoc($res)) {
            if (key_exists($row['intended_end_user_role'], self::INTENDED_END_USER_ROLE_TRANSLATION)) {
                $row['intended_end_user_role'] = self::INTENDED_END_USER_ROLE_TRANSLATION[$row['intended_end_user_role']];
            }
            $this->setIntendedEndUserRole((string) $row['intended_end_user_role']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readFirstLearningResourceType()

ilMDEducational::readFirstLearningResourceType ( )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 741 of file class.ilMDEducational.php.

References $res, getLearningResourceTypeId(), and setLearningResourceType().

Referenced by read().

                                                      : void
    {
        $query = "SELECT * FROM il_meta_lr_type WHERE meta_lr_type_id = " .
            $this->db->quote($this->getLearningResourceTypeId(), 'integer');

        $res = $this->db->query($query);
        if ($row = $this->db->fetchAssoc($res)) {
            if (key_exists($row['learning_resource_type'], self::LEARNING_RESOURCE_TYPE_TRANSLATION)) {
                $row['learning_resource_type'] = self::LEARNING_RESOURCE_TYPE_TRANSLATION[$row['learning_resource_type']];
            }
            $this->setLearningResourceType((string) $row['learning_resource_type']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readIntendedEndUserRoleId()

ilMDEducational::readIntendedEndUserRoleId ( int  $parent_id )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 861 of file class.ilMDEducational.php.

References $res, and ILIAS\Repository\int().

Referenced by setMetaId().

                                                                : void
    {
        $query = "SELECT meta_end_usr_role_id FROM il_meta_end_usr_role WHERE parent_type = 'meta_educational'
                AND parent_id = " . $this->db->quote($parent_id, 'integer') .
            " ORDER BY meta_end_usr_role_id";

        $res = $this->db->query($query);
        if ($row = $this->db->fetchAssoc($res)) {
            $this->intended_end_user_role_id = (int) $row['meta_end_usr_role_id'];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readLearningResourceTypeId()

ilMDEducational::readLearningResourceTypeId ( int  $parent_id )

protected

Compatibility fix for legacy MD classes for new db tables.

Definition at line 846 of file class.ilMDEducational.php.

References $res, and ILIAS\Repository\int().

Referenced by setMetaId().

                                                                 : void
    {
        $query = "SELECT meta_lr_type_id FROM il_meta_lr_type WHERE parent_type = 'meta_educational'
                AND parent_id = " . $this->db->quote($parent_id, 'integer') .
            " ORDER BY meta_lr_type_id";

        $res = $this->db->query($query);
        if ($row = $this->db->fetchAssoc($res)) {
            $this->learning_resource_type_id = (int) $row['meta_lr_type_id'];
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilMDEducational::save

(

)

Definition at line 407 of file class.ilMDEducational.php.

References __getFields(), createOrUpdateContext(), createOrUpdateIntendedEndUserRole(), createOrUpdateLearningResourceType(), ilMDBase\getMetaId(), and setMetaId().

                          : int
    {
        $fields = $this->__getFields();
        $fields['meta_educational_id'] = array('integer', $next_id = $this->db->nextId('il_meta_educational'));

        if ($this->db->insert('il_meta_educational', $fields)) {
            $this->setMetaId($next_id);
            $this->createOrUpdateLearningResourceType();
            $this->createOrUpdateIntendedEndUserRole();
            $this->createOrUpdateContext();
            return $this->getMetaId();
        }
        return 0;
    }

Here is the call graph for this function:

setContext()

ilMDEducational::setContext

(

string

$a_context

)

Definition at line 313 of file class.ilMDEducational.php.

Referenced by readFirstContext().

                                                 : bool
    {
        switch ($a_context) {
            case 'School':
            case 'HigherEducation':
            case 'Training':
            case 'Other':
                $this->context = $a_context;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setDifficulty()

ilMDEducational::setDifficulty

(

string

$a_difficulty

)

Definition at line 333 of file class.ilMDEducational.php.

Referenced by read().

                                                       : bool
    {
        switch ($a_difficulty) {
            case 'VeryEasy':
            case 'Easy':
            case 'Medium':
            case 'Difficult':
            case 'VeryDifficult':
                $this->difficulty = $a_difficulty;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setIntendedEndUserRole()

ilMDEducational::setIntendedEndUserRole

(

string

$a_ieur

)

Definition at line 293 of file class.ilMDEducational.php.

Referenced by readFirstIntendedEndUserRole().

                                                          : bool
    {
        switch ($a_ieur) {
            case 'Teacher':
            case 'Author':
            case 'Learner':
            case 'Manager':
                $this->intended_end_user_role = $a_ieur;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setInteractivityLevel()

ilMDEducational::setInteractivityLevel

(

string

$a_iat

)

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

Referenced by read().

                                                        : bool
    {
        switch ($a_iat) {
            case 'VeryLow':
            case 'Low':
            case 'Medium':
            case 'High':
            case 'VeryHigh':
                $this->interactivity_level = $a_iat;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setInteractivityType()

ilMDEducational::setInteractivityType

(

string

$a_iat

)

Definition at line 201 of file class.ilMDEducational.php.

Referenced by read().

                                                       : bool
    {
        switch ($a_iat) {
            case 'Active':
            case 'Expositive':
            case 'Mixed':
                $this->interactivity_type = $a_iat;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setLearningResourceType()

ilMDEducational::setLearningResourceType

(

string

$a_lrt

)

Definition at line 220 of file class.ilMDEducational.php.

Referenced by readFirstLearningResourceType().

                                                          : bool
    {
        switch ($a_lrt) {
            case 'Exercise':
            case 'Simulation':
            case 'Questionnaire':
            case 'Diagram':
            case 'Figure':
            case 'Graph':
            case 'Index':
            case 'Slide':
            case 'Table':
            case 'NarrativeText':
            case 'Exam':
            case 'Experiment':
            case 'ProblemStatement':
            case 'SelfAssessment':
            case 'Lecture':
                $this->learning_resource_type = $a_lrt;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setMetaId()

ilMDEducational::setMetaId	(	int	$a_meta_id,
		bool	$a_read_data = true
	)

Compatibility fix for legacy MD classes for new db tables.

Definition at line 891 of file class.ilMDEducational.php.

References readContextId(), readIntendedEndUserRoleId(), and readLearningResourceTypeId().

Referenced by save().

                                                                       : void
    {
        $this->readLearningResourceTypeId($a_meta_id);
        $this->readIntendedEndUserRoleId($a_meta_id);
        $this->readContextId($a_meta_id);
        parent::setMetaId($a_meta_id, $a_read_data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPhysicalTypicalLearningTime()

ilMDEducational::setPhysicalTypicalLearningTime	(	int	$months,
		int	$days,
		int	$hours,
		int	$minutes,
		int	$seconds
	)

Definition at line 354 of file class.ilMDEducational.php.

References setTypicalLearningTime().

     : bool {
        if (!$months && !$days && !$hours && !$minutes && !$seconds) {
            $this->setTypicalLearningTime('PT00H00M');
            return true;
        }
        $tlt = 'P';
        if ($months) {
            $tlt .= ($months . 'M');
        }
        if ($days) {
            $tlt .= ($days . 'D');
        }
        if ($hours || $minutes || $seconds) {
            $tlt .= 'T';
        }
        if ($hours) {
            $tlt .= ($hours . 'H');
        }
        if ($minutes) {
            $tlt .= ($minutes . 'M');
        }
        if ($seconds) {
            $tlt .= ($seconds . 'S');
        }
        $this->setTypicalLearningTime($tlt);
        return true;
    }

Here is the call graph for this function:

setSemanticDensity()

ilMDEducational::setSemanticDensity

(

string

$a_sd

)

Definition at line 272 of file class.ilMDEducational.php.

Referenced by read().

                                                    : bool
    {
        switch ($a_sd) {
            case 'VeryLow':
            case 'Low':
            case 'Medium':
            case 'High':
            case 'VeryHigh':
                $this->semantic_density = $a_sd;
                return true;

            default:
                return false;
        }
    }

Here is the caller graph for this function:

setTypicalLearningTime()

ilMDEducational::setTypicalLearningTime

(

string

$a_tlt

)

Definition at line 388 of file class.ilMDEducational.php.

Referenced by read(), and setPhysicalTypicalLearningTime().

                                                         : void
    {
        $this->typical_learning_time = $a_tlt;
    }

Here is the caller graph for this function:

toXML()

ilMDEducational::toXML

(

ilXmlWriter

$writer

)

Definition at line 553 of file class.ilMDEducational.php.

References $id, getContext(), getDescription(), getDescriptionIds(), getDifficulty(), getIntendedEndUserRole(), getInteractivityLevel(), getInteractivityType(), getLanguage(), getLanguageIds(), getLearningResourceType(), ilMDBase\getObjId(), ilMDBase\getRBACId(), getSemanticDensity(), getTypicalAgeRange(), getTypicalAgeRangeIds(), getTypicalLearningTime(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag(
            'Educational',
            array(
                'InteractivityType' => $this->getInteractivityType() ?: 'Active',
                'LearningResourceType' => $this->getLearningResourceType() ?: 'Exercise',
                'InteractivityLevel' => $this->getInteractivityLevel() ?: 'Medium',
                'SemanticDensity' => $this->getSemanticDensity() ?: 'Medium',
                'IntendedEndUserRole' => $this->getIntendedEndUserRole() ?: 'Learner',
                'Context' => $this->getContext() ?: 'Other',
                'Difficulty' => $this->getDifficulty() ?: 'Medium'
            )
        );

        // TypicalAgeRange
        $typ_ages = $this->getTypicalAgeRangeIds();
        foreach ($typ_ages as $id) {
            $key = $this->getTypicalAgeRange($id);

            // extra test due to bug 5316 (may be due to eLaix import)
            if (is_object($key)) {
                $key->toXML($writer);
            }
        }
        if (!count($typ_ages)) {
            $typ = new ilMDTypicalAgeRange($this->getRBACId(), $this->getObjId());
            $typ->toXML($writer);
        }

        // TypicalLearningTime
        $writer->xmlElement('TypicalLearningTime', null, $this->getTypicalLearningTime());

        // Description
        foreach ($this->getDescriptionIds() as $id) {
            $key = $this->getDescription($id);
            $key->toXML($writer);
        }
        // Language
        foreach ($this->getLanguageIds() as $id) {
            $lang = $this->getLanguage($id);
            $lang->toXML($writer);
        }
        $writer->xmlEndTag('Educational');
    }

Here is the call graph for this function:

update()

ilMDEducational::update

(

)

Definition at line 422 of file class.ilMDEducational.php.

References __getFields(), createOrUpdateContext(), createOrUpdateIntendedEndUserRole(), createOrUpdateLearningResourceType(), and ilMDBase\getMetaId().

                            : bool
    {
        if (!$this->getMetaId()) {
            return false;
        }

        $this->createOrUpdateLearningResourceType();
        $this->createOrUpdateIntendedEndUserRole();
        $this->createOrUpdateContext();

        return (bool) $this->db->update(
            'il_meta_educational',
            $this->__getFields(),
            array("meta_educational_id" => array('integer', $this->getMetaId()))
        );
    }

Here is the call graph for this function:

Field Documentation

$context

string ilMDEducational::$context = ''

private

Definition at line 99 of file class.ilMDEducational.php.

Referenced by getContext().

$context_id

int ilMDEducational::$context_id = 0

private

Definition at line 109 of file class.ilMDEducational.php.

Referenced by getContextId().

$difficulty

string ilMDEducational::$difficulty = ''

private

Definition at line 100 of file class.ilMDEducational.php.

Referenced by getDifficulty().

$intended_end_user_role

string ilMDEducational::$intended_end_user_role = ''

private

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

Referenced by getIntendedEndUserRole().

$intended_end_user_role_id

int ilMDEducational::$intended_end_user_role_id = 0

private

Definition at line 108 of file class.ilMDEducational.php.

Referenced by getIntendedEndUserRoleId().

$interactivity_level

string ilMDEducational::$interactivity_level = ''

private

Definition at line 96 of file class.ilMDEducational.php.

Referenced by getInteractivityLevel().

$interactivity_type

const const const const const const const string ilMDEducational::$interactivity_type = ''

private

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

Referenced by getInteractivityType().

$learning_resource_type

string ilMDEducational::$learning_resource_type = ''

private

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

Referenced by getLearningResourceType().

$learning_resource_type_id

int ilMDEducational::$learning_resource_type_id = 0

private

Compatibility fix for legacy MD classes for new db tables.

Definition at line 107 of file class.ilMDEducational.php.

Referenced by getLearningResourceTypeId().

$semantic_density

string ilMDEducational::$semantic_density = ''

private

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

Referenced by getSemanticDensity().

$typical_learning_time

string ilMDEducational::$typical_learning_time = ''

private

Definition at line 101 of file class.ilMDEducational.php.

Referenced by getTypicalLearningTime().

CONTEXT_TRANSLATION

const const const const const const ilMDEducational::CONTEXT_TRANSLATION

private

Initial value:

= [
        'school' => 'School'

Definition at line 79 of file class.ilMDEducational.php.

DIFFICULTY_TRANSLATION

const const const const const const const ilMDEducational::DIFFICULTY_TRANSLATION

private

Initial value:

= [
        'very easy' => 'VeryEasy'

Definition at line 86 of file class.ilMDEducational.php.

INTENDED_END_USER_ROLE_TRANSLATION

const const const const const ilMDEducational::INTENDED_END_USER_ROLE_TRANSLATION

private

Initial value:

= [
        'teacher' => 'Teacher'

Definition at line 72 of file class.ilMDEducational.php.

INTERACTIVITY_LEVEL_TRANSLATION

const const const ilMDEducational::INTERACTIVITY_LEVEL_TRANSLATION

private

Initial value:

= [
        'very low' => 'VeryLow'

Definition at line 56 of file class.ilMDEducational.php.

INTERACTIVITY_TYPE_TRANSLATION

const ilMDEducational::INTERACTIVITY_TYPE_TRANSLATION

private

Initial value:

= [
        'active' => 'Active'

Compatibility fix for legacy MD classes for new db tables.

Definition at line 32 of file class.ilMDEducational.php.

LEARNING_RESOURCE_TYPE_TRANSLATION

const const ilMDEducational::LEARNING_RESOURCE_TYPE_TRANSLATION

private

Initial value:

= [
        'exercise' => 'Exercise'

Definition at line 38 of file class.ilMDEducational.php.

SEMANTIC_DENSITY_TRANSLATION

const const const const ilMDEducational::SEMANTIC_DENSITY_TRANSLATION

private

Initial value:

= [
        'very low' => 'VeryLow'

Definition at line 64 of file class.ilMDEducational.php.

---

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

• components/ILIAS/MetaData/classes/class.ilMDEducational.php