ILIAS  release_8 Revision v8.19
•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

 __construct ()
 
 getSupportedVersions ()
 
 readData (string $a_entity, string $a_version, array $a_ids)
 
 getXmlRecord (string $a_entity, string $a_version, array $a_set)
 
- Public Member Functions inherited from ilDataSet
 __construct ()
 
 init (string $a_entity, string $a_schema_version)
 Init. More...
 
 getSupportedVersions ()
 
 readData (string $a_entity, string $a_version, array $a_ids)
 Read data from DB. More...
 
 setExportDirectories (string $a_relative, string $a_absolute)
 
 setImportDirectory (string $a_val)
 
 getImportDirectory ()
 
 setDSPrefix (string $a_val)
 
 getDSPrefix ()
 
 getDSPrefixString ()
 
 getDirectDataFromQuery (string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
 Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...
 
 convertToLeadingUpper (string $a_str)
 Make xyz_abc a XyzAbc string. More...
 
 getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")
 
 afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)
 
 getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)
 
 getXmlRecord (string $a_entity, string $a_version, array $a_set)
 Get xml record for version. More...
 
 getXmlTypes (string $a_entity, string $a_version)
 Get xml types. More...
 
 getXMLEntityName (string $a_entity, string $a_version)
 Get entity name for xml (may be overwritten) More...
 
 getXMLEntityTag (string $a_entity, string $a_schema_version)
 Get entity tag. More...
 
 setImport (ilSurveyImporter $a_val)
 
 getImport ()
 
 setCurrentInstallationId (string $a_val)
 
 getCurrentInstallationId ()
 
 importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
 Needs to be overwritten for import use case. More...
 

Protected Member Functions

 getXmlNamespace (string $a_entity, string $a_schema_version)
 
 getTypes (string $a_entity, string $a_version)
 
 getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
 
- Protected Member Functions inherited from ilDataSet
 getTypes (string $a_entity, string $a_version)
 Get (abstract) types for (abstract) field names. More...
 
 getXmlNamespace (string $a_entity, string $a_schema_version)
 
 getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)
 
 createObjectExportId (string $a_type, string $a_id)
 Build ilias export id. More...
 
 parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
 Parse export id. More...
 
 stripTags (array $rec, array $omit_keys=[])
 

Protected Attributes

ILIAS Notes Service $notes
 
- Protected Attributes inherited from ilDataSet
string $current_installation_id = ""
 
array $data = []
 
ilDBInterface $db
 
ilLogger $ds_log
 
string $import_directory = ""
 
string $entity = ""
 
string $schema_version = ""
 
string $relative_export_dir = ""
 
string $absolute_export_dir = ""
 
string $ds_prefix = "ds"
 
string $version = ""
 
ilSurveyImporter $import
 

Additional Inherited Members

- Data Fields inherited from ilDataSet
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
 
int $dircnt = 0
 

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

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

Constructor & Destructor Documentation

◆ __construct()

ilPollDataSet::__construct ( )

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

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

35  {
36  global $DIC;
37 
38  parent::__construct();
39  $this->notes = $DIC->notes();
40  }
$DIC
global $DIC
Definition: feed.php:28
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
+ Here is the call graph for this function:

Member Function Documentation

◆ getDependencies()

ilPollDataSet::getDependencies ( string  $a_entity,
string  $a_version,
?array  $a_rec = null,
?array  $a_ids = null 
)
protected

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

154  : array {
155  switch ($a_entity) {
156  case "poll":
157  return array(
158  "poll_answer" => array("ids" => $a_rec["Id"] ?? null)
159  );
160  }
161  return [];
162  }

◆ getSupportedVersions()

ilPollDataSet::getSupportedVersions ( )

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

42  : array
43  {
44  return array("4.3.0", "5.0.0");
45  }

◆ getTypes()

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

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

