File Core/src/Model/Entity/AsyncJob.php | BEdita API doc

 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 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

<?php
namespace BEdita\Core\Model\Entity;

use BEdita\Core\Job\ServiceRegistry;
use BEdita\Core\Utility\JsonApiSerializable;
use Cake\I18n\FrozenTime;
use Cake\ORM\Entity;

/**
 * Asynchronous Job Entity
 *
 * @property string $uuid
 * @property string $service
 * @property int $priority
 * @property array $payload
 * @property \Cake\I18n\Time $scheduled_from
 * @property \Cake\I18n\Time $expires
 * @property int $max_attempts
 * @property \Cake\I18n\Time $locked_until
 * @property \Cake\I18n\Time $created
 * @property \Cake\I18n\Time $modified
 * @property \Cake\I18n\Time $completed
 * @property string $status
 * @since 4.0.0
 */
class AsyncJob extends Entity implements JsonApiSerializable
{
    use JsonApiAdminTrait;

    /**
     * @inheritDoc
     */
    protected $_accessible = [
        'uuid' => true,
        'service' => true,
        'priority' => true,
        'payload' => true,
        'scheduled_from' => true,
        'expires' => true,
        'max_attempts' => true,
    ];

    /**
     * @inheritDoc
     */
    protected $_virtual = [
        'status',
    ];

    /**
     * Magic getter for status.
     *
     * @return string
     */
    protected function _getStatus()
    {
        if ($this->completed !== null) {
            return 'completed';
        }

        $now = new FrozenTime();
        if ($this->locked_until !== null && $this->locked_until->gte($now)) {
            return 'locked';
        }
        if ($this->max_attempts === 0 || ($this->expires !== null && $this->expires->lt($now))) {
            return 'failed';
        }
        if ($this->scheduled_from !== null && $this->scheduled_from->gt($now)) {
            return 'planned';
        }

        return 'pending';
    }

    /**
     * Run this asynchronous job.
     *
     * @param array $options Additional options.
     * @return bool
     * @throws \BadMethodCallException Throws an exception if job hasn't been locked.
     */
    public function run(array $options = [])
    {
        if ($this->status !== 'locked') {
            throw new \BadMethodCallException('Only locked jobs can be run');
        }

        $service = ServiceRegistry::get($this->service);

        return $service->run($this->payload, $options);
    }
}

Namespaces

Classes

Traits