Inheritance diagram for ilObjPollGUI:

Collaboration diagram for ilObjPollGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...

	getType ()
	Functions that must be overwritten. More...

	setTabs ()
	create tabs (repository/workspace switch) More...

	executeCommand ()
	execute command More...

	render ($a_form=null)
	Render object context. More...

	saveQuestion ()

	showParticipants ()

	showParticipantVotes ()

	confirmDeleteAllVotes ()

	deleteAllVotes ()

	vote ()

	subscribe ()

	unsubscribe ()

	getHTML ()
	return user view More...

	addLocatorItems ()
	Functions to be overwritten. More...

Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...

	executeCommand ()
	execute command More...

	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 ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	isVisible ($a_ref_id, $a_type)

	trash ()

	undelete ()

	cancelDelete ()

	removeFromSystem ()

	cloneAll ()

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	Deleted in ilObject. More...

	save ()

	edit ()

	update ()

	cancel ()

	importFile ()
	Import. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

	withReferences ()
	determines wether objects are referenced or not (got ref ids or not) More...

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

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

	cancelDeleteObject ()
	cancel deletion of object More...

	cancelObject ()
	cancel action and go back to previous page @access public More...

	createObject ()
	create new object form More...

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()
	save object More...

	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject ($a_error=false)
	Display deletion confirmation screen. More...

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

	addToDeskObject ()
	@inheritDoc More...

	removeFromDeskObject ()
	@inheritDoc More...

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Static Public Member Functions
static	_goto ($a_target)
	Deep link. More...

Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...

Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Protected Member Functions
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...

	initQuestionForm ($a_read_only=false)

	setParticipantsSubTabs ($a_active)

	sendNotifications ()

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 ()
	Get access handler. More...

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...

	setTitleAndDescription ()
	called by prepare output More...

	showUpperIcon ()

	omitLocator ($a_omit=true)

	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	fillCloneSearchTemplate ($a_tpl_varname, $a_type)

	searchCloneSource ()

	buildCloneSelect ($existing_objs)

	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

	showActions ()

	getTabs ()
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	addLocatorItems ()
	Functions to be overwritten. More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	redrawHeaderAction ()
	Updating icons after ajax call. More...

	getPermanentLinkWidget ($a_append=null, $a_center=false)

	handleAutoRating (ilObject $a_new_obj)

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	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 @access public More...

	setAdminTabs ()
	set admin tabs @access public More...

	setLocator ()
	set Locator More...

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator ($a_omit=true)

	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	initCreationForms ($a_new_type)
	Init creation froms. More...

	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook. More...

	initEditForm ()
	Init object edit form. More...

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()
	Get values for edit form. More...

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $a_form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

	afterImport (ilObject $a_new_object)
	Post (successful) object import hook. More...

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$help

	$tabs

	$nav_history

	$ui

Protected Attributes inherited from ilObject2GUI
	$object_id

	$node_id

	$creation_forms = array()

	$id_type = array()

	$parent_id

	$access_handler

Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

	$ilErr

	$locator

	$user

	$access

	$rbacsystem

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

	$favourites

	$request

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	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	COPY_WIZARD_NEEDS_PAGE = 1

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

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

Id: class.ilObjFolderGUI.php 25134 2010-08-13 14:22:11Z smeyer

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters

int	$a_id
int	$a_id_type
int	$a_parent_node_id

Reimplemented from ilObject2GUI.

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

    {
        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"];
        $lng = $DIC->language();
        $this->ui = $DIC->ui();
        
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);
        
        $lng->loadLanguageModule("poll");
    }

