Actions

Difference between revisions of "Plugin events"

From LimeSurvey Manual

(Global Events)
(Global Events)
Line 42: Line 42:
 
*[[beforeSurveySettings]]
 
*[[beforeSurveySettings]]
 
*[[beforeSurveySettingsSave]]
 
*[[beforeSurveySettingsSave]]
*[[beforeSurveysStartpageRender]]{{DeprecatedIn|v=3.10.0}}
+
*[[beforeSurveysStartpageRender]]{{DeprecatedIn|v=3.0.0}}
 
*[[beforeTokenEmail]]{{NewIn|v=2.05|b=140404}}
 
*[[beforeTokenEmail]]{{NewIn|v=2.05|b=140404}}
 
*[[beforeToolsMenuRender]]
 
*[[beforeToolsMenuRender]]

Revision as of 13:15, 13 November 2018

At version 2.50 build 160425 the following events are available for plugins to subscribe to:

NB: Version 2.60.0 is not the save as version 2.6, which is the new number for version 2.06. 2.60.0 comes after 2.59.1.

Global Events

Model Events

All models (Survey, Question, etc.) support a series of before & after events.

Specific Model events

These include model-specific events (example for Survey model):

  • beforeSurveyDelete
  • beforeSurveySave
  • afterSurveyDelete
  • afterSurveySave

Dynamic model events (New in 3.15.1 )

  • beforeTokenDelete
  • beforeTokenSave
  • afterTokenDelete
  • afterTokenSave
  • beforeResponseDelete
  • beforeResponseSave
  • afterResponseDelete
  • afterResponseSave
  • beforeTokenDynamicDelete
  • beforeTokenDynamicSave
  • afterTokenDynamicDelete
  • afterTokenDynamicSave
  • beforeSurveyDynamicDelete
  • beforeSurveyDynamicSave
  • afterSurveyDynamicDelete
  • afterSurveyDynamicSave

Generic events

As well as generic events independent of the model's name:

In all of the above events, the associated model object is available as part of event data:

$model = $this->event->get('model');