Download the PHP package dimadin/backdrop without Composer
On this page you can find all versions of the php package dimadin/backdrop. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dimadin/backdrop
More information about dimadin/backdrop
Files in dimadin/backdrop
Package backdrop
Short Description Backdrop
License GPL-2.0-or-later
Homepage https://github.com/dimadin/Backdrop
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 backdrop
Backdrop
Backdrop is a simple library that does one thing: allows you to run one-off tasks in the background.
How to Use
Backdrop is available as Composer package that you can use in your project.
Alternately, you can download and include all files from /inc directory in your project.
In either case, you then need to register it with Main::init() not after admin_init hook.
In this example, we create task if option doesn't exist, pass parameter to it, and then schedule it, while also hooking initialization of Backdrop:
API
Full code reference is available at http://api.milandinic.com/backdrop/.
Task::__construct( $callback [, $...] )
Creating a new task sets up all of the internal data for your task. Pass in your callback followed by your arguments to the function, and Backdrop will call it in a background process.
Arguments
$callback: Callback method you want to use. Can be any callable type (including object methods and static methods) except for anonymous functions. Closures cannot be serialized, so they cannot be used for Backdrop callbacks. This is an internal PHP limitation.$...: Any other arguments you'd like to pass to your callback, as variable arguments. e.g.new Task( 'a', 'b', 'c', 'd' )maps toa( 'b', 'c', 'd' )
Return Value
None (constructor).
Task::schedule()
Schedules your task to run. Typically runs after your page has been rendered, in a separate process.
Backdrop de-duplicates tasks based on the arguments passed in. For example, you
can do new Task( 'myfunc', 1 ) on every request, and only one will be run.
After this has been run, the next call will schedule again.
To avoid this, you should pass in unique identifiers as needed. Everything that makes your task unique should be passed in and used by your function, as global state may change.
Arguments
None.
Return Value
Either true, or a WP_Error on failure. The error object will indicate the
type of error; typically this is a md_backdrop_scheduled if the task is
already scheduled to run or is currently running.
Task::is_scheduled()
Checks whether your task is scheduled to run.
Arguments
None.
Return Value
Boolean indicating whether your task is scheduled to run, or is already running.
Task::cancel()
Cancels a previously scheduled task.
Note that if the task is already running, this will not cancel execution; it simply removes it from the tasks scheduled to run.
Arguments
None.
Return Value
Either true, or a WP_Error on failure. The error object will indicate the
type of error; typically this is a md_backdrop_not_scheduled if the task
hasn't been scheduled.
Main::init()
Register Backdrop.
Arguments
None.
Return Value
None.
Compatibility
Backdrop is compatible with PHP 5.4 and upwards.
License
Backdrop is licensed under the GPL version 2.
Copyright 2014 Human Made Limited, 2015-2018 Milan Dinić
