ILIAS  Release_4_4_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Protected Member Functions
ilItemGroupDataSet Class Reference

Item group data set class. More...

+ Inheritance diagram for ilItemGroupDataSet:
+ Collaboration diagram for ilItemGroupDataSet:

Public Member Functions

 getSupportedVersions ()
 Get supported versions.
 getXmlNamespace ($a_entity, $a_schema_version)
 Get xml namespace.
 readData ($a_entity, $a_version, $a_ids, $a_field="")
 Read data.
 getXmlRecord ($a_entity, $a_version, $a_set)
 Get xml record (export)
 importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
 Import record.
- Public Member Functions inherited from ilDataSet
 __construct ()
 Constructor.
 init ($a_entity, $a_schema_version)
 Init.
 readData ($a_entity, $a_version, $a_ids)
 Read data from DB.
 setExportDirectories ($a_relative, $a_absolute)
 Set export directories.
 setImportDirectory ($a_val)
 Set import directory.
 getImportDirectory ()
 Get import directory.
 setDSPrefix ($a_val)
 Set XML dataset namespace prefix.
 getDSPrefix ()
 Get XML dataset namespace prefix.
 getDSPrefixString ()
 getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true)
 Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields.
 convertToLeadingUpper ($a_str)
 Make xyz_abc a XyzAbc string.
 getJsonRepresentation ()
 Get json representation.
 getXmlRepresentation ($a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
 Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ...
 addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
 Add records xml.
 afterXmlRecordWriting ($a_entity, $a_version, $a_set)
 After xml record writing hook record.
 getNamespaces (&$namespaces, $a_entity, $a_schema_version)
 Get xml namespaces.
 getJsonRecord ($a_set)
 Get json record for version.
 getXmlTypes ($a_entity, $a_version)
 Get xml types.
 getJsonTypes ($a_entity, $a_version)
 Get json types.
 getXMLEntityName ($a_entity, $a_version)
 Get entity name for xml (may be overwritten)
 getXMLEntityTag ($a_entity, $a_schema_version)
 Get entity tag.
 getJsonEntityName ($a_entity, $a_version)
 Get entity name for json (may be overwritten)
 setImport ($a_val)
 Set import object.
 getImport ()
 Get import object.

Protected Member Functions

 getTypes ($a_entity, $a_version)
 Get field types for entity.
 getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
 Determine the dependent sets of data.
- Protected Member Functions inherited from ilDataSet
 createObjectExportId ($a_type, $a_id)
 Build ilias export id.
 parseObjectExportId ($a_id, $a_fallback_id=NULL)
 Parse export id.

Additional Inherited Members

- Data Fields inherited from ilDataSet
 $dircnt
const EXPORT_NO_INST_ID = 1
const EXPORT_ID_ILIAS_LOCAL = 2
const EXPORT_ID_ILIAS_LOCAL_INVALID = 3
const EXPORT_ID_ILIAS_REMOTE = 4
const EXPORT_ID_ILIAS_REMOTE_INVALID = 5
const EXPORT_ID = 6
const EXPORT_ID_INVALID = 7

Detailed Description

Item group data set class.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 13 of file class.ilItemGroupDataSet.php.

Member Function Documentation

ilItemGroupDataSet::getDependencies (   $a_entity,
  $a_version,
  $a_rec,
  $a_ids 
)
protected

Determine the dependent sets of data.

Definition at line 133 of file class.ilItemGroupDataSet.php.

{
switch ($a_entity)
{
case "itgr":
return array (
"itgr_item" => array("ids" => $a_rec["Id"])
);
}
return false;
}
ilItemGroupDataSet::getSupportedVersions ( )

Get supported versions.

Parameters
@return

Reimplemented from ilDataSet.

Definition at line 21 of file class.ilItemGroupDataSet.php.

{
return array("4.3.0");
}
ilItemGroupDataSet::getTypes (   $a_entity,
  $a_version 
)
protected

Get field types for entity.

Parameters
@return

Reimplemented from ilDataSet.

Definition at line 43 of file class.ilItemGroupDataSet.php.

{
if ($a_entity == "itgr")
{
switch ($a_version)
{
case "4.3.0":
return array(
"Id" => "integer",
"Title" => "text",
"Description" => "text");
}
}
if ($a_entity == "itgr_item")
{
switch ($a_version)
{
case "4.3.0":
return array(
"ItemGroupId" => "integer",
"ItemId" => "text"
);
}
}
}
ilItemGroupDataSet::getXmlNamespace (   $a_entity,
  $a_schema_version 
)

Get xml namespace.

Parameters
@return

Reimplemented from ilDataSet.

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

{
return "http://www.ilias.de/xml/Modules/ItemGroup/".$a_entity;
}
ilItemGroupDataSet::getXmlRecord (   $a_entity,
  $a_version,
  $a_set 
)

Get xml record (export)

Parameters
arrayabstract data record
Returns
array xml record

Reimplemented from ilDataSet.

Definition at line 120 of file class.ilItemGroupDataSet.php.

References ilObject\_lookupObjId().

{
if ($a_entity == "itgr_item")
{
// make ref id an object id
$a_set["ItemId"] = ilObject::_lookupObjId($a_set["ItemId"]);
}
return $a_set;
}

+ Here is the call graph for this function:

ilItemGroupDataSet::importRecord (   $a_entity,
  $a_types,
  $a_rec,
  $a_mapping,
  $a_schema_version 
)

Import record.

Parameters
@return

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

References $ilLog, $ref_id, ilObject\_getAllReferences(), and ilObjectFactory\getInstanceByObjId().

{
global $ilLog;
//echo $a_entity;
//var_dump($a_rec);
switch ($a_entity)
{
case "itgr":
include_once("./Modules/ItemGroup/classes/class.ilObjItemGroup.php");
if ($new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['Id']))
{
$newObj = ilObjectFactory::getInstanceByObjId($new_id,false);
}
else
{
$newObj = new ilObjItemGroup();
$newObj->setType("itgr");
$newObj->create(true);
}
$newObj->setTitle($a_rec["Title"]);
$newObj->setDescription($a_rec["Description"]);
$newObj->update(true);
$this->current_obj = $newObj;
$a_mapping->addMapping("Modules/ItemGroup", "itgr", $a_rec["Id"], $newObj->getId());
break;
case "itgr_item":
if($obj_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['ItemId']))
{
$ref_id = current(ilObject::_getAllReferences($obj_id));
include_once './Modules/ItemGroup/classes/class.ilItemGroupItems.php';
$itgri = new ilItemGroupItems();
$itgri->setItemGroupId($this->current_obj->getId());
$itgri->read();
$itgri->addItem($ref_id);
//$ilLog->write("Adding item with ref id -".$ref_id."- to group with id -".$this->current_obj->getId()."-.");
$itgri->update();
}
break;
}
}

+ Here is the call graph for this function:

ilItemGroupDataSet::readData (   $a_entity,
  $a_version,
  $a_ids,
  $a_field = "" 
)

Read data.

Parameters
@return

Definition at line 77 of file class.ilItemGroupDataSet.php.

References ilDataSet\getDirectDataFromQuery().

{
global $ilDB;
if (!is_array($a_ids))
{
$a_ids = array($a_ids);
}
if ($a_entity == "itgr")
{
switch ($a_version)
{
case "4.3.0":
$this->getDirectDataFromQuery("SELECT obj_id id, title, description ".
" FROM object_data ".
"WHERE ".
$ilDB->in("obj_id", $a_ids, false, "integer"));
break;
}
}
if ($a_entity == "itgr_item")
{
switch ($a_version)
{
case "4.3.0":
$this->getDirectDataFromQuery($q = "SELECT item_group_id itgr_id, item_ref_id item_id".
" FROM item_group_item ".
"WHERE ".
$ilDB->in("item_group_id", $a_ids, false, "integer"));
break;
}
}
}

+ Here is the call graph for this function:

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