References $DIC, ilObjectGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), help(), ui(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilObjPollGUI::_goto ( $a_target )

static

Deep link.

Parameters

string $a_target

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

    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        $ilAccess = $DIC->access();
        
        $id = explode("_", $a_target);
        $ref_id = $id[0];
                    
        // #13728 - used in notification mostly
        if ($ilAccess->checkAccess("write", "", $ref_id)) {
            $_GET["baseClass"] = "ilRepositoryGUI";
            $_GET["ref_id"] = $ref_id;
            $_GET["cmd"] = "showParticipants";
            include("ilias.php");
            exit;
        } else {
            // is sideblock: so show parent instead
            $container_id = $tree->getParentId($ref_id);
 
            // #11810
            include_once "Services/Link/classes/class.ilLink.php";
            ilUtil::redirect(ilLink::_getLink($container_id) .
                "#poll" . ilObject::_lookupObjId($id[0]));
        }
    }

References $_GET, $DIC, ilObjectGUI\$ref_id, ilObjectGUI\$tree, ilLink\_getLink(), ilObject\_lookupObjId(), exit, and ilUtil\redirect().

Here is the call graph for this function:

◆ addLocatorItems()

ilObjPollGUI::addLocatorItems ( )

Functions to be overwritten.

Reimplemented from ilObject2GUI.

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

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

References ilObjectGUI\$locator.

◆ afterSave()

ilObjPollGUI::afterSave ( ilObject $a_new_object )

protected

Post (successful) object creation hook.

Parameters

ilObject $a_new_object

Reimplemented from ilObjectGUI.

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

    {
        $ilCtrl = $this->ctrl;
        
        ilUtil::sendSuccess($this->lng->txt("object_added"), true);
        $ilCtrl->redirect($this, "render");
    }

References ilObjectGUI\$ctrl.

◆ confirmDeleteAllVotes()

ilObjPollGUI::confirmDeleteAllVotes ( )

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

    {
        $lng = $this->lng;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        
        if (!$this->checkPermissionBool("write")) {
            ilUtil::sendInfo($lng->txt("no_permission"));
            return;
        }
        
        $ilTabs->activateTab("participants");
        
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $cgui = new ilConfirmationGUI();
        $cgui->setHeaderText($lng->txt("poll_delete_votes_sure"));
 
        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setCancel($lng->txt("cancel"), "showParticipants");
        $cgui->setConfirm($lng->txt("confirm"), "deleteAllVotes");
 
        $tpl->setContent($cgui->getHTML());
    }

References ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilObject2GUI\checkPermissionBool(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ deleteAllVotes()

ilObjPollGUI::deleteAllVotes ( )

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

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        if (!$this->checkPermissionBool("write")) {
            ilUtil::sendInfo($lng->txt("no_permission"));
            return;
        }
        
        $this->object->deleteAllVotes();
            
        $ilCtrl->redirect($this, "showParticipants");
    }

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, ilObject2GUI\checkPermissionBool(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ executeCommand()

ilObjPollGUI::executeCommand ( )

execute command

Reimplemented from ilObject2GUI.

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

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilNavigationHistory = $this->nav_history;
 
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();
                        
        $tpl->loadStandardTemplate();
 
        // add entry to navigation history
        if (!$this->getCreationMode() &&
            $this->getAccessHandler()->checkAccess("read", "", $this->node_id)) {
            $link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "frameset");
            $ilNavigationHistory->addItem($this->node_id, $link, "poll");
        }
        
        switch ($next_class) {
            case "ilinfoscreengui":
                $this->prepareOutput();
                $this->infoScreenForward();
                break;
            
            case "ilcommonactiondispatchergui":
                include_once("Services/Object/classes/class.ilCommonActionDispatcherGUI.php");
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;
            
            case "ilpermissiongui":
                $this->prepareOutput();
                $ilTabs->activateTab("id_permissions");
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            
            case "ilobjectcopygui":
                include_once "./Services/Object/classes/class.ilObjectCopyGUI.php";
                $cp = new ilObjectCopyGUI($this);
                $cp->setType("poll");
                $this->ctrl->forwardCommand($cp);
                break;
            
            case 'ilexportgui':
                $this->prepareOutput();
                $ilTabs->activateTab("export");
                include_once("./Services/Export/classes/class.ilExportGUI.php");
                $exp_gui = new ilExportGUI($this);
                $exp_gui->addFormat("xml");
                $ilCtrl->forwardCommand($exp_gui);
                break;
 
            default:
                return parent::executeCommand();
        }
        
        return true;
    }

