hhxsv5 / laravel-s

src/Swoole/Timer/TimerTrait.php

<?php

Missing file doc comment

namespace Hhxsv5\LaravelS\Swoole\Timer;

use Swoole\Event;
use Swoole\Http\Server;
use Swoole\Process;
use Swoole\Timer;

trait TimerTrait

Missing doc comment for trait TimerTrait

{
    private $timerPidFile = 'laravels-timer-process.pid';

Private member variable "timerPidFile" must be prefixed with an underscore

    public function addTimerProcess(Server $swoole, array $config, array $laravelConfig)

Missing doc comment for function addTimerProcess()

    {
        if (empty($config['enable']) || empty($config['jobs'])) {
            return false;
        }

        // Add backup cron job.
        $config['jobs'][] = BackupCronJob::class;
        if (!empty($config['global_lock'])) {
            // Add auxiliary jobs for global timer.
            $config['jobs'][] = RenewGlobalTimerLockCronJob::class;
            $config['jobs'][] = CheckGlobalTimerAliveCronJob::class;
        }

        $callback = function (Process $process) use ($swoole, $config, $laravelConfig) {
            $pidfile = dirname($swoole->setting['pid_file']) . '/' . $this->timerPidFile;
            file_put_contents($pidfile, $process->pid);
            $this->setProcessTitle(sprintf('%s laravels: timer process', $config['process_prefix']));

It seems like setProcessTitle() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->initLaravel($laravelConfig, $swoole);

It seems like initLaravel() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            // Implement global timer by Cache lock.
            if (!empty($config['global_lock'])) {
                CronJob::setGlobalTimerLockKey($config['global_lock_key']);
                CronJob::checkSetEnable();
            }

            $timerIds = $this->registerTimers($config['jobs']);

            Process::signal(SIGUSR1, function ($signo) use ($config, $timerIds, $process) {

The parameter $signo is not used and could be removed.

The opening parenthesis of a multi-line function call should be the last content on the line.

                foreach ($timerIds as $timerId) {
                    if (Timer::exists($timerId)) {
                        Timer::clear($timerId);
                    }
                }
                Timer::after($config['max_wait_time'] * 1000, function () use ($process) {

The opening parenthesis of a multi-line function call should be the last content on the line.

                    $process->exit(0);
                });

For multi-line function calls, the closing parenthesis should be on a new line.

            });

For multi-line function calls, the closing parenthesis should be on a new line.

            // For Swoole 4.6.x
            // Deprecated: Swoole\Event::rshutdown(): Event::wait() in shutdown function is deprecated in Unknown on line 0
            Event::wait();
        };

        $process = new Process($callback, false, 0);
        $swoole->addProcess($process);
        return $process;
    }

    public function registerTimers(array $jobs)

Missing doc comment for function registerTimers()

    {
        $timerIds = [];
        foreach ($jobs as $jobClass) {
            if (is_array($jobClass) && isset($jobClass[0])) {
                $job = new $jobClass[0](isset($jobClass[1]) ? $jobClass[1] : []);
            } else {
                $job = new $jobClass();
            }
            if (!($job instanceof CronJob)) {
                throw new \InvalidArgumentException(sprintf(

The opening parenthesis of a multi-line function call should be the last content on the line.

                        '%s must extend the abstract class %s',

This line of the multi-line function call does not seem to be indented correctly. Expected 20 spaces, but found 24.

                        get_class($job),

This line of the multi-line function call does not seem to be indented correctly. Expected 20 spaces, but found 24.

                        CronJob::class

This line of the multi-line function call does not seem to be indented correctly. Expected 20 spaces, but found 24.

                    )

This line of the multi-line function call does not seem to be indented correctly. Expected 16 spaces, but found 20.

                );
            }
            if (empty($job->interval())) {
                throw new \InvalidArgumentException(sprintf('The interval of %s cannot be empty', get_class($job)));
            }
            $runJob = function () use ($job) {
                $runCallback = function () use ($job) {
                    $this->callWithCatchException(function () use ($job) {

It seems like callWithCatchException() must be provided by classes using this trait. How about adding it as abstract method to this trait?

The opening parenthesis of a multi-line function call should be the last content on the line.

                        if (($job instanceof CheckGlobalTimerAliveCronJob) || $job::isEnable()) {
                            $job->run();
                        }
                    });

For multi-line function calls, the closing parenthesis should be on a new line.

                };
                class_exists('Swoole\Coroutine') ? \Swoole\Coroutine::create($runCallback) : $runCallback();
            };

            $timerId = Timer::tick($job->interval(), $runJob);
            $timerIds[] = $timerId;
            $job->setTimerId($timerId);
            if ($job->isImmediate()) {
                Timer::after(1, $runJob);
            }
        }
        return $timerIds;
    }
}