Files
file	access.php
	Plugin capabilities.

file	activity.php
	Search area for mod_survey activities.

file	activity_base.php
	Activity base class.

file	backup_survey_activity_task.class.php
	Defines backup_survey_activity_task class.

file	backup_survey_stepslib.php
	@subpackage backup-moodle2

file	cognitive_depth.php
	Cognitive depth indicator - survey.

file	course_module_instance_list_viewed.php
	The mod_survey instance list viewed event.

file	course_module_viewed.php
	The mod_survey course module viewed event.

file	external.php
	Survey external API.

file	lib.php
	mod_survey data generator.

file	lib.php

file	lib.php
	Provides support for the conversion of moodle1 backup to the moodle2 format.

file	log.php
	Definition of log events.

file	provider.php
	Data provider.

file	report_downloaded.php
	The mod_survey report downloaded event.

file	report_viewed.php
	The mod_survey report viewed event.

file	response_submitted.php
	The mod_survey response submitted event.

file	restore_survey_activity_task.class.php
	@subpackage backup-moodle2

file	restore_survey_stepslib.php
	@subpackage backup-moodle2

file	services.php
	Survey external functions and service definitions.

file	social_breadth.php
	Social breadth indicator - survey.

file	version.php
	Version information.

Namespaces
	mod_survey\analytics\indicator


	mod_survey\event


	mod_survey\privacy


	mod_survey\search

Classes
class	backup_survey_activity_structure_step
	Define all the backup steps that will be used by the backup_survey_activity_task. More...

class	backup_survey_activity_task
	Provides all the settings and steps to perform one complete backup of the activity. More...

class	mod_survey\analytics\indicator\activity_base
	Activity base class. More...

class	mod_survey\analytics\indicator\cognitive_depth
	Cognitive depth indicator - survey. More...

class	mod_survey\analytics\indicator\social_breadth
	Social breadth indicator - survey. More...

class	mod_survey\event\course_module_instance_list_viewed
	The mod_survey instance list viewed event class. More...

class	mod_survey\event\course_module_viewed

class	mod_survey\event\report_downloaded

class	mod_survey\event\report_viewed

class	mod_survey\event\response_submitted

class	mod_survey\privacy\provider
	Data provider class. More...

class	mod_survey\search\activity
	Search area for mod_survey activities. More...

class	mod_survey_external

class	mod_survey_generator

class	moodle1_mod_survey_handler
	Survey conversion handler. More...

class	restore_survey_activity_structure_step
	Define all the restore steps that will be used by the restore_survey_activity_task. More...

class	restore_survey_activity_task
	survey restore task that provides all the settings and steps to perform one complete restore of the activity More...

Functions
	mod_survey_core_calendar_provide_event_action (calendar_event $event, core_calendar\action_factory $factory, int $userid=0)
	This function receives a calendar event and returns the action associated with it, or null if there is none. More...

	mod_survey_get_completion_active_rule_descriptions ($cm)
	Callback which returns human-readable strings describing the active completion custom rules for the module instance. More...

object	survey_add_analysis ($survey, $user, $notes)

object	survey_add_instance ($survey)
	Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will create a new instance and return the id number of the new instance. More...

object	survey_already_done ($survey, $user)

	survey_check_updates_since (cm_info $cm, $from, $filter=array())
	Check if the module has any update that affects the current user since a given time. More...

	survey_count_responses ($surveyid, $groupid, $groupingid)

object	survey_delete_instance ($id)
	Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it. More...

	survey_extend_settings_navigation ($settings, $surveynode)
	This function extends the settings navigation block for the site. More...

object	survey_get_analysis ($survey, $user)

	survey_get_completion_state ($course, $cm, $userid, $type)
	Obtains the automatic completion state for this survey based on the condition in feedback settings. More...

	survey_get_coursemodule_info ($coursemodule)
	Add a get_coursemodule_info function in case any survey type wants to add 'extra' information for the course (see resource). More...

	survey_get_post_actions ()
	List the actions that correspond to a post of this module. More...

	survey_get_questions ($survey)
	Returns the questions for a survey (ordered). More...

