ilMDTechnical Class Reference

Inheritance diagram for ilMDTechnical:

Collaboration diagram for ilMDTechnical:

Public Member Functions
	getPossibleSubelements ()
	getFormatIds ()
	getFormat (int $a_format_id)
	addFormat ()
	getLocationIds ()
	getLocation (int $a_location_id)
	addLocation ()
	getRequirementIds ()
	getRequirement (int $a_requirement_id)
	addRequirement ()
	getOrCompositeIds ()
	getOrComposite (int $a_or_composite_id)
	addOrComposite ()
	setSize (string $a_size)
	getSize ()
	setInstallationRemarks (string $a_val)
	getInstallationRemarks ()
	setInstallationRemarksLanguage (ilMDLanguageItem $lng_obj)
	getInstallationRemarksLanguage ()
	getInstallationRemarksLanguageCode ()
	setOtherPlatformRequirements (string $a_val)
	getOtherPlatformRequirements ()
	setOtherPlatformRequirementsLanguage (ilMDLanguageItem $lng_obj)
	getOtherPlatformRequirementsLanguage ()
	getOtherPlatformRequirementsLanguageCode ()
	setDuration (string $a_val)
	getDuration ()
	save ()
	update ()
	delete ()
	__getFields ()
	read ()
	toXML (ilXmlWriter $writer)
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)

Private Attributes
string	$size = ''
string	$installation_remarks = ''
ilMDLanguageItem	$installation_remarks_language = null
string	$other_platform_requirements = ''
ilMDLanguageItem	$other_platform_requirements_language = null
string	$duration = ''

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

Detailed Description

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

Member Function Documentation

__getFields()

ilMDTechnical::__getFields

(

)

Returns

array<string, array<string, mixed>>

Definition at line 294 of file class.ilMDTechnical.php.

References getDuration(), getInstallationRemarks(), getInstallationRemarksLanguageCode(), ilMDBase\getObjId(), ilMDBase\getObjType(), getOtherPlatformRequirements(), getOtherPlatformRequirementsLanguageCode(), ilMDBase\getRBACId(), and getSize().

Referenced by save(), and update().

                                 : array
    {
        return array(
            'rbac_id' => array('integer', $this->getRBACId()),
            'obj_id' => array('integer', $this->getObjId()),
            'obj_type' => array('text', $this->getObjType()),
            't_size' => array('text', $this->getSize()),
            'ir' => array('text', $this->getInstallationRemarks()),
            'ir_language' => array('text', $this->getInstallationRemarksLanguageCode()),
            'opr' => array('text', $this->getOtherPlatformRequirements()),
            'opr_language' => array('text', $this->getOtherPlatformRequirementsLanguageCode()),
            'duration' => array('text', $this->getDuration())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getId()

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

static

Definition at line 394 of file class.ilMDTechnical.php.

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

Referenced by ilMD\getTechnical().

                                                                : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT meta_technical_id FROM il_meta_technical " .
            "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_technical_id;
        }
        return 0;
    }

Here is the caller graph for this function:

addFormat()

ilMDTechnical::addFormat

(

)

Definition at line 74 of file class.ilMDTechnical.php.

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

                               : ilMDFormat
    {
        $for = new ilMDFormat($this->getRBACId(), $this->getObjId(), $this->getObjType());

        return $for;
    }

Here is the call graph for this function:

addLocation()

ilMDTechnical::addLocation

