silverstripe / silverstripe-contentreview

src/Jobs/ContentReviewNotificationJob.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 25 and the first side effect is on line 13.

namespace SilverStripe\ContentReview\Jobs;

use SilverStripe\ContentReview\Tasks\ContentReviewEmails;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Config\Config;
use Symbiote\QueuedJobs\Services\AbstractQueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJobService;

if (!class_exists(AbstractQueuedJob::class)) {
    return;
}

/**
 * Allows the content review module to use the optional queued jobs module to automatically
 * process content review emails. If the module isn't installed, nothing is done - SilverStripe
 * will never include this class declaration.
 *
 * If the module is installed, it will create a new job to be processed once every day by default.
 *
 * @see https://github.com/silverstripe-australia/silverstripe-queuedjobs
 */
class ContentReviewNotificationJob extends AbstractQueuedJob implements QueuedJob
{
    /**
     * The hour that the first job will be created at (for the next day). All other jobs should
     * be triggered around this time too, as the next generation is queued when this job is run.
     *
     * @var int
     *
     * @config
     */
    private static $first_run_hour = 9;

The property $first_run_hour is not used and could be removed.

    /**
     * The hour at which to run these jobs.
     *
     * @var int
     *
     * @config
     */
    private static $next_run_hour = 9;

The property $next_run_hour is not used and could be removed.

    /**
     * The minutes past the hour (see above) at which to run these jobs.
     *
     * @var int
     *
     * @config
     */
    private static $next_run_minute = 0;

The property $next_run_minute is not used and could be removed.

    /**
     * The number of days to skip between job runs (1 means run this job every day,
     * 2 means run it every second day etc).
     *
     * @var int
     *
     * @config
     */
    private static $next_run_in_days = 1;

The property $next_run_in_days is not used and could be removed.

    /**
     * @return string
     */
    public function getTitle()
    {
        return "Content Review Notification Job";
    }

    /**
     * @return string
     */
    public function getJobType()
    {
        $this->totalSteps = 1;

        return QueuedJob::QUEUED;
    }

    public function process()
    {
        $this->queueNextRun();

        $task = new ContentReviewEmails();
        $task->run(new HTTPRequest("GET", "/dev/tasks/ContentReviewEmails"));

        $this->currentStep = 1;
        $this->isComplete = true;
    }

    /**
     * Queue up the next job to run.
     */
    protected function queueNextRun()
    {
        $nextRun = new ContentReviewNotificationJob();

        $nextRunTime = mktime(
            Config::inst()->get(__CLASS__, 'next_run_hour'),
            Config::inst()->get(__CLASS__, 'next_run_minute'),
            0,
            date("m"),
            date("d") + Config::inst()->get(__CLASS__, 'next_run_in_days'),
            date("Y")
        );

        singleton(QueuedJobService::class)->queueJob(
            $nextRun,
            date("Y-m-d H:i:s", $nextRunTime)
        );
    }
}