ride/wba-task

UI for time-consuming tasks of the Ride framework

Ride: Tasks web application

This module adds a UI to run different time-consuming tasks., _(*1)

Task

The Task interface is what you need to implement for each task you want to offer., _(*2)

You can inherit from AbstractTask to omit the obvious functions., _(*3)

Define Your Task

To make the application know your task, add a dependency definition for it in your dependencies.json:, _(*4)

{
    "dependencies": [
        {
            "interfaces": "ride\\web\\base\\task\\Task",
            "class": "my\\TestTask",
            "id": "test"
        }
    ]
}

Code Sample

Check the following code sample to get you on your way:, _(*5)

```php <?php, <sub>(*6)</sub>

namespace my;, <sub>(*7)</sub>

use ride\library\i18n\translator\Translator; use ride\library\form\FormBuilder; use ride\library\system\file\browser\FileBrowser;, <sub>(*8)</sub>

use ride\web\base\task\AbstractTask;, <sub>(*9)</sub>

class TestTask extends AbstractTask {, <sub>(*10)</sub>

/**
 * Name of this task, should be the same as your dependency id
 * @var string
 */
const NAME = 'test';

/**
 * Constructs a new test task
 * @param \ride\library\system\file\browser\FileBrowser $fileBrowser Let's 
 * use the file browser to retrieve the job result
 */
public function __construct(FileBrowser $fileBrowser) {
    $this->fileBrowser = $fileBrowser;
}

/**
 * Hook to prepare the form to ask for extra arguments
 * @param \ride\library\form\FormBuilder $form
 * @param \ride\library\i18n\translator\Translator $translator
 * @return null
 */
public function prepareForm(FormBuilder $form, Translator $translator) {
    // if you need extra information for your task, you can use this hook
    // to prepare a form which asks for these arguments
    $form->addRow('test', 'string', array(
        'validators' => array('required' => array()),
    ));
}

/**
 * Gets the queue job of this task
 * @param array $data Extra arguments from the form
 * @return \ride\library\queue\job\QueueJob Job to invoke
 */
public function getQueueJob(array $data) {
    // your extra arguments, as defined in prepareForm, will be passed on to 
    // this method

    // you should return a QueueJob which holds the logic of your task
    return new TestQueueJob();
}

/**
 * Gets the result of this task
 * @param string $queueJobId Id of the invoked queue job
 * @return mixed
 */
public function getResult($jobId) {
    // extract the result 
    $application = $this->fileBrowser->getApplicationDirectory();

    return $application->getChild('data/test-' . $jobId . '.txt');
}

}, <sub>(*11)</sub>