Helix\Asana\Job

Complexity

Total Complexity

9

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Importance

Changes	4
Bugs	1	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	isFailed()	0	2	1
A	isQueued()	0	2	1
A	__toString()	0	2	1
A	isSuccessful()	0	2	1
A	isActive()	0	2	1
A	wait()	0	6	2
A	isDone()	0	2	2

<?php

namespace Helix\Asana;

use Helix\Asana\Base\AbstractEntity;

/**
 * An asynchronous job.
 *
 * @see https://developers.asana.com/docs/asana-jobs
 * @see https://developers.asana.com/docs/job
 *
 * @immutable Jobs may only be polled.
 *
 * @method null|Project getNewProject       ()
 * @method null|Task    getNewTask          ()
 * @method string       getResourceSubtype  ()
 * @method string       getStatus           ()
 */
class Job extends AbstractEntity {

    const TYPE = 'job';
    const TYPE_DUPLICATE_PROJECT = 'duplicate_project';
    const TYPE_DUPLICATE_TASK = 'duplicate_task';

    const STATUS_QUEUED = 'not_started';
    const STATUS_ACTIVE = 'in_progress';
    const STATUS_SUCCESS = 'succeeded'; // api docs say "completed" but that's wrong.
    const STATUS_FAIL = 'failed';

    protected static $map = [
        'new_project' => Project::class,
        'new_task' => Task::class
    ];

    final public function __toString (): string {
        return "jobs/{$this->getGid()}";
    }

    /**
     * Whether the job is in progress.
     *
     * @return bool
     */
    public function isActive (): bool {
        return $this->getStatus() === self::STATUS_ACTIVE;
    }

    /**
     * Whether the job has completed successfully or failed.
     *
     * @return bool
     */
    public function isDone (): bool {
        return $this->isSuccessful() or $this->isFailed();
    }

    /**
     * Whether the job failed.
     *
     * @return bool
     */
    public function isFailed (): bool {
        return $this->getStatus() === self::STATUS_FAIL;
    }

    /**
     * Whether the job has yet to be started.
     *
     * @return bool
     */
    public function isQueued (): bool {
        return $this->getStatus() === self::STATUS_QUEUED;
    }

    /**
     * Whether the job completed successfully.
     *
     * @return bool
     */
    public function isSuccessful (): bool {
        return $this->getStatus() === self::STATUS_SUCCESS;
    }

    /**
     * Sleeps a few seconds between reloads until the job completes successfully or fails.
     *
     * @return $this
     */
    public function wait () {
        while (!$this->isDone()) {
            sleep(3);
            $this->reload();
        }
        return $this;
    }
}