QuestionnaireAssignmentPlugin Interface Reference

Public Member Functions
	isQuestionnaireViewable (QuestionnaireAssignment $questionnaire)
	isQuestionnaireEditable (QuestionnaireAssignment $questionnaire)
	getQuestionnaireAssignmentName (QuestionnaireAssignment $questionnaire)
	getQuestionnaireAssignmentEditTemplate (Questionnaire $questionnaire)
	storeQuestionnaireAssignments (Questionnaire $questionnaire)

Detailed Description

Interface QuestionnaireAssignmentPlugin Implement this interface if you want to relate Stud.IP-questionnaires to your plugin-contents. By storing an assignment you should set the range_type to something unique that is related to your plugin like "mytaskplugin". In all methods you should first check if the assignment is related to your plugin, because other QuestionnaireAssignmentPlugins might be installed as well.

Member Function Documentation

getQuestionnaireAssignmentEditTemplate()

getQuestionnaireAssignmentEditTemplate

(

Questionnaire

$questionnaire

)

This template will get displayed when someone at tools -> questionnaires wants to edit the contexts of the questionnaire. Maybe you don't want to provide a template here, so return null or just a readonly html-snippet.

Parameters

Questionnaire

$questionnaire

Returns

null|Flexi

getQuestionnaireAssignmentName()

getQuestionnaireAssignmentName

(

QuestionnaireAssignment

$questionnaire

)

The display name of the assignment.

Parameters

QuestionnaireAssignment

$questionnaire

Returns

string

isQuestionnaireEditable()

isQuestionnaireEditable

(

QuestionnaireAssignment

$questionnaire

)

Returns if the questionnaire is editable dependend on the assignment. Check for the range_type and range_id to see if the the assignment has to do with your plugin (and not with somebody else's plugin) and if type and id fit.

Parameters

QuestionnaireAssignment

$questionnaire

Returns

boolean

isQuestionnaireViewable()

isQuestionnaireViewable

(

QuestionnaireAssignment

$questionnaire

)

Returns if the questionnaire is viewable dependend on the assignment. Check for the range_type and range_id to see if the the assignment has to do with your plugin (and not with somebody else's plugin) and if type and id fit.

Parameters

QuestionnaireAssignment

$questionnaire

Returns

boolean

storeQuestionnaireAssignments()

storeQuestionnaireAssignments

(

Questionnaire

$questionnaire

)

When the context of the questionnaire is stored at tools -> questionnaires (where the template from getQuestionnaireAssignmentEditTemplate was displayed) you should use this method to store your assignments as well.

Parameters

Questionnaire

$questionnaire

Returns

null

---

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

• lib/plugins/core/QuestionnaireAssignmentPlugin.php