Download the PHP package philippgrashoff/cronforatk without Composer
On this page you can find all versions of the php package philippgrashoff/cronforatk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package cronforatk
cronforatk
This repository is an extension for atk4/data. It enables you to easily set and store the execution of many different cronjobs. Many different schedule options from yearly to minutely are available. The logic of these cronjobs has to be implemented separately.
The repository consists of these classes:
- BaseCronJob: This is a base for all real cronjobs. The actual logic for a cronjob is implemented in a class extending BaseCronJob.
- Scheduler: This is used to persist each wanted execution. It contains the info which BaseCronJob child should be executed when.
- Executor: This class contains all the logic to decide when which Scheduler (and hence the corresponding BaseCronJob child) should be executed. Executor::run() needs to be executed each minute by a system cron for this repo to work properly.
- ExecutionLog: In here, execution results are logged. If execution results should be logged can be defined per Scheduler.
- CronJobLoader: This is a small helper. As all Cronjobs are stored as PHP classes, this class checks given directories for available BaseCronJob implementations.
How to use
Installation
The easiest way to use this repository is to add it to your composer.json in the require section:
Setup Database
Two classes in this package need a database table: Scheduler and ExecutionLog You can use Atk4\Data\Schema\Migrator to create these 2 tables and the foreign key in your database.
Sample usage
1) Create a real cronjob that extends BaseCronJob
2) Add one or more Schedulers to schedule when the cronjob should be executed
Note: You can create a nice UI to create and update schedulers by using atk4\ui. In the following sample code, the schedulers are solely created on data level.
3) Run Executor::run() minutely
Executor::run() checks which schedulers (and hence cronjobs) need to be executed at each minute by the definitions set in the schedulers. Add a simple script which is executed each minute by the system cron:
All sample code from this readme can be found in the docs directory.
Versioning
The version numbers of this repository correspond with the atk4\data versions. So 4.0.x is compatible with atk4\data 4.0.x and so on.
Open Todos
- Currently, there are different time fields in Scheduler: time_yearly, time_monthly, time_weekly and time_daily. This should be replaced be a single time field.
- There is no locking implemented (A cronjob could still be in schedule/currently being executed while being executed again by the next minutely Executor::run()). This should only be an issue for crons that are executed minutely.
- There currently is no option to execute a cronjob at the last day of the month. This would be a sensible addition.
