Actions

BeforeSurveyDeactivate

From LimeSurvey Manual

Revision as of 10:58, 17 August 2016 by Olle (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
 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.');
  }
}