Inheritance diagram for ilMDAnnotation:

Collaboration diagram for ilMDAnnotation:

Public Member Functions
	setEntity ($a_entity)

	getEntity ()

	setDate ($a_date)

	getDate ()

	setDescription ($a_desc)

	getDescription ()

	setDescriptionLanguage ($lng_obj)

&	getDescriptionLanguage ()

	getDescriptionLanguageCode ()

	save ()

	update ()

	delete ()

	__getFields ()

	read ()

	toXML (&$writer)

	setEntity ($a_entity)

	getEntity ()

	setDate ($a_date)

	getDate ()

	setDescription ($a_desc)

	getDescription ()

	setDescriptionLanguage ($lng_obj)

&	getDescriptionLanguage ()

	getDescriptionLanguageCode ()

	save ()

	update ()

	delete ()

	__getFields ()

	read ()

	toXML (&$writer)

	_getIds ($a_rbac_id, $a_obj_id)

Public Member Functions inherited from ilMDBase
	__construct ($a_rbac_id=0, $a_obj_id=0, $a_type=0)

	setRBACId ($a_id)

	getRBACId ()

	setObjId ($a_id)

	getObjId ()

	setObjType ($a_type)

	getObjType ()

	setMetaId ($a_meta_id, $a_read_data=true)

	getMetaId ()

	setParentType ($a_parent_type)

	getParentType ()

	setParentId ($a_id)

	getParentId ()

	setExportMode ($a_export_mode=true)

	getExportMode ()

	validate ()

	update ()

	save ()

	delete ()

	toXML (&$writer)

	__construct ($a_rbac_id=0, $a_obj_id=0, $a_type=0)

	setRBACId ($a_id)

	getRBACId ()

	setObjId ($a_id)

	getObjId ()

	setObjType ($a_type)

	getObjType ()

	setMetaId ($a_meta_id, $a_read_data=true)

	getMetaId ()

	setParentType ($a_parent_type)

	getParentType ()

	setParentId ($a_id)

	getParentId ()

	validate ()

	update ()

	save ()

	delete ()

	toXML (&$writer)

Static Public Member Functions
static	_getIds ($a_rbac_id, $a_obj_id)

Additional Inherited Members
Data Fields inherited from ilMDBase
	$rbac_id

	$obj_id

	$obj_type

	$export_mode = false

Protected Attributes inherited from ilMDBase
	$log

Detailed Description

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

Member Function Documentation

◆ __getFields() [1/2]

ilMDAnnotation::__getFields ( )

Definition at line 127 of file class.ilMDAnnotation.php.

References array, getDate(), getDescription(), getDescriptionLanguageCode(), getEntity(), ilMDBase\getObjId(), ilMDBase\getObjType(), and ilMDBase\getRBACId().