object	survey_get_responses ($surveyid, $groupid, $groupingid)

	survey_get_subquestions ($question)
	Returns subquestions for a given question (ordered). More...

object	survey_get_template_name ($templateid)

object	survey_get_user_answer ($surveyid, $questionid, $userid)

object	survey_get_user_answers ($surveyid, $questionid, $groupid, $sort="sa.answer1,sa.answer2 ASC")

	survey_get_view_actions ()
	List the actions that correspond to a view of this module. More...

object	survey_log_info ($log)

	survey_order_questions ($questions, $questionorder)
	Helper function for ordering a set of questions by the given ids. More...

	survey_page_type_list ($pagetype, $parentcontext, $currentcontext)
	Return a list of page types. More...

	survey_print_all_responses ($cmid, $results, $courseid)

object	survey_print_graph ($url)
	@global int @global int More...

object	survey_print_multi ($question)

stdClass	survey_print_recent_activity ($course, $viewfullnames, $timestart)
	@global object More...

object	survey_print_single ($question)
	@global int More...

	survey_question_rowclass ($qnum)

	survey_reset_course_form_defaults ($course)
	Course reset form defaults. More...

	survey_reset_course_form_definition (&$mform)
	Implementation of the function for printing the form elements that control whether the course reset functionality affects the survey. More...

object	survey_reset_userdata ($data)
	Actual implementation of the reset course functionality, delete all the survey responses for course $data->courseid. More...

	survey_save_answers ($survey, $answersrawdata, $course, $context)
	Save the answer for the given survey. More...

	survey_shorten_name ($name, $numwords)

	survey_supports ($feature)
	@uses FEATURE_GROUPS @uses FEATURE_GROUPINGS @uses FEATURE_MOD_INTRO @uses FEATURE_COMPLETION_TRACKS_VIEWS @uses FEATURE_GRADE_HAS_GRADE @uses FEATURE_GRADE_OUTCOMES More...

	survey_translate_question ($question)
	Translate the question texts and options. More...

object	survey_update_analysis ($survey, $user, $notes)

object	survey_update_instance ($survey)
	Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will update an existing instance with new data. More...

stdObject	survey_user_complete ($course, $user, $mod, $survey)
	@global object @uses SURVEY_CIQ More...

object	survey_user_outline ($course, $user, $mod, $survey)

	survey_view ($survey, $course, $cm, $context, $viewed)
	Mark the activity completed (if required) and trigger the course_module_viewed event. More...

Variables
	$capabilities

	$functions

	$logs

global int	$SURVEY_GHEIGHT = 500
	Graph size $SURVEY_GHEIGHT.

global int	$SURVEY_GWIDTH = 900
	Graph size $SURVEY_GWIDTH.

global array	$SURVEY_QTYPE
	Question Type $SURVEY_QTYPE. More...

$plugin	component = 'mod_survey'

$plugin	cron = 0

$plugin	requires = 2019111200

const	SURVEY_ATTLS "4"

const	SURVEY_CIQ "5"

const	SURVEY_COLLES_ACTUAL "1"

const	SURVEY_COLLES_PREFERRED "2"

const	SURVEY_COLLES_PREFERRED_ACTUAL "3"

$plugin	version = 2019111800

Detailed Description

Function Documentation

◆ mod_survey_core_calendar_provide_event_action()

mod_survey_core_calendar_provide_event_action	(	calendar_event	$event,
		core_calendar\action_factory	$factory,
		int	$userid = `0`
	)

This function receives a calendar event and returns the action associated with it, or null if there is none.

This is used by block_myoverview in order to display the event appropriately. If null is returned then the event is not displayed on the block.

Parameters

calendar_event	$event
core_calendar\action_factory	$factory
int	$userid	User id to use for all capability checks, etc. Set to 0 for current user (default).

Return values

core_calendar

◆ mod_survey_get_completion_active_rule_descriptions()

mod_survey_get_completion_active_rule_descriptions ( $cm )

