maqe / laravel-qwatcher

src/Qwatcher.php

<?php namespace Maqe\Qwatcher;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Pagination\LengthAwarePaginator;
use Maqe\Qwatcher\Tracks\Enums\StatusType;
use Maqe\Qwatcher\Tracks\TracksInterface;
use Maqe\Qwatcher\Tracks\Tracks;
use Maqe\Qwatcher\Tracks\Transformers\TrackTransformerInterface;

class Qwatcher extends QwatchersAbstract
{
    private $trackTransformer;

    protected $statusable = [];

    protected $queryable = ['sort', 'limit'];

    protected $sortColumn = 'id';

    protected $sortOrder = 'asc';

    protected $sortable = ['id', 'driver', 'queue_at', 'job_name', 'process_at', 'success_at', 'failed_at'];

    protected $limit = null;

    public function __construct()
    {
        $this->trackTransformer = app(TrackTransformerInterface::class);
        $this->statusable = StatusType::statsTypes();
    }

    /**
     * Insert or update Track table depend on TracksInterface sub class (Adapter)
     *
     * @param  TracksInterface $tracks      Sub class that implements TracksInterface
     * @return mixed
     */
    public static function tracks(TracksInterface $tracks)
    {
        return $tracks;
    }

    /**
     * Added sort order to $this->sortOrder string, use with builder
     *
     * @param  string $sortBy The sort string

There is no parameter named $sortBy. Was it maybe removed?

     * @return $this
     */
    public function sortBy($sortColumn = 'id', $sortOrder = 'asc')
    {

        $this->sortColumn = $this->filterSortColumn($sortColumn);
        $this->sortOrder = $this->filterSortOrder($sortOrder);

        return $this;
    }

    /**
     * Set limit record to show
     *
     * @param  integer $limit   The number of record to retrieve
     * @return $this
     */
    public function limit($limit)
    {
        $this->limit = $limit;

        return $this;
    }

    /**
     * Get the list of the queue track
     *
     * @return collection
     */
    public function all()
    {
        $builder = new Tracks;

        $builder = $builder->newQuery();

        $this->queryApplies($builder);

        return $this->trackTransformer->transforms($builder->get());
    }

    /**
     * Get paginate list of the queue track
     *
     * @param  $perPage     The number of per page
     * @return collection
     */
    public function paginate($perPage)
    {
        $builder = new Tracks;

        $builder = $builder->newQuery();

        $this->queryApplies($builder);

        return $this->trackTransformer->transforms($builder->paginate($perPage));
    }

    /**
     * Get the track record by id
     *
     * @param  $id          The track id
     * @return object
     */
    public function getById($id)
    {
        return $this->trackTransformer->transform(Tracks::where('id', $id)->firstOrFail());
    }

    /**
     * Get the track record by current status
     *
     * @param  $status      The track status
     * @param  $perPage     The number of per page
     * @return collection
     */
    public function getByStatus($status, $per_page = null)
    {
        if(!in_array($status, $this->statusable)) {
            throw new \InvalidArgumentException('"'.$status.'" is not allowed in status type');
        }

        $builder = Tracks::whereNotNull('queue_at');

        $methodName = 'filterBy'.ucfirst($status);

        if (method_exists($this, $methodName)) {
            $this->{$methodName}($builder);
        }

        $this->queryApplies($builder);

        if (!is_null($per_page)) {
            return $this->trackTransformer->transformPaginator($builder->paginate($per_page));
        } else {
            return $this->trackTransformer->transforms($builder->get());
        }
    }

    /**
     * Get the track record by job name
     *
     * @param  $name        The job name
     * @param  $perPage     The number of per page
     * @return collection
     */
    public function getByJobName($name, $per_page = null)
    {
        $collecName = strtolower(str_replace('_', '%',$name));
        $condition = "`tracks`.`job_name` LIKE '%{$collecName}%'";
        $builder = Tracks::whereRaw($condition);

        $this->queryApplies($builder);

        if (!is_null($per_page)) {
            return $this->trackTransformer->transformPaginator($builder->paginate($per_page));
        } else {
            return $this->trackTransformer->transforms($builder->get());
        }
    }

    /**
     * Filter by queue date is not null (get queue that not run the job yet)
     * - process, succeed and failed must be null
     *
     * @param  Builder $builder The tracks builder
     * @return Builder          The query builder with filter applied.
     */
    protected function filterByQueue(Builder $builder)
    {
        return $builder
            ->whereNull('process_at')
            ->whereNull('succeed_at')
            ->whereNull('failed_at');
    }

    /**
     * Filter by process date is not null
     * - succeed and failed must be null
     *
     * @param  Builder $builder The tracks builder
     * @return Builder          The query builder with filter applied.
     */
    protected function filterByProcess(Builder $builder)
    {
        return $builder
            ->whereNotNull('process_at')
            ->whereNull('succeed_at')
            ->whereNull('failed_at');
    }

    /**
     * Filter by succeed date is not null
     * - process is not null
     * - failed is null
     *
     * @param  Builder $builder The tracks builder
     * @return Builder          The query builder with filter applied.
     */
    protected function filterBySucceed(Builder $builder)
    {
        return $builder
            ->whereNotNull('succeed_at')
            ->whereNull('failed_at');
    }

    /**
     * Filter by failed date is not null
     * - succeed is null
     *
     * @param  Builder $builder The tracks builder
     * @return Builder          The query builder with filter applied.
     */
    protected function filterByFailed(Builder $builder)
    {
        return $builder
            ->whereNotNull('failed_at')
            ->whereNull('succeed_at');
    }

    /**
     * Filter sort order column string
     *
     * @param  string $sortColumn  The sort order column string
     * @return stirng
     */
    protected function filterSortColumn($sortColumn)
    {
        return in_array($sortColumn, $this->sortable) ? $sortColumn : 'id';
    }

    /**
     * Filter sort order string, allowed only asc, desc
     *
     * @param  string $sortOrder The sort order string
     * @return stirng
     */
    protected function filterSortOrder($sortOrder)
    {
        return in_array($sortOrder, ['asc', 'desc']) ? $sortOrder : 'asc';
    }

    /**
     * Apply limit if $this->limit is not null
     *
     * @param  Builder $builder The tracks builder
     * @return Builder          The query builder with take applied.
     */
    protected function applyLimit(Builder $builder)
    {
        return (!is_null($this->limit)) ? $builder->take($this->limit) : $builder;
    }

    protected function applySort(Builder $builder)
    {
        return $builder->orderBy($this->sortColumn, $this->sortOrder);
    }
}