References ilObjectGUI\$ctrl, $nav_history, $tabs, ilObjectGUI\$tpl, ilObject2GUI\getAccessHandler(), ilObject2GUI\getCreationMode(), ilCommonActionDispatcherGUI\getInstanceFromAjaxCall(), and ilObject2GUI\prepareOutput().

Here is the call graph for this function:

◆ getEditFormCustomValues()

ilObjPollGUI::getEditFormCustomValues ( array & $a_values )

protected

Add values to custom edit fields.

Parameters

array $a_values

Reimplemented from ilObjectGUI.

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

    {
        include_once "Services/Object/classes/class.ilObjectActivation.php";
        
        $a_values["online"] = $this->object->IsOnline();
        $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"] = $this->object->getSortResultByVotes();
        $a_values["comment"] = $this->object->getShowComments();
        $a_values["show_results_as"] = $this->object->getShowResultsAs();
    }

References IL_CAL_UNIX.

◆ getHTML()

ilObjPollGUI::getHTML ( )

return user view

Returns: string

Reimplemented from ilObject2GUI.

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

677 {

678 }

◆ getType()

ilObjPollGUI::getType ( )

Functions that must be overwritten.

Reimplemented from ilObject2GUI.

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

    {
        return "poll";
    }

◆ initEditCustomForm()

ilObjPollGUI::initEditCustomForm ( ilPropertyFormGUI $a_form )

protected

