Inheritance diagram for ilMDBase:

Collaboration diagram for ilMDBase:

Public Member Functions
	__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)

Protected Attributes
ilLogger	$log

ilDBInterface	$db

Private Attributes
int	$rbac_id
	object id (NOT ref_id!) of rbac object (e.g for page objects the obj_id of the content object; for media objects this is set to 0, because their object id are not assigned to ref ids) More...

int	$obj_id
	obj_id (e.g for structure objects the obj_id of the structure object) More...

string	$obj_type
	type of the object (e.g st,pg,crs ...) More...

int	$meta_id = null

int	$parent_id

string	$parent_type

bool	$export_mode = false
	export mode, if true, first Identifier will be set to ILIAS/il_<INSTALL_ID>_<TYPE>_<ID> More...

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMDBase::__construct	(	int	$a_rbac_id = `0`,
		int	$a_obj_id = `0`,
		string	$a_type = `''`
	)

constructor

Parameters

int	$a_rbac_id	object id (NOT ref_id!) of rbac object (e.g for page objects the obj_id of the content object; for media objects this is set to 0, because their object id are not assigned to ref ids)
int	$a_obj_id	object id (e.g for structure objects the obj_id of the structure object)
string	$a_type	type of the object (e.g st,pg,crs ...)

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

      {
        global $DIC;
 
        $this->db = $DIC->database();
 
        if ($a_obj_id === 0) {
            $a_obj_id = $a_rbac_id;
        }
 
        $this->log = ilLoggerFactory::getLogger("meta");
 
        $this->rbac_id = $a_rbac_id;
        $this->obj_id = $a_obj_id;
        $this->obj_type = $a_type;
    }

References $DIC, and ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilMDBase::delete ( )

Reimplemented in ilMDAnnotation, ilMDClassification, ilMDContribute, ilMDDescription, ilMDEducational, ilMDEntity, ilMDFormat, ilMDGeneral, ilMDIdentifier, ilMDIdentifier_, ilMDKeyword, ilMDLanguage, ilMDLifecycle, ilMDLocation, ilMDMetaMetadata, ilMDOrComposite, ilMDRelation, ilMDRequirement, ilMDRights, ilMDTaxon, ilMDTaxonPath, ilMDTechnical, and ilMDTypicalAgeRange.

Definition at line 185 of file class.ilMDBase.php.

                            : bool
    {
        return false;
    }

◆ getExportMode()

ilMDBase::getExportMode ( )

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

                                   : bool
    {
        return $this->export_mode;
    }

References $export_mode.

Referenced by ilMD\toXML(), ilMDGeneral\toXML(), and ilMDIdentifier\toXML().

Here is the caller graph for this function:

◆ getMetaId()

ilMDBase::getMetaId ( )

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

                               : ?int
    {
        return $this->meta_id;
    }

References $meta_id.

