resque/Job.php at master · dinbrca/resque · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?php

namespace ResqueBundle\Resque;

/**
 * Class Job
 * @package ResqueBundle\Resque
 */
abstract class Job
{
    /**
     * @var \Resque_Job
     */
    public $job;

    /**
     * @var string The queue name
     */
    public $queue = 'default';

    /**
     * @var array The job args
     */
    public $args = [];

    /**
     * Job constructor.
     * @param array $args The Job Arguments
     */
    public function __construct($args = [])
    {
        $this->args = $args;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return \get_class($this);
    }

    /**
     * Default function used to set up, can be overloaded by individual Jobs
     * @todo test - I dont think this method is actually used?
     */
    public function setUp()
    {

    }

    /**
     * @todo test - I dont think this method is actually used?
     */
    public function perform()
    {
        $this->run($this->args);
    }

    /**
     * This is the method that is called when the job is run
     *
     * @param $args
     * @return mixed
     */
    abstract public function run($args);

    /**
     * Default function used to tear down, can be overloaded by individual Jobs
     * @todo test - I dont think this method is actually used?
     */
    public function tearDown()
    {

    }
}