Add custom fields to update form.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilObjectGUI.

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

    {
        $lng = $this->lng;
        
        // activation
        
        include_once "Services/Object/classes/class.ilObjectActivation.php";
        $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 (sizeof(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);
        
        include_once "Services/Form/classes/class.ilDateDurationInputGUI.php";
        $dur = new ilDateDurationInputGUI($this->lng->txt('rep_visibility_until'), "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($lng->txt("poll_view_results"), "results");
        $results->setRequired(true);
        $results->addOption(new ilRadioOption(
            $lng->txt("poll_view_results_always"),
            ilObjPoll::VIEW_RESULTS_ALWAYS
        ));
        $results->addOption(new ilRadioOption(
            $lng->txt("poll_view_results_never"),
            ilObjPoll::VIEW_RESULTS_NEVER
        ));
        $results->addOption(new ilRadioOption(
            $lng->txt("poll_view_results_after_vote"),
            ilObjPoll::VIEW_RESULTS_AFTER_VOTE
        ));
        $results->addOption(new ilRadioOption(
            $lng->txt("poll_view_results_after_period"),
            ilObjPoll::VIEW_RESULTS_AFTER_PERIOD
        ));
        $a_form->addItem($results);
        
        $show_result_as = new ilRadioGroupInputGUI($lng->txt("poll_show_results_as"), "show_results_as");
        $show_result_as->setRequired(true);
        $result_bar = new ilRadioOption(
            $lng->txt("poll_barchart"),
            ilObjPoll::SHOW_RESULTS_AS_BARCHART
        );
        $show_result_as->addOption($result_bar);
        $show_result_as->addOption(new ilRadioOption(
            $lng->txt("poll_piechart"),
            ilObjPoll::SHOW_RESULTS_AS_PIECHART
        ));
        $a_form->addItem($show_result_as);
 
        $sort = new ilRadioGroupInputGUI($lng->txt("poll_result_sorting"), "sort");
        $sort->setRequired(true);
        $sort->addOption(new ilRadioOption($lng->txt("poll_result_sorting_answers"), 0));
        $sort->addOption(new ilRadioOption($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);
    }

References $comment, ilObjectGUI\$lng, $results, $section, ilObject\_getAllReferences(), ilPropertyFormGUI\addItem(), ilObjPoll\SHOW_RESULTS_AS_BARCHART, ilObjPoll\SHOW_RESULTS_AS_PIECHART, ilObjPoll\VIEW_RESULTS_AFTER_PERIOD, ilObjPoll\VIEW_RESULTS_AFTER_VOTE, ilObjPoll\VIEW_RESULTS_ALWAYS, and ilObjPoll\VIEW_RESULTS_NEVER.

Here is the call graph for this function:

◆ initQuestionForm()

ilObjPollGUI::initQuestionForm ( $a_read_only = false )

protected

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, "saveQuestion"));
        $form->setTitle($lng->txt("obj_poll"));
        
        $question = new ilTextAreaInputGUI($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($lng->txt("poll_image") . $dimensions, "image");
        $img->setDisabled($a_read_only);
        $form->addItem($img);
            
        // show existing file
        $file = $this->object->getImageFullPath(true);
        if ($file) {
            $img->setImage($file);
        }
        
        $anonymous = new ilRadioGroupInputGUI($lng->txt("poll_mode"), "mode");
        $anonymous->setRequired(true);
        $option = new ilRadioOption($lng->txt("poll_mode_anonymous"), 0);
        $option->setInfo($lng->txt("poll_mode_anonymous_info"));
        $anonymous->addOption($option);
        $option = new ilRadioOption($lng->txt("poll_mode_personal"), 1);
        $option->setInfo($lng->txt("poll_mode_personal_info"));
        $anonymous->addOption($option);
        $anonymous->setValue($this->object->getNonAnonymous());
        $anonymous->setDisabled($a_read_only);
        $form->addItem($anonymous);
        
        $nanswers = new ilNumberInputGUI($lng->txt("poll_max_number_of_answers"), "nanswers");
        $nanswers->setRequired(true);
        $nanswers->setMinValue(1);
        $nanswers->setSize(3);
        $nanswers->setValue($this->object->getMaxNumberOfAnswers());
        $nanswers->setDisabled($a_read_only);
        $form->addItem($nanswers);
        
        $answers = new ilTextInputGUI($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) {
            if (!$idx) {
                $answers->setValue($item["answer"]);
            }
            $multi_answers[] = $item["answer"];
        }
        $answers->setMultiValues($multi_answers);
        
        if (!$a_read_only) {
            $form->addCommandButton("saveQuestion", $lng->txt("save"));
        }
        
        return $form;
    }

References ilObjectGUI\$ctrl, $img, ilObjectGUI\$lng, and ilObjPoll\getImageSize().

Referenced by render(), and saveQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilObjPollGUI::render ( $a_form = null )

Render object context.

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

    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilToolbar = $this->toolbar;
        $ilUser = $this->user;
        $ui = $this->ui;
        
        if (!$this->checkPermissionBool("write")) {
            ilUtil::sendInfo($lng->txt("no_permission"));
            return;
        }
        
        $ilTabs->activateTab("content");
        
        if (!$a_form) {
            if ($this->object->countVotes()) {
                $url = $ilCtrl->getLinkTarget($this, "showParticipants");
 
                $mbox = $ui->factory()->messageBox()->info($lng->txt("poll_votes_no_edit"))
                    ->withLinks([$ui->factory()->link()->standard(
                        $lng->txt("poll_result"),
                        $url
                    )]);
 
                $message = $ui->renderer()->render($mbox);
            }
            
            $a_form = $this->initQuestionForm($this->object->countVotes());
        }
            
        $tpl->setPermanentLink('poll', $this->node_id);
        
        $tpl->setContent($message . $a_form->getHTML());
    }

References ilObjectGUI\$ctrl, $ilUser, ilObjectGUI\$lng, $message, $tabs, ilObjectGUI\$toolbar, ilObjectGUI\$tpl, $ui, $url, ilObjectGUI\$user, ilObject2GUI\checkPermissionBool(), initQuestionForm(), and ilUtil\sendInfo().

Referenced by saveQuestion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveQuestion()