Callback which returns human-readable strings describing the active completion custom rules for the module instance.

Parameters

cm_info | stdClass $cm object with fields ->completion and ->customdata['customcompletionrules']

Return values

array::$descriptions the array of descriptions for the custom rules.

◆ survey_add_analysis()

object survey_add_analysis	(	$survey,
		$user,
		$notes
	)

Parameters

int	$survey
int	$user
string	$notes

Return values

bool|int

◆ survey_add_instance()

object survey_add_instance ( $survey )

Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will create a new instance and return the id number of the new instance.

Parameters

object $survey

Return values

int|bool

◆ survey_already_done()

object survey_already_done	(	$survey,
		$user
	)

Parameters

int	$survey
int	$user

Return values

bool

◆ survey_check_updates_since()

survey_check_updates_since	(	cm_info	$cm,
			$from,
			$filter = `array()`
	)

Check if the module has any update that affects the current user since a given time.

Parameters

cm_info	$cm	course module data
int	$from	the time to check updates from
array	$filter	if we need to check only specific updates

Return values

stdClass an object with the different type of areas indicating if they were updated or not

Since: Moodle 3.2

◆ survey_count_responses()

survey_count_responses	(	$surveyid,
		$groupid,
		$groupingid
	)

Parameters

int	$surveyid
int	$groupid
int	$groupingid

Return values

int

◆ survey_delete_instance()

object survey_delete_instance ( $id )

Given an ID of an instance of this module, this function will permanently delete the instance and any data that depends on it.

Parameters

int $id

Return values

bool

◆ survey_extend_settings_navigation()

survey_extend_settings_navigation	(	$settings,
		$surveynode
	)

This function extends the settings navigation block for the site.

It is safe to rely on PAGE here as we will only ever be within the module context when this is called

Parameters

navigation_node	$settings
navigation_node	$surveynode

◆ survey_get_analysis()

object survey_get_analysis	(	$survey,
		$user
	)

Parameters

int	$survey
int	$user

Return values

array

◆ survey_get_completion_state()

survey_get_completion_state	(	$course,
		$cm,
		$userid,
		$type
	)

Obtains the automatic completion state for this survey based on the condition in feedback settings.

Parameters

object	$course	Course
object	$cm	Course-module
int	$userid	User ID
bool	$type	Type of comparison (or/and; can be used as return value if no conditions)

Return values

bool	True if completed, false if not, $type if conditions not set.

◆ survey_get_coursemodule_info()

survey_get_coursemodule_info ( $coursemodule )

Add a get_coursemodule_info function in case any survey type wants to add 'extra' information for the course (see resource).

Given a course_module object, this function returns any "extra" information that may be needed when printing this activity in a course listing. See get_array_of_activities() in course/lib.php.

Parameters

stdClass $coursemodule The coursemodule object (record).

Return values

cached_cm_info An object on information that the courses will know about (most noticeably, an icon).

◆ survey_get_post_actions()

survey_get_post_actions ( )

List the actions that correspond to a post of this module.

This is used by the participation report.

Note: This is not used by new logging system. Event with crud = ('c' || 'u' || 'd') and edulevel = LEVEL_PARTICIPATING will be considered as post action.

Return values

array

◆ survey_get_questions()

survey_get_questions ( $survey )

Returns the questions for a survey (ordered).

Parameters

stdClass $survey survey object

Return values

array list of questions ordered

Since: Moodle 3.0

Exceptions

moodle_exception

◆ survey_get_responses()

object survey_get_responses	(	$surveyid,
		$groupid,
		$groupingid
	)

Parameters

int	$surveyid
int	$groupid
int	$groupingid

Return values

array

◆ survey_get_subquestions()

survey_get_subquestions ( $question )

Returns subquestions for a given question (ordered).

Parameters

stdClass $question questin object

Return values

array list of subquestions ordered

Since: Moodle 3.0

◆ survey_get_template_name()

object survey_get_template_name ( $templateid )

Parameters

int $templateid

Return values

string

◆ survey_get_user_answer()

