ilObjPoll Class Reference

Class ilObjPoll. More...

Inheritance diagram for ilObjPoll:

Collaboration diagram for ilObjPoll:

Public Member Functions
	__construct (int $a_id=0, bool $a_reference=true)
	setAccessType (int $a_value)
	getAccessType ()
	setAccessBegin (int $a_value)
	getAccessBegin ()
	setAccessEnd (int $a_value)
	getAccessEnd ()
	setAccessVisibility (bool $a_value)
	getAccessVisibility ()
	setQuestion (string $a_value)
	getQuestion ()
	setImage (string $a_value)
	getImage ()
	setViewResults (int $a_value)
	getViewResults ()
	setVotingPeriod (bool $a_value)
	getVotingPeriod ()
	setVotingPeriodBegin (int $a_value)
	getVotingPeriodBegin ()
	setVotingPeriodEnd (int $a_value)
	getVotingPeriodEnd ()
	setMaxNumberOfAnswers (int $a_value)
	getMaxNumberOfAnswers ()
	setSortResultByVotes (bool $a_value)
	getSortResultByVotes ()
	setNonAnonymous (bool $a_value)
	getNonAnonymous ()
	setShowComments (bool $a_value)
	getShowComments ()
	setShowResultsAs (int $a_value)
	getShowResultsAs ()
	getImageFullPath (bool $a_as_thumb=false)
	deleteImage ()
	uploadImage (array $a_upload, bool $a_clone=false)
	getAnswers ()
	getAnswer (int $a_id)
	saveAnswer (string $a_text, ?int $a_pos=null)
	updateAnswer (int $a_id, string $a_text)
	rebuildAnswerPositions ()
	updateAnswerPositions (array $a_pos)
	deleteAnswer (int $a_id)
	deleteAllVotes ()
	saveAnswers (array $a_answers)
	saveVote (int $a_user_id, array $a_answers)
	hasUserVoted (int $a_user_id)
	countVotes ()
	getVotePercentages ()
	getVotesByUsers ()
Public Member Functions inherited from ilObject2
	__construct (int $a_id=0, bool $a_reference=true)
	Constructor. More...
	read ()
	create (bool $a_clone_mode=false)
	update ()
	delete ()
	cloneMetaData (ilObject $target_obj)
	cloneObject (int $target_id, int $copy_id=0, bool $omit_tree=false)
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	initStorage (int $a_id, ?string $a_subdir=null)
static	getImageSize ()
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, \ilDBInterface $ilDB=null)

Data Fields
const	VIEW_RESULTS_ALWAYS = 1
const	VIEW_RESULTS_NEVER = 2
const	VIEW_RESULTS_AFTER_VOTE = 3
const	VIEW_RESULTS_AFTER_PERIOD = 4
const	SHOW_RESULTS_AS_BARCHART = 1
const	SHOW_RESULTS_AS_PIECHART = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	initType ()
	doRead ()
	propertiesToDB ()
	doCreate (bool $clone_mode=false)
	doUpdate ()
	doDelete ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=0)
	deleteAllAnswers ()
Protected Member Functions inherited from ilObject2
	initType ()
	doRead ()
	doCreate (bool $clone_mode=false)
	beforeCreate ()
	If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...
	doUpdate ()
	beforeUpdate ()
	doDelete ()
	beforeDelete ()
	doCloneObject (ilObject2 $new_obj, int $a_target_id, ?int $a_copy_id=null)
	beforeCloneObject ()
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
ILIAS Notes Service	$notes
int	$access_type = 0
int	$access_begin = 0
int	$access_end = 0
bool	$access_visibility = false
string	$question = ""
string	$image = ""
int	$view_results = 0
bool	$period = false
int	$period_begin = 0
int	$period_end = 0
int	$max_number_answers = 0
bool	$result_sort_by_votes = false
bool	$mode_non_anonymous = false
bool	$show_comments = false
int	$show_results_as = 1
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Attributes
ILIAS Filesystem Util Convert LegacyImages	$image_converter

Detailed Description

Class ilObjPoll.

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 28 of file class.ilObjPoll.php.

Constructor & Destructor Documentation

__construct()

ilObjPoll::__construct	(	int	$a_id = 0,
		bool	$a_reference = true
	)

Definition at line 57 of file class.ilObjPoll.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), setAccessType(), setViewResults(), setVotingPeriod(), and ilObjectActivation\TIMINGS_DEACTIVATED.

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->image_converter = $DIC->fileConverters()->legacyImages();
        // default
        $this->setViewResults(self::VIEW_RESULTS_AFTER_VOTE);
        $this->setAccessType(ilObjectActivation::TIMINGS_DEACTIVATED);
        $this->setVotingPeriod(false);
        $this->notes = $DIC->notes();

        parent::__construct($a_id, $a_reference);
    }

Here is the call graph for this function:

Member Function Documentation

countVotes()

ilObjPoll::countVotes

(

)

Definition at line 710 of file class.ilObjPoll.php.

References ilObject\getId().

Referenced by getVotePercentages().

                                : int
    {
        $sql = "SELECT COUNT(DISTINCT(user_id)) cnt" .
            " FROM il_poll_vote" .
            " WHERE poll_id = " . $this->db->quote($this->getId(), "integer");
        $set = $this->db->query($sql);
        $row = $this->db->fetchAssoc($set);
        return (int) $row["cnt"];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAllAnswers()

ilObjPoll::deleteAllAnswers ( )

protected

Definition at line 609 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, deleteAllVotes(), and ilObject\getId().

Referenced by doDelete().

                                         : void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $this->deleteAllVotes();

            $ilDB->manipulate("DELETE FROM il_poll_answer" .
                " WHERE poll_id = " . $ilDB->quote($this->getId(), "integer"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAllVotes()

ilObjPoll::deleteAllVotes

(

)

Definition at line 621 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, and ilObject\getId().

Referenced by deleteAllAnswers().

                                    : void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $ilDB->manipulate("DELETE FROM il_poll_vote" .
                " WHERE poll_id = " . $ilDB->quote($this->getId(), "integer"));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAnswer()

ilObjPoll::deleteAnswer

(

int

$a_id

)

Definition at line 596 of file class.ilObjPoll.php.

References ilObject\$db, and $ilDB.

Referenced by saveAnswers().

                                           : void
    {
        $ilDB = $this->db;

        if ($a_id) {
            $ilDB->manipulate("DELETE FROM il_poll_vote" .
                " WHERE answer_id = " . $ilDB->quote($this->getId(), "integer"));

            $ilDB->manipulate("DELETE FROM il_poll_answer" .
                " WHERE id = " . $ilDB->quote($a_id, "integer"));
        }
    }

Here is the caller graph for this function:

deleteImage()

ilObjPoll::deleteImage

(

)

Definition at line 406 of file class.ilObjPoll.php.

References setImage().

Referenced by doDelete(), and uploadImage().

                                 : void
    {
        if ($this->id) {
            $storage = new ilFSStoragePoll($this->id);
            $storage->delete();

            $this->setImage("");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doCloneObject()

ilObjPoll::doCloneObject ( ilObject2  $new_obj, int  $a_target_id, ?int  $a_copy_id = 0  )

protected

Definition at line 343 of file class.ilObjPoll.php.

References ilCopyWizardOptions\_getInstance(), getAnswers(), getImage(), getImageFullPath(), getMaxNumberOfAnswers(), getNonAnonymous(), getQuestion(), getShowComments(), getShowResultsAs(), getSortResultByVotes(), getViewResults(), ilObject\setOfflineStatus(), ilObject2\update(), VIEW_RESULTS_AFTER_PERIOD, and VIEW_RESULTS_ALWAYS.

                                                                                               : void
    {
        assert($new_obj instanceof ilObjPoll);

        // question/image
        $new_obj->setQuestion($this->getQuestion());
        $image = $this->getImageFullPath();
        if ($image) {
            $image = array("tmp_name" => $image,
                "name" => $this->getImage());
            $new_obj->uploadImage($image, true);
        }

        //copy online status if object is not the root copy object
        $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);

        if ($cp_options->isRootNode($this->getRefId())) {
            $new_obj->setOfflineStatus(true);
        }

        $view_results = $this->getViewResults();
        if ($view_results === ilObjPoll::VIEW_RESULTS_AFTER_PERIOD) {
            // default view results setting to always, since
            // voting period is not copied.
            $view_results = ilObjPoll::VIEW_RESULTS_ALWAYS;
        }
        $new_obj->setViewResults($view_results);
        $new_obj->setShowComments($this->getShowComments());
        $new_obj->setShowResultsAs($this->getShowResultsAs());
        $new_obj->setMaxNumberOfAnswers($this->getMaxNumberOfAnswers());
        $new_obj->setSortResultByVotes($this->getSortResultByVotes());
        $new_obj->setNonAnonymous($this->getNonAnonymous());
        $new_obj->update();

        // answers
        $answers = $this->getAnswers();
        if ($answers) {
            foreach ($answers as $item) {
                $new_obj->saveAnswer($item["answer"]);
            }
        }
    }

Here is the call graph for this function:

doCreate()

ilObjPoll::doCreate ( bool  $clone_mode = false )

protected

Definition at line 276 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, ilObject\getId(), and propertiesToDB().

                                                         : void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $fields = $this->propertiesToDB();
            $fields["id"] = array("integer", $this->getId());

            $ilDB->insert("il_poll", $fields);


            // object activation default entry will be created on demand


            // block handling
            $block = new ilPollBlock();
            $block->setType("poll");
            $block->setContextObjId($this->getId());
            $block->setContextObjType("poll");
            $block->create();
        }
    }

Here is the call graph for this function:

doDelete()

ilObjPoll::doDelete ( )

protected

Definition at line 326 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, deleteAllAnswers(), ilObjectActivation\deleteAllEntries(), deleteImage(), and ilObject\getId().

                                 : void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $this->deleteImage();
            $this->deleteAllAnswers();

            if ($this->ref_id) {
                ilObjectActivation::deleteAllEntries($this->ref_id);
            }

            $ilDB->manipulate("DELETE FROM il_poll" .
                " WHERE id = " . $ilDB->quote($this->id, "integer"));
        }
    }

Here is the call graph for this function:

doRead()

ilObjPoll::doRead ( )

protected

Definition at line 227 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, getAccessType(), ilObject\getId(), ilObjectActivation\getItem(), setAccessBegin(), setAccessEnd(), setAccessType(), setAccessVisibility(), setImage(), setMaxNumberOfAnswers(), setNonAnonymous(), setQuestion(), setShowComments(), setShowResultsAs(), setSortResultByVotes(), setViewResults(), setVotingPeriod(), setVotingPeriodBegin(), setVotingPeriodEnd(), ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

                               : void
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT * FROM il_poll" .
                " WHERE id = " . $ilDB->quote($this->getId(), "integer"));
        $row = $ilDB->fetchAssoc($set);
        $this->setQuestion((string) ($row["question"] ?? ''));
        $this->setImage((string) ($row["image"] ?? ''));
        $this->setViewResults((int) ($row["view_results"] ?? self::VIEW_RESULTS_AFTER_VOTE));
        $this->setVotingPeriod((bool) ($row["period"] ?? 0));
        $this->setVotingPeriodBegin((int) ($row["period_begin"] ?? 0));
        $this->setVotingPeriodEnd((int) ($row["period_end"] ?? 0));
        $this->setMaxNumberOfAnswers((int) ($row["max_answers"] ?? 0));
        $this->setSortResultByVotes((bool) ($row["result_sort"] ?? 0));
        $this->setNonAnonymous((bool) ($row["non_anon"] ?? 0));
        $this->setShowResultsAs((int) ($row["show_results_as"] ?? self::SHOW_RESULTS_AS_BARCHART));

        // #14661
        $this->setShowComments($this->notes->domain()->commentsActive($this->getId()));

        if ($this->ref_id) {
            $activation = ilObjectActivation::getItem($this->ref_id);
            $this->setAccessType((int) ($activation["timing_type"] ?? ilObjectActivation::TIMINGS_DEACTIVATED));
            if ($this->getAccessType() === ilObjectActivation::TIMINGS_ACTIVATION) {
                // default entry values should not be loaded if not activated
                $this->setAccessBegin((int) ($activation["timing_start"] ?? time()));
                $this->setAccessEnd((int) ($activation["timing_end"] ?? time()));
                $this->setAccessVisibility((bool) ($activation["visible"] ?? false));
            }
        }
    }

Here is the call graph for this function:

doUpdate()

ilObjPoll::doUpdate ( )

protected

Definition at line 299 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, getAccessBegin(), getAccessEnd(), getAccessType(), getAccessVisibility(), ilObject\getId(), ilObject\getRefId(), getShowComments(), and propertiesToDB().

                                 : void
    {
        $ilDB = $this->db;

        if ($this->getId()) {
            $fields = $this->propertiesToDB();

            $ilDB->update(
                "il_poll",
                $fields,
                array("id" => array("integer", $this->getId()))
            );

            // #14661
            $this->notes->domain()->activateComments($this->getId(), $this->getShowComments());

            if ($this->getRefId()) {
                $activation = new ilObjectActivation();
                $activation->setTimingType($this->getAccessType());
                $activation->setTimingStart($this->getAccessBegin());
                $activation->setTimingEnd($this->getAccessEnd());
                $activation->toggleVisible($this->getAccessVisibility());
                $activation->update($this->ref_id);
            }
        }
    }

Here is the call graph for this function:

getAccessBegin()

ilObjPoll::getAccessBegin

(

)

Definition at line 92 of file class.ilObjPoll.php.

References $access_begin.

Referenced by doUpdate(), and ilPollStateInfo\isOfflineOrUnavailable().

                                    : int
    {
        return $this->access_begin;
    }

Here is the caller graph for this function:

getAccessEnd()

ilObjPoll::getAccessEnd

(

)

Definition at line 102 of file class.ilObjPoll.php.

References $access_end.

Referenced by doUpdate(), and ilPollStateInfo\isOfflineOrUnavailable().

                                  : int
    {
        return $this->access_end;
    }

Here is the caller graph for this function:

getAccessType()

ilObjPoll::getAccessType

(

)

Definition at line 82 of file class.ilObjPoll.php.

References $access_type.

Referenced by doRead(), doUpdate(), and ilPollStateInfo\isOfflineOrUnavailable().

                                   : int
    {
        return $this->access_type;
    }

Here is the caller graph for this function:

getAccessVisibility()

ilObjPoll::getAccessVisibility

(

)

Definition at line 112 of file class.ilObjPoll.php.

References $access_visibility.

Referenced by doUpdate().

                                         : bool
    {
        return $this->access_visibility;
    }

Here is the caller graph for this function:

getAnswer()

ilObjPoll::getAnswer

(

int

$a_id

)

Definition at line 513 of file class.ilObjPoll.php.

References ilObject\$db, and $ilDB.

                                        : array
    {
        $ilDB = $this->db;

        $sql = "SELECT * FROM il_poll_answer" .
            " WHERE id = " . $ilDB->quote($a_id, "integer");
        $set = $ilDB->query($sql);
        return (array) $ilDB->fetchAssoc($set);
    }

getAnswers()

ilObjPoll::getAnswers

(

)

Definition at line 497 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, $res, and ilObject\getId().

Referenced by ilPollAnswersHandler\__construct(), doCloneObject(), ilPollStateInfo\hasQuestion(), rebuildAnswerPositions(), and saveAnswers().

                                : array
    {
        $ilDB = $this->db;

        $res = [];

        $sql = "SELECT * FROM il_poll_answer" .
            " WHERE poll_id = " . $ilDB->quote($this->getId(), "integer") .
            " ORDER BY pos ASC";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImage()

ilObjPoll::getImage

(

)

Definition at line 132 of file class.ilObjPoll.php.

References $image.

Referenced by doCloneObject(), getImageFullPath(), and propertiesToDB().

                              : string
    {
        return $this->image;
    }

Here is the caller graph for this function:

getImageFullPath()

ilObjPoll::getImageFullPath

(

bool

$a_as_thumb = false

)

Definition at line 391 of file class.ilObjPoll.php.

References $path, and getImage().

Referenced by doCloneObject(), and ilPollContentRenderer\render().

                                                              : ?string
    {
        $img = $this->getImage();
        if ($img) {
            $path = self::initStorage($this->id);
            if (!$a_as_thumb) {
                return $path . $img;
            } else {
                return $path . "thb_" . $img;
            }
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getImageSize()

static ilObjPoll::getImageSize ( )

static

Definition at line 486 of file class.ilObjPoll.php.

Referenced by ilObjPollGUI\initQuestionForm().

                                         : string
    {
        // :TODO:
        return "600x600";
    }

Here is the caller graph for this function:

getMaxNumberOfAnswers()

ilObjPoll::getMaxNumberOfAnswers

(

)

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

References $max_number_answers.

Referenced by ilPollAnswersHandler\__construct(), doCloneObject(), and propertiesToDB().

                                           : int
    {
        return $this->max_number_answers;
    }

Here is the caller graph for this function:

getNonAnonymous()

ilObjPoll::getNonAnonymous

(

)

Definition at line 202 of file class.ilObjPoll.php.

References $mode_non_anonymous.

Referenced by doCloneObject(), propertiesToDB(), and ilPollContentRenderer\renderAnswers().

                                     : bool
    {
        return $this->mode_non_anonymous;
    }

Here is the caller graph for this function:

getQuestion()

ilObjPoll::getQuestion

(

)

Definition at line 122 of file class.ilObjPoll.php.

References $question.

Referenced by doCloneObject(), propertiesToDB(), and ilPollContentRenderer\render().

                                 : string
    {
        return $this->question;
    }

Here is the caller graph for this function:

getShowComments()

ilObjPoll::getShowComments

(

)

Definition at line 212 of file class.ilObjPoll.php.

References $show_comments.

Referenced by doCloneObject(), doUpdate(), and ilPollContentRenderer\render().

                                     : bool
    {
        return $this->show_comments;
    }

Here is the caller graph for this function:

getShowResultsAs()

ilObjPoll::getShowResultsAs

(

)

Definition at line 222 of file class.ilObjPoll.php.

References $show_results_as.

Referenced by doCloneObject(), propertiesToDB(), and ilPollContentRenderer\renderResults().

                                      : int
    {
        return $this->show_results_as;
    }

Here is the caller graph for this function:

getSortResultByVotes()

ilObjPoll::getSortResultByVotes

(

)

Definition at line 192 of file class.ilObjPoll.php.

References $result_sort_by_votes.

Referenced by ilPollResultsHandler\__construct(), doCloneObject(), and propertiesToDB().

                                          : bool
    {
        return $this->result_sort_by_votes;
    }

Here is the caller graph for this function:

getViewResults()

ilObjPoll::getViewResults

(

)

Definition at line 142 of file class.ilObjPoll.php.

References $view_results.

Referenced by ilPollStateInfo\areResultsVisible(), doCloneObject(), propertiesToDB(), and ilPollStateInfo\willResultsBeShown().

                                    : int
    {
        return $this->view_results;
    }

Here is the caller graph for this function:

getVotePercentages()

ilObjPoll::getVotePercentages

(

)

Definition at line 720 of file class.ilObjPoll.php.

References $id, $res, countVotes(), ilObject\getId(), and ILIAS\Repository\int().

Referenced by ilPollResultsHandler\__construct().

                                        : array
    {
        $res = [];
        $cnt = 0;

        $sql = "SELECT answer_id, count(*) cnt" .
            " FROM il_poll_vote" .
            " WHERE poll_id = " . $this->db->quote($this->getId(), "integer") .
            " GROUP BY answer_id";
        $set = $this->db->query($sql);
        while ($row = $this->db->fetchAssoc($set)) {
            $cnt += (int) $row["cnt"];
            $res[(int) $row["answer_id"]] = array("abs" => (int) $row["cnt"], "perc" => 0);
        }

        foreach ($res as $id => $item) {
            $abs = (int) ($item['abs'] ?? 0);
            $id = (int) ($id ?? 0);
            if ($cnt === 0) {
                $res[$id]["perc"] = 0;
            } else {
                $res[$id]["perc"] = $abs / $cnt * 100;
            }
        }

        return array("perc" => $res, "total" => $this->countVotes());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getVotesByUsers()

ilObjPoll::getVotesByUsers

(

)

Definition at line 748 of file class.ilObjPoll.php.

References ilObject\$db, $ilDB, $res, ilObject\getId(), and ILIAS\Repository\int().

                                     : array
    {
        $ilDB = $this->db;

        $res = [];

        $sql = "SELECT answer_id, user_id, firstname, lastname, login" .
            " FROM il_poll_vote" .
            " JOIN usr_data ON (usr_data.usr_id = il_poll_vote.user_id)" .
            " WHERE poll_id = " . $ilDB->quote($this->getId(), "integer");
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $user_id = (int) ($row["user_id"] ?? 0);
            if (!isset($res[$user_id])) {
                $res[$user_id] = $row;
            }
            $res[$user_id]["answers"][] = (int) ($row["answer_id"] ?? 0);
        }

        return $res;
    }

Here is the call graph for this function:

getVotingPeriod()

ilObjPoll::getVotingPeriod

(

)

Definition at line 152 of file class.ilObjPoll.php.

References $period.

Referenced by ilPollStateInfo\hasVotingPeriodEnded(), ilPollStateInfo\hasVotingPeriodNotStarted(), and propertiesToDB().

                                     : bool
    {
        return $this->period;
    }

Here is the caller graph for this function:

getVotingPeriodBegin()

ilObjPoll::getVotingPeriodBegin

(

)

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

References $period_begin.

Referenced by ilPollStateInfo\hasVotingPeriodNotStarted(), propertiesToDB(), and ilPollContentRenderer\render().

                                          : int
    {
        return $this->period_begin;
    }

Here is the caller graph for this function:

getVotingPeriodEnd()

ilObjPoll::getVotingPeriodEnd

(

)

Definition at line 172 of file class.ilObjPoll.php.

References $period_end.

Referenced by ilPollStateInfo\hasVotingPeriodEnded(), propertiesToDB(), ilPollContentRenderer\render(), ilPollContentRenderer\renderAnswers(), and ilPollContentRenderer\renderAnswersAndResults().

                                        : int
    {
        return $this->period_end;
    }

Here is the caller graph for this function:

hasUserVoted()

ilObjPoll::hasUserVoted

(

int

$a_user_id

)

Definition at line 699 of file class.ilObjPoll.php.

References ilObject\getId().

Referenced by ilPollStateInfo\hasUserAlreadyVoted(), and saveVote().

                                                : bool
    {
        $sql = "SELECT user_id" .
            " FROM il_poll_vote" .
            " WHERE poll_id = " . $this->db->quote($this->getId(), "integer") .
            " AND user_id = " . $this->db->quote($a_user_id, "integer");
        $this->db->setLimit(1, 0);
        $set = $this->db->query($sql);
        return (bool) $this->db->numRows($set);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initStorage()

static ilObjPoll::initStorage ( int  $a_id, ?string  $a_subdir = null  )

static

Definition at line 416 of file class.ilObjPoll.php.

References $path.

Referenced by ilPollDataSet\getXmlRecord().

                                                                           : string
    {
        $storage = new ilFSStoragePoll($a_id);
        $storage->create();

        $path = $storage->getAbsolutePath() . "/";

        if ($a_subdir) {
            $path .= $a_subdir . "/";

            if (!is_dir($path)) {
                mkdir($path);
            }
        }

        return $path;
    }

Here is the caller graph for this function:

initType()

ilObjPoll::initType ( )

protected

Definition at line 72 of file class.ilObjPoll.php.

                                 : void
    {
        $this->type = "poll";
    }

propertiesToDB()

ilObjPoll::propertiesToDB ( )

protected

Definition at line 260 of file class.ilObjPoll.php.

References getImage(), getMaxNumberOfAnswers(), getNonAnonymous(), getQuestion(), getShowResultsAs(), getSortResultByVotes(), getViewResults(), getVotingPeriod(), getVotingPeriodBegin(), and getVotingPeriodEnd().

Referenced by doCreate(), and doUpdate().

                                       : array
    {
        return array(
            "question" => array("text", $this->getQuestion()),
            "image" => array("text", $this->getImage()),
            "view_results" => array("integer", $this->getViewResults()),
            "period" => array("integer", $this->getVotingPeriod()),
            "period_begin" => array("integer", $this->getVotingPeriodBegin()),
            "period_end" => array("integer", $this->getVotingPeriodEnd()),
            "max_answers" => array("integer", $this->getMaxNumberOfAnswers()),
            "result_sort" => array("integer", $this->getSortResultByVotes()),
            "non_anon" => array("integer", $this->getNonAnonymous()),
            "show_results_as" => array("integer", $this->getShowResultsAs()),
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rebuildAnswerPositions()

ilObjPoll::rebuildAnswerPositions

(

)

Definition at line 565 of file class.ilObjPoll.php.

References $id, getAnswers(), ILIAS\Repository\int(), and updateAnswerPositions().

                                            : void
    {
        $answers = $this->getAnswers();

        $pos = [];
        foreach ($answers as $item) {
            $id = (int) ($item['id'] ?? 0);
            $pos[$id] = (int) ($item["pos"] ?? 10);
        }

        $this->updateAnswerPositions($pos);
    }

Here is the call graph for this function:

saveAnswer()

ilObjPoll::saveAnswer	(	string	$a_text,
		?int	$a_pos = null
	)

Definition at line 523 of file class.ilObjPoll.php.

References ilObject\$db, $id, $ilDB, ilObject\getId(), and ILIAS\Repository\int().

Referenced by saveAnswers().

                                                                  : ?int
    {
        $ilDB = $this->db;

        if (!trim($a_text)) {
            return null;
        }

        $id = $ilDB->nextId("il_poll_answer");

        if (!$a_pos) {
            // append
            $sql = "SELECT max(pos) pos" .
                " FROM il_poll_answer" .
                " WHERE poll_id = " . $ilDB->quote($this->getId(), "integer");
            $set = $ilDB->query($sql);
            $a_pos = $ilDB->fetchAssoc($set);
            $a_pos = (int) ($a_pos["pos"] ?? 0) + 10;
        }

        $fields = array(
            "id" => array("integer", $id),
            "poll_id" => array("integer", $this->getId()),
            "answer" => array("text", trim($a_text)),
            "pos" => array("integer", $a_pos)
        );
        $ilDB->insert("il_poll_answer", $fields);

        return $id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAnswers()

ilObjPoll::saveAnswers

(

array

$a_answers

)

Definition at line 631 of file class.ilObjPoll.php.

References $id, deleteAnswer(), getAnswers(), ILIAS\Repository\int(), saveAnswer(), and updateAnswerPositions().

                                                 : int
    {
        $existing = $this->getAnswers();

        $ids = [];
        $pos = 0;
        $id = null;
        foreach ($a_answers as $answer) {
            if (trim($answer)) {
                // existing answer?
                $found = false;
                foreach ($existing as $idx => $item) {
                    if (trim($answer) === (string) ($item["answer"] ?? '')) {
                        $found = true;
                        unset($existing[$idx]);

                        $id = (int) ($item["id"] ?? 0);
                    }
                }

                // create new answer
                if (!$found) {
                    $id = $this->saveAnswer($answer);
                }

                // add existing answer id to order
                if (isset($id) && is_int($id)) {
                    $ids[$id] = ++$pos;
                }
            }
        }

        // remove obsolete answers
        if (count($existing)) {
            foreach ($existing as $item) {
                if (isset($item["id"])) {
                    $this->deleteAnswer((int) $item["id"]);
                }
            }
        }

        // save current order
        if (count($ids)) {
            $this->updateAnswerPositions($ids);
        }

        return count($ids);
    }

Here is the call graph for this function:

saveVote()

ilObjPoll::saveVote	(	int	$a_user_id,
		array	$a_answers
	)

Definition at line 685 of file class.ilObjPoll.php.

References ilObject\getId(), and hasUserVoted().

                                                              : void
    {
        if ($this->hasUserVoted($a_user_id)) {
            return;
        }

        foreach ($a_answers as $answer_id) {
            $fields = array("user_id" => array("integer", $a_user_id),
                "poll_id" => array("integer", $this->getId()),
                "answer_id" => array("integer", $answer_id));
            $this->db->insert("il_poll_vote", $fields);
        }
    }

Here is the call graph for this function:

setAccessBegin()

ilObjPoll::setAccessBegin

(

int

$a_value

)

Definition at line 87 of file class.ilObjPoll.php.

Referenced by doRead().

                                                : void
    {
        $this->access_begin = $a_value;
    }

Here is the caller graph for this function:

setAccessEnd()

ilObjPoll::setAccessEnd

(

int

$a_value

)

Definition at line 97 of file class.ilObjPoll.php.

Referenced by doRead().

                                              : void
    {
        $this->access_end = $a_value;
    }

Here is the caller graph for this function:

setAccessType()

ilObjPoll::setAccessType

(

int

$a_value

)

Definition at line 77 of file class.ilObjPoll.php.

Referenced by __construct(), and doRead().

                                               : void
    {
        $this->access_type = $a_value;
    }

Here is the caller graph for this function:

setAccessVisibility()

ilObjPoll::setAccessVisibility

(

bool

$a_value

)

Definition at line 107 of file class.ilObjPoll.php.

Referenced by doRead().

                                                      : void
    {
        $this->access_visibility = $a_value;
    }

Here is the caller graph for this function:

setImage()

ilObjPoll::setImage

(

string

$a_value

)

Definition at line 127 of file class.ilObjPoll.php.

Referenced by deleteImage(), doRead(), and uploadImage().

                                             : void
    {
        $this->image = $a_value;
    }

Here is the caller graph for this function:

setMaxNumberOfAnswers()

ilObjPoll::setMaxNumberOfAnswers

(

int

$a_value

)

Definition at line 177 of file class.ilObjPoll.php.

Referenced by doRead().

                                                       : void
    {
        $this->max_number_answers = $a_value;
    }

Here is the caller graph for this function:

setNonAnonymous()

ilObjPoll::setNonAnonymous

(

bool

$a_value

)

Definition at line 197 of file class.ilObjPoll.php.

Referenced by doRead().

                                                  : void
    {
        $this->mode_non_anonymous = $a_value;
    }

Here is the caller graph for this function:

setQuestion()

ilObjPoll::setQuestion

(

string

$a_value

)

Definition at line 117 of file class.ilObjPoll.php.

Referenced by doRead().

                                                : void
    {
        $this->question = $a_value;
    }

Here is the caller graph for this function:

setShowComments()

ilObjPoll::setShowComments

(

bool

$a_value

)

Definition at line 207 of file class.ilObjPoll.php.

Referenced by doRead().

                                                  : void
    {
        $this->show_comments = $a_value;
    }

Here is the caller graph for this function:

setShowResultsAs()

ilObjPoll::setShowResultsAs

(

int

$a_value

)

Definition at line 217 of file class.ilObjPoll.php.

Referenced by doRead().

                                                  : void
    {
        $this->show_results_as = $a_value;
    }

Here is the caller graph for this function:

setSortResultByVotes()

ilObjPoll::setSortResultByVotes

(

bool

$a_value

)

Definition at line 187 of file class.ilObjPoll.php.

Referenced by doRead().

                                                       : void
    {
        $this->result_sort_by_votes = $a_value;
    }

Here is the caller graph for this function:

setViewResults()

ilObjPoll::setViewResults

(

int

$a_value

)

Definition at line 137 of file class.ilObjPoll.php.

Referenced by __construct(), and doRead().

                                                : void
    {
        $this->view_results = $a_value;
    }

Here is the caller graph for this function:

setVotingPeriod()

ilObjPoll::setVotingPeriod

(

bool

$a_value

)

Definition at line 147 of file class.ilObjPoll.php.

Referenced by __construct(), and doRead().

                                                  : void
    {
        $this->period = $a_value;
    }

Here is the caller graph for this function:

setVotingPeriodBegin()

ilObjPoll::setVotingPeriodBegin

(

int

$a_value

)

Definition at line 157 of file class.ilObjPoll.php.

Referenced by doRead().

                                                      : void
    {
        $this->period_begin = $a_value;
    }

Here is the caller graph for this function:

setVotingPeriodEnd()

ilObjPoll::setVotingPeriodEnd

(

int

$a_value

)

Definition at line 167 of file class.ilObjPoll.php.

Referenced by doRead().

                                                    : void
    {
        $this->period_end = $a_value;
    }

Here is the caller graph for this function:

updateAnswer()

ilObjPoll::updateAnswer	(	int	$a_id,
		string	$a_text
	)

Definition at line 554 of file class.ilObjPoll.php.

References ilObject\$db, and $ilDB.

                                                           : void
    {
        $ilDB = $this->db;

        $ilDB->update(
            "il_poll_answer",
            array("answer" => array("text", $a_text)),
            array("id" => array("integer", $a_id))
        );
    }

updateAnswerPositions()

ilObjPoll::updateAnswerPositions

(

array

$a_pos

)

Definition at line 578 of file class.ilObjPoll.php.

References ilObject\$db, $id, and $ilDB.

Referenced by rebuildAnswerPositions(), and saveAnswers().

                                                       : void
    {
        $ilDB = $this->db;

        asort($a_pos);

        $pos = 0;
        foreach (array_keys($a_pos) as $id) {
            $pos += 10;

            $ilDB->update(
                "il_poll_answer",
                array("pos" => array("integer", $pos)),
                array("id" => array("integer", $id))
            );
        }
    }

Here is the caller graph for this function:

uploadImage()

ilObjPoll::uploadImage	(	array	$a_upload,
		bool	$a_clone = false
	)

Definition at line 434 of file class.ilObjPoll.php.

References $path, deleteImage(), ilFileUtils\moveUploadedFile(), and setImage().

                                                                       : bool
    {
        if (!$this->id) {
            return false;
        }

        $this->deleteImage();

        // #10074
        $name = (string) ($a_upload['name'] ?? '');
        $tmp_name = (string) ($a_upload['tmp_name'] ?? '');
        $clean_name = preg_replace("/[^a-zA-Z0-9\_\.\-]/", "", $name);

        $path = self::initStorage($this->id);
        $original = "org_" . $this->id . "_" . $clean_name;
        $thumb = "thb_" . $this->id . "_" . $clean_name;
        $processed = $this->id . "_" . $clean_name;

        $success = false;
        if (!$a_clone) {
            $success = ilFileUtils::moveUploadedFile($tmp_name, $original, $path . $original);
        } else {
            $success = copy($tmp_name, $path . $original);
        }
        if ($success) {
            chmod($path . $original, 0770);

            // take quality 100 to avoid jpeg artefacts when uploading jpeg files
            $original_file = $path . $original;
            $thumb_file = $path . $thumb;
            $processed_file = $path . $processed;

            $this->image_converter->croppedSquare(
                $original_file,
                $thumb_file,
                100,
                ImageOutputOptions::FORMAT_PNG
            );

            $this->image_converter->croppedSquare(
                $original_file,
                $processed_file,
                300,
                ImageOutputOptions::FORMAT_PNG
            );

            $this->setImage($processed);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$access_begin

int ilObjPoll::$access_begin = 0

protected

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

Referenced by getAccessBegin().

$access_end

int ilObjPoll::$access_end = 0

protected

Definition at line 33 of file class.ilObjPoll.php.

Referenced by getAccessEnd().

$access_type

int ilObjPoll::$access_type = 0

protected

Definition at line 31 of file class.ilObjPoll.php.

Referenced by getAccessType().

$access_visibility

bool ilObjPoll::$access_visibility = false

protected

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

Referenced by getAccessVisibility().

$image

string ilObjPoll::$image = ""

protected

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

Referenced by getImage().

$image_converter

ILIAS Filesystem Util Convert LegacyImages ilObjPoll::$image_converter

private

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

$max_number_answers

int ilObjPoll::$max_number_answers = 0

protected

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

Referenced by getMaxNumberOfAnswers().

$mode_non_anonymous

bool ilObjPoll::$mode_non_anonymous = false

protected

Definition at line 44 of file class.ilObjPoll.php.

Referenced by getNonAnonymous().

$notes

ILIAS Notes Service ilObjPoll::$notes

protected

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

$period

bool ilObjPoll::$period = false

protected

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

Referenced by getVotingPeriod().

$period_begin

int ilObjPoll::$period_begin = 0

protected

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

Referenced by getVotingPeriodBegin().

$period_end

int ilObjPoll::$period_end = 0

protected

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

Referenced by getVotingPeriodEnd().

$question

string ilObjPoll::$question = ""

protected

Definition at line 35 of file class.ilObjPoll.php.

Referenced by getQuestion().

$result_sort_by_votes

bool ilObjPoll::$result_sort_by_votes = false

protected

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

Referenced by getSortResultByVotes().

$show_comments

bool ilObjPoll::$show_comments = false

protected

Definition at line 45 of file class.ilObjPoll.php.

Referenced by getShowComments().

$show_results_as

int ilObjPoll::$show_results_as = 1

protected

Definition at line 46 of file class.ilObjPoll.php.

Referenced by getShowResultsAs().

$view_results

int ilObjPoll::$view_results = 0

protected

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

Referenced by getViewResults().

SHOW_RESULTS_AS_BARCHART

const ilObjPoll::SHOW_RESULTS_AS_BARCHART = 1

Definition at line 53 of file class.ilObjPoll.php.

Referenced by ilObjPollGUI\initEditCustomForm().

SHOW_RESULTS_AS_PIECHART

const ilObjPoll::SHOW_RESULTS_AS_PIECHART = 2

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

Referenced by ilObjPollGUI\initEditCustomForm(), and ilPollResultsRenderer\render().

VIEW_RESULTS_AFTER_PERIOD

const ilObjPoll::VIEW_RESULTS_AFTER_PERIOD = 4

Definition at line 51 of file class.ilObjPoll.php.

Referenced by ilPollStateInfo\areResultsVisible(), doCloneObject(), ilObjPollGUI\initEditCustomForm(), ilObjPollGUI\validateCustom(), and ilPollStateInfo\willResultsBeShown().

VIEW_RESULTS_AFTER_VOTE

const ilObjPoll::VIEW_RESULTS_AFTER_VOTE = 3

Definition at line 50 of file class.ilObjPoll.php.

Referenced by ilPollStateInfo\areResultsVisible(), ilPollDataSet\getXmlRecord(), and ilObjPollGUI\initEditCustomForm().

VIEW_RESULTS_ALWAYS

const ilObjPoll::VIEW_RESULTS_ALWAYS = 1

Definition at line 48 of file class.ilObjPoll.php.

Referenced by ilPollStateInfo\areResultsVisible(), doCloneObject(), and ilObjPollGUI\initEditCustomForm().

VIEW_RESULTS_NEVER

const ilObjPoll::VIEW_RESULTS_NEVER = 2

Definition at line 49 of file class.ilObjPoll.php.

Referenced by ilPollStateInfo\areResultsVisible(), and ilObjPollGUI\initEditCustomForm().

---

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

• Modules/Poll/classes/class.ilObjPoll.php