Actions

Plugin events: Difference between revisions

From LimeSurvey Manual

m (Fore redirect)
 
(66 intermediate revisions by 12 users not shown)
Line 1: Line 1:
At version 2.05+ build 140320 the following events are available for plugins to subscribe to:
As of version 5 the following events are available for plugins to subscribe to:
*[[Authentication plugin development#afterLoginFormSubmit|afterLoginFormSubmit]]
 
*[[Authentication plugin development#afterLogout|afterLogout]]
== Global Events ==
 
*[[afterFindSurvey]]
*[[afterGenerateToken]]
*[[afterPluginLoad]]
*[[afterPluginLoad]]
*[[afterQuickMenuLoad]]
*[[afterSurveyActivate]]
*[[afterSurveyComplete]]
*[[afterSurveyComplete]]
*[[afterSurveyQuota]]{{NewIn|v=2.05|b=141006}}
*[[afterSurveyDeactivate]]
*[[afterSurveyQuestionAssessment]]
*[[afterSurveyQuota]]
*[[afterSurveySettingsSave]]
*[[beforeActivate]]
*[[beforeActivate]]
*[[beforeAdminMenuRender]]
*[[beforeEmail]]
*[[beforeCloseHtml]]
*[[beforeControllerAction]]
*[[beforeDeactivate]]
*[[beforeDeactivate]]
*[[beforeHasPermission]]{{NewIn|v=2.06}}
*[[beforeHasPermission]]
*[[beforeLogin]]
*[[beforeLoadResponse]]
*[[beforeLogout]]
*[[beforeRenderQuestion]]{{NewIn|v=2.05|b=140922}}
*[[beforeRegister]]{{NewIn|v=2.06}}
*[[beforeRegisterForm]]{{NewIn|v=2.06}}
*[[beforePermissionSetSave]]
*[[beforePermissionSetSave]]
*[[beforeSurveyPage]]{{NewIn|v=2.05|b=140109}}
*[[beforePluginManagerMenuRender]]
*[[beforeQuestionRender]]
*[[beforeRegister]]
*[[beforeRegisterForm]]
*[[beforeSideMenuRender]]
*[[beforeSurveyAdminView]]
*[[beforeSurveyActivate]]
*[[beforeSurveyBarRender]]
*[[beforeSurveyDeactivate]]
*[[beforeSurveyEmail]]
*[[beforeSurveyPage]]
*[[beforeSurveySettings]]
*[[beforeSurveySettings]]
*[[beforeTokenEmail]]{{NewIn|v=2.05|b=140404}}
*[[beforeSurveysStartpageRender]]{{DeprecatedIn|v=3.0.0}}
*[[cron]]{{NewIn|v=2.05|b=140404}}
*[[beforeTokenEmail]]
*[[beforeTwigRenderTemplate]]
*[[beforeToolsMenuRender]]
*[[beforeUrlCheck]]
*[[beforeWelcomePageRender]]
*[[createNewUser]]
*[[createRandomPassword]]
*[[checkPasswordRequirement]]
*[[ExpressionManagerStart]]
*[[getGlobalBasePermissions]]
*[[getPluginTwigPath]]
*[[getValidScreenFiles]]
*[[listExportOptions]]
*[[listExportOptions]]
*[[listExportPlugins]]
*[[listExportPlugins]]
Line 23: Line 52:
*[[newDirectRequest]]
*[[newDirectRequest]]
*[[newExport]]
*[[newExport]]
*[[NewQuestionAttributes|newQuestionAttributes]]
*[[newSurveySettings]]
*[[newUnsecureRequest|NewUnsecureRequest]]
*[[onSurveyDenied]]
*[[setVariableExpressionEnd]]
*[[saveSurveyForm]]{{NewIn|v=5.3.8}}
== CLI Events ==
This events needs to be called with php cli command.
*[[cron (command)|cron]]
*[[direct (command)|direct]]
== Authentification related events ==
*[[newLoginForm]]
*[[newLoginForm]]
*[[newSurveySettings]]
*[[Authentication plugin development#afterLoginFormSubmit|afterLoginFormSubmit]]
*[[afterSuccessfulLogin]]
*[[newUserLogin]]
*[[newUserSession]]
*[[newUserSession]]
*[[Authentication plugin development#afterLogout|afterLogout]]
*[[afterFailedLoginAttempt]]
*[[Authentication plugin development#remoteControlLogin|remoteControlLogin]]
== Model 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):
* beforeSurveyDelete
* beforeSurveySave
* afterSurveyDelete
* afterSurveySave
[https://github.com/LimeSurvey/LimeSurvey/tree/master/application/models Available model in application/models/.]
=== [[Dynamic model events]]{{NewIn|v=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:
<code>$model = $this->event->get('model');</code>


[[Category:Development]]
[[Category:Development]]
[[Category:Plugins]]
[[Category:Plugins]]

Latest revision as of 12:17, 23 February 2024

As of version 5 the following events are available for plugins to subscribe to:

Global Events

CLI Events

This events needs to be called with php cli command.

Authentification related 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

Available model in application/models/.

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');

Retrieved from "http://manual.limesurvey.org/index.php?title=Plugin_events&oldid=374723"