Referenced by ilMDLifecycle\addContribute(), ilMDMetaMetadata\addContribute(), ilMDEducational\addDescription(), ilMDGeneral\addDescription(), ilMDRelation\addDescription(), ilMDContribute\addEntity(), ilMDGeneral\addIdentifier(), ilMDMetaMetadata\addIdentifier(), ilMDRelation\addIdentifier_(), ilMDClassification\addKeyword(), ilMDGeneral\addKeyword(), ilMDEducational\addLanguage(), ilMDGeneral\addLanguage(), ilMDTechnical\addLocation(), ilMDTechnical\addOrComposite(), ilMDTechnical\addRequirement(), ilMDTaxonPath\addTaxon(), ilMDClassification\addTaxonPath(), ilMDEducational\addTypicalAgeRange(), ilMDAnnotation\delete(), ilMDClassification\delete(), ilMDContribute\delete(), ilMDDescription\delete(), ilMDEntity\delete(), ilMDFormat\delete(), ilMDGeneral\delete(), ilMDIdentifier\delete(), ilMDIdentifier_\delete(), ilMDKeyword\delete(), ilMDLanguage\delete(), ilMDLifecycle\delete(), ilMDLocation\delete(), ilMDMetaMetadata\delete(), ilMDRelation\delete(), ilMDRequirement\delete(), ilMDRights\delete(), ilMDTaxon\delete(), ilMDTaxonPath\delete(), ilMDTechnical\delete(), ilMDTypicalAgeRange\delete(), ilMDLifecycle\getContributeIds(), ilMDMetaMetadata\getContributeIds(), ilMDEducational\getDescriptionIds(), ilMDGeneral\getDescriptionIds(), ilMDRelation\getDescriptionIds(), ilMDContribute\getEntityIds(), ilMDRelation\getIdentifier_Ids(), ilMDGeneral\getIdentifierIds(), ilMDMetaMetadata\getIdentifierIds(), ilMDClassification\getKeywordIds(), ilMDGeneral\getKeywordIds(), ilMDEducational\getLanguageIds(), ilMDGeneral\getLanguageIds(), ilMDTechnical\getLocationIds(), ilMDTechnical\getOrComposite(), ilMDTechnical\getOrCompositeIds(), ilMDTechnical\getRequirementIds(), ilMDTaxonPath\getTaxonIds(), ilMDClassification\getTaxonPathIds(), ilMDEducational\getTypicalAgeRangeIds(), ilMDAnnotation\read(), ilMDClassification\read(), ilMDContribute\read(), ilMDDescription\read(), ilMDEntity\read(), ilMDFormat\read(), ilMDGeneral\read(), ilMDIdentifier\read(), ilMDIdentifier_\read(), ilMDKeyword\read(), ilMDLanguage\read(), ilMDLifecycle\read(), ilMDLocation\read(), ilMDMetaMetadata\read(), ilMDRelation\read(), ilMDRequirement\read(), ilMDRights\read(), ilMDTaxon\read(), ilMDTaxonPath\read(), ilMDTechnical\read(), ilMDTypicalAgeRange\read(), ilMDAnnotation\save(), ilMDClassification\save(), ilMDContribute\save(), ilMDDescription\save(), ilMDEntity\save(), ilMDFormat\save(), ilMDGeneral\save(), ilMDIdentifier\save(), ilMDIdentifier_\save(), ilMDKeyword\save(), ilMDLanguage\save(), ilMDLifecycle\save(), ilMDLocation\save(), ilMDMetaMetadata\save(), ilMDRelation\save(), ilMDRequirement\save(), ilMDRights\save(), ilMDTaxon\save(), ilMDTaxonPath\save(), ilMDTechnical\save(), ilMDTypicalAgeRange\save(), ilMDAnnotation\update(), ilMDClassification\update(), ilMDContribute\update(), ilMDDescription\update(), ilMDEntity\update(), ilMDFormat\update(), ilMDGeneral\update(), ilMDIdentifier\update(), ilMDIdentifier_\update(), ilMDKeyword\update(), ilMDLanguage\update(), ilMDLifecycle\update(), ilMDLocation\update(), ilMDMetaMetadata\update(), ilMDRelation\update(), ilMDRequirement\update(), ilMDRights\update(), ilMDTaxon\update(), ilMDTaxonPath\update(), ilMDTechnical\update(), and ilMDTypicalAgeRange\update().

Here is the caller graph for this function:

◆ getObjId()

ilMDBase::getObjId ( )

Definition at line 111 of file class.ilMDBase.php.

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

Here is the caller graph for this function:

◆ getObjType()

ilMDBase::getObjType ( )

Definition at line 121 of file class.ilMDBase.php.

                                : string
    {
        return $this->obj_type;
    }

References $obj_type.

Here is the caller graph for this function:

◆ getParentId()

ilMDBase::getParentId ( )

Definition at line 155 of file class.ilMDBase.php.

                                 : int
    {
        return $this->parent_id;
    }

References $parent_id.

Referenced by ilMDContribute\__getFields(), ilMDDescription\__getFields(), ilMDEntity\__getFields(), ilMDIdentifier\__getFields(), ilMDIdentifier_\__getFields(), ilMDKeyword\__getFields(), ilMDLanguage\__getFields(), ilMDLocation\__getFields(), ilMDRequirement\__getFields(), ilMDTaxon\__getFields(), ilMDTaxonPath\__getFields(), ilMDTypicalAgeRange\__getFields(), ilMDOrComposite\addRequirement(), and ilMDOrComposite\getRequirementIds().

Here is the caller graph for this function:

◆ getParentType()

ilMDBase::getParentType ( )

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

                                   : string
    {
        return $this->parent_type;
    }

References $parent_type.

Referenced by ilMDContribute\__getFields(), ilMDDescription\__getFields(), ilMDEntity\__getFields(), ilMDIdentifier\__getFields(), ilMDIdentifier_\__getFields(), ilMDKeyword\__getFields(), ilMDLanguage\__getFields(), ilMDLocation\__getFields(), ilMDRequirement\__getFields(), ilMDTaxon\__getFields(), ilMDTaxonPath\__getFields(), and ilMDTypicalAgeRange\__getFields().

Here is the caller graph for this function:

◆ getRBACId()

ilMDBase::getRBACId ( )

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

                               : int
    {
        return $this->rbac_id;
    }

References $rbac_id.

Here is the caller graph for this function:

◆ read()

ilMDBase::read ( )

abstract

Reimplemented in ilMD, ilMDAnnotation, ilMDClassification, ilMDContribute, ilMDDescription, ilMDEducational, ilMDEntity, ilMDFormat, ilMDGeneral, ilMDIdentifier, ilMDIdentifier_, ilMDKeyword, ilMDLanguage, ilMDLifecycle, ilMDLocation, ilMDMetaMetadata, ilMDRelation, ilMDRequirement, ilMDRights, ilMDTaxon, ilMDTaxonPath, ilMDTechnical, and ilMDTypicalAgeRange.

