ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
ilMediaPoolDataSet Class Reference

Media Pool Data set class. More...

+ Inheritance diagram for ilMediaPoolDataSet:
+ Collaboration diagram for ilMediaPoolDataSet:

Public Member Functions

 getSupportedVersions ()
 Get supported versions. More...
 
 getXmlNamespace ($a_entity, $a_schema_version)
 Get xml namespace. More...
 
 readData ($a_entity, $a_version, $a_ids, $a_field="")
 Read data. More...
 
 importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
 Import record. More...
 
- Public Member Functions inherited from ilDataSet
 __construct ()
 Constructor. More...
 
 init ($a_entity, $a_schema_version)
 Init. More...
 
 getSupportedVersions ()
 Get supported version. More...
 
 readData ($a_entity, $a_version, $a_ids)
 Read data from DB. More...
 
 setExportDirectories ($a_relative, $a_absolute)
 Set export directories. More...
 
 setImportDirectory ($a_val)
 Set import directory. More...
 
 getImportDirectory ()
 Get import directory. More...
 
 setDSPrefix ($a_val)
 Set XML dataset namespace prefix. More...
 
 getDSPrefix ()
 Get XML dataset namespace prefix. More...
 
 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. More...
 
 convertToLeadingUpper ($a_str)
 Make xyz_abc a XyzAbc string. More...
 
 getJsonRepresentation ()
 Get json representation. More...
 
 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 ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> More...
 
 addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
 Add records xml. More...
 
 afterXmlRecordWriting ($a_entity, $a_version, $a_set)
 After xml record writing hook record. More...
 
 getNamespaces (&$namespaces, $a_entity, $a_schema_version)
 Get xml namespaces. More...
 
 getXmlRecord ($a_entity, $a_version, $a_set)
 Get xml record for version. More...
 
 getJsonRecord ($a_set)
 Get json record for version. More...
 
 getXmlTypes ($a_entity, $a_version)
 Get xml types. More...
 
 getJsonTypes ($a_entity, $a_version)
 Get json types. More...
 
 getXMLEntityName ($a_entity, $a_version)
 Get entity name for xml (may be overwritten) More...
 
 getXMLEntityTag ($a_entity, $a_schema_version)
 Get entity tag. More...
 
 getJsonEntityName ($a_entity, $a_version)
 Get entity name for json (may be overwritten) More...
 
 setImport ($a_val)
 Set import object. More...
 
 getImport ()
 Get import object. More...
 

Protected Member Functions

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

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

Media Pool Data set class.

This class implements the following entities:

  • mep_data: data from table mep_data
  • mep_tree: data from a join on mep_tree and mep_item
Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 17 of file class.ilMediaPoolDataSet.php.

Member Function Documentation

◆ getDependencies()

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

Determine the dependent sets of data.

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

134 {
135 switch ($a_entity)
136 {
137 case "mep":
138 return array (
139 "mep_tree" => array("ids" => $a_rec["Id"])
140 );
141 }
142 return false;
143 }

◆ getSupportedVersions()

ilMediaPoolDataSet::getSupportedVersions ( )

Get supported versions.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 25 of file class.ilMediaPoolDataSet.php.

26 {
27 return array("4.1.0");
28 }

◆ getTypes()

ilMediaPoolDataSet::getTypes (   $a_entity,
  $a_version 
)
protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 47 of file class.ilMediaPoolDataSet.php.

48 {
49 // mep
50 if ($a_entity == "mep")
51 {
52 switch ($a_version)
53 {
54 case "4.1.0":
55 return array(
56 "Id" => "integer",
57 "Title" => "text",
58 "Description" => "text",
59 "DefaultWidth" => "integer",
60 "DefaultHeight" => "integer");
61 }
62 }
63
64 // mep_tree
65 if ($a_entity == "mep_tree")
66 {
67 switch ($a_version)
68 {
69 case "4.1.0":
70 return array(
71 "MepId" => "integer",
72 "Child" => "integer",
73 "Parent" => "integer",
74 "Depth" => "integer",
75 "Type" => "text",
76 "Title" => "text",
77 "ForeignId" => "integer"
78 );
79 }
80 }
81 }

◆ getXmlNamespace()

ilMediaPoolDataSet::getXmlNamespace (   $a_entity,
  $a_schema_version 
)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

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