ilObjPollGUI::saveQuestion ( )

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

    {
        $form = $this->initQuestionForm();
        if ($form->checkInput()) {
            $this->object->setQuestion($form->getInput("question"));
            $this->object->setNonAnonymous($form->getInput("mode"));
                        
            $image = $form->getItemByPostVar("image");
            if ($_FILES["image"]["tmp_name"]) {
                $this->object->uploadImage($_FILES["image"]);
            } elseif ($image->getDeletionFlag()) {
                $this->object->deleteImage();
            }
             
            $nr_of_anwers = $this->object->saveAnswers($form->getInput("answers"));
            
            // #15073
            $this->object->setMaxNumberOfAnswers(min($form->getInput("nanswers"), $nr_of_anwers));
            
            if ($this->object->update()) {
                ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
                $this->ctrl->redirect($this, "render");
            }
        }
        
        $form->setValuesByPost();
        $this->render($form);
    }

References initQuestionForm(), and render().

Here is the call graph for this function:

◆ sendNotifications()

ilObjPollGUI::sendNotifications ( )

protected

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

    {
        $ilUser = $this->user;
        
        // recipients
        include_once "./Services/Notification/classes/class.ilNotification.php";
        $users = ilNotification::getNotificationsForObject(
            ilNotification::TYPE_POLL,
            $this->object->getId(),
            null,
            true
        );
        if (!sizeof($users)) {
            return;
        }
                                            
        include_once "./Services/Notification/classes/class.ilSystemNotification.php";
        $ntf = new ilSystemNotification();
        $ntf->setLangModules(array("poll"));
        $ntf->setRefId($this->ref_id);
        
        if ($this->object->getNonAnonymous()) {
            $ntf->setChangedByUserId($ilUser->getId());
        }
        
        $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->sendMail($users, null, "read");
 
        ilNotification::updateNotificationTime(ilNotification::TYPE_POLL, $this->object->getId(), $notified);
    }

References $ilUser, ilObjectGUI\$user, ilNotification\getNotificationsForObject(), ilNotification\TYPE_POLL, and ilNotification\updateNotificationTime().

Referenced by vote().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParticipantsSubTabs()

ilObjPollGUI::setParticipantsSubTabs ( $a_active )

protected

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

    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        if (!$this->object->getNonAnonymous()) {
            return;
        }
        
        $ilTabs->addSubTab(
            "result_answers",
            $lng->txt("poll_result_answers"),
            $ilCtrl->getLinkTarget($this, "showParticipants")
        );
        $ilTabs->addSubTab(
            "result_users",
            $lng->txt("poll_result_users"),
            $ilCtrl->getLinkTarget($this, "showParticipantVotes")
        );
        
        $ilTabs->activateSubTab($a_active);
    }

References ilObjectGUI\$ctrl, ilObjectGUI\$lng, and $tabs.

Referenced by showParticipants(), and showParticipantVotes().

Here is the caller graph for this function:

◆ setTabs()

ilObjPollGUI::setTabs ( )

create tabs (repository/workspace switch)

this had to be moved here because of the context-specific permission tab

Reimplemented from ilObject2GUI.

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

    {
        $lng = $this->lng;
        $ilHelp = $this->help;
 
        $ilHelp->setScreenIdComponent("poll");
 
        if ($this->checkPermissionBool("write")) {
            $this->tabs_gui->addTab(
                "content",
                $lng->txt("content"),
                $this->ctrl->getLinkTarget($this, "")
            );
        }
        
        if ($this->checkPermissionBool("write")) {
            $this->tabs_gui->addTab(
                "settings",
                $lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "edit")
            );
            
            $this->tabs_gui->addTab(
                "participants",
                $lng->txt("poll_result"),
                $this->ctrl->getLinkTarget($this, "showParticipants")
            );
            
            $this->tabs_gui->addTab(
                "export",
                $lng->txt("export"),
                $this->ctrl->getLinkTargetByClass("ilexportgui", "")
            );
        }
 
        // will add permissions if needed
        parent::setTabs();
    }

References $help, ilObjectGUI\$lng, and ilObject2GUI\checkPermissionBool().

Here is the call graph for this function:

◆ showParticipants()

