ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilMDBase Class Reference
+ 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_idobject 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_idobject id (e.g for structure objects the obj_id of the structure object)
string$a_typetype of the object (e.g st,pg,crs ...)

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

References $DIC, ilLoggerFactory\getLogger(), and read().

77  {
78  global $DIC;
79 
80  $this->db = $DIC->database();
81 
82  if ($a_obj_id === 0) {
83  $a_obj_id = $a_rbac_id;
84  }
85 
86  $this->log = ilLoggerFactory::getLogger("meta");
87 
88  $this->rbac_id = $a_rbac_id;
89  $this->obj_id = $a_obj_id;
90  $this->obj_type = $a_type;
91  }
static getLogger(string $a_component_id)
Get component logger.
global $DIC
Definition: feed.php:28
+ Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilMDBase::delete ( )

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

185  : bool
186  {
187  return false;
188  }

◆ getExportMode()

ilMDBase::getExportMode ( )

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

References $export_mode.

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

165  : bool
166  {
167  return $this->export_mode;
168  }
bool $export_mode
export mode, if true, first Identifier will be set to ILIAS/il_<INSTALL_ID>_<TYPE>_<ID> ...
+ Here is the caller graph for this function:

◆ getMetaId()

ilMDBase::getMetaId ( )

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

References $meta_id.

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

135  : ?int
136  {
137  return $this->meta_id;
138  }
+ Here is the caller graph for this function:

◆ getObjId()

ilMDBase::getObjId ( )

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

References $obj_id.

Referenced by ilMDFormat\__getFields(), ilMDEntity\__getFields(), ilMDIdentifier\__getFields(), ilMDIdentifier_\__getFields(), ilMDLocation\__getFields(), ilMDKeyword\__getFields(), ilMDDescription\__getFields(), ilMDLanguage\__getFields(), ilMDTaxon\__getFields(), ilMDTypicalAgeRange\__getFields(), ilMDAnnotation\__getFields(), ilMDTaxonPath\__getFields(), ilMDContribute\__getFields(), ilMDLifecycle\__getFields(), ilMDRights\__getFields(), ilMDRelation\__getFields(), ilMDRequirement\__getFields(), ilMDMetaMetadata\__getFields(), ilMDClassification\__getFields(), ilMDTechnical\__getFields(), ilMDGeneral\__getFields(), ilMDEducational\__getFields(), ilMD\addAnnotation(), ilMD\addClassification(), ilMDLifecycle\addContribute(), ilMDMetaMetadata\addContribute(), ilMDRelation\addDescription(), ilMDEducational\addDescription(), ilMDGeneral\addDescription(), ilMD\addEducational(), ilMDContribute\addEntity(), ilMDTechnical\addFormat(), ilMD\addGeneral(), ilMDMetaMetadata\addIdentifier(), ilMDGeneral\addIdentifier(), ilMDRelation\addIdentifier_(), ilMDClassification\addKeyword(), ilMDGeneral\addKeyword(), ilMDGeneral\addLanguage(), ilMDEducational\addLanguage(), ilMD\addLifecycle(), ilMDTechnical\addLocation(), ilMD\addMetaMetadata(), ilMDTechnical\addOrComposite(), ilMD\addRelation(), ilMDOrComposite\addRequirement(), ilMDTechnical\addRequirement(), ilMD\addRights(), ilMDTaxonPath\addTaxon(), ilMDClassification\addTaxonPath(), ilMD\addTechnical(), ilMDEducational\addTypicalAgeRange(), ilMD\cloneMD(), ilMD\deleteAll(), ilMD\getAnnotationIds(), ilMD\getClassificationIds(), ilMDLifecycle\getContributeIds(), ilMDMetaMetadata\getContributeIds(), ilMDRelation\getDescriptionIds(), ilMDEducational\getDescriptionIds(), ilMDGeneral\getDescriptionIds(), ilMD\getEducational(), ilMDContribute\getEntityIds(), ilMDTechnical\getFormatIds(), ilMD\getGeneral(), ilMDRelation\getIdentifier_Ids(), ilMDMetaMetadata\getIdentifierIds(), ilMDGeneral\getIdentifierIds(), ilMDClassification\getKeywordIds(), ilMDGeneral\getKeywordIds(), ilMDGeneral\getLanguageIds(), ilMDEducational\getLanguageIds(), ilMD\getLifecycle(), ilMDTechnical\getLocationIds(), ilMD\getMetaMetadata(), ilMDTechnical\getOrComposite(), ilMDOrComposite\getOrCompositeId(), ilMDTechnical\getOrCompositeIds(), ilMD\getRelationIds(), ilMDOrComposite\getRequirementIds(), ilMDTechnical\getRequirementIds(), ilMD\getRights(), ilMDTaxonPath\getTaxonIds(), ilMDClassification\getTaxonPathIds(), ilMD\getTechnical(), ilMDEducational\getTypicalAgeRangeIds(), ilMDOrComposite\toXML(), ilMDIdentifier\toXML(), ilMDTaxonPath\toXML(), ilMDContribute\toXML(), ilMDLifecycle\toXML(), ilMDRelation\toXML(), ilMDMetaMetadata\toXML(), ilMDClassification\toXML(), ilMD\toXML(), ilMDGeneral\toXML(), and ilMDEducational\toXML().

