BeforeSurveyActivate: Difference between revisions
From LimeSurvey Manual
No edit summary |
Markusfluer (talk | contribs) No edit summary |
||
(2 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
'''When''' | '''When''' | ||
Line 37: | 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]] |
Revision as of 12:45, 6 November 2018
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.');
}
}