Referenced by save().

         {
                 return array('rbac_id'  => array('integer',$this->getRBACId()),
                                          'obj_id'       => array('integer',$this->getObjId()),
                                          'obj_type'     => array('text',$this->getObjType()),
                                          'entity'       => array('clob',$this->getEntity()),
                                          'a_date'               => array('clob',$this->getDate()),
                                          'description' => array('clob',$this->getDescription()),
                                          'description_language' => array('text',$this->getDescriptionLanguageCode()));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __getFields() [2/2]

ilMDAnnotation::__getFields ( )

Definition at line 127 of file class.ilMDAnnotation.php.

References array, getDate(), getDescription(), getDescriptionLanguageCode(), getEntity(), ilMDBase\getObjId(), ilMDBase\getObjType(), ilMDBase\getRBACId(), and ilUtil\prepareDBString().

         {
                 return array('rbac_id'  => $this->getRBACId(),
                                          'obj_id'       => $this->getObjId(),
                                          'obj_type'     => ilUtil::prepareDBString($this->getObjType()),
                                          'entity'       => ilUtil::prepareDBString($this->getEntity()),
                                          'date'         => ilUtil::prepareDBString($this->getDate()),
                                          'description' => ilUtil::prepareDBString($this->getDescription()),
                                          'description_language' => ilUtil::prepareDBString($this->getDescriptionLanguageCode()));
         }

Here is the call graph for this function:

◆ _getIds() [1/2]

ilMDAnnotation::_getIds	(	$a_rbac_id,
		$a_obj_id
	)

Definition at line 181 of file class.ilMDAnnotation.php.

References $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

         {
                 global $ilDB;
 
                 $query = "SELECT meta_annotation_id FROM il_meta_annotation ".
                         "WHERE rbac_id = ".$ilDB->quote($a_rbac_id)." ".
                         "AND obj_id = ".$ilDB->quote($a_obj_id);
 
 
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                 {
                         $ids[] = $row->meta_annotation_id;
                 }
                 return $ids ? $ids : array();
         }

◆ _getIds() [2/2]

static ilMDAnnotation::_getIds	(	$a_rbac_id,
		$a_obj_id
	)

static

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

References $ilDB, $query, $res, $row, array, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilMD\getAnnotationIds().

         {
                 global $ilDB;
 
                 $query = "SELECT meta_annotation_id FROM il_meta_annotation ".
                         "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))
                 {
                         $ids[] = $row->meta_annotation_id;
                 }
                 return $ids ? $ids : array();
         }

Here is the caller graph for this function:

◆ delete() [1/2]

ilMDAnnotation::delete ( )

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

References $ilDB, $query, and ilMDBase\getMetaId().

         {
                 global $ilDB;
                 
                 if($this->getMetaId())
                 {
                         $query = "DELETE FROM il_meta_annotation ".
                                 "WHERE meta_annotation_id = ".$ilDB->quote($this->getMetaId());
                         
                         $this->db->query($query);
                         
                         return true;
                 }
                 return false;
         }

Here is the call graph for this function:

◆ delete() [2/2]

ilMDAnnotation::delete ( )

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

References $ilDB, $query, $res, and ilMDBase\getMetaId().

         {
                 global $ilDB;
                 
                 if($this->getMetaId())
                 {
                         $query = "DELETE FROM il_meta_annotation ".
                                 "WHERE meta_annotation_id = ".$ilDB->quote($this->getMetaId() ,'integer');
                         $res = $ilDB->manipulate($query);
                         
                         return true;
                 }
                 return false;
         }

Here is the call graph for this function:

◆ getDate() [1/2]

ilMDAnnotation::getDate ( )

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

         {
                 return $this->date;
         }

◆ getDate() [2/2]

ilMDAnnotation::getDate ( )

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

Referenced by __getFields(), and toXML().

         {
                 return $this->date;
         }

Here is the caller graph for this function:

◆ getDescription() [1/2]

ilMDAnnotation::getDescription ( )

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

         {
                 return $this->description;
         }

◆ getDescription() [2/2]

ilMDAnnotation::getDescription ( )

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

Referenced by __getFields(), and toXML().

         {
                 return $this->description;
         }

Here is the caller graph for this function:

◆ getDescriptionLanguage() [1/2]

& ilMDAnnotation::getDescriptionLanguage ( )

Definition at line 67 of file class.ilMDAnnotation.php.

         {
                 return $this->description_language;
         }

◆ getDescriptionLanguage() [2/2]

& ilMDAnnotation::getDescriptionLanguage ( )

Definition at line 67 of file class.ilMDAnnotation.php.

         {
                 return $this->description_language;
         }

◆ getDescriptionLanguageCode() [1/2]

ilMDAnnotation::getDescriptionLanguageCode ( )

Definition at line 71 of file class.ilMDAnnotation.php.

Referenced by __getFields(), and toXML().

         {
                 if(is_object($this->description_language))
                 {
                         return $this->description_language->getLanguageCode();
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ getDescriptionLanguageCode() [2/2]

ilMDAnnotation::getDescriptionLanguageCode ( )

Definition at line 71 of file class.ilMDAnnotation.php.

         {
                 if(is_object($this->description_language))
                 {
                         return $this->description_language->getLanguageCode();
                 }
                 return false;
         }

◆ getEntity() [1/2]

ilMDAnnotation::getEntity ( )

Definition at line 40 of file class.ilMDAnnotation.php.

Referenced by __getFields(), and toXML().

         {
                 return $this->entity;
         }

Here is the caller graph for this function:

◆ getEntity() [2/2]

ilMDAnnotation::getEntity ( )

Definition at line 40 of file class.ilMDAnnotation.php.

         {
                 return $this->entity;
         }

◆ read() [1/2]

ilMDAnnotation::read ( )

Definition at line 138 of file class.ilMDAnnotation.php.

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setDate(), setDescription(), setEntity(), ilMDBase\setObjId(), ilMDBase\setObjType(), and ilMDBase\setRBACId().

         {
                 global $ilDB;
                 
                 include_once 'Services/MetaData/classes/class.ilMDLanguageItem.php';
 
                 if($this->getMetaId())
                 {
                         $query = "SELECT * FROM il_meta_annotation ".
                                 "WHERE meta_annotation_id = ".$ilDB->quote($this->getMetaId() ,'integer');
 
                         $res = $this->db->query($query);
                         while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                         {
                                 $this->setRBACId($row->rbac_id);
                                 $this->setObjId($row->obj_id);
                                 $this->setObjType($row->obj_type);
                                 $this->setEntity($row->entity);
                                 $this->setDate($row->a_date);
                                 $this->setDescription($row->description);
                                 $this->description_language = new ilMDLanguageItem($row->description_language);
                         }
                 }
                 return true;
         }

Here is the call graph for this function:

◆ read() [2/2]

ilMDAnnotation::read ( )

Definition at line 138 of file class.ilMDAnnotation.php.

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, ilMDBase\getMetaId(), setDate(), setDescription(), setEntity(), ilMDBase\setObjId(), ilMDBase\setObjType(), ilMDBase\setRBACId(), and ilUtil\stripSlashes().

         {
                 global $ilDB;
                 
                 include_once 'Services/Migration/DBUpdate_426/classes/class.ilMDLanguageItem.php';
 
                 if($this->getMetaId())
                 {
                         $query = "SELECT * FROM il_meta_annotation ".
                                 "WHERE meta_annotation_id = ".$ilDB->quote($this->getMetaId());
 
                         $res = $this->db->query($query);
                         while($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT))
                         {
                                 $this->setRBACId($row->rbac_id);
                                 $this->setObjId($row->obj_id);
                                 $this->setObjType($row->obj_type);
                                 $this->setEntity(ilUtil::stripSlashes($row->entity));
                                 $this->setDate(ilUtil::stripSlashes($row->date));
                                 $this->setDescription(ilUtil::stripSlashes($row->description));
                                 $this->description_language = new ilMDLanguageItem($row->description_language);
                         }
                 }
                 return true;
         }

Here is the call graph for this function:

◆ save() [1/2]

ilMDAnnotation::save ( )

Definition at line 80 of file class.ilMDAnnotation.php.

References $ilDB, __getFields(), array, ilMDBase\getMetaId(), and ilMDBase\setMetaId().

         {
                 global $ilDB;
                 
                 $fields = $this->__getFields();
                 $fields['meta_annotation_id'] = array('integer',$next_id = $ilDB->nextId('il_meta_annotation'));
                 
                 if($this->db->insert('il_meta_annotation',$fields))
                 {
                         $this->setMetaId($next_id);
                         return $this->getMetaId();
                 }
                 return false;
         }

Here is the call graph for this function:

◆ save() [2/2]

ilMDAnnotation::save ( )

Definition at line 80 of file class.ilMDAnnotation.php.

References ilMDBase\getMetaId(), ilDBConstants\MDB2_AUTOQUERY_INSERT, and ilMDBase\setMetaId().

         {
                 if($this->db->autoExecute('il_meta_annotation',
                                                                   $this->__getFields(),
                                                                   ilDBConstants::MDB2_AUTOQUERY_INSERT))
                 {
                         $this->setMetaId($this->db->getLastInsertId());
 
                         return $this->getMetaId();
                 }
                 return false;
         }

Here is the call graph for this function:

◆ setDate() [1/2]

ilMDAnnotation::setDate ( $a_date )

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

References date.

         {
             $this->date = $a_date;
         }

◆ setDate() [2/2]

ilMDAnnotation::setDate ( $a_date )

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

References date.

Referenced by read().

         {
             $this->date = $a_date;
         }

Here is the caller graph for this function:

◆ setDescription() [1/2]

ilMDAnnotation::setDescription ( $a_desc )

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

         {
                 $this->description = $a_desc;
         }

◆ setDescription() [2/2]

ilMDAnnotation::setDescription ( $a_desc )

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

Referenced by read().

         {
                 $this->description = $a_desc;
         }

Here is the caller graph for this function:

◆ setDescriptionLanguage() [1/2]

ilMDAnnotation::setDescriptionLanguage ( $lng_obj )

Definition at line 60 of file class.ilMDAnnotation.php.

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

◆ setDescriptionLanguage() [2/2]

ilMDAnnotation::setDescriptionLanguage ( $lng_obj )

Definition at line 60 of file class.ilMDAnnotation.php.

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

◆ setEntity() [1/2]

ilMDAnnotation::setEntity ( $a_entity )

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

Referenced by read().

         {
                 $this->entity = $a_entity;
         }

Here is the caller graph for this function:

◆ setEntity() [2/2]

ilMDAnnotation::setEntity ( $a_entity )

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

         {
                 $this->entity = $a_entity;
         }

◆ toXML() [1/2]

ilMDAnnotation::toXML ( & $writer )

Definition at line 169 of file class.ilMDAnnotation.php.

References array, getDate(), getDescription(), getDescriptionLanguageCode(), and getEntity().

         {
                 $writer->xmlStartTag('Annotation');
                 $writer->xmlElement('Entity',null,$this->getEntity());
                 $writer->xmlElement('Date',null,$this->getDate());
                 $writer->xmlElement('Description',array('Language' => $this->getDescriptionLanguageCode()
                                                                                                 ? $this->getDescriptionLanguageCode()
                                                                                                 : 'en'),
                                                         $this->getDescription());
                 $writer->xmlEndTag('Annotation');
         }

Here is the call graph for this function:

◆ toXML() [2/2]

ilMDAnnotation::toXML ( & $writer )

Definition at line 169 of file class.ilMDAnnotation.php.

References array, getDate(), getDescription(), getDescriptionLanguageCode(), and getEntity().

         {
                 $writer->xmlStartTag('Annotation');
                 $writer->xmlElement('Entity',null,$this->getEntity());
                 $writer->xmlElement('Date',null,$this->getDate());
                 $writer->xmlElement('Description',array('Language' => $this->getDescriptionLanguageCode()),$this->getDescription());
                 $writer->xmlEndTag('Annotation');
         }

Here is the call graph for this function:

◆ update() [1/2]

ilMDAnnotation::update ( )

Definition at line 93 of file class.ilMDAnnotation.php.

References $ilDB, ilMDBase\getMetaId(), and ilDBConstants\MDB2_AUTOQUERY_UPDATE.

         {
                 global $ilDB;
                 
                 if($this->getMetaId())
                 {
                         if($this->db->autoExecute('il_meta_annotation',
                                                                           $this->__getFields(),
                                                                           ilDBConstants::MDB2_AUTOQUERY_UPDATE,
                                                                           "meta_annotation_id = ".$ilDB->quote($this->getMetaId())))
                         {
                                 return true;
                         }
                 }
                 return false;
         }

Here is the call graph for this function:

◆ update() [2/2]

ilMDAnnotation::update ( )

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

References $ilDB, array, and ilMDBase\getMetaId().

         {
                 global $ilDB;
                 
                 if($this->getMetaId())
                 {
                         if($this->db->update('il_meta_annotation',
                                                                         $this->__getFields(),
                                                                         array("meta_annotation_id" => array('integer',$this->getMetaId()))))
                         {
                                 return true;
                         }
                 }
                 return false;
         }

Here is the call graph for this function:

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

Services/MetaData/classes/class.ilMDAnnotation.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __getFields() [1/2]

◆ __getFields() [2/2]

◆ _getIds() [1/2]

◆ _getIds() [2/2]

◆ delete() [1/2]

◆ delete() [2/2]

◆ getDate() [1/2]

◆ getDate() [2/2]

◆ getDescription() [1/2]

◆ getDescription() [2/2]

◆ getDescriptionLanguage() [1/2]

◆ getDescriptionLanguage() [2/2]

◆ getDescriptionLanguageCode() [1/2]

◆ getDescriptionLanguageCode() [2/2]

◆ getEntity() [1/2]

◆ getEntity() [2/2]

◆ read() [1/2]

◆ read() [2/2]

◆ save() [1/2]

◆ save() [2/2]

◆ setDate() [1/2]

◆ setDate() [2/2]

◆ setDescription() [1/2]

◆ setDescription() [2/2]

◆ setDescriptionLanguage() [1/2]

◆ setDescriptionLanguage() [2/2]

◆ setEntity() [1/2]

◆ setEntity() [2/2]

◆ toXML() [1/2]

◆ toXML() [2/2]

◆ update() [1/2]

◆ update() [2/2]