Download the PHP package jetty-dev/background-processing without Composer
On this page you can find all versions of the php package jetty-dev/background-processing. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jetty-dev/background-processing
More information about jetty-dev/background-processing
Files in jetty-dev/background-processing
Package background-processing
Short Description WP Background Processing can be used to fire off non-blocking asynchronous requests or as a background processing tool, allowing you to queue tasks.
License GPL-2.0-or-later
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 background-processing
WP Background Processing
WP Background Processing can be used to fire off non-blocking asynchronous requests or as a background processing tool, allowing you to queue tasks. Check out the example plugin or read the accompanying article.
Inspired by TechCrunch WP Asynchronous Tasks.
Requires PHP 5.2+
Install
The recommended way to install this library in your project is by loading it through Composer:
It is highly recommended to prefix wrap the library class files using the Mozart package, to prevent collisions with other projects using this same library.
Usage
Async Request
Async requests are useful for pushing slow one-off tasks such as sending emails to a background process. Once the request has been dispatched it will process in the background instantly.
Extend the WP_Async_Request class:
protected $action
Should be set to a unique name.
protected function handle()
Should contain any logic to perform during the non-blocking request. The data passed to the request will be accessible via $_POST.
Dispatching Requests
Instantiate your request:
$this->example_request = new WP_Example_Request();
Add data to the request if required:
$this->example_request->data( array( 'value1' => $value1, 'value2' => $value2 ) );
Fire off the request:
$this->example_request->dispatch();
Chaining is also supported:
$this->example_request->data( array( 'data' => $data ) )->dispatch();
Background Process
Background processes work in a similar fashion to async requests but they allow you to queue tasks. Items pushed onto the queue will be processed in the background once the queue has been dispatched. Queues will also scale based on available server resources, so higher end servers will process more items per batch. Once a batch has completed the next batch will start instantly.
Health checks run by default every 5 minutes to ensure the queue is running when queued items exist. If the queue has failed it will be restarted.
Queues work on a first in first out basis, which allows additional items to be pushed to the queue even if it’s already processing.
Extend the WP_Background_Process class:
protected $action
Should be set to a unique name.
protected function task( $item )
Should contain any logic to perform on the queued item. Return false to remove the item from the queue or return $item to push it back onto the queue for further processing. If the item has been modified and is pushed back onto the queue the current state will be saved before the batch is exited.
protected function complete()
Optionally contain any logic to perform once the queue has completed.
Dispatching Processes
Instantiate your process:
$this->example_process = new WP_Example_Process();
Note: You must instantiate your process unconditionally. All requests should do this, even if nothing is pushed to the queue.
Push items to the queue:
Save and dispatch the queue:
$this->example_process->save()->dispatch();
BasicAuth
If your site is behind BasicAuth, both async requests and background processes will fail to complete. This is because WP Background Processing relies on the WordPress HTTP API, which requires you to attach your BasicAuth credentials to requests. The easiest way to do this is using the following filter:
