BeforeSurveyDeactivate: Difference between revisions
From LimeSurvey Manual
Created page with "{{FeatureStarting|2.5}} '''When''' This event is fired just before the survey deactivation screen. '''Input''' The event receives the following information: ''surveyId''..." |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
This event is fired just before the survey deactivation screen. | This event is fired just before the survey deactivation screen. | ||
'''Input''' | '''Input''' | ||
| Line 19: | Line 20: | ||
''message'' Error message to show. This will be shown independent of ''success'' | ''message'' Error message to show. This will be shown independent of ''success'' | ||
'''Example''' | '''Example''' | ||
| Line 25: | Line 27: | ||
public function beforeSurveyDeactivate() | public function beforeSurveyDeactivate() | ||
{ | { | ||
$event = $this->getEvent(); | |||
$surveyId = $event->get('surveyId'); | |||
$survey = Survey::model()->findByPk($surveyId); | |||
if ($survey->owner_id == Yii::app()->user->id) | |||
{ | |||
$event->set('success', false); | |||
$event->set('message', 'User can\'t disable his/hers own survey. Silly.'); | |||
} | |||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
[[Category:Plugins events]] | [[Category:Plugins events]] | ||
Latest revision as of 10:58, 17 August 2016
Hint: This features is available starting in version 2.5
When
This event is fired just before the survey deactivation screen.
Input
The event receives the following information:
surveyId the id of the current survey
Possible output
The following information can be set in the event:
success False will hide the deactivation options
message Error message to show. This will be shown independent of success
Example
public function beforeSurveyDeactivate()
{
$event = $this->getEvent();
$surveyId = $event->get('surveyId');
$survey = Survey::model()->findByPk($surveyId);
if ($survey->owner_id == Yii::app()->user->id)
{
$event->set('success', false);
$event->set('message', 'User can\'t disable his/hers own survey. Silly.');
}
}