55  : array
56  {
57  if ($a_entity === "poll") {
58  switch ($a_version) {
59  case "4.3.0":
60  return array(
61  "Id" => "integer",
62  "Title" => "text",
63  "Description" => "text",
64  "Question" => "text",
65  "Image" => "text",
66  "ViewResults" => "integer",
67  "Dir" => "directory"
68  );
69  break;
70  case "5.0.0":
71  return array(
72  "Id" => "integer",
73  "Title" => "text",
74  "Description" => "text",
75  "Question" => "text",
76  "Image" => "text",
77  "ViewResults" => "integer",
78  "Dir" => "directory",
79  "ShowResultsAs" => "integer",
80  "ShowComments" => "integer",
81  "MaxAnswers" => "integer",
82  "ResultSort" => "integer",
83  "NonAnon" => "integer",
84  "Period" => "integer",
85  "PeriodBegin" => "integer",
86  "PeriodEnd" => "integer"
87 
88  );
89  break;
90  }
91  }
92 
93  if ($a_entity === "poll_answer") {
94  switch ($a_version) {
95  case "4.3.0":
96  case "5.0.0":
97  return array(
98  "Id" => "integer",
99  "PollId" => "integer",
100  "Answer" => "text",
101  "Pos" => "integer",
102  );
103  break;
104  }
105  }
106 
107  return [];
108  }

◆ getXmlNamespace()

ilPollDataSet::getXmlNamespace ( string  $a_entity,
string  $a_schema_version 
)
protected

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

47  : string
48  {
49  return "http://www.ilias.de/xml/Modules/Poll/" . $a_entity;
50  }

◆ getXmlRecord()

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

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

References ilImportMapping\addMapping(), ilDataSet\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), ilDataSet\importRecord(), ilObjPoll\initStorage(), ILIAS\Repository\int(), ilFileUtils\rCopy(), ilDataSet\stripTags(), and ilObjPoll\VIEW_RESULTS_AFTER_VOTE.

164  : array
165  {
166  if ($a_entity === "poll") {
167  $dir = ilObjPoll::initStorage((int) $a_set["Id"]);
168  $a_set["Dir"] = $dir;
169 
170  $a_set["ShowComments"] = $this->notes->domain()->commentsActive((int) $a_set["Id"]);
171  }
172 
173  return $a_set;
174  }
ilObjPoll\initStorage
static initStorage(int $a_id, ?string $a_subdir=null)
Definition: class.ilObjPoll.php:404
+ Here is the call graph for this function:

◆ readData()

ilPollDataSet::readData ( string  $a_entity,
string  $a_version,
array  $a_ids 
)

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

References ilDataSet\$db, $ilDB, and ilDataSet\getDirectDataFromQuery().

110  : void
111  {
112  $ilDB = $this->db;
113 
114  if ($a_entity === "poll") {
115  switch ($a_version) {
116  case "4.3.0":
117  $this->getDirectDataFromQuery("SELECT pl.id,od.title,od.description," .
118  "pl.question,pl.image,pl.view_results" .
119  " FROM il_poll pl" .
120  " JOIN object_data od ON (od.obj_id = pl.id)" .
121  " WHERE " . $ilDB->in("pl.id", $a_ids, false, "integer") .
122  " AND od.type = " . $ilDB->quote("poll", "text"));
123  break;
124  case "5.0.0":
125  $this->getDirectDataFromQuery("SELECT pl.id,od.title,od.description" .
126  ",pl.question,pl.image,pl.view_results,pl.show_results_as" .
127  ",pl.max_answers,pl.result_sort,pl.non_anon,pl.period,pl.period_begin,pl.period_end" .
128  " FROM il_poll pl" .
129  " JOIN object_data od ON (od.obj_id = pl.id)" .
130  " WHERE " . $ilDB->in("pl.id", $a_ids, false, "integer") .
131  " AND od.type = " . $ilDB->quote("poll", "text"));
132  break;
133 
134  }
135  }
136 
137  if ($a_entity === "poll_answer") {
138  switch ($a_version) {
139  case "4.3.0":
140  case "5.0.0":
141  $this->getDirectDataFromQuery("SELECT id,poll_id,answer,pos" .
142  " FROM il_poll_answer WHERE " .
143  $ilDB->in("poll_id", $a_ids, false, "integer"));
144  break;
145  }
146  }
147  }
ilDataSet\$db
ilDBInterface $db
Definition: class.ilDataSet.php:49
ilDataSet\getDirectDataFromQuery
getDirectDataFromQuery(string $a_query, bool $a_convert_to_leading_upper=true, bool $a_set=true)
Get data from query.This is a standard procedure, all db field names are directly mapped to abstract ...
Definition: class.ilDataSet.php:148
+ Here is the call graph for this function:

Field Documentation

◆ $notes

ILIAS Notes Service ilPollDataSet::$notes
protected

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

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