BeforeSurveyActivate: Difference between revisions
From LimeSurvey Manual
No edit summary |
mNo edit summary |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
'''When''' | '''When''' | ||
| Line 10: | Line 8: | ||
The event receives the following information: | The event receives the following information: | ||
{| | |||
! Name !! Type !! Description | |||
|- | |||
| surveyId || integer || The id of the current survey | |||
|- | |||
| simulate || boolean || - | |||
|} | |||
| Line 19: | Line 21: | ||
The following information can be set in the event: | 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 | |||
|} | |||
| Line 27: | Line 35: | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
public function beforeSurveyActivate() | |||
{ | |||
$event = $this->getEvent(); | |||
if ($this->checkSomeCondition()) | |||
{ | |||
$event->set('success', false); | |||
$event->set('message', 'Can\'t activate survey - some condition is not met.'); | |||
} | |||
} | |||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:Plugins events]] | [[Category:Plugins events]] | ||
Latest revision as of 22:43, 24 February 2021
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
public function beforeSurveyActivate()
{
$event = $this->getEvent();
if ($this->checkSomeCondition())
{
$event->set('success', false);
$event->set('message', 'Can\'t activate survey - some condition is not met.');
}
}