111  : int
112  {
113  return $this->obj_id;
114  }
int $obj_id
obj_id (e.g for structure objects the obj_id of the structure object)
+ Here is the caller graph for this function:

◆ getObjType()

ilMDBase::getObjType ( )

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

References $obj_type.

Referenced by ilMDFormat\__getFields(), ilMDEntity\__getFields(), ilMDIdentifier_\__getFields(), ilMDIdentifier\__getFields(), ilMDLocation\__getFields(), ilMDKeyword\__getFields(), ilMDDescription\__getFields(), ilMDLanguage\__getFields(), ilMDTaxon\__getFields(), ilMDTypicalAgeRange\__getFields(), ilMDAnnotation\__getFields(), ilMDTaxonPath\__getFields(), ilMDContribute\__getFields(), ilMDLifecycle\__getFields(), ilMDRights\__getFields(), ilMDRelation\__getFields(), ilMDRequirement\__getFields(), ilMDMetaMetadata\__getFields(), ilMDClassification\__getFields(), ilMDTechnical\__getFields(), ilMDGeneral\__getFields(), ilMDEducational\__getFields(), ilMD\addAnnotation(), ilMD\addClassification(), ilMDLifecycle\addContribute(), ilMDMetaMetadata\addContribute(), ilMDRelation\addDescription(), ilMDEducational\addDescription(), ilMDGeneral\addDescription(), ilMD\addEducational(), ilMDContribute\addEntity(), ilMDTechnical\addFormat(), ilMD\addGeneral(), ilMDMetaMetadata\addIdentifier(), ilMDGeneral\addIdentifier(), ilMDRelation\addIdentifier_(), ilMDClassification\addKeyword(), ilMDGeneral\addKeyword(), ilMDGeneral\addLanguage(), ilMDEducational\addLanguage(), ilMD\addLifecycle(), ilMDTechnical\addLocation(), ilMD\addMetaMetadata(), ilMDTechnical\addOrComposite(), ilMD\addRelation(), ilMDOrComposite\addRequirement(), ilMDTechnical\addRequirement(), ilMD\addRights(), ilMDTaxonPath\addTaxon(), ilMDClassification\addTaxonPath(), ilMD\addTechnical(), ilMDEducational\addTypicalAgeRange(), ilMD\cloneMD(), ilMDTechnical\getOrComposite(), ilMDIdentifier\toXML(), ilMD\toXML(), and ilMDGeneral\toXML().

121  : string
122  {
123  return $this->obj_type;
124  }
string $obj_type
type of the object (e.g st,pg,crs ...)
+ Here is the caller graph for this function:

◆ getParentId()

◆ getParentType()

◆ getRBACId()

ilMDBase::getRBACId ( )

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

References $rbac_id.