Referenced by setMetaId().

Here is the caller graph for this function:

◆ save()

ilMDBase::save ( )

Reimplemented in ilMDAnnotation, ilMDClassification, ilMDContribute, ilMDDescription, ilMDEducational, ilMDEntity, ilMDFormat, ilMDGeneral, ilMDIdentifier, ilMDIdentifier_, ilMDKeyword, ilMDLanguage, ilMDLifecycle, ilMDLocation, ilMDMetaMetadata, ilMDOrComposite, ilMDRelation, ilMDRequirement, ilMDRights, ilMDTaxon, ilMDTaxonPath, ilMDTechnical, and ilMDTypicalAgeRange.

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

                          : int
    {
        return 0;
    }

◆ setExportMode()

ilMDBase::setExportMode ( bool $a_export_mode = true )

Definition at line 160 of file class.ilMDBase.php.

                                                             : void
    {
        $this->export_mode = $a_export_mode;
    }

◆ setMetaId()

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

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

                                                                       : void
    {
        $this->meta_id = $a_meta_id;
 
        if ($a_read_data) {
            $this->read();
        }
    }

References read().

Referenced by ilMDAnnotation\save(), ilMDClassification\save(), ilMDContribute\save(), ilMDDescription\save(), ilMDEntity\save(), ilMDFormat\save(), ilMDGeneral\save(), ilMDIdentifier\save(), ilMDIdentifier_\save(), ilMDKeyword\save(), ilMDLanguage\save(), ilMDLifecycle\save(), ilMDLocation\save(), ilMDMetaMetadata\save(), ilMDRelation\save(), ilMDRequirement\save(), ilMDRights\save(), ilMDTaxon\save(), ilMDTaxonPath\save(), ilMDTechnical\save(), and ilMDTypicalAgeRange\save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setObjId()

ilMDBase::setObjId ( int $a_id )

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

                                       : void
    {
        $this->obj_id = $a_id;
    }

Referenced by ilMDAnnotation\read(), ilMDClassification\read(), ilMDContribute\read(), ilMDDescription\read(), ilMDEntity\read(), ilMDFormat\read(), ilMDGeneral\read(), ilMDIdentifier\read(), ilMDIdentifier_\read(), ilMDKeyword\read(), ilMDLanguage\read(), ilMDLifecycle\read(), ilMDLocation\read(), ilMDMetaMetadata\read(), ilMDRelation\read(), ilMDRequirement\read(), ilMDRights\read(), ilMDTaxon\read(), ilMDTaxonPath\read(), ilMDTechnical\read(), and ilMDTypicalAgeRange\read().

Here is the caller graph for this function:

◆ setObjType()

ilMDBase::setObjType ( string $a_type )

Definition at line 116 of file class.ilMDBase.php.

                                              : void
    {
        $this->obj_type = $a_type;
    }

Referenced by ilMDAnnotation\read(), ilMDClassification\read(), ilMDContribute\read(), ilMDDescription\read(), ilMDEntity\read(), ilMDFormat\read(), ilMDGeneral\read(), ilMDIdentifier\read(), ilMDIdentifier_\read(), ilMDKeyword\read(), ilMDLanguage\read(), ilMDLifecycle\read(), ilMDLocation\read(), ilMDMetaMetadata\read(), ilMDRelation\read(), ilMDRequirement\read(), ilMDRights\read(), ilMDTaxon\read(), ilMDTaxonPath\read(), ilMDTechnical\read(), and ilMDTypicalAgeRange\read().

Here is the caller graph for this function:

◆ setParentId()

ilMDBase::setParentId ( int $a_id )

Definition at line 150 of file class.ilMDBase.php.

                                          : void
    {
        $this->parent_id = $a_id;
    }

Referenced by ilMDContribute\read(), ilMDDescription\read(), ilMDEntity\read(), ilMDIdentifier\read(), ilMDIdentifier_\read(), ilMDKeyword\read(), ilMDLanguage\read(), ilMDLocation\read(), ilMDRequirement\read(), ilMDTaxon\read(), ilMDTaxonPath\read(), and ilMDTypicalAgeRange\read().

Here is the caller graph for this function:

◆ setParentType()

ilMDBase::setParentType ( string $a_parent_type )

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

                                                        : void
    {
        $this->parent_type = $a_parent_type;
    }

Referenced by ilMDContribute\read(), ilMDDescription\read(), ilMDEntity\read(), ilMDIdentifier\read(), ilMDIdentifier_\read(), ilMDKeyword\read(), ilMDLanguage\read(), ilMDLocation\read(), ilMDRequirement\read(), ilMDTaxon\read(), ilMDTaxonPath\read(), and ilMDTypicalAgeRange\read().

