LimeSurvey Manual - User contributions [en]

Plugin events

2016-09-23T00:06:14Z

YuriyBabenko: added 11 events found in codebase, but not documented;

At version 2.50 build 160425 the following events are available for plugins to subscribe to:
*[[Authentication plugin development#afterLoginFormSubmit|afterLoginFormSubmit]]
*[[Authentication plugin development#afterLogout|afterLogout]]
*[[afterFailedLoginAttempt]]
*[[afterPluginLoad]]
*[[afterQuickMenuLoad]]
*[[afterSuccessfulLogin]]
*[[afterSurveyComplete]]
*[[afterSurveyQuota]]{{NewIn|v=2.05|b=141006}}
*[[afterSurveySettingsSave]]
*[[beforeActivate]]
*[[beforeAdminMenuRender]]
*[[beforeControllerAction]]{{NewIn|v=2.50|b=160425}}
*[[beforeDeactivate]]
*[[beforeHasPermission]]{{NewIn|v=2.06}}
*[[beforeLoadResponse]]
*[[beforeLogin]]
*[[beforeLogout]]
*[[beforeQuestionRender]]{{NewIn|v=2.05|b=140922}}
*[[beforeParticipantSave]]
*[[beforeParticipantDelete]]
*[[beforePermissionSetSave]]
*[[beforeRegister]]{{NewIn|v=2.06}}
*[[beforeRegisterForm]]{{NewIn|v=2.06}}
*[[beforeSideMenuRender]]{{NewIn|v=2.51.0}}
*[[beforeSurveyAdminView]]
*[[beforeTokenDelete]]
*[[beforeTokenSave]]
*[[beforeSurveyActivate]]{{NewIn|v=2.5}}
*[[beforeSurveyBarRender]]{{NewIn|v=2.51.0}}
*[[beforeSurveyDeactivate]]{{NewIn|v=2.5}}
*[[beforeSurveyPage]]{{NewIn|v=2.05|b=140109}}
*[[beforeSurveySettings]]
*[[beforeSurveySettingsSave]]
*[[beforeSurveysStartpageRender]]
*[[beforeTokenEmail]]{{NewIn|v=2.05|b=140404}}
*[[beforeToolsMenuRender]]
*[[beforeUserSave]]
*[[beforeUserDelete]]
*[[createNewUser]]
*[[cron]]{{NewIn|v=2.05|b=140404}}
*[[listExportOptions]]
*[[listExportPlugins]]
*[[listQuestionPlugins]]
*[[newDirectRequest]]
*[[newExport]]
*[[newLoginForm]]
*[[NewQuestionAttributes|newQuestionAttributes]]{{NewIn|v=2.50|b=160731}}
*[[newSurveySettings]]
*[[newUnsecureRequest]]
*[[newUserSession]]
*[[newUserLogin]]
*[[onSurveyDenied]]{{NewIn|v=2.5}}

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

== Model Events ==

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

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

* [[beforeSurveyDelete]]
* [[beforeSurveySave]]
* [[afterSurveyDelete]]
* [[afterSurveySave]]

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

* [[beforeModelDelete]]
* [[beforeModelSave]]
* [[afterModelDelete]]
* [[afterModelSave]]

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

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

Plugin events

2016-09-16T00:31:22Z

YuriyBabenko:

At version 2.50 build 160425 the following events are available for plugins to subscribe to:
*[[Authentication plugin development#afterLoginFormSubmit|afterLoginFormSubmit]]
*[[Authentication plugin development#afterLogout|afterLogout]]
*[[afterFailedLoginAttempt]]
*[[afterPluginLoad]]
*[[afterSurveyComplete]]
*[[afterSurveyQuota]]{{NewIn|v=2.05|b=141006}}
*[[beforeActivate]]
*[[beforeControllerAction]]{{NewIn|v=2.50|b=160425}}
*[[beforeDeactivate]]
*[[beforeHasPermission]]{{NewIn|v=2.06}}
*[[beforeLoadResponse]]
*[[beforeLogin]]
*[[beforeLogout]]
*[[beforeQuestionRender]]{{NewIn|v=2.05|b=140922}}
*[[beforeParticipantSave]]
*[[beforeParticipantDelete]]
*[[beforePermissionSetSave]]
*[[beforeRegister]]{{NewIn|v=2.06}}
*[[beforeRegisterForm]]{{NewIn|v=2.06}}
*[[beforeSideMenuRender]]{{NewIn|v=2.51.0}}
*[[beforeTokenDelete]]
*[[beforeTokenSave]]
*[[beforeSurveyActivate]]{{NewIn|v=2.5}}
*[[beforeSurveyBarRender]]{{NewIn|v=2.51.0}}
*[[beforeSurveyDeactivate]]{{NewIn|v=2.5}}
*[[beforeSurveyPage]]{{NewIn|v=2.05|b=140109}}
*[[beforeSurveySettings]]
*[[beforeTokenEmail]]{{NewIn|v=2.05|b=140404}}
*[[beforeUserSave]]
*[[beforeUserDelete]]
*[[cron]]{{NewIn|v=2.05|b=140404}}
*[[listExportOptions]]
*[[listExportPlugins]]
*[[listQuestionPlugins]]
*[[newDirectRequest]]
*[[newExport]]
*[[newLoginForm]]
*[[NewQuestionAttributes|newQuestionAttributes]]{{NewIn|v=2.50|b=160731}}
*[[newSurveySettings]]
*[[newUserSession]]
*[[onSurveyDenied]]{{NewIn|v=2.5}}

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

== Model Events ==

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

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

* [[beforeSurveyDelete]]
* [[beforeSurveySave]]
* [[afterSurveyDelete]]
* [[afterSurveySave]]

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

* [[beforeModelDelete]]
* [[beforeModelSave]]
* [[afterModelDelete]]
* [[afterModelSave]]

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

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

Cron (command)

2016-09-13T23:54:30Z

YuriyBabenko:

{{FeatureStarting|2.06}}

'''Usage'''

This event is used when server admin sets a crontab command.

'''How to use'''

This event needs to be called with php cli command.
<code>php yourlimesurveydir/application/commands/console.php plugin cron --interval=X</code>

The directory <code>yourlimesurveydir/application/runtime</code> must be writable by the webserver.

'''Input'''

The event receives the following information:
''interval'' the interval parameter, set this to the interval (in minutes) you want to run this cron job. Plugins can use this information to self-limit their execution time or check when the event will fire next.

[[Category:Plugins events]]