37 {
38 return "http://www.ilias.de/xml/Modules/MediaPool/".$a_entity;
39 }

◆ importRecord()

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

Import record.

Parameters

return

Definition at line 156 of file class.ilMediaPoolDataSet.php.

157 {
158//echo $a_entity;
159//var_dump($a_rec);
160
161 switch ($a_entity)
162 {
163 case "mep":
164 include_once("./Modules/MediaPool/classes/class.ilObjMediaPool.php");
165
166 if($new_id = $a_mapping->getMapping('Services/Container','objs',$a_rec['Id']))
167 {
168 $newObj = ilObjectFactory::getInstanceByObjId($new_id,false);
169 }
170 else
171 {
172 $newObj = new ilObjMediaPool();
173 $newObj->setType("mep");
174 $newObj->create(true);
175 }
176
177 $newObj->setTitle($a_rec["Title"]);
178 $newObj->setDescription($a_rec["Description"]);
179 $newObj->setDefaultWidth($a_rec["DefaultWidth"]);
180 $newObj->setDefaultHeight($a_rec["DefaultHeight"]);
181 $newObj->update();
182
183 $this->current_obj = $newObj;
184 $a_mapping->addMapping("Modules/MediaPool", "mep", $a_rec["Id"], $newObj->getId());
185 break;
186
187 case "mep_tree":
188 switch ($a_rec["Type"])
189 {
190 case "fold":
191 $parent = (int) $a_mapping->getMapping("Modules/MediaPool", "mep_tree", $a_rec["Parent"]);
192 $fold_id =
193 $this->current_obj->createFolder($a_rec["Title"], $parent);
194 $a_mapping->addMapping("Modules/MediaPool", "mep_tree", $a_rec["Child"],
195 $fold_id);
196 break;
197
198 case "mob":
199 $parent = (int) $a_mapping->getMapping("Modules/MediaPool", "mep_tree", $a_rec["Parent"]);
200 $mob_id = (int) $a_mapping->getMapping("Services/MediaObjects", "mob", $a_rec["ForeignId"]);
201 $item = new ilMediaPoolItem();
202 $item->setType("mob");
203 $item->setForeignId($mob_id);
204 $item->setTitle($a_rec["Title"]);
205 $item->create();
206 if ($item->getId() > 0)
207 {
208 $this->current_obj->insertInTree($item->getId(), $parent);
209 }
210 break;
211
212 case "pg":
213 $parent = (int) $a_mapping->getMapping("Modules/MediaPool", "mep_tree", $a_rec["Parent"]);
214
215 $item = new ilMediaPoolItem();
216 $item->setType("pg");
217 $item->setTitle($a_rec["Title"]);
218 $item->create();
219 $a_mapping->addMapping("Services/COPage", "pg", "mep:".$a_rec["Child"],
220 "mep:".$item->getId());
221 if ($item->getId() > 0)
222 {
223 $this->current_obj->insertInTree($item->getId(), $parent);
224 }
225 break;
226
227 }
228 }
229 }
Media pool object.
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id

References ilObjectFactory\getInstanceByObjId().

+ Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

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

90 {
91 global $ilDB;
92
93 if (!is_array($a_ids))
94 {
95 $a_ids = array($a_ids);
96 }
97
98 // mep_data
99 if ($a_entity == "mep")
100 {
101 switch ($a_version)
102 {
103 case "4.1.0":
104 $this->getDirectDataFromQuery("SELECT id, title, description, ".
105 " default_width, default_height".
106 " FROM mep_data JOIN object_data ON (mep_data.id = object_data.obj_id) ".
107 "WHERE ".
108 $ilDB->in("id", $a_ids, false, "integer"));
109 break;
110 }
111 }
112
113 // mep_tree
114 if ($a_entity == "mep_tree")
115 {
116 switch ($a_version)
117 {
118 case "4.1.0":
119 $this->getDirectDataFromQuery("SELECT mep_id, child ".
120 " ,parent,depth,type,title,foreign_id ".
121 " FROM mep_tree JOIN mep_item ON (child = obj_id) ".
122 " WHERE ".
123 $ilDB->in("mep_id", $a_ids, false, "integer").
124 " ORDER BY depth");
125 break;
126 }
127 }
128 }
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 ...
global $ilDB

References $ilDB, and ilDataSet\getDirectDataFromQuery().

+ Here is the call graph for this function:

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