Here is the caller graph for this function:

◆ setRBACId()

ilMDBase::setRBACId ( int $a_id )

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

                                        : void
    {
        $this->rbac_id = $a_id;
    }

Referenced by ilMDAnnotation\read(), ilMDClassification\read(), ilMDContribute\read(), ilMDDescription\read(), ilMDEntity\read(), ilMDFormat\read(), ilMDGeneral\read(), ilMDIdentifier\read(), ilMDIdentifier_\read(), ilMDKeyword\read(), ilMDLanguage\read(), ilMDLifecycle\read(), ilMDLocation\read(), ilMDMetaMetadata\read(), ilMDRelation\read(), ilMDRequirement\read(), ilMDRights\read(), ilMDTaxon\read(), ilMDTaxonPath\read(), ilMDTechnical\read(), and ilMDTypicalAgeRange\read().

Here is the caller graph for this function:

◆ toXML()

ilMDBase::toXML ( ilXmlWriter $writer )

Reimplemented in ilMD, ilMDAnnotation, ilMDClassification, ilMDContribute, ilMDDescription, ilMDEducational, ilMDEntity, ilMDFormat, ilMDGeneral, ilMDIdentifier, ilMDIdentifier_, ilMDKeyword, ilMDLanguage, ilMDLifecycle, ilMDLocation, ilMDMetaMetadata, ilMDOrComposite, ilMDRelation, ilMDRequirement, ilMDRights, ilMDTaxon, ilMDTaxonPath, ilMDTechnical, and ilMDTypicalAgeRange.

Definition at line 190 of file class.ilMDBase.php.

                                              : void
    {
    }

◆ update()

ilMDBase::update ( )

Reimplemented in ilMDAnnotation, ilMDClassification, ilMDContribute, ilMDDescription, ilMDEducational, ilMDEntity, ilMDFormat, ilMDGeneral, ilMDIdentifier, ilMDIdentifier_, ilMDKeyword, ilMDLanguage, ilMDLifecycle, ilMDLocation, ilMDMetaMetadata, ilMDRelation, ilMDRequirement, ilMDRights, ilMDTaxon, ilMDTaxonPath, ilMDTechnical, and ilMDTypicalAgeRange.

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

                            : bool
    {
        return false;
    }

◆ validate()

ilMDBase::validate ( )

Definition at line 170 of file class.ilMDBase.php.

                              : bool
    {
        return false;
    }

Field Documentation

◆ $db

ilDBInterface ilMDBase::$db

protected

Definition at line 62 of file class.ilMDBase.php.

Referenced by ilMDRights\lookupRightsByTypeAndCopyright().

◆ $export_mode

bool ilMDBase::$export_mode = false

private

export mode, if true, first Identifier will be set to ILIAS/il_<INSTALL_ID>_<TYPE>_<ID>

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

Referenced by getExportMode().

◆ $log

ilLogger ilMDBase::$log

protected

Definition at line 61 of file class.ilMDBase.php.

◆ $meta_id

int ilMDBase::$meta_id = null

private

Definition at line 51 of file class.ilMDBase.php.

Referenced by getMetaId().

◆ $obj_id

int ilMDBase::$obj_id

private

obj_id (e.g for structure objects the obj_id of the structure object)

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

Referenced by getObjId().

◆ $obj_type

string ilMDBase::$obj_type

private

type of the object (e.g st,pg,crs ...)

Definition at line 49 of file class.ilMDBase.php.

Referenced by getObjType().

◆ $parent_id

int ilMDBase::$parent_id

private

Definition at line 52 of file class.ilMDBase.php.

Referenced by getParentId().

◆ $parent_type

string ilMDBase::$parent_type

private

Definition at line 53 of file class.ilMDBase.php.

Referenced by getParentType().

◆ $rbac_id

int ilMDBase::$rbac_id

private

object id (NOT ref_id!) of rbac object (e.g for page objects the obj_id of the content object; for media objects this is set to 0, because their object id are not assigned to ref ids)

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

Referenced by getRBACId().

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

Services/MetaData/classes/class.ilMDBase.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ getExportMode()

◆ getMetaId()

◆ getObjId()

◆ getObjType()

◆ getParentId()

◆ getParentType()

◆ getRBACId()

◆ read()

◆ save()

◆ setExportMode()

◆ setMetaId()

◆ setObjId()

◆ setObjType()

◆ setParentId()

◆ setParentType()

◆ setRBACId()

◆ toXML()

◆ update()

◆ validate()

Field Documentation

◆ $db

◆ $export_mode

◆ $log

◆ $meta_id

◆ $obj_id

◆ $obj_type

◆ $parent_id

◆ $parent_type

◆ $rbac_id