(

)

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

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

                                 : ilMDLocation
    {
        $loc = new ilMDLocation($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $loc->setParentId($this->getMetaId());
        $loc->setParentType('meta_technical');

        return $loc;
    }

Here is the call graph for this function:

addOrComposite()

ilMDTechnical::addOrComposite

(

)

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

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

                                    : ilMDOrComposite
    {
        $orc = new ilMDOrComposite($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $orc->setParentId($this->getMetaId());
        $orc->setParentType('meta_technical');

        return $orc;
    }

Here is the call graph for this function:

addRequirement()

ilMDTechnical::addRequirement

(

)

Definition at line 128 of file class.ilMDTechnical.php.

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

                                    : ilMDRequirement
    {
        $rec = new ilMDRequirement($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $rec->setParentId($this->getMetaId());
        $rec->setParentType('meta_technical');

        return $rec;
    }

Here is the call graph for this function:

delete()

ilMDTechnical::delete

(

)

Definition at line 261 of file class.ilMDTechnical.php.

References $id, XapiProxy\$req, $res, getFormat(), getFormatIds(), getLocation(), getLocationIds(), ilMDBase\getMetaId(), getOrComposite(), getOrCompositeIds(), getRequirement(), and getRequirementIds().

                            : bool
    {
        if ($this->getMetaId()) {
            $query = "DELETE FROM il_meta_technical " .
                "WHERE meta_technical_id = " . $this->db->quote($this->getMetaId(), 'integer');
            $res = $this->db->manipulate($query);

            foreach ($this->getFormatIds() as $id) {
                $for = $this->getFormat($id);
                $for->delete();
            }

            foreach ($this->getLocationIds() as $id) {
                $loc = $this->getLocation($id);
                $loc->delete();
            }
            foreach ($this->getRequirementIds() as $id) {
                $req = $this->getRequirement($id);
                $req->delete();
            }
            foreach ($this->getOrCompositeIds() as $id) {
                $orc = $this->getOrComposite($id);
                $orc->delete();
            }

            return true;
        }
        return false;
    }

Here is the call graph for this function:

getDuration()

ilMDTechnical::getDuration

(

)

Definition at line 235 of file class.ilMDTechnical.php.

References $duration.

Referenced by __getFields(), and toXML().

                                 : string
    {
        return $this->duration;
    }

Here is the caller graph for this function:

getFormat()

ilMDTechnical::getFormat

(

int

$a_format_id

)

Definition at line 63 of file class.ilMDTechnical.php.

References ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                               : ?ilMDFormat
    {
        if (!$a_format_id) {
            return null;
        }
        $for = new ilMDFormat($this->getRBACId(), $a_format_id);
        $for->setMetaId($a_format_id);

        return $for;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFormatIds()

ilMDTechnical::getFormatIds

(

)

Returns

int[]

Definition at line 58 of file class.ilMDTechnical.php.

References ilMDFormat\_getIds(), ilMDBase\getObjId(), and ilMDBase\getRBACId().

Referenced by delete(), and toXML().

                                  : array
    {
        return ilMDFormat::_getIds($this->getRBACId(), $this->getObjId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstallationRemarks()

ilMDTechnical::getInstallationRemarks

(

)

Definition at line 183 of file class.ilMDTechnical.php.

References $installation_remarks.

Referenced by __getFields(), and toXML().

                                            : string
    {
        return $this->installation_remarks;
    }

Here is the caller graph for this function:

getInstallationRemarksLanguage()

ilMDTechnical::getInstallationRemarksLanguage

(

)

Definition at line 193 of file class.ilMDTechnical.php.

                                                    : ?ilMDLanguageItem
    {
        return is_object($this->installation_remarks_language) ? $this->installation_remarks_language : null;
    }

getInstallationRemarksLanguageCode()

ilMDTechnical::getInstallationRemarksLanguageCode

(

)

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

Referenced by __getFields(), and toXML().

                                                        : string
    {
        return is_object($this->installation_remarks_language) ? $this->installation_remarks_language->getLanguageCode() : '';
    }

Here is the caller graph for this function:

getLocation()

ilMDTechnical::getLocation

(

int

$a_location_id

)

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

Referenced by delete(), and toXML().

                                                   : ?ilMDLocation
    {
        if (!$a_location_id) {
            return null;
        }
        $loc = new ilMDLocation();
        $loc->setMetaId($a_location_id);

        return $loc;
    }

Here is the caller graph for this function:

getLocationIds()

ilMDTechnical::getLocationIds

(

)

Returns

int[]

Definition at line 84 of file class.ilMDTechnical.php.

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

Referenced by delete(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getOrComposite()

ilMDTechnical::getOrComposite

(

int

$a_or_composite_id

)

Definition at line 145 of file class.ilMDTechnical.php.

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

Referenced by delete(), and toXML().

                                                          : ?ilMDOrComposite
    {
        if (!$a_or_composite_id) {
            return null;
        }
        $orc = new ilMDOrComposite($this->getRBACId(), $this->getObjId(), $this->getObjType());
        $orc->setOrCompositeId($a_or_composite_id);
        $orc->setParentId($this->getMetaId());
        $orc->setParentType('meta_technical');

        return $orc;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOrCompositeIds()

ilMDTechnical::getOrCompositeIds

(

)

Returns

int[]

Definition at line 140 of file class.ilMDTechnical.php.

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

Referenced by delete(), getPossibleSubelements(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getOtherPlatformRequirements()

ilMDTechnical::getOtherPlatformRequirements

(

)

Definition at line 208 of file class.ilMDTechnical.php.

References $other_platform_requirements.

Referenced by __getFields(), and toXML().

                                                  : string
    {
        return $this->other_platform_requirements;
    }

Here is the caller graph for this function:

getOtherPlatformRequirementsLanguage()

ilMDTechnical::getOtherPlatformRequirementsLanguage

(

)

Definition at line 218 of file class.ilMDTechnical.php.

                                                          : ?ilMDLanguageItem
    {
        return is_object($this->other_platform_requirements_language) ? $this->other_platform_requirements_language : null;
    }

getOtherPlatformRequirementsLanguageCode()

ilMDTechnical::getOtherPlatformRequirementsLanguageCode

(

)

Definition at line 223 of file class.ilMDTechnical.php.

Referenced by __getFields(), and toXML().

                                                              : string
    {
        return is_object($this->other_platform_requirements_language)
            ? $this->other_platform_requirements_language->getLanguageCode()
            : '';
    }

Here is the caller graph for this function:

getPossibleSubelements()

ilMDTechnical::getPossibleSubelements

(

)

Returns

array<string, string>

Definition at line 39 of file class.ilMDTechnical.php.

References getOrCompositeIds(), and getRequirementIds().

                                            : array
    {
        $subs['Format'] = 'meta_format';
        $subs['Location'] = 'meta_location';
        if (!$this->getOrCompositeIds()) {
            $subs['Requirement'] = 'meta_requirement';
        }
        if (!$this->getRequirementIds()) {
            $subs['OrComposite'] = 'meta_or_composite';
        }

        return $subs;
    }

Here is the call graph for this function:

getRequirement()

ilMDTechnical::getRequirement

(

int

$a_requirement_id

)

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

Referenced by delete(), and toXML().

                                                         : ?ilMDRequirement
    {
        if (!$a_requirement_id) {
            return null;
        }
        $rec = new ilMDRequirement();
        $rec->setMetaId($a_requirement_id);

        return $rec;
    }

Here is the caller graph for this function:

getRequirementIds()

ilMDTechnical::getRequirementIds

(

)

Returns

int[]

Definition at line 112 of file class.ilMDTechnical.php.

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

Referenced by delete(), getPossibleSubelements(), and toXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getSize()

ilMDTechnical::getSize

(

)

Definition at line 173 of file class.ilMDTechnical.php.

References $size.

Referenced by __getFields(), and toXML().

                             : string
    {
        return $this->size;
    }

Here is the caller graph for this function:

read()

ilMDTechnical::read

(

)

Definition at line 309 of file class.ilMDTechnical.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setDuration(), setInstallationRemarks(), setInstallationRemarksLanguage(), ilMDBase\setObjId(), ilMDBase\setObjType(), setOtherPlatformRequirements(), setOtherPlatformRequirementsLanguage(), ilMDBase\setRBACId(), and setSize().

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

            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->setRBACId((int) $row->rbac_id);
                $this->setObjId((int) $row->obj_id);
                $this->setObjType($row->obj_type);
                $this->setSize($row->t_size ?? '');
                $this->setInstallationRemarks($row->ir ?? '');
                $this->setInstallationRemarksLanguage(new ilMDLanguageItem($row->ir_language ?? ''));
                $this->setOtherPlatformRequirements($row->opr ?? '');
                $this->setOtherPlatformRequirementsLanguage(new ilMDLanguageItem($row->opr_language ?? ''));
                $this->setDuration($row->duration ?? '');
            }
            return true;
        }
        return false;
    }

Here is the call graph for this function:

save()

ilMDTechnical::save

(

)

Definition at line 240 of file class.ilMDTechnical.php.

References __getFields(), ilMDBase\getMetaId(), and ilMDBase\setMetaId().

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

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

Here is the call graph for this function:

setDuration()

ilMDTechnical::setDuration

(

string

$a_val

)

Definition at line 230 of file class.ilMDTechnical.php.

Referenced by read().

                                              : void
    {
        $this->duration = $a_val;
    }

Here is the caller graph for this function:

setInstallationRemarks()

ilMDTechnical::setInstallationRemarks

(

string

$a_val

)

Definition at line 178 of file class.ilMDTechnical.php.

Referenced by read().

                                                         : void
    {
        $this->installation_remarks = $a_val;
    }

Here is the caller graph for this function:

setInstallationRemarksLanguage()

ilMDTechnical::setInstallationRemarksLanguage

(

ilMDLanguageItem

$lng_obj

)

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

Referenced by read().

                                                                             : void
    {
        $this->installation_remarks_language = $lng_obj;
    }

Here is the caller graph for this function:

setOtherPlatformRequirements()

ilMDTechnical::setOtherPlatformRequirements

(

string

$a_val

)

Definition at line 203 of file class.ilMDTechnical.php.

Referenced by read().

                                                               : void
    {
        $this->other_platform_requirements = $a_val;
    }

Here is the caller graph for this function:

setOtherPlatformRequirementsLanguage()

ilMDTechnical::setOtherPlatformRequirementsLanguage

(

ilMDLanguageItem

$lng_obj

)

Definition at line 213 of file class.ilMDTechnical.php.

Referenced by read().

                                                                                   : void
    {
        $this->other_platform_requirements_language = $lng_obj;
    }

Here is the caller graph for this function:

setSize()

ilMDTechnical::setSize

(

string

$a_size

)

Definition at line 168 of file class.ilMDTechnical.php.

Referenced by read().

                                           : void
    {
        $this->size = $a_size;
    }

Here is the caller graph for this function:

toXML()

ilMDTechnical::toXML

(

ilXmlWriter

$writer

)

Definition at line 332 of file class.ilMDTechnical.php.

References $id, XapiProxy\$req, getDuration(), getFormat(), getFormatIds(), getInstallationRemarks(), getInstallationRemarksLanguageCode(), getLocation(), getLocationIds(), getOrComposite(), getOrCompositeIds(), getOtherPlatformRequirements(), getOtherPlatformRequirementsLanguageCode(), getRequirement(), getRequirementIds(), getSize(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                              : void
    {
        $writer->xmlStartTag('Technical');

        // Format
        foreach ($this->getFormatIds() as $id) {
            $for = $this->getFormat($id);
            $for->toXML($writer);
        }

        // Size
        if ($this->getSize() !== '') {
            $writer->xmlElement('Size', null, $this->getSize());
        }

        // Location
        foreach ($this->getLocationIds() as $id) {
            $loc = $this->getLocation($id);
            $loc->toXML($writer);
        }

        // Requirement
        foreach ($this->getRequirementIds() as $id) {
            $req = $this->getRequirement($id);
            $req->toXML($writer);
        }

        // OrComposite
        foreach ($this->getOrCompositeIds() as $id) {
            $orc = $this->getOrComposite($id);
            $orc->toXML($writer);
        }

        // InstallationRemarks
        if ($this->getInstallationRemarks() !== '') {
            $writer->xmlElement(
                'InstallationRemarks',
                array(
                    'Language' => $this->getInstallationRemarksLanguageCode() ?: 'en'
                ),
                $this->getInstallationRemarks()
            );
        }

        // OtherPlatformRequirements
        if ($this->getOtherPlatformRequirements() !== '') {
            $writer->xmlElement(
                'OtherPlatformRequirements',
                array(
                    'Language' => $this->getOtherPlatformRequirementsLanguageCode() ?: 'en'
                ),
                $this->getOtherPlatformRequirements()
            );
        }
        // Duration
        if ($this->getDuration() !== '') {
            $writer->xmlElement('Duration', null, $this->getDuration());
        }

        $writer->xmlEndTag('Technical');
    }

Here is the call graph for this function:

update()

ilMDTechnical::update

(

)

Definition at line 252 of file class.ilMDTechnical.php.

References __getFields(), and ilMDBase\getMetaId().

                            : bool
    {
        return $this->getMetaId() && $this->db->update(
            'il_meta_technical',
            $this->__getFields(),
            array("meta_technical_id" => array('integer', $this->getMetaId()))
        );
    }

Here is the call graph for this function:

Field Documentation

$duration

string ilMDTechnical::$duration = ''

private

Definition at line 34 of file class.ilMDTechnical.php.

Referenced by getDuration().

$installation_remarks

string ilMDTechnical::$installation_remarks = ''

private

Definition at line 30 of file class.ilMDTechnical.php.

Referenced by getInstallationRemarks().

$installation_remarks_language

ilMDLanguageItem ilMDTechnical::$installation_remarks_language = null

private

Definition at line 31 of file class.ilMDTechnical.php.

$other_platform_requirements

string ilMDTechnical::$other_platform_requirements = ''

private

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

Referenced by getOtherPlatformRequirements().

$other_platform_requirements_language

ilMDLanguageItem ilMDTechnical::$other_platform_requirements_language = null

private

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

$size

string ilMDTechnical::$size = ''

private

Definition at line 29 of file class.ilMDTechnical.php.

Referenced by getSize().

---

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

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