ilObjPollGUI::showParticipants ( )

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

    {
        $lng = $this->lng;
        $ilTabs = $this->tabs;
        $tpl = $this->tpl;
        
        if (!$this->checkPermissionBool("write")) {
            ilUtil::sendInfo($lng->txt("no_permission"));
            return;
        }
        
        $ilTabs->activateTab("participants");
        $this->setParticipantsSubTabs("result_answers");
    
        include_once "Modules/Poll/classes/class.ilPollAnswerTableGUI.php";
        $tbl = new ilPollAnswerTableGUI($this, "showParticipants");
        $tpl->setContent($tbl->getHTML());
    }

References ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilObject2GUI\checkPermissionBool(), ilUtil\sendInfo(), and setParticipantsSubTabs().

Here is the call graph for this function:

◆ showParticipantVotes()

ilObjPollGUI::showParticipantVotes ( )

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

    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $tpl = $this->tpl;
        
        if (!$this->checkPermissionBool("write") ||
            !$this->object->getNonAnonymous()) {
            ilUtil::sendInfo($lng->txt("no_permission"));
            return;
        }
        
        $ilTabs->activateTab("participants");
        $this->setParticipantsSubTabs("result_users");
        
        include_once "Modules/Poll/classes/class.ilPollUserTableGUI.php";
        $tbl = new ilPollUserTableGUI($this, "showParticipantVotes");
        $tpl->setContent($tbl->getHTML());
    }

References ilObjectGUI\$lng, $tabs, ilObjectGUI\$tpl, ilObject2GUI\checkPermissionBool(), ilUtil\sendInfo(), and setParticipantsSubTabs().

Here is the call graph for this function:

◆ subscribe()

ilObjPollGUI::subscribe ( )

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

    {
        $ilUser = $this->user;
        $tree = $this->tree;
        $lng = $this->lng;
        
        include_once "./Services/Notification/classes/class.ilNotification.php";
        ilNotification::setNotification(ilNotification::TYPE_POLL, $ilUser->getId(), $this->object->getId(), true);
        
        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
        include_once "Services/Link/classes/class.ilLink.php";
        ilUtil::redirect(ilLink::_getLink($tree->getParentId($this->ref_id)));
    }

References $ilUser, ilObjectGUI\$lng, ilObjectGUI\$tree, ilObjectGUI\$user, ilLink\_getLink(), ilUtil\redirect(), ilNotification\setNotification(), and ilNotification\TYPE_POLL.

Here is the call graph for this function:

◆ unsubscribe()

ilObjPollGUI::unsubscribe ( )

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

    {
        $ilUser = $this->user;
        $tree = $this->tree;
        $lng = $this->lng;
        
        include_once "./Services/Notification/classes/class.ilNotification.php";
        ilNotification::setNotification(ilNotification::TYPE_POLL, $ilUser->getId(), $this->object->getId(), false);
        
        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
        include_once "Services/Link/classes/class.ilLink.php";
        ilUtil::redirect(ilLink::_getLink($tree->getParentId($this->ref_id)));
    }

References $ilUser, ilObjectGUI\$lng, ilObjectGUI\$tree, ilObjectGUI\$user, ilLink\_getLink(), ilUtil\redirect(), ilNotification\setNotification(), and ilNotification\TYPE_POLL.

Here is the call graph for this function:

◆ updateCustom()

ilObjPollGUI::updateCustom ( ilPropertyFormGUI $a_form )

protected

Insert custom update form values into object.

Parameters

ilPropertyFormGUI $a_form

Reimplemented from ilObjectGUI.

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

    {
        $this->object->setViewResults($a_form->getInput("results"));
        $this->object->setOnline($a_form->getInput("online"));
        $this->object->setSortResultByVotes($a_form->getInput("sort"));
        $this->object->setShowComments($a_form->getInput("comment"));
        $this->object->setShowResultsAs($a_form->getInput("show_results_as"));
        
        include_once "Services/Object/classes/class.ilObjectActivation.php";
        $period = $a_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 = $a_form->getItemByPostVar("voting_period");
        if ($period->getStart() && $period->getEnd()) {
            $this->object->setVotingPeriod(1);
            $this->object->setVotingPeriodBegin($period->getStart()->get(IL_CAL_UNIX));
            $this->object->setVotingPeriodEnd($period->getEnd()->get(IL_CAL_UNIX));
        } else {
            $this->object->setVotingPeriodBegin(null);
            $this->object->setVotingPeriodEnd(null);
            $this->object->setVotingPeriod(0);
        }
    }

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

