BeforeSurveyActivate: Difference between revisions

Revision as of 16:14, 18 August 2016

Hint: This features is available starting in version 2.5

When

This event is fired just before the survey is activated.

Input

The event receives the following information:

Name	Type	Description
surveyid	integer	The id of the current survey
simulate	boolean	-

Possible output

The following information can be set in the event:

Name	Type	Description
success	boolean	False will abort the activation
message	string	Error message to show. This will be shown independent of success
pluginFeedback	string	If set, will show this HTML instead of the default success feedback message

Example

// todo

@@ Line 13: / Line 13: @@
 ! Name !! Type !! Description
 |-
-| surveyid || Integer || The id of the current survey
+| surveyid || integer || The id of the current survey
 |-
 | simulate || boolean || -
@@ Line 23: / Line 23: @@
 The following information can be set in the event:
-''success'' False will abort the activation
+{|
+! Name !! Type !! Description
-''message'' Error message to show. This will be shown independent of ''success''
+|-
+| success || boolean || False will abort the activation
-''pluginFeedback'' HTML; if set, will show this HTML instead of the default success feedback message
+|-
+| message || string || Error message to show. This will be shown independent of ''success''
+|-
+| pluginFeedback || string || If set, will show this HTML instead of the default success feedback message
+|}
@@ Line 33: / Line 37: @@
 <syntaxhighlight lang="php">
+// todo
 </syntaxhighlight>
 [[Category:Plugins events]]