Referenced by ilMDFormat\__getFields(), ilMDEntity\__getFields(), ilMDIdentifier\__getFields(), ilMDIdentifier_\__getFields(), ilMDLocation\__getFields(), ilMDKeyword\__getFields(), ilMDDescription\__getFields(), ilMDLanguage\__getFields(), ilMDTaxon\__getFields(), ilMDTypicalAgeRange\__getFields(), ilMDAnnotation\__getFields(), ilMDTaxonPath\__getFields(), ilMDContribute\__getFields(), ilMDLifecycle\__getFields(), ilMDRights\__getFields(), ilMDRelation\__getFields(), ilMDRequirement\__getFields(), ilMDMetaMetadata\__getFields(), ilMDClassification\__getFields(), ilMDTechnical\__getFields(), ilMDGeneral\__getFields(), ilMDEducational\__getFields(), ilMD\addAnnotation(), ilMD\addClassification(), ilMDLifecycle\addContribute(), ilMDMetaMetadata\addContribute(), ilMDRelation\addDescription(), ilMDEducational\addDescription(), ilMDGeneral\addDescription(), ilMD\addEducational(), ilMDContribute\addEntity(), ilMDTechnical\addFormat(), ilMD\addGeneral(), ilMDMetaMetadata\addIdentifier(), ilMDGeneral\addIdentifier(), ilMDRelation\addIdentifier_(), ilMDClassification\addKeyword(), ilMDGeneral\addKeyword(), ilMDGeneral\addLanguage(), ilMDEducational\addLanguage(), ilMD\addLifecycle(), ilMDTechnical\addLocation(), ilMD\addMetaMetadata(), ilMDTechnical\addOrComposite(), ilMD\addRelation(), ilMDOrComposite\addRequirement(), ilMDTechnical\addRequirement(), ilMD\addRights(), ilMDTaxonPath\addTaxon(), ilMDClassification\addTaxonPath(), ilMD\addTechnical(), ilMDEducational\addTypicalAgeRange(), ilMD\cloneMD(), ilMD\deleteAll(), ilMD\getAnnotationIds(), ilMD\getClassificationIds(), ilMDLifecycle\getContributeIds(), ilMDMetaMetadata\getContributeIds(), ilMDRelation\getDescriptionIds(), ilMDEducational\getDescriptionIds(), ilMDGeneral\getDescriptionIds(), ilMD\getEducational(), ilMDContribute\getEntityIds(), ilMDTechnical\getFormat(), ilMDTechnical\getFormatIds(), ilMD\getGeneral(), ilMDRelation\getIdentifier_Ids(), ilMDMetaMetadata\getIdentifierIds(), ilMDGeneral\getIdentifierIds(), ilMDClassification\getKeywordIds(), ilMDGeneral\getKeywordIds(), ilMDGeneral\getLanguageIds(), ilMDEducational\getLanguageIds(), ilMD\getLifecycle(), ilMDTechnical\getLocationIds(), ilMD\getMetaMetadata(), ilMDTechnical\getOrComposite(), ilMDOrComposite\getOrCompositeId(), ilMDTechnical\getOrCompositeIds(), ilMD\getRelationIds(), ilMDOrComposite\getRequirementIds(), ilMDTechnical\getRequirementIds(), ilMD\getRights(), ilMDTaxonPath\getTaxonIds(), ilMDClassification\getTaxonPathIds(), ilMD\getTechnical(), ilMDEducational\getTypicalAgeRangeIds(), ilMDOrComposite\toXML(), ilMDIdentifier\toXML(), ilMDTaxonPath\toXML(), ilMDContribute\toXML(), ilMDLifecycle\toXML(), ilMDRelation\toXML(), ilMDMetaMetadata\toXML(), ilMDClassification\toXML(), ilMD\toXML(), ilMDGeneral\toXML(), and ilMDEducational\toXML().

101  : int
102  {
103  return $this->rbac_id;
104  }
int $rbac_id
object id (NOT ref_id!) of rbac object (e.g for page objects the obj_id of the content object; for me...
+ Here is the caller graph for this function:

◆ read()

ilMDBase::read ( )
abstract

Referenced by __construct(), and setMetaId().

+ Here is the caller graph for this function:

◆ save()

ilMDBase::save ( )

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

Referenced by ilObjCmiXapiGUI\initMetadata(), ilObjLTIConsumerGUI\initMetadata(), ilObjQuestionPoolSettingsGeneralGUI\performSaveForm(), and ilObjTestSettingsGeneralGUI\saveGeneralProperties().

180  : int
181  {
182  return 0;
183  }
+ Here is the caller graph for this function:

◆ setExportMode()

ilMDBase::setExportMode ( bool  $a_export_mode = true)

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

160  : void
161  {
162  $this->export_mode = $a_export_mode;
163  }

◆ setMetaId()

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

◆ setObjId()

◆ setObjType()

◆ setParentId()

ilMDBase::setParentId ( int  $a_id)

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

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

150  : void
151  {
152  $this->parent_id = $a_id;
153  }
+ Here is the caller graph for this function:

◆ setParentType()

ilMDBase::setParentType ( string  $a_parent_type)

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

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

140  : void
141  {
142  $this->parent_type = $a_parent_type;
143  }
+ Here is the caller graph for this function:

◆ setRBACId()

◆ toXML()

ilMDBase::toXML ( ilXmlWriter  $writer)

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

190  : void
191  {
192  }

◆ update()

ilMDBase::update ( )

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

Referenced by ilTermDefinitionEditorGUI\executeCommand(), ilObjQuestionPoolSettingsGeneralGUI\performSaveForm(), ilObjTestSettingsGeneralGUI\saveGeneralProperties(), ilLMObject\saveTitles(), and ilMediaPoolPage\updateMetaData().

175  : bool
176  {
177  return false;
178  }
+ Here is the caller graph for this function:

◆ validate()

ilMDBase::validate ( )

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

170  : bool
171  {
172  return false;
173  }

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: