ilObjPollGUI Class Reference

Class ilObjPollGUI. More...

Inheritance diagram for ilObjPollGUI:

Collaboration diagram for ilObjPollGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)
	getType ()
	executeCommand ()
	render (?ilPropertyFormGUI $a_form=null)
	saveQuestion ()
	showParticipants ()
	showParticipantVotes ()
	confirmDeleteAllVotes ()
	deleteAllVotes ()
	vote ()
	subscribe ()
	unsubscribe ()
Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)
	executeCommand ()
	execute command More...
	getIdType ()
	delete ()
	Display delete confirmation form (repository/workspace switch) More...
	confirmedDelete ()
	Delete objects (repository/workspace switch) More...
	getHTML ()
	withReferences ()
	Final/Private declaration of unchanged parent methods. More...
	setCreationMode (bool $mode=true)
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	isVisible (int $ref_id, string $type)
	setColumnSettings (ilColumnGUI $column_gui)
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	CRUD. More...
	save ()
	edit ()
	update ()
	cancel ()
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
Public Member Functions inherited from ilObjectGUI
	getRefId ()
	setAdminMode (string $mode)
	getAdminMode ()
	getObject ()
	executeCommand ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...
	getCreationMode ()
	prepareOutput (bool $show_sub_objects=true)
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	getHTML ()
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...
	cancelObject ()
	cancel action and go back to previous page More...
	createObject ()
	create new object form More...
	editAvailabilityPeriodObject ()
	saveAvailabilityPeriodObject ()
	cancelCreation ()
	cancel create action and go back to repository parent More...
	saveObject ()
	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...
	putObjectInTree (ilObject $obj, int $parent_node_id=null)
	Add object to tree at given position. More...
	editObject ()
	addExternalEditFormCustom (ilPropertyFormGUI $form)
	updateObject ()
	updates object entry in object_data More...
	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...
	isVisible (int $ref_id, string $type)
	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...
	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...
	setColumnSettings (ilColumnGUI $column_gui)
	addToDeskObject ()
	removeFromDeskObject ()
Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto (string $a_target)
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...
static	_gotoRepositoryNode (int $ref_id, string $cmd="")
static	_gotoSharedWorkspaceNode (int $wsp_id)

Protected Member Functions
	afterSave (ilObject $new_object)
	initEditCustomForm (ilPropertyFormGUI $a_form)
	getEditFormCustomValues (array &$a_values)
	validateCustom (ilPropertyFormGUI $form)
	updateCustom (ilPropertyFormGUI $form)
	setTabs ()
	initQuestionForm (bool $a_read_only=false)
	setParticipantsSubTabs (string $a_active)
	sendNotifications ()
	addLocatorItems ()
Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...
	assignObject ()
	create object instance as internal property (repository/workspace switch) More...
	getAccessHandler ()
	setLocator ()
	set Locator More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...
	setTitleAndDescription ()
	omitLocator (bool $omit=true)
	getTargetFrame (string $cmd, string $target_frame="")
	setTargetFrame (string $cmd, string $target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	checkPermission (string $perm, string $cmd="", string $type="", int $ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId (int $ref_id, string $cmd="")
	addAdminLocatorItems (bool $do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...
	setReturnLocation (string $cmd, string $location)
	showActions ()
	getTabs ()
	addLocatorItems ()
	Functions to be overwritten. More...
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $node_id=null)
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	assignObject ()
	setTitleAndDescription ()
	createActionDispatcherGUI ()
	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...
	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...
	addHeaderAction ()
	Add header action menu. More...
	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...
	setTabs ()
	set admin tabs More...
	setAdminTabs ()
	set admin tabs More...
	setLocator ()
	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...
	omitLocator (bool $omit=true)
	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...
	getCreationFormsHTML (StandardForm|ilPropertyFormGUI|array $form)
	getTitleForCreationFormPage ()
	getCreationFormTitle ()
	initCreateForm (string $new_type)
	didacticTemplatesToForm ()
	initDidacticTemplate (ilPropertyFormGUI $form)
	retrieveAdditionalDidacticTemplateOptions ()
	addAdoptContentLinkToToolbar ()
	addImportButtonToToolbar ()
	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)
	parseDidacticTemplateVar (string $var, string $type)
	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...
	initEditForm ()
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...
	getEditFormValues ()
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...
	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...
	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...
	afterUpdate ()
	Post (successful) object update hook. More...
	routeImportCmdObject ()
	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)
	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)
	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...
	setFormAction (string $cmd, string $form_action)
	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...
	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...
	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...
	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...
	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...
	getTabs ()
	overwrite in derived GUI class of your object type More...
	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...
	getCenterColumnHTML ()
	Get center column. More...
	getRightColumnHTML ()
	Display right column. More...
	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...
	getCreatableObjectTypes ()
	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)
	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
ilHelpGUI	$help
ilTabsGUI	$tabs
ilNavigationHistory	$nav_history
UIFactory	$ui_factory
UIRenderer	$ui_renderer
DataFactory	$data_factory
PollImageFactoryInterface	$poll_image_factory
Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilCtrl	$ctrl
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ilFavouritesManager	$favourites
ilErrorHandling	$error
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilToolbarGUI	$toolbar
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Factory	$refinery
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
int	$request_ref_id
int	$id_type
int	$parent_id
string	$type
string	$html
int	$object_id
int	$node_id = null
array	$creation_forms = []
	$access_handler
Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service
ServerRequestInterface	$request
ilLocatorGUI	$locator
ilObjUser	$user
ilAccessHandler	$access
ilSetting	$settings
ilToolbarGUI	$toolbar
ilRbacAdmin	$rbac_admin
ilRbacSystem	$rbac_system
ilRbacReview	$rbac_review
ilObjectService	$object_service
ilObjectDefinition	$obj_definition
ilGlobalTemplateInterface	$tpl
ilTree	$tree
ilCtrl	$ctrl
ilErrorHandling	$error
ilLanguage	$lng
ilTabsGUI	$tabs_gui
ILIAS	$ilias
ArrayBasedRequestWrapper	$post_wrapper
RequestWrapper	$request_wrapper
Refinery	$refinery
ilFavouritesManager	$favourites
ilObjectCustomIconFactory	$custom_icon_factory
UIFactory	$ui_factory
UIRenderer	$ui_renderer
Filesystem	$temp_file_system
ilObject	$object = null
bool	$creation_mode = false
	$data
int	$id
bool	$call_by_reference = false
bool	$prepare_output
int	$ref_id
int	$obj_id
int	$maxcount
array	$form_action = []
array	$return_location = []
array	$target_frame = []
string	$tmp_import_dir
string	$sub_objects = ""
bool	$omit_locator = false
string	$type = ""
string	$admin_mode = self::ADMIN_MODE_NONE
int	$requested_ref_id = 0
int	$requested_crtptrefid = 0
int	$requested_crtcb = 0
string	$requested_new_type = ""
string	$link_params
string	$html = ""

Additional Inherited Members
Data Fields inherited from ilObject2GUI
const	OBJECT_ID = 0
const	REPOSITORY_NODE_ID = 1
const	WORKSPACE_NODE_ID = 2
const	REPOSITORY_OBJECT_ID = 3
const	WORKSPACE_OBJECT_ID = 4
const	PORTFOLIO_OBJECT_ID = 5
Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""
const	ADMIN_MODE_SETTINGS = "settings"
const	ADMIN_MODE_REPOSITORY = "repository"
const	UPLOAD_TYPE_LOCAL = 1
const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2
const	CFORM_NEW = 1
const	CFORM_IMPORT = 2
const	CFORM_CLONE = 3
const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Detailed Description

Class ilObjPollGUI.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilObjPollGUI: ilInfoScreenGUI, ilNoteGUI, ilCommonActionDispatcherGUI ilObjPollGUI: ilPermissionGUI, ilObjectCopyGUI, ilExportGUI

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

Constructor & Destructor Documentation

__construct()

ilObjPollGUI::__construct	(	int	$a_id = 0,
		int	$a_id_type = self::REPOSITORY_NODE_ID,
		int	$a_parent_node_id = 0
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\locator(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->help = $DIC["ilHelp"];
        $this->tpl = $DIC["tpl"];
        $this->tabs = $DIC->tabs();
        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->tree = $DIC->repositoryTree();
        $this->locator = $DIC["ilLocator"];
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->poll_image_factory = new PollImageFactory();
        $this->data_factory = new DataFactory();

        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->lng->loadLanguageModule("poll");
    }

Here is the call graph for this function:

Member Function Documentation

_goto()

static ilObjPollGUI::_goto ( string  $a_target )

static

Definition at line 647 of file class.ilObjPollGUI.php.

References $DIC, ilObjectGUI\$id, ilObjectGUI\$ref_id, ilObjectGUI\$tree, ilObject\_lookupObjId(), ilTree\getParentId(), ILIAS\Repository\int(), and ilUtil\redirect().

                                                  : void
    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilAccess = $DIC->access();
        $ilCtrl = $DIC->ctrl();

        $id = explode("_", $a_target);
        $ref_id = (int) ($id[0] ?? 0);

        // #13728 - used in notification mostly
        if ($ilAccess->checkAccess("write", "", $ref_id)) {
            $ilCtrl->setParameterByClass(self::class, "ref_id", $ref_id);
            $ilCtrl->redirectByClass([ilRepositoryGUI::class, self::class,], "showParticipants");
        } else {
            // is sideblock: so show parent instead
            $container_id = $tree->getParentId($ref_id);

            // #11810
            ilUtil::redirect(ilLink::_getLink($container_id) .
                "#poll" . ilObject::_lookupObjId($ref_id));
        }
    }

Here is the call graph for this function:

addLocatorItems()

ilObjPollGUI::addLocatorItems ( )

protected

Definition at line 640 of file class.ilObjPollGUI.php.

References ilObject2GUI\$node_id, ILIAS\Repository\ctrl(), ILIAS\Repository\locator(), and ILIAS\Repository\object().

                                        : void
    {
        if (is_object($this->object)) {
            $this->locator->addItem($this->object->getTitle(), $this->ctrl->getLinkTarget($this, ""), "", $this->node_id);
        }
    }

Here is the call graph for this function:

afterSave()

ilObjPollGUI::afterSave ( ilObject  $new_object )

protected

Definition at line 75 of file class.ilObjPollGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                                      : void
    {
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("object_added"), true);
        $this->ctrl->redirect($this, "render");
    }

Here is the call graph for this function:

confirmDeleteAllVotes()

ilObjPollGUI::confirmDeleteAllVotes

(

)

Definition at line 534 of file class.ilObjPollGUI.php.

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                           : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_permission"));
            return;
        }

        $this->tabs->activateTab("participants");

        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($this->lng->txt("poll_delete_votes_sure"));

        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setCancel($this->lng->txt("cancel"), "showParticipants");
        $cgui->setConfirm($this->lng->txt("confirm"), "deleteAllVotes");

        $this->tpl->setContent($cgui->getHTML());
    }

Here is the call graph for this function:

deleteAllVotes()

ilObjPollGUI::deleteAllVotes

(

)

Definition at line 553 of file class.ilObjPollGUI.php.

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                    : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_permission"));
            return;
        }

        $this->object->deleteAllVotes();

        $this->ctrl->redirect($this, "showParticipants");
    }

Here is the call graph for this function:

executeCommand()

ilObjPollGUI::executeCommand

(

)

Definition at line 267 of file class.ilObjPollGUI.php.

References ILIAS\Repository\ctrl(), ilObject2GUI\getAccessHandler(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), ilObject2GUI\prepareOutput(), and ILIAS\Repository\tabs().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->tpl->loadStandardTemplate();

        // add entry to navigation history
        if (!$this->getCreationMode() &&
            $this->getAccessHandler()->checkAccess("read", "", $this->node_id)) {
            $link = $this->ctrl->getLinkTargetByClass("ilrepositorygui", "frameset");
            $this->nav_history->addItem($this->node_id, $link, "poll");
        }

        switch ($next_class) {
            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case "ilpermissiongui":
                $this->prepareOutput();
                $this->tabs->activateTab("id_permissions");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case "ilobjectcopygui":
                $cp = new ilObjectCopyGUI($this);
                $cp->setType("poll");
                $this->ctrl->forwardCommand($cp);
                break;

            case 'ilexportgui':
                $this->prepareOutput();
                $this->tabs->activateTab("export");
                $exp_gui = new ilExportGUI($this);
                $this->ctrl->forwardCommand($exp_gui);
                break;

            default:
                parent::executeCommand();
        }
    }

Here is the call graph for this function:

getEditFormCustomValues()

ilObjPollGUI::getEditFormCustomValues ( array &  $a_values )

protected

Definition at line 161 of file class.ilObjPollGUI.php.

References IL_CAL_UNIX, and ILIAS\Repository\object().

                                                                : void
    {
        $a_values["online"] = !$this->object->getOfflineStatus();
        $a_values["results"] = $this->object->getViewResults();
        $a_values["access_period"]["start"] = $this->object->getAccessBegin()
            ? new ilDateTime($this->object->getAccessBegin(), IL_CAL_UNIX)
            : null;
        $a_values["access_period"]["end"] = $this->object->getAccessEnd()
            ? new ilDateTime($this->object->getAccessEnd(), IL_CAL_UNIX)
            : null;
        $a_values["voting_period"]["start"] = $this->object->getVotingPeriodBegin()
            ? new ilDateTime($this->object->getVotingPeriodBegin(), IL_CAL_UNIX)
            : null;
        $a_values["voting_period"]["end"] = $this->object->getVotingPeriodEnd()
            ? new ilDateTime($this->object->getVotingPeriodEnd(), IL_CAL_UNIX)
            : null;
        $a_values["sort"] = (string) (int) $this->object->getSortResultByVotes();
        $a_values["comment"] = $this->object->getShowComments();
        $a_values["show_results_as"] = $this->object->getShowResultsAs();
    }

Here is the call graph for this function:

getType()

ilObjPollGUI::getType

(

)

Definition at line 70 of file class.ilObjPollGUI.php.

                             : string
    {
        return "poll";
    }

initEditCustomForm()

ilObjPollGUI::initEditCustomForm ( ilPropertyFormGUI  $a_form )

protected

Definition at line 81 of file class.ilObjPollGUI.php.

References $comment, $results, ilObject\_getAllReferences(), ilPropertyFormGUI\addItem(), ilRadioGroupInputGUI\addOption(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilObjPoll\SHOW_RESULTS_AS_BARCHART, ilObjPoll\SHOW_RESULTS_AS_STACKED_CHART, ilObjPoll\VIEW_RESULTS_AFTER_PERIOD, ilObjPoll\VIEW_RESULTS_AFTER_VOTE, ilObjPoll\VIEW_RESULTS_ALWAYS, and ilObjPoll\VIEW_RESULTS_NEVER.

                                                                    : void
    {
        // activation
        $this->lng->loadLanguageModule('rep');

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('rep_activation_availability'));
        $a_form->addItem($section);

        // additional info only with multiple references
        $act_obj_info = $act_ref_info = "";
        if (count(ilObject::_getAllReferences($this->object->getId())) > 1) {
            $act_obj_info = ' ' . $this->lng->txt('rep_activation_online_object_info');
            $act_ref_info = $this->lng->txt('rep_activation_access_ref_info');
        }

        $online = new ilCheckboxInputGUI($this->lng->txt('rep_activation_online'), 'online');
        $online->setInfo($this->lng->txt('poll_activation_online_info') . $act_obj_info);
        $a_form->addItem($online);

        $dur = new ilDateDurationInputGUI($this->lng->txt('rep_time_based_availability'), "access_period");
        $dur->setShowTime(true);
        $a_form->addItem($dur);


        // period/results

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('poll_voting_period_and_results'));
        $a_form->addItem($section);

        $vdur = new ilDateDurationInputGUI($this->lng->txt('poll_voting_period_limited'), "voting_period");
        $vdur->setShowTime(true);
        $a_form->addItem($vdur);

        $results = new ilRadioGroupInputGUI($this->lng->txt("poll_view_results"), "results");
        $results->addOption(new ilRadioOption(
            $this->lng->txt("poll_view_results_always"),
            (string) ilObjPoll::VIEW_RESULTS_ALWAYS
        ));
        $results->addOption(new ilRadioOption(
            $this->lng->txt("poll_view_results_never"),
            (string) ilObjPoll::VIEW_RESULTS_NEVER
        ));
        $results->addOption(new ilRadioOption(
            $this->lng->txt("poll_view_results_after_vote"),
            (string) ilObjPoll::VIEW_RESULTS_AFTER_VOTE
        ));
        $results->addOption(new ilRadioOption(
            $this->lng->txt("poll_view_results_after_period"),
            (string) ilObjPoll::VIEW_RESULTS_AFTER_PERIOD
        ));
        $a_form->addItem($results);

        $show_result_as = new ilRadioGroupInputGUI($this->lng->txt("poll_show_results_as"), "show_results_as");
        $result_bar = new ilRadioOption(
            $this->lng->txt("poll_barchart"),
            (string) ilObjPoll::SHOW_RESULTS_AS_BARCHART
        );
        $show_result_as->addOption($result_bar);
        $show_result_as->addOption(new ilRadioOption(
            $this->lng->txt("poll_stacked_chart"),
            (string) ilObjPoll::SHOW_RESULTS_AS_STACKED_CHART
        ));
        $a_form->addItem($show_result_as);

        $sort = new ilRadioGroupInputGUI($this->lng->txt("poll_result_sorting"), "sort");
        $sort->addOption(new ilRadioOption($this->lng->txt("poll_result_sorting_answers"), "0"));
        $sort->addOption(new ilRadioOption($this->lng->txt("poll_result_sorting_votes"), "1"));
        $a_form->addItem($sort);

        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt('poll_comments'));
        $a_form->addItem($section);

        $comment = new ilCheckboxInputGUI($this->lng->txt('poll_comments'), 'comment');
        //$comment->setInfo($this->lng->txt('poll_comments_info'));
        $a_form->addItem($comment);
    }

Here is the call graph for this function:

initQuestionForm()

ilObjPollGUI::initQuestionForm ( bool  $a_read_only = false )

protected

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

References $url, ILIAS\Repository\ctrl(), ilObjPoll\getImageSize(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ilFormPropertyGUI\setDisabled(), ilFormPropertyGUI\setInfo(), and ilFormPropertyGUI\setRequired().

Referenced by render(), and saveQuestion().

                                                                  : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, "saveQuestion"));
        $form->setTitle($this->lng->txt("obj_poll"));

        $question = new ilTextAreaInputGUI($this->lng->txt("poll_question"), "question");
        $question->setRequired(true);
        $question->setCols(40);
        $question->setRows(2);
        $question->setValue($this->object->getQuestion());
        $question->setDisabled($a_read_only);
        $form->addItem($question);

        $dimensions = " (" . ilObjPoll::getImageSize() . "px)";
        $img = new ilImageFileInputGUI($this->lng->txt("poll_image") . $dimensions, "image");
        $img->setDisabled($a_read_only);
        $form->addItem($img);

        // show existing file
        $url = $this->poll_image_factory->handler()->getThumbnailImageURL($this->data_factory->objId($this->object_id));
        if (!is_null($url)) {
            $img->setImage($url);
        }

        $anonymous = new ilRadioGroupInputGUI($this->lng->txt("poll_mode"), "mode");
        $option = new ilRadioOption($this->lng->txt("poll_mode_anonymous"), "0");
        $option->setInfo($this->lng->txt("poll_mode_anonymous_info"));
        $anonymous->addOption($option);
        $option = new ilRadioOption($this->lng->txt("poll_mode_personal"), "1");
        $option->setInfo($this->lng->txt("poll_mode_personal_info"));
        $anonymous->addOption($option);
        $anonymous->setValue($this->object->getNonAnonymous() ? "1" : "0");
        $anonymous->setDisabled($a_read_only);
        $form->addItem($anonymous);

        $answers = new ilTextInputGUI($this->lng->txt("poll_answers"), "answers");
        $answers->setRequired(true);
        $answers->setMulti(true, true);
        $answers->setDisabled($a_read_only);
        $form->addItem($answers);

        $multi_answers = array();
        foreach ($this->object->getAnswers() as $idx => $item) {
            $answer = (string) ($item['answer'] ?? '');
            if (!$idx) {
                $answers->setValue($answer);
            }
            $multi_answers[] = $answer;
        }
        $answers->setMultiValues($multi_answers);

        $answer_count = count($this->object->getAnswers());
        $limit = new ilCheckboxInputGUI($this->lng->txt("poll_limit_number_of_answers"), 'limit');
        $limit->setChecked($this->object->getMaxNumberOfAnswers() !== $answer_count);
        $limit->setDisabled($a_read_only);
        $nanswers = new ilNumberInputGUI($this->lng->txt("poll_max_number_of_answers"), "nanswers");
        $nanswers->setRequired(true);
        $nanswers->setMinValue(1);
        $nanswers->setSize(3);
        $max_answers = 1;
        if ($this->object->getMaxNumberOfAnswers() < $answer_count) {
            $max_answers = $this->object->getMaxNumberOfAnswers();
        }
        $nanswers->setValue((string) $max_answers);
        $nanswers->setDisabled($a_read_only);
        $limit->addSubItem($nanswers);
        $form->addItem($limit);

        if (!$a_read_only) {
            $form->addCommandButton("saveQuestion", $this->lng->txt("save"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilObjPollGUI::render

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 312 of file class.ilObjPollGUI.php.

References $url, ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), initQuestionForm(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\tabs().

Referenced by saveQuestion().

                                                             : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_permission"));
            return;
        }

        $this->tabs->activateTab("question");

        $message = "";
        if (!$a_form) {
            if ($this->object->countVotes()) {
                $url = $this->ctrl->getLinkTarget($this, "showParticipants");

                $mbox = $this->ui_factory->messageBox()->info($this->lng->txt("poll_votes_no_edit"))
                    ->withLinks([$this->ui_factory->link()->standard(
                        $this->lng->txt("poll_result"),
                        $url
                    )]);

                $message = $this->ui_renderer->render($mbox);
            }

            $a_form = $this->initQuestionForm((bool) $this->object->countVotes());
        }

        $this->tpl->setPermanentLink('poll', $this->node_id);

        $this->tpl->setContent($message . $a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveQuestion()

ilObjPollGUI::saveQuestion

(

)

Definition at line 420 of file class.ilObjPollGUI.php.

References $res, ILIAS\Repository\ctrl(), initQuestionForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\object(), render(), and ILIAS\Repository\user().

                                  : void
    {
        $form = $this->initQuestionForm();
        if ($form->checkInput()) {
            $prelim_nr_of_answers = count((array) $form->getInput("answers"));

            if (
                $form->getInput("limit") &&
                (int) $form->getInput("nanswers") >= $prelim_nr_of_answers
            ) {
                $form->getItemByPostVar('nanswers')->setAlert(
                    $this->lng->txt('poll_limit_not_below_answer_count')
                );
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
                $form->setValuesByPost();
                $this->render($form);
                return;
            }

            $nr_of_anwers = $this->object->saveAnswers((array) $form->getInput("answers"));

            if ($form->getInput("limit")) {
                // #15073
                $this->object->setMaxNumberOfAnswers(min((int) $form->getInput("nanswers"), $nr_of_anwers));
            } else {
                $this->object->setMaxNumberOfAnswers($nr_of_anwers);
            }

            $this->object->setQuestion((string) $form->getInput("question"));
            $this->object->setNonAnonymous((bool) $form->getInput("mode"));

            $image = $form->getItemByPostVar("image");
            $res = $form->getFileUpload("image");
            if (!empty($res)) {
                $this->object->uploadImage(
                    (string) ($res['tmp_name'] ?? ""),
                    (string) ($res['name'] ?? "")
                );
            } elseif ($image->getDeletionFlag()) {
                $this->poll_image_factory->handler()->deleteImage(
                    $this->data_factory->objId($this->object->getId()),
                    $this->user->getId()
                );
            }

            if ($this->object->update()) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"), true);
                $this->ctrl->redirect($this, "render");
            }
        }

        $form->setValuesByPost();
        $this->render($form);
    }

Here is the call graph for this function:

sendNotifications()

ilObjPollGUI::sendNotifications ( )

protected

Definition at line 613 of file class.ilObjPollGUI.php.

References ilNotification\getNotificationsForObject(), ILIAS\Repository\object(), ilNotification\TYPE_POLL, and ilNotification\updateNotificationTime().

Referenced by vote().

                                          : void
    {
        // recipients
        $users = ilNotification::getNotificationsForObject(
            ilNotification::TYPE_POLL,
            $this->object->getId(),
            null,
            true
        );
        if (!count($users)) {
            return;
        }

        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("poll"));
        $ntf->setRefId($this->ref_id);

        $ntf->setSubjectLangId('poll_vote_notification_subject');
        $ntf->setIntroductionLangId('poll_vote_notification_body');
        $ntf->setGotoLangId('poll_vote_notification_link');
        $ntf->setReasonLangId('poll_vote_notification_reason');

        $notified = $ntf->sendMailAndReturnRecipients($users, null, "read");

        ilNotification::updateNotificationTime(ilNotification::TYPE_POLL, $this->object->getId(), $notified);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setParticipantsSubTabs()

ilObjPollGUI::setParticipantsSubTabs ( string  $a_active )

protected

Definition at line 475 of file class.ilObjPollGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\tabs().

Referenced by showParticipants(), and showParticipantVotes().

                                                               : void
    {
        if (!$this->object->getNonAnonymous()) {
            return;
        }

        $this->tabs->addSubTab(
            "result_answers",
            $this->lng->txt("poll_result_answers"),
            $this->ctrl->getLinkTarget($this, "showParticipants")
        );
        $this->tabs->addSubTab(
            "result_users",
            $this->lng->txt("poll_result_users"),
            $this->ctrl->getLinkTarget($this, "showParticipantVotes")
        );

        $this->tabs->activateSubTab($a_active);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTabs()

ilObjPollGUI::setTabs ( )

protected

Definition at line 231 of file class.ilObjPollGUI.php.

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), and ILIAS\Repository\lng().

                                : void
    {
        $this->help->setScreenIdComponent("poll");

        if ($this->checkPermissionBool("write")) {
            $this->tabs_gui->addTab(
                "question",
                $this->lng->txt("question"),
                $this->ctrl->getLinkTarget($this, "")
            );
        }

        if ($this->checkPermissionBool("write")) {
            $this->tabs_gui->addTab(
                "settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "edit")
            );

            $this->tabs_gui->addTab(
                "participants",
                $this->lng->txt("poll_result"),
                $this->ctrl->getLinkTarget($this, "showParticipants")
            );

            $this->tabs_gui->addTab(
                "export",
                $this->lng->txt("export"),
                $this->ctrl->getLinkTargetByClass("ilexportgui", "")
            );
        }

        // will add permissions if needed
        parent::setTabs();
    }

Here is the call graph for this function:

showParticipants()

ilObjPollGUI::showParticipants

(

)

Definition at line 495 of file class.ilObjPollGUI.php.

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), setParticipantsSubTabs(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

                                      : void
    {
        if (!$this->checkPermissionBool("write")) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_permission"));
            return;
        }

        $this->tabs->activateTab("participants");
        $this->setParticipantsSubTabs("result_answers");

        $tbl = new ilPollAnswerTableGUI($this, "showParticipants");

        if ($tbl->getItems()) {
            $this->toolbar->addComponent(
                $this->ui_factory->button()->standard(
                    $this->lng->txt("poll_delete_votes"),
                    $this->ctrl->getLinkTarget($this, 'confirmDeleteAllVotes')
                )
            );
        }

        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

showParticipantVotes()

ilObjPollGUI::showParticipantVotes

(

)

Definition at line 519 of file class.ilObjPollGUI.php.

References ilObject2GUI\checkPermissionBool(), ILIAS\Repository\lng(), ILIAS\Repository\object(), setParticipantsSubTabs(), and ILIAS\Repository\tabs().

                                          : void
    {
        if (!$this->checkPermissionBool("write") ||
            !$this->object->getNonAnonymous()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("no_permission"));
            return;
        }

        $this->tabs->activateTab("participants");
        $this->setParticipantsSubTabs("result_users");

        $tbl = new ilPollUserTableGUI($this, "showParticipantVotes");
        $this->tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

subscribe()

ilObjPollGUI::subscribe

(

)

Definition at line 597 of file class.ilObjPollGUI.php.

References ILIAS\Repository\lng(), ilUtil\redirect(), ilNotification\setNotification(), ilNotification\TYPE_POLL, and ILIAS\Repository\user().

                               : void
    {
        ilNotification::setNotification(ilNotification::TYPE_POLL, $this->user->getId(), $this->object->getId(), true);

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("poll_notification_activated"), true);
        ilUtil::redirect(ilLink::_getLink($this->tree->getParentId($this->ref_id)));
    }

Here is the call graph for this function:

unsubscribe()

ilObjPollGUI::unsubscribe

(

)

Definition at line 605 of file class.ilObjPollGUI.php.

References ILIAS\Repository\lng(), ilUtil\redirect(), ilNotification\setNotification(), ilNotification\TYPE_POLL, and ILIAS\Repository\user().

                                 : void
    {
        ilNotification::setNotification(ilNotification::TYPE_POLL, $this->user->getId(), $this->object->getId(), false);

        $this->tpl->setOnScreenMessage('success', $this->lng->txt("poll_notification_deactivated"), true);
        ilUtil::redirect(ilLink::_getLink($this->tree->getParentId($this->ref_id)));
    }

Here is the call graph for this function:

updateCustom()

ilObjPollGUI::updateCustom ( ilPropertyFormGUI  $form )

protected

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

References ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, ilObjectActivation\TIMINGS_ACTIVATION, and ilObjectActivation\TIMINGS_DEACTIVATED.

                                                            : void
    {
        $this->object->setViewResults((int) $form->getInput("results"));
        $this->object->setOfflineStatus(!((string) $form->getInput("online") === "1"));
        $this->object->setSortResultByVotes((bool) $form->getInput("sort"));
        $this->object->setShowComments((bool) $form->getInput("comment"));
        $this->object->setShowResultsAs((int) $form->getInput("show_results_as"));

        $period = $form->getItemByPostVar("access_period");
        if ($period->getStart() && $period->getEnd()) {
            $this->object->setAccessType(ilObjectActivation::TIMINGS_ACTIVATION);
            $this->object->setAccessBegin($period->getStart()->get(IL_CAL_UNIX));
            $this->object->setAccessEnd($period->getEnd()->get(IL_CAL_UNIX));
        } else {
            $this->object->setAccessType(ilObjectActivation::TIMINGS_DEACTIVATED);
        }

        $period = $form->getItemByPostVar("voting_period");
        if ($period->getStart() && $period->getEnd()) {
            $this->object->setVotingPeriod(true);
            $this->object->setVotingPeriodBegin($period->getStart()->get(IL_CAL_UNIX));
            $this->object->setVotingPeriodEnd($period->getEnd()->get(IL_CAL_UNIX));
        } else {
            $this->object->setVotingPeriodBegin(0);
            $this->object->setVotingPeriodEnd(0);
            $this->object->setVotingPeriod(false);
        }
    }

Here is the call graph for this function:

validateCustom()

ilObjPollGUI::validateCustom ( ilPropertyFormGUI  $form )

protected

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

References $valid, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ILIAS\Repository\lng(), and ilObjPoll\VIEW_RESULTS_AFTER_PERIOD.

                                                              : bool
    {
        $valid = true;
        if ($form->getInput("online") && !$this->object->getAnswers()) {
            $form->getItemByPostVar("online")->setAlert($this->lng->txt("poll_cannot_set_online_no_answers"));
            $valid = false;
        }
        #20594
        if (!array_filter($form->getInput("voting_period")) &&
            (int) $form->getInput("results") === ilObjPoll::VIEW_RESULTS_AFTER_PERIOD) {
            $form->getItemByPostVar("results")->setAlert($this->lng->txt("poll_view_results_after_period_impossible"));
            $valid = false;
        }
        if (!$valid) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("form_input_not_valid"));
            return false;
        }
        return parent::validateCustom($form);
    }

Here is the call graph for this function:

vote()

ilObjPollGUI::vote

(

)

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

References $DIC, $valid, ANONYMOUS_USER_ID, ilSession\get(), ILIAS\Repository\object(), ilUtil\redirect(), sendNotifications(), ilSession\set(), and ILIAS\Repository\user().

                          : void
    {
        global $DIC;
        $aw = (array) ($DIC->http()->request()->getParsedBody()['aw'] ?? array());

        $valid = true;
        if ($this->object->getMaxNumberOfAnswers() > 1) {
            if (count($aw) > $this->object->getMaxNumberOfAnswers()) {
                $valid = false;
            }
            if (!count($aw)) {
                $valid = false;
            }
        } elseif ((int) !$aw) {
            $valid = false;
        }

        $session_last_poll_vote = ilSession::get('last_poll_vote');
        if ($valid && $this->user->getId() != ANONYMOUS_USER_ID) {
            unset($session_last_poll_vote[$this->object->getId()]);
            ilSession::set('last_poll_vote', $session_last_poll_vote);
            $this->object->saveVote($this->user->getId(), $aw);

            $this->sendNotifications();
        } else {
            $session_last_poll_vote[$this->object->getId()] = $aw;
            ilSession::set('last_poll_vote', $session_last_poll_vote);
        }

        ilUtil::redirect(ilLink::_getLink($this->tree->getParentId($this->ref_id)));
    }

Here is the call graph for this function:

Field Documentation

$data_factory

DataFactory ilObjPollGUI::$data_factory

protected

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

$help

ilHelpGUI ilObjPollGUI::$help

protected

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

$nav_history

ilNavigationHistory ilObjPollGUI::$nav_history

protected

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

$poll_image_factory

PollImageFactoryInterface ilObjPollGUI::$poll_image_factory

protected

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

$tabs

ilTabsGUI ilObjPollGUI::$tabs

protected

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

$ui_factory

UIFactory ilObjPollGUI::$ui_factory

protected

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

$ui_renderer

UIRenderer ilObjPollGUI::$ui_renderer

protected

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

---

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

• components/ILIAS/Poll/classes/class.ilObjPollGUI.php