Cron (command): Difference between revisions
From LimeSurvey Manual
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{FeatureStarting|2.06}} | {{FeatureStarting|2.06}} | ||
''' | '''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> | <code>php yourlimesurveydir/application/commands/console.php plugin cron --interval=X<code> | ||
| Line 13: | Line 13: | ||
The event receives the following information: | The event receives the following information: | ||
''interval'' the interval parameter, set this to the interval (in minutes) you run this cron job. Plugins can use this information to self-limit their execution time | ''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]] | ||
Revision as of 11:43, 7 April 2014
Hint: This features is available starting in version 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.
php yourlimesurveydir/application/commands/console.php plugin cron --interval=X
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.