[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/mod/survey/ -> lib.php (summary)

(no description)

Copyright: 1999 onwards Martin Dougiamas {@link http://moodle.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 840 lines (27 kb)
Included or required: 5 times
Referenced: 0 times
Includes or requires: 0 files

Defines 31 functions

  survey_add_instance()
  survey_update_instance()
  survey_delete_instance()
  survey_user_outline()
  survey_user_complete()
  survey_print_recent_activity()
  survey_log_info()
  survey_get_responses()
  survey_get_analysis()
  survey_update_analysis()
  survey_get_user_answers()
  survey_get_user_answer()
  survey_add_analysis()
  survey_already_done()
  survey_count_responses()
  survey_print_all_responses()
  survey_get_template_name()
  survey_shorten_name()
  survey_print_multi()
  survey_print_single()
  survey_question_rowclass()
  survey_print_graph()
  survey_get_view_actions()
  survey_get_post_actions()
  survey_reset_course_form_definition()
  survey_reset_course_form_defaults()
  survey_reset_userdata()
  survey_get_extra_capabilities()
  survey_supports()
  survey_extend_settings_navigation()
  survey_page_type_list()

Functions
Functions that are not part of a class:

survey_add_instance($survey)   X-Ref
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.

param: object $survey
return: int|bool

survey_update_instance($survey)   X-Ref
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.

param: object $survey
return: bool

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

param: int $id
return: bool

survey_user_outline($course, $user, $mod, $survey)   X-Ref

param: object $course
param: object $user
param: object $mod
param: object $survey
return: $result

survey_user_complete($course, $user, $mod, $survey)   X-Ref

param: object $course
param: object $user
param: object $mod
param: object $survey

survey_print_recent_activity($course, $viewfullnames, $timestart)   X-Ref

param: object $course
param: mixed $viewfullnames
param: int $timestamp
return: bool

survey_log_info($log)   X-Ref

param: sting $log
return: array

survey_get_responses($surveyid, $groupid, $groupingid)   X-Ref

param: int $surveyid
param: int $groupid
param: int $groupingid
return: array

survey_get_analysis($survey, $user)   X-Ref

param: int $survey
param: int $user
return: array

survey_update_analysis($survey, $user, $notes)   X-Ref

param: int $survey
param: int $user
param: string $notes

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

param: int $surveyid
param: int $groupid
param: string $sort
return: array

survey_get_user_answer($surveyid, $questionid, $userid)   X-Ref

param: int $surveyid
param: int $questionid
param: int $userid
return: array

survey_add_analysis($survey, $user, $notes)   X-Ref

param: int $survey
param: int $user
param: string $notes
return: bool|int

survey_already_done($survey, $user)   X-Ref

param: int $survey
param: int $user
return: bool

survey_count_responses($surveyid, $groupid, $groupingid)   X-Ref

param: int $surveyid
param: int $groupid
param: int $groupingid
return: int

survey_print_all_responses($cmid, $results, $courseid)   X-Ref

param: int $cmid
param: array $results
param: int $courseid

survey_get_template_name($templateid)   X-Ref

param: int $templateid
return: string

survey_shorten_name($name, $numwords)   X-Ref

param: string $name
param: array $numwords
return: string

survey_print_multi($question)   X-Ref

param: object $question

survey_print_single($question)   X-Ref

param: object $question

survey_question_rowclass($qnum)   X-Ref

param: int $qnum
return: string

survey_print_graph($url)   X-Ref

param: string $url

survey_get_view_actions()   X-Ref
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: array

survey_get_post_actions()   X-Ref
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: array

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

param: object $mform form passed by reference

survey_reset_course_form_defaults($course)   X-Ref
Course reset form defaults.

return: array

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

param: $data the data submitted from the reset course.
return: array status array

survey_get_extra_capabilities()   X-Ref
Returns all other caps used in module

return: array

survey_supports($feature)   X-Ref

param: string $feature FEATURE_xx constant for requested feature
return: mixed True if module supports feature, false if not, null if doesn't know

survey_extend_settings_navigation($settings, $surveynode)   X-Ref
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

param: navigation_node $settings
param: navigation_node $surveynode

survey_page_type_list($pagetype, $parentcontext, $currentcontext)   X-Ref
Return a list of page types

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



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1