hhxsv5 / laravel-s

src/Swoole/Timer/CronJob.php

<?php

Missing file doc comment

namespace Hhxsv5\LaravelS\Swoole\Timer;

use Swoole\Timer;

abstract class CronJob implements CronJobInterface

Missing doc comment for class CronJob

{
    /**
     * The seconds of global timer locking
     * @var int

There must be exactly one blank line before the tags in a doc comment

     */
    const GLOBAL_TIMER_LOCK_SECONDS = 60;

    /**
     * Swoole timer id
     * @var int

There must be exactly one blank line before the tags in a doc comment

     */
    protected $timerId;

    /**
     * The interval of Job in millisecond
     * @var int

There must be exactly one blank line before the tags in a doc comment

     */
    protected $interval;

    /**
     * Whether run immediately after start
     * @var bool

There must be exactly one blank line before the tags in a doc comment

     */
    protected $isImmediate;

    /**
     * The lock key of global timer
     * @var string

There must be exactly one blank line before the tags in a doc comment

     */
    protected static $globalTimerLockKey;

    /**
     * Whether enable CronJob
     * @var bool

There must be exactly one blank line before the tags in a doc comment

     */
    protected static $enable = true;

    /**
     * CronJob constructor.
     * Optional:
     *     argument 0 is interval, int ms, default null, overridden by method interval()
     *     argument 1 is isImmediate, bool, default false, overridden by method isImmediate()
     */
    public function __construct()
    {
        $args = func_get_args();
        $config = isset($args[0]) ? $args[0] : [];
        if (is_array($config)) {
            if (isset($config[0])) {
                $this->interval = $config[0];
            }
            if (isset($config[1])) {
                $this->isImmediate = $config[1];
            }
        }
    }

    /**

Missing short description in doc comment

     * @return int
     */
    public function interval()
    {
        return $this->interval;
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function isImmediate()
    {
        return $this->isImmediate;
    }

    public function setTimerId($timerId)

Missing doc comment for function setTimerId()

    {
        $this->timerId = $timerId;
    }

    public function stop()

Missing doc comment for function stop()

    {
        if ($this->timerId && Timer::exists($this->timerId)) {
            Timer::clear($this->timerId);
        }
    }

    public static function getGlobalTimerCacheKey()

Missing doc comment for function getGlobalTimerCacheKey()

    {
        return 'laravels:timer:' . strtolower(self::$globalTimerLockKey);
    }

    public static function getGlobalTimerLock()

Missing doc comment for function getGlobalTimerLock()

    {
        /**@var \Illuminate\Redis\RedisManager $redis */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $redis = app('redis');

The function app was not found. Maybe you did not declare it correctly or list all dependencies?

        $key = self::getGlobalTimerCacheKey();
        $value = self::getCurrentInstanceId();
        $expire = self::GLOBAL_TIMER_LOCK_SECONDS;
        $result = $redis->set($key, $value, 'ex', $expire, 'nx');
        // Compatible with Predis and PhpRedis
        return $result === true || ((string)$result === 'OK');
    }

    protected static function getCurrentInstanceId()

Missing doc comment for function getCurrentInstanceId()

    {
        return sprintf('%s:%d', current(swoole_get_local_ip()) ?: gethostname(), config('laravels.listen_port'));

The function config was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    public static function isGlobalTimerAlive()

Missing doc comment for function isGlobalTimerAlive()

    {
        /**@var \Redis|\RedisCluster|\Predis\Client $redis */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $redis = app('redis')->client(); // Fix: Redis exists() always returns false on cluster mode for some older versions of Laravel/Lumen, see https://github.com/illuminate/redis/commit/62ff6a06a9c91902d3baa7feda20bab5e807606f

The function app was not found. Maybe you did not declare it correctly or list all dependencies?

        return (bool)$redis->exists(self::getGlobalTimerCacheKey());
    }

    public static function isCurrentTimerAlive()

Missing doc comment for function isCurrentTimerAlive()

    {
        /**@var \Illuminate\Redis\RedisManager $redis */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $redis = app('redis');

The function app was not found. Maybe you did not declare it correctly or list all dependencies?

        $key = self::getGlobalTimerCacheKey();
        $instanceId = $redis->get($key);
        return $instanceId === self::getCurrentInstanceId();
    }

    public static function renewGlobalTimerLock($expire)

Missing doc comment for function renewGlobalTimerLock()

    {
        /**@var \Illuminate\Redis\RedisManager $redis */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $redis = app('redis');

The function app was not found. Maybe you did not declare it correctly or list all dependencies?

        return (bool)$redis->expire(self::getGlobalTimerCacheKey(), $expire);
    }

    public static function setGlobalTimerLockKey($lockKey)

Missing doc comment for function setGlobalTimerLockKey()

    {
        self::$globalTimerLockKey = $lockKey;
    }

    public static function checkSetEnable()

Missing doc comment for function checkSetEnable()

    {
        if (self::isGlobalTimerAlive()) {
            // Reset current timer to avoid repeated execution
            self::setEnable(self::isCurrentTimerAlive());
        } else {
            // Compete for timer lock
            self::setEnable(self::getGlobalTimerLock());
        }
    }

    public static function setEnable($enable)

Missing doc comment for function setEnable()

    {
        self::$enable = (bool)$enable;
    }

    public static function isEnable()

Missing doc comment for function isEnable()

    {
        return self::$enable;
    }
}