Actions

Cron (command): Difference between revisions

From LimeSurvey Manual

No edit summary
({{FeatureChange|2.57.2}})
Line 1: Line 1:
{{FeatureStarting|2.06}}  
{{FeatureStarting|2.06}}  
{{FeatureChange|2.57.2}}


'''Usage'''
'''Usage'''
Line 10: Line 11:
<code>php yourlimesurveydir/application/commands/console.php plugin cron --interval=X</code>
<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.
{{Alert|title=Before 2.75.2|text=You must call the command in the LimeSurvey directiry.The directory <code>yourlimesurveydir/application/runtime</code> must be writable by the webserver and the interval is not in option.}}


'''Input'''
'''Input'''


The event receives the following information:
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.
 
* '''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 17:24, 17 December 2016

 Hint: This features is available starting in version 2.06
 Hint: This feature changed with version 2.57.2


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

  Before 2.75.2 : You must call the command in the LimeSurvey directiry.The directory 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.