Here is the call graph for this function:

◆ validateCustom()

ilObjPollGUI::validateCustom ( ilPropertyFormGUI $a_form )

protected

Validate custom values (if not possible with checkInput())

Parameters

ilPropertyFormGUI $a_form

Returns: boolean

Reimplemented from ilObjectGUI.

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

    {
        #20594
        if (!$a_form->getInput("voting_period") &&
            $a_form->getInput("results") == ilObjPoll::VIEW_RESULTS_AFTER_PERIOD) {
            ilUtil::sendFailure($this->lng->txt("form_input_not_valid"));
            $a_form->getItemByPostVar("results")->setAlert($this->lng->txt("poll_view_results_after_period_impossible"));
            return false;
        }
        return parent::validateCustom($a_form);
    }

References ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilUtil\sendFailure(), and ilObjPoll\VIEW_RESULTS_AFTER_PERIOD.

Here is the call graph for this function:

◆ vote()

ilObjPollGUI::vote ( )

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

    {
        $tree = $this->tree;
        $ilUser = $this->user;
        
        $valid = true;
        if ($this->object->getMaxNumberOfAnswers() > 1) {
            if (sizeof($_POST["aw"]) > $this->object->getMaxNumberOfAnswers()) {
                $valid = false;
            }
            if (!sizeof($_POST["aw"])) {
                $valid = false;
            }
        } else {
            if ((int) !$_POST["aw"]) {
                $valid = false;
            }
        }
        
        if ($valid && $ilUser->getId() != ANONYMOUS_USER_ID) {
            unset($_SESSION["last_poll_vote"][$this->object->getId()]);
            $this->object->saveVote($ilUser->getId(), $_POST["aw"]);
            
            $this->sendNotifications();
        } else {
            $_SESSION["last_poll_vote"][$this->object->getId()] = $_POST["aw"];
        }
        
        include_once "Services/Link/classes/class.ilLink.php";
        ilUtil::redirect(ilLink::_getLink($tree->getParentId($this->ref_id)));
    }

References $_POST, $_SESSION, $ilUser, ilObjectGUI\$tree, ilObjectGUI\$user, $valid, ilLink\_getLink(), ANONYMOUS_USER_ID, ilUtil\redirect(), and sendNotifications().

Here is the call graph for this function:

Field Documentation

◆ $help

ilObjPollGUI::$help

protected

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

Referenced by setTabs().

◆ $nav_history

ilObjPollGUI::$nav_history

protected

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

Referenced by executeCommand().

◆ $tabs

ilObjPollGUI::$tabs

protected

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

Referenced by confirmDeleteAllVotes(), executeCommand(), render(), setParticipantsSubTabs(), showParticipants(), and showParticipantVotes().

◆ $ui

ilObjPollGUI::$ui

protected

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

Referenced by render().

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

Modules/Poll/classes/class.ilObjPollGUI.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _goto()

◆ addLocatorItems()

◆ afterSave()

◆ confirmDeleteAllVotes()

◆ deleteAllVotes()

◆ executeCommand()

◆ getEditFormCustomValues()

◆ getHTML()

◆ getType()

◆ initEditCustomForm()

◆ initQuestionForm()

◆ render()

◆ saveQuestion()

◆ sendNotifications()

◆ setParticipantsSubTabs()

◆ setTabs()

◆ showParticipants()

◆ showParticipantVotes()

◆ subscribe()

◆ unsubscribe()

◆ updateCustom()

◆ validateCustom()

◆ vote()

Field Documentation

◆ $help

◆ $nav_history

◆ $tabs

◆ $ui