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, $a_set=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...

	setCurrentInstallationId ($a_val)
	Set current installation id. More...

	getCurrentInstallationId ()
	Get current installation id. 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

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

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

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

◆ getSupportedVersions()

ilPollDataSet::getSupportedVersions ( )

Get supported versions.

Reimplemented from ilDataSet.

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

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

◆ getTypes()

ilPollDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Reimplemented from ilDataSet.

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

    {
        if ($a_entity == "poll") {
            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;
            }
        }
        
        if ($a_entity == "poll_answer") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.0":
                    return array(
                        "Id" => "integer",
                        "PollId" => "integer",
                        "Answer" => "text",
                        "Pos" => "integer",
                    );
                    break;
            }
        }
    }

◆ getXmlNamespace()

ilPollDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Reimplemented from ilDataSet.

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

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

◆ getXmlRecord()

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

Get xml record.

Parameters

return

Reimplemented from ilDataSet.

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

    {
        if ($a_entity == "poll") {
            include_once("./Modules/Poll/classes/class.ilObjPoll.php");
            $dir = ilObjPoll::initStorage($a_set["Id"]);
            $a_set["Dir"] = $dir;
            
            include_once("./Services/Notes/classes/class.ilNote.php");
            $a_set["ShowComments"] = ilNote::commentsActivated($a_set["Id"], 0, "poll");
        }
 
        return $a_set;
    }

References ilNote\commentsActivated(), and ilObjPoll\initStorage().

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

return

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

    {
        switch ($a_entity) {
            case "poll":
                include_once("./Modules/Poll/classes/class.ilObjPoll.php");
                
                // container copy
                if ($new_id = $a_mapping->getMapping("Services/Container", "objs", $a_rec["Id"])) {
                    $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                } else {
                    $newObj = new ilObjPoll();
                    $newObj->create();
                }
                    
                $newObj->setTitle($a_rec["Title"]);
                $newObj->setDescription($a_rec["Description"]);
                if ((int) $a_rec["MaxAnswers"]) {
                    $newObj->setMaxNumberOfAnswers($a_rec["MaxAnswers"]);
                }
                $newObj->setSortResultByVotes((bool) $a_rec["ResultSort"]);
                $newObj->setNonAnonymous((bool) $a_rec["NonAnon"]);
                if ((int) $a_rec["ShowResultsAs"]) {
                    $newObj->setShowResultsAs($a_rec["ShowResultsAs"]);
                }
                $newObj->setShowComments($a_rec["ShowComments"]);
                $newObj->setQuestion($a_rec["Question"]);
                $newObj->setImage($a_rec["Image"]);
                $newObj->setViewResults($a_rec["ViewResults"]);
                $newObj->setVotingPeriod($a_rec["Period"]);
                $newObj->setVotingPeriodBegin($a_rec["PeriodBegin"]);
                $newObj->setVotingPeriodEnd($a_rec["PeriodEnd"]);
                $newObj->update();
                
                // handle image(s)
                if ($a_rec["Image"]) {
                    $dir = str_replace("..", "", $a_rec["Dir"]);
                    if ($dir != "" && $this->getImportDirectory() != "") {
                        $source_dir = $this->getImportDirectory() . "/" . $dir;
                        $target_dir = ilObjPoll::initStorage($newObj->getId());
                        ilUtil::rCopy($source_dir, $target_dir);
                    }
                }
 
                $a_mapping->addMapping("Modules/Poll", "poll", $a_rec["Id"], $newObj->getId());
                break;
 
            case "poll_answer":
                $poll_id = (int) $a_mapping->getMapping("Modules/Poll", "poll", $a_rec["PollId"]);
                if ($poll_id) {
                    $poll = new ilObjPoll($poll_id, false);
                    $poll->saveAnswer($a_rec["Answer"], $a_rec["pos"]);
                }
                break;
        }
    }

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

Here is the call graph for this function:

◆ readData()

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

Read data.

Parameters

return

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

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
        
        if ($a_entity == "poll") {
            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;
 
            }
        }
 
        if ($a_entity == "poll_answer") {
            switch ($a_version) {
                case "4.3.0":
                case "5.0.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

◆ $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:

Modules/Poll/classes/class.ilPollDataSet.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getDependencies()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ getXmlRecord()

◆ importRecord()

◆ readData()

Field Documentation

◆ $current_blog