ILIAS  release_4-4 Revision
•All Data Structures Namespaces Files Functions Variables Modules Pages
Public Member Functions | Protected Member Functions | Protected Attributes
ilPollDataSet Class Reference

Poll Dataset class. More...

+ Inheritance diagram for ilPollDataSet:
+ Collaboration diagram for ilPollDataSet:

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...
 
 getXmlRecord ($a_entity, $a_version, $a_set)
 Get xml record. 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 ...> ... 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...
 

Protected Attributes

 $current_blog
 

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

Poll Dataset class.

This class implements the following entities:

  • poll: object data
  • poll_answer: data from table il_poll_answer
Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Member Function Documentation

◆ getDependencies()

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

Determine the dependent sets of data.

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

121  {
122  switch ($a_entity)
123  {
124  case "poll":
125  return array (
126  "poll_answer" => array("ids" => $a_rec["Id"])
127  );
128  }
129  return false;
130  }

◆ getSupportedVersions()

ilPollDataSet::getSupportedVersions ( )

Get supported versions.

Definition at line 24 of file class.ilPollDataSet.php.

25  {
26  return array("4.3.0");
27  }

◆ getTypes()

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

Get field types for entity.

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

41  {
42  if ($a_entity == "poll")
43  {
44  switch ($a_version)
45  {
46  case "4.3.0":
47  return array(
48  "Id" => "integer",
49  "Title" => "text",
50  "Description" => "text",
51  "Question" => "text",
52  "Image" => "text",
53  "ViewResults" => "integer",
54  "Dir" => "directory"
55  );
56  }
57  }
58 
59  if ($a_entity == "poll_answer")
60  {
61  switch ($a_version)
62  {
63  case "4.3.0":
64  return array(
65  "Id" => "integer",
66  "PollId" => "integer",
67  "Answer" => "text",
68  "Pos" => "integer",
69  );
70  }
71  }
72  }

◆ getXmlNamespace()

ilPollDataSet::getXmlNamespace (   $a_entity,
  $a_schema_version 
)

Get xml namespace.

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

33  {
34  return "http://www.ilias.de/xml/Modules/Poll/".$a_entity;
35  }

◆ getXmlRecord()

ilPollDataSet::getXmlRecord (   $a_entity,
  $a_version,
  $a_set 
)

Get xml record.

Parameters

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

References ilObjPoll\initStorage().

139  {
140  if ($a_entity == "poll")
141  {
142  include_once("./Modules/Poll/classes/class.ilObjPoll.php");
143  $dir = ilObjPoll::initStorage($a_set["Id"]);
144  $a_set["Dir"] = $dir;
145  }
146 
147  return $a_set;
148  }
ilObjPoll\initStorage
static initStorage($a_id, $a_subdir=null)
Init file system storage.
Definition: class.ilObjPoll.php:354
+ Here is the call graph for this function:

◆ importRecord()

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

Import record.

Parameters

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

References ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilObjPoll\initStorage(), and ilUtil\rCopy().

157  {
158  switch ($a_entity)
159  {
160  case "poll":
161  include_once("./Modules/Poll/classes/class.ilObjPoll.php");
162 
163  // #13605
164  if($new_id = $a_mapping->getMapping("Services/Container", "objs", $a_rec["Id"]))
165  {
166  $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
167  }
168  else
169  {
170  $newObj = new ilObjPoll();
171  $newObj->create();
172  }
173 
174  $newObj->setTitle($a_rec["Title"]);
175  $newObj->setDescription($a_rec["Description"]);
176  $newObj->setQuestion($a_rec["Question"]);
177  $newObj->setImage($a_rec["Image"]);
178  $newObj->setViewResults($a_rec["ViewResults"]);
179  $newObj->update();
180 
181  // handle image(s)
182  if($a_rec["Image"])
183  {
184  $dir = str_replace("..", "", $a_rec["Dir"]);
185  if ($dir != "" && $this->getImportDirectory() != "")
186  {
187  $source_dir = $this->getImportDirectory()."/".$dir;
188  $target_dir = ilObjPoll::initStorage($newObj->getId());
189  ilUtil::rCopy($source_dir, $target_dir);
190  }
191  }
192 
193  $a_mapping->addMapping("Modules/Poll", "poll", $a_rec["Id"], $newObj->getId());
194  break;
195 
196  case "poll_answer":
197  $poll_id = (int) $a_mapping->getMapping("Modules/Poll", "poll", $a_rec["PollId"]);
198  if($poll_id)
199  {
200  $poll = new ilObjPoll($poll_id, false);
201  $poll->saveAnswer($a_rec["Answer"], $a_rec["pos"]);
202  }
203  break;
204  }
205  }
ilUtil\rCopy
static rCopy($a_sdir, $a_tdir, $preserveTimeAttributes=false)
Copies content of a directory $a_sdir recursively to a directory $a_tdir.
Definition: class.ilUtil.php:1601
ilDataSet\getImportDirectory
getImportDirectory()
Get import directory.
Definition: class.ilDataSet.php:121
ilObjectFactory\getInstanceByObjId
getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:72
ilObjPoll\initStorage
static initStorage($a_id, $a_subdir=null)
Init file system storage.
Definition: class.ilObjPoll.php:354
ilObjPoll
Class ilObjPoll.
Definition: class.ilObjPoll.php:16
+ Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

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

References ilDataSet\getDirectDataFromQuery().

81  {
82  global $ilDB;
83 
84  if (!is_array($a_ids))
85  {
86  $a_ids = array($a_ids);
87  }
88 
89  if ($a_entity == "poll")
90  {
91  switch ($a_version)
92  {
93  case "4.3.0":
94  $this->getDirectDataFromQuery("SELECT pl.id,od.title,od.description,".
95  "pl.question,pl.image,pl.view_results".
96  " FROM il_poll pl".
97  " JOIN object_data od ON (od.obj_id = pl.id)".
98  " WHERE ".$ilDB->in("pl.id", $a_ids, false, "integer").
99  " AND od.type = ".$ilDB->quote("poll", "text"));
100  break;
101  }
102  }
103 
104  if ($a_entity == "poll_answer")
105  {
106  switch ($a_version)
107  {
108  case "4.3.0":
109  $this->getDirectDataFromQuery("SELECT id,poll_id,answer,pos".
110  " FROM il_poll_answer WHERE ".
111  $ilDB->in("poll_id", $a_ids, false, "integer"));
112  break;
113  }
114  }
115  }
ilDataSet\getDirectDataFromQuery
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 ...
Definition: class.ilDataSet.php:161
+ Here is the call graph for this function:

Field Documentation

◆ $current_blog

ilPollDataSet::$current_blog
protected

Definition at line 19 of file class.ilPollDataSet.php.

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