Plugin events: Difference between revisions
From LimeSurvey Manual
No edit summary |
DenisChenu (talk | contribs) |
||
| Line 70: | Line 70: | ||
All models (Survey, Question, etc.) support a series of before & after events. | All models (Survey, Question, etc.) support a series of before & after events. | ||
=== [[Specific model events|Specific Model events]] === | |||
These include model-specific events (example for Survey model): | These include model-specific events (example for Survey model): | ||
| Line 77: | Line 79: | ||
* [[afterSurveyDelete]] | * [[afterSurveyDelete]] | ||
* [[afterSurveySave]] | * [[afterSurveySave]] | ||
=== [[Dynamic model events]]{{NewIn|v=3.15.1}}=== | |||
* beforeTokenDelete | |||
* beforeTokenSave | |||
* afterTokenDelete | |||
* afterTokenSave | |||
* beforeResponseDelete | |||
* beforeResponseSave | |||
* afterResponseDelete | |||
* afterResponseSave | |||
* beforeTokenDynamicDelete | |||
* beforeTokenDynamicSave | |||
* afterTokenDynamicDelete | |||
* afterTokenDynamicSave | |||
* beforeSurveyDynamicDelete | |||
* beforeSurveyDynamicSave | |||
* afterSurveyDynamicDelete | |||
* afterSurveyDynamicSave | |||
=== [[Model events|Generic events]] === | |||
As well as generic events independent of the model's name: | As well as generic events independent of the model's name: | ||
* | * beforeModelDelete | ||
* | * beforeModelSave | ||
* | * afterModelDelete | ||
* | * afterModelSave | ||
* | * beforeModelDeleteMany | ||
In all of the above events, the associated model object is available as part of event data: | In all of the above events, the associated model object is available as part of event data: | ||
<code>$model = $this->event->get('model');</code> | <code>$model = $this->event->get('model');</code> | ||
Revision as of 15:09, 10 October 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.
- afterLoginFormSubmit
- afterLogout
- afterFailedLoginAttempt
- afterFindSurvey
- afterPluginLoad
- afterQuickMenuLoad
- afterSuccessfulLogin
- afterSurveyComplete
- afterSurveyQuestionAssessment (New in 2.62 build 170207)
- afterSurveyQuota (New in 2.05 build 141006)
- afterSurveySettingsSave
- beforeActivate
- beforeAdminMenuRender
- beforeCloseHtml (New in 2.60.0 )
- beforeControllerAction (New in 2.50 build 160425)
- beforeDeactivate
- beforeHasPermission (New in 2.06 )
- beforeLoadResponse
- beforeLogin
- beforeLogout
- beforeParticipantSave
- beforeParticipantDelete
- beforePermissionSetSave
- beforePluginManagerMenuRender (New in 4.0.0 )
- beforeQuestionRender (New in 2.05 build 140922)
- beforeRegister (New in 2.06 )
- beforeRegisterForm (New in 2.06 )
- beforeSideMenuRender (New in 2.51.0 )
- beforeSurveyAdminView
- beforeTokenDelete
- beforeTokenSave
- beforeSurveyActivate(Not yet released)
- beforeSurveyBarRender (Not yet released)
- beforeSurveyDeactivate (New in 2.5 )
- beforeSurveyPage (New in 2.05 build 140109)
- beforeSurveySettings
- beforeSurveySettingsSave
- beforeSurveysStartpageRender
- beforeTokenEmail (New in 2.05 build 140404)
- beforeToolsMenuRender
- beforeUserSave
- beforeUserDelete
- createNewUser
- cron (command) (New in 2.05 build 140404)
- direct (command) (New in 2.63.0 build 170304)
- getGlobalBasePermissions] (New in 3.0.0 )
- getPluginTwigPath (New in 3.10.0 )
- listExportOptions
- listExportPlugins
- listQuestionPlugins
- newDirectRequest
- newExport
- newLoginForm
- newQuestionAttributes (New in 2.50 build 160731)
- newSurveySettings
- NewUnsecureRequest
- newUserSession
- newUserLogin
- onSurveyDenied (New in 3.0.0 )
- beforeUrlCheck (New in 3.12.2 )
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):
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:
- beforeModelDelete
- beforeModelSave
- afterModelDelete
- afterModelSave
- beforeModelDeleteMany
In all of the above events, the associated model object is available as part of event data:
$model = $this->event->get('model');