justinyost / cakephp-queue
The Queue plugin for CakePHP provides deferred task execution, forked to support SQLite.
Installs: 34
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 137
Type:cakephp-plugin
Requires
- php: >=5.5
- cakephp/cakephp: ^3.2
Requires (Dev)
- cakephp/migrations: ^1.0
- dereuromark/cakephp-tools: ^1.2
- fig-r/psr2r-sniffer: dev-master
Suggests
- dereuromark/cakephp-tools: For the Email lib and QueueEmailTask. Or write your own task here. Also for admin backend.
README
This branch is for use with CakePHP 3 and SQLite. It is a fork only for use to support SQLite, the real version of this package should be used at: https://github.com/dereuromark/cakephp-queue.
Background
This is a very simple and minimalistic job queue (or deferred-task) system for CakePHP. It is mainly for demo purposes on how queues work and doesn't have any dependencies.
Overall functionality is inspired by systems like Gearman, Beanstalk or dropr, but without any illusion to compete with these more advanced Systems.
The plugin is an attempt to provide a basic, simple to use method to enable deferred job execution, without the hassle of setting up or running an extra queue daemon, while integrating nicely into CakePHP and also simplifying the creation of worker scripts.
Please also read the blog post. For more robust and production use cases please see the awesome list.
Why use deferred execution?
Deferred execution makes sense (especially in PHP) when your page wants to execute tasks, which are not directly related to rendering the current page. For instance, in a BBS-type system, a new users post might require the creation of multiple personalized email messages, notifying other users of the new content. Creating and sending these emails is completely irrelevant to the currently active user, and should not increase page response time. Another example would be downloading, extraction and/or analyzing an external file per request of the user. The regular solution to these problems would be to create specialized cronjobs which use specific database states to determine which action should be done.
The Queue plugin provides a simple method to create and run such non-user-interaction-critical tasks.
While you can run multiple workers, and can (to some extent) spread these workers to different machines via a shared database, you should seriously consider using a more advanced system for high volume/high number of workers systems.
Installation and Usage
See Documentation.
Limitation
If you want to use multiple workers, please use only one per type. Currently it would otherwise risk the jobs being run multiple times!
History
Recent Improvements
- QueuedJobs table instead of QueuedTasks (Tasks are the implementing classes only)
- json_encode/decode instead of serialize
- Priority for jobs
- Transactions on getting a new job if supported from the database
- Code improvements, stricter typehinting
And...
A huge thx to Max (Dee-Fuse) for making the 3.x upgrade complete!
Modified by David Yell (davidyell)
- Basic CakePHP 3.x support
Modified by Mark Scherer (dereuromark)
- CakePHP 2.x support
- Some minor fixes
- Added crontasks (as a different approach on specific problems)
- Possible (optional) Tools Plugin dependencies for frontend access via /admin/queue
- Config key "queue" is now "Queue" ($config['Queue'][...])
Added by Christian Charukiewicz (charukiewicz):
- Configuration option 'gcprop' is now 'gcprob'
- Fixed typo in README and variable name (Propability -> Probability)
- Added a few lines about createJob() usage to README
- Added comments to queue.php explaining configuration options