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)
	Read data from DB. More...

	getXmlRecord (string $a_entity, string $a_version, array $a_set)
	Get xml record for version. More...

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...

	initByExporter (ilXmlExporter $xml_exporter)

	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 ...> ... </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 (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...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

	getContainerExportConfig (array $record, string $entity, string $schema_version, string $field, string $value)

Protected Member Functions
	getXmlNamespace (string $a_entity, string $a_schema_version)

	getTypes (string $a_entity, string $a_version)
	Get (abstract) types for (abstract) field names.Please note that the abstract fields/types only depend on the version! Not on a choosen representation! Returns array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...) More...

	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)

	getExportDirInContainer (string $exp_dir)

	getIRSSContainerExportConfig (StorableResource $source_container, string $source_path, string $target_path="")

	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
const string	ENTITY = "poll"

NotesService	$notes

DataFactory	$data_factory

ilObjuser	$user

PollImageFactoryInterface	$poll_image_factory

Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$component_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

ilExport	$export

Additional Inherited Members
Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

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 35 of file class.ilPollDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilPollDataSet::__construct ( )

Reimplemented from ilDataSet.

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

    {
        global $DIC;
 
        parent::__construct();
        $this->notes = $DIC->notes();
        $this->data_factory = new DataFactory();
        $this->user = $DIC->user();
        $this->poll_image_factory = new PollImageFactory();
    }

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

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

Reimplemented from ilDataSet.

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

     : array {
        switch ($a_entity) {
            case "poll":
                return array(
                    "poll_answer" => array("ids" => $a_rec["Id"] ?? null)
                );
        }
        return [];
    }

◆ getSupportedVersions()

ilPollDataSet::getSupportedVersions ( )

Reimplemented from ilDataSet.

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

                                          : array
    {
        return array("4.3.0", "5.0.0", "10.0");
    }

◆ getTypes()

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

protected

Get (abstract) types for (abstract) field names.Please note that the abstract fields/types only depend on the version! Not on a choosen representation!

Returns: array types array, e.g. array("field_1" => "text", "field_2" => "integer", ...)

Reimplemented from ilDataSet.

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

                                                                    : array
    {
        if ($a_entity === self::ENTITY) {
            switch ($a_version) {
                case "4.3.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Question" => "text",
                        "Image" => "text",
                        "ViewResults" => "integer",
                        "Dir" => "directory"
                        );
                    break;
                case "5.0.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Question" => "text",
                        "Image" => "text",
                        "ViewResults" => "integer",
                        "Dir" => "directory",
                        "ShowResultsAs" => "integer",
                        "ShowComments" => "integer",
                        "MaxAnswers" => "integer",
                        "ResultSort" => "integer",
                        "NonAnon" => "integer",
                        "Period" => "integer",
                        "PeriodBegin" => "integer",
                        "PeriodEnd" => "integer"
 
                    );
                    break;
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Question" => "text",
                        "Image" => "text", // Image now contains the full path, not just the name
                        "ViewResults" => "integer",
                        "ShowResultsAs" => "integer",
                        "ShowComments" => "integer",
                        "MaxAnswers" => "integer",
                        "ResultSort" => "integer",
                        "NonAnon" => "integer",
                        "Period" => "integer",
                        "PeriodBegin" => "integer",
                        "PeriodEnd" => "integer"
                    );
                    break;
            }
        }
 
        if ($a_entity === "poll_answer") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "10.0":
                    return array(
                        "Id" => "integer",
                        "PollId" => "integer",
                        "Answer" => "text",
                        "Pos" => "integer",
                    );
                    break;
            }
        }
 
        return [];
    }

◆ getXmlNamespace()

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

protected

Reimplemented from ilDataSet.

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

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

◆ getXmlRecord()

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

Get xml record for version.

Parameters

array $a_set abstract data record

Reimplemented from ilDataSet.

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

                                                                                   : array
    {
        if ($a_entity === self::ENTITY) {
            $resource = $this->poll_image_factory->handler()->getRessource(
                $this->data_factory->objId((int) $a_set["Id"])
            );
            if ($resource !== null) {
                $title = $resource->getTitle();
                $path_in_container = ltrim($this->export->getExportDirInContainer(), '/') . '/image/' . $title;
                $this->export->getExportWriter()->writeFilesByResourceId(
                    $resource->getIdentification()->serialize(),
                    $path_in_container
                );
                /*
                 * For some reason, the name of the import file itself is included in getImportDirectory,
                 * so has to be removed here. Might need to take this out again if anything changes.
                 */
                $path_to_image = explode('/', $path_in_container);
                unset($path_to_image[0]);
                $path_to_image = implode('/', $path_to_image);
                $a_set["Image"] = $path_to_image;
            } else {
                $a_set["Image"] = '';
            }
 
            $a_set["ShowComments"] = $this->notes->domain()->commentsActive((int) $a_set["Id"]);
        }
        return $a_set;
    }

◆ readData()

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

Read data from DB.

This should result in the abstract field structure of the version set in the constructor.

Reimplemented from ilDataSet.

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

                                                                               : void
    {
        $ilDB = $this->db;
 
        if ($a_entity === self::ENTITY) {
            switch ($a_version) {
                case "4.3.0":
                    $this->getDirectDataFromQuery("SELECT pl.id,od.title,od.description," .
                        "pl.question,pl.image,pl.view_results" .
                        " FROM il_poll pl" .
                        " JOIN object_data od ON (od.obj_id = pl.id)" .
                        " WHERE " . $ilDB->in("pl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("poll", "text"));
                    break;
                case "5.0.0":
                    $this->getDirectDataFromQuery("SELECT pl.id,od.title,od.description" .
                        ",pl.question,pl.image,pl.view_results,pl.show_results_as" .
                        ",pl.max_answers,pl.result_sort,pl.non_anon,pl.period,pl.period_begin,pl.period_end" .
                        " FROM il_poll pl" .
                        " JOIN object_data od ON (od.obj_id = pl.id)" .
                        " WHERE " . $ilDB->in("pl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("poll", "text"));
                    break;
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT pl.id,od.title,od.description" .
                        ",pl.question,pl.view_results,pl.show_results_as" .
                        ",pl.max_answers,pl.result_sort,pl.non_anon,pl.period,pl.period_begin,pl.period_end" .
                        " FROM il_poll pl" .
                        " JOIN object_data od ON (od.obj_id = pl.id)" .
                        " WHERE " . $ilDB->in("pl.id", $a_ids, false, "integer") .
                        " AND od.type = " . $ilDB->quote("poll", "text"));
                    break;
            }
        }
 
        if ($a_entity === "poll_answer") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                case "10.0":
                    $this->getDirectDataFromQuery("SELECT id,poll_id,answer,pos" .
                        " FROM il_poll_answer WHERE " .
                        $ilDB->in("poll_id", $a_ids, false, "integer"));
                    break;
            }
        }
    }

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

Here is the call graph for this function:

Field Documentation

◆ $data_factory

DataFactory ilPollDataSet::$data_factory

protected

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

◆ $notes

NotesService ilPollDataSet::$notes

protected

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

◆ $poll_image_factory

PollImageFactoryInterface ilPollDataSet::$poll_image_factory

protected

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

◆ $user

ilObjuser ilPollDataSet::$user

protected

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

◆ ENTITY

const string ilPollDataSet::ENTITY = "poll"

protected

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

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

components/ILIAS/Poll/classes/class.ilPollDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ readData()

Field Documentation

◆ $data_factory

◆ $notes

◆ $poll_image_factory

◆ $user

◆ ENTITY