object survey_get_user_answer	(	$surveyid,
		$questionid,
		$userid
	)

Parameters

int	$surveyid
int	$questionid
int	$userid

Return values

array

◆ survey_get_user_answers()

object survey_get_user_answers	(	$surveyid,
		$questionid,
		$groupid,
		$sort = `"sa.answer1,sa.answer2 ASC"`
	)

Parameters

int	$surveyid
int	$groupid
string	$sort

Return values

array

◆ survey_get_view_actions()

survey_get_view_actions ( )

List the actions that correspond to a view of this module.

This is used by the participation report.

Note: This is not used by new logging system. Event with crud = 'r' and edulevel = LEVEL_PARTICIPATING will be considered as view action.

Return values

array

◆ survey_log_info()

object survey_log_info ( $log )

Parameters

sting $log

Return values

array

◆ survey_order_questions()

survey_order_questions	(	$questions,
		$questionorder
	)

Helper function for ordering a set of questions by the given ids.

Parameters

array	$questions	array of questions objects
array	$questionorder	array of questions ids indicating the correct order

Return values

array list of questions ordered

Since: Moodle 3.0

◆ survey_page_type_list()

survey_page_type_list	(	$pagetype,
		$parentcontext,
		$currentcontext
	)

Return a list of page types.

Parameters

string	$pagetype	current page type
stdClass	$parentcontext	Block's parent context
stdClass	$currentcontext	Current context of block

◆ survey_print_all_responses()

survey_print_all_responses	(	$cmid,
		$results,
		$courseid
	)

Parameters

int	$cmid
array	$results
int	$courseid

◆ survey_print_graph()

object survey_print_graph ( $url )

@global int @global int

Parameters

string $url

◆ survey_print_multi()

object survey_print_multi ( $question )

Todo:: Check this function

@global object @global int @global void This is never defined @global object This is defined twice?

Parameters

object $question

◆ survey_print_recent_activity()

stdClass survey_print_recent_activity	(	$course,
		$viewfullnames,
		$timestart
	)

@global object

Parameters

object	$course
mixed	$viewfullnames
int	$timestamp

Return values

bool

◆ survey_print_single()

object survey_print_single ( $question )

@global int

Parameters

object $question

◆ survey_question_rowclass()

survey_question_rowclass ( $qnum )

Parameters

int $qnum

Return values

string

◆ survey_reset_course_form_defaults()

survey_reset_course_form_defaults ( $course )

Course reset form defaults.

Return values

array

◆ survey_reset_course_form_definition()

survey_reset_course_form_definition ( & $mform )

Implementation of the function for printing the form elements that control whether the course reset functionality affects the survey.

Parameters

object $mform form passed by reference

◆ survey_reset_userdata()

object survey_reset_userdata ( $data )

Actual implementation of the reset course functionality, delete all the survey responses for course $data->courseid.

Parameters

$data the data submitted from the reset course.

Return values

array status array

◆ survey_save_answers()

survey_save_answers	(	$survey,
		$answersrawdata,
		$course,
		$context
	)

Save the answer for the given survey.

Parameters

stdClass	$survey	a survey object
array	$answersrawdata	the answers to be saved
stdClass	$course	a course object (required for trigger the submitted event)
stdClass	$context	a context object (required for trigger the submitted event)

Since: Moodle 3.0

◆ survey_shorten_name()

survey_shorten_name	(	$name,
		$numwords
	)

Parameters

string	$name
array	$numwords

Return values

string

◆ survey_supports()

survey_supports ( $feature )

@uses FEATURE_GROUPS @uses FEATURE_GROUPINGS @uses FEATURE_MOD_INTRO @uses FEATURE_COMPLETION_TRACKS_VIEWS @uses FEATURE_GRADE_HAS_GRADE @uses FEATURE_GRADE_OUTCOMES

Parameters

string $feature FEATURE_xx constant for requested feature

Return values

mixed True if module supports feature, false if not, null if doesn't know

◆ survey_translate_question()

survey_translate_question ( $question )

Translate the question texts and options.

Parameters

stdClass $question question object

