Cron (command): Difference between revisions
From LimeSurvey Manual
DenisChenu (talk | contribs) Page creation |
DenisChenu (talk | contribs) No edit summary |
||
(7 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{FeatureStarting|2.06}} | {{FeatureStarting|2.06}} | ||
{{FeatureChange|2.57.2}} | |||
''' | '''Usage''' | ||
This event | This event is used when server admin sets a crontab command. | ||
'''How to use''' | '''How to use''' | ||
This event | This event needs to be called with php cli command. | ||
<code>php yourlimesurveydir/application/commands/console.php plugin cron --interval=X</code> | |||
{{Alert|title=Before 2.75.2|text=You must call the command in the LimeSurvey directory.The directory <code>yourlimesurveydir/application/runtime</code> must be writable by the webserver and the interval is not in option.}} | |||
'''Input''' | '''Input''' | ||
Line 14: | Line 17: | ||
The event receives the following information: | The event receives the following information: | ||
''interval'' the interval parameter | * '''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]] | [[Category:Plugins events]] |
Latest revision as of 18:13, 17 November 2017
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.
php yourlimesurveydir/application/commands/console.php plugin cron --interval=X

yourlimesurveydir/application/runtime
must be writable by the webserver and the interval is not in option.
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.