Return values

stdClass question object with all the text fields translated

Since: Moodle 3.0

◆ survey_update_analysis()

object survey_update_analysis	(	$survey,
		$user,
		$notes
	)

Parameters

int	$survey
int	$user
string	$notes

◆ survey_update_instance()

object survey_update_instance ( $survey )

Given an object containing all the necessary data, (defined by the form in mod_form.php) this function will update an existing instance with new data.

Parameters

object $survey

Return values

bool

◆ survey_user_complete()

stdObject survey_user_complete	(	$course,
		$user,
		$mod,
		$survey
	)

@global object @uses SURVEY_CIQ

Parameters

object	$course
object	$user
object	$mod
object	$survey

◆ survey_user_outline()

object survey_user_outline	(	$course,
		$user,
		$mod,
		$survey
	)

Parameters

object	$course
object	$user
object	$mod
object	$survey

Return values

$result

◆ survey_view()

survey_view	(	$survey,
		$course,
		$cm,
		$context,
		$viewed
	)

Mark the activity completed (if required) and trigger the course_module_viewed event.

Parameters

stdClass	$survey	survey object
stdClass	$course	course object
stdClass	$cm	course module object
stdClass	$context	context object
string	$viewed	which page viewed

Since: Moodle 3.0

Variable Documentation

◆ $logs

$logs

Initial value:

= array(
    array('module'=>'survey', 'action'=>'add', 'mtable'=>'survey', 'field'=>'name'),
    array('module'=>'survey', 'action'=>'update', 'mtable'=>'survey', 'field'=>'name'),
    array('module'=>'survey', 'action'=>'download', 'mtable'=>'survey', 'field'=>'name'),
    array('module'=>'survey', 'action'=>'view form', 'mtable'=>'survey', 'field'=>'name'),
    array('module'=>'survey', 'action'=>'view graph', 'mtable'=>'survey', 'field'=>'name'),
    array('module'=>'survey', 'action'=>'view report', 'mtable'=>'survey', 'field'=>'name'),
    array('module'=>'survey', 'action'=>'submit', 'mtable'=>'survey', 'field'=>'name'),
)

◆ $SURVEY_QTYPE

$SURVEY_QTYPE

Initial value:

= array (
        "-3" => "Virtual Actual and Preferred",
        "-2" => "Virtual Preferred",
        "-1" => "Virtual Actual",
         "0" => "Text",
         "1" => "Actual",
         "2" => "Preferred",
         "3" => "Actual and Preferred",
        )

Question Type $SURVEY_QTYPE.

Files

Namespaces

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ mod_survey_core_calendar_provide_event_action()

◆ mod_survey_get_completion_active_rule_descriptions()

◆ survey_add_analysis()

◆ survey_add_instance()

◆ survey_already_done()

◆ survey_check_updates_since()

◆ survey_count_responses()

◆ survey_delete_instance()

◆ survey_extend_settings_navigation()

◆ survey_get_analysis()

◆ survey_get_completion_state()

◆ survey_get_coursemodule_info()

◆ survey_get_post_actions()

◆ survey_get_questions()

◆ survey_get_responses()

◆ survey_get_subquestions()

◆ survey_get_template_name()

◆ survey_get_user_answer()

◆ survey_get_user_answers()

◆ survey_get_view_actions()

◆ survey_log_info()

◆ survey_order_questions()

◆ survey_page_type_list()

◆ survey_print_all_responses()

◆ survey_print_graph()

◆ survey_print_multi()

◆ survey_print_recent_activity()

◆ survey_print_single()

◆ survey_question_rowclass()

◆ survey_reset_course_form_defaults()

◆ survey_reset_course_form_definition()

◆ survey_reset_userdata()

◆ survey_save_answers()

◆ survey_shorten_name()

◆ survey_supports()

◆ survey_translate_question()

◆ survey_update_analysis()

◆ survey_update_instance()

◆ survey_user_complete()

◆ survey_user_outline()

◆ survey_view()

Variable Documentation

◆ $logs

◆ $SURVEY_QTYPE