hhxsv5 / laravel-s

src/LaravelS.php

<?php

Missing file doc comment

namespace Hhxsv5\LaravelS;

use Hhxsv5\LaravelS\Illuminate\Laravel;
use Hhxsv5\LaravelS\Illuminate\LaravelTrait;
use Hhxsv5\LaravelS\Illuminate\LogTrait;
use Hhxsv5\LaravelS\Swoole\DynamicResponse;
use Hhxsv5\LaravelS\Swoole\Events\ServerStartInterface;
use Hhxsv5\LaravelS\Swoole\Events\ServerStopInterface;
use Hhxsv5\LaravelS\Swoole\Events\WorkerErrorInterface;
use Hhxsv5\LaravelS\Swoole\Events\WorkerStartInterface;
use Hhxsv5\LaravelS\Swoole\Events\WorkerStopInterface;
use Hhxsv5\LaravelS\Swoole\InotifyTrait;
use Hhxsv5\LaravelS\Swoole\Process\CustomProcessTrait;
use Hhxsv5\LaravelS\Swoole\Process\ProcessTitleTrait;
use Hhxsv5\LaravelS\Swoole\Request;
use Hhxsv5\LaravelS\Swoole\Server;
use Hhxsv5\LaravelS\Swoole\StaticResponse;
use Hhxsv5\LaravelS\Swoole\Timer\TimerTrait;
use Illuminate\Http\Request as IlluminateRequest;

The type Illuminate\Http\Request was not found. Maybe you did not declare it correctly or list all dependencies?

use Swoole\Http\Request as SwooleRequest;
use Swoole\Http\Response as SwooleResponse;
use Swoole\Http\Server as HttpServer;
use Swoole\Process;
use Swoole\Server\Port;
use Symfony\Component\Console\Style\OutputStyle;
use Symfony\Component\HttpFoundation\BinaryFileResponse;

The type Symfony\Component\HttpFoundation\BinaryFileResponse was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * Swoole Request => Laravel Request
 * Laravel Request => Laravel handle => Laravel Response
 * Laravel Response => Swoole Response
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class LaravelS extends Server
{
    /**
     * Fix conflicts of traits
     */
    use InotifyTrait, LaravelTrait, LogTrait, ProcessTitleTrait, TimerTrait, CustomProcessTrait;

The trait Hhxsv5\LaravelS\Swoole\Process\CustomProcessTrait requires some properties which are not provided by Hhxsv5\LaravelS\LaravelS: $setting, $pid

The trait Hhxsv5\LaravelS\Swoole\Timer\TimerTrait requires some properties which are not provided by Hhxsv5\LaravelS\LaravelS: $setting, $pid

    /**@var array */

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

    protected array $laravelConf;

    /**@var Laravel */

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

    protected Laravel $laravel;

    /**@var Process[] */

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

    protected static array $customProcesses = [];

    public function __construct(array $svrConf, array $laravelConf)

Missing doc comment for function __construct()

    {
        parent::__construct($svrConf);
        $this->laravelConf = $laravelConf;

        $timerConf = $this->conf['timer'] ?? [];
        $timerConf['process_prefix'] = $svrConf['process_prefix'];
        $this->addTimerProcess($this->swoole, $timerConf, $this->laravelConf);

        $inotifyConf = $this->conf['inotify_reload'] ?? [];
        if (!isset($inotifyConf['watch_path'])) {
            $inotifyConf['watch_path'] = $this->laravelConf['root_path'];
        }
        $inotifyConf['process_prefix'] = $svrConf['process_prefix'];
        $this->addInotifyProcess($this->swoole, $inotifyConf, $this->laravelConf);

        $processes = $this->conf['processes'] ?? [];
        static::$customProcesses = $this->addCustomProcesses($this->swoole, $svrConf['process_prefix'], $processes, $this->laravelConf);

        // Fire ServerStart event
        if (isset($this->conf['event_handlers']['ServerStart'])) {
            Laravel::autoload($this->laravelConf['root_path']);
            $this->fireEvent('ServerStart', ServerStartInterface::class, [$this->swoole]);
        }
    }

    public static function getCustomProcesses(): array

Missing doc comment for function getCustomProcesses()

    {
        return static::$customProcesses;
    }

    protected function beforeWebSocketHandShake(SwooleRequest $request)

Missing doc comment for function beforeWebSocketHandShake()

    {
        // Start Laravel's lifetime, then support session ...middleware.
        $laravelRequest = $this->convertRequest($this->laravel, $request);
        $this->laravel->bindRequest($laravelRequest);
        $this->laravel->fireEvent('laravels.received_request', [$laravelRequest]);
        $this->laravel->cleanProviders();
        $laravelResponse = $this->laravel->handleDynamic($laravelRequest);
        $this->laravel->fireEvent('laravels.generated_response', [$laravelRequest, $laravelResponse]);
    }

    protected function afterWebSocketOpen(SwooleRequest $request)

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

Missing doc comment for function afterWebSocketOpen()

    {
        // End Laravel's lifetime.
        $this->laravel->saveSession();
        $this->laravel->clean();
    }

    protected function triggerWebSocketEvent($event, array $params)

Missing doc comment for function triggerWebSocketEvent()

    {
        if ($event === 'onHandShake') {
            $this->beforeWebSocketHandShake($params[0]);
            if (!empty($this->conf['server'])) {
                $params[1]->header('Server', $this->conf['server']);
            }
        }

        parent::triggerWebSocketEvent($event, $params);

        switch ($event) {
            case 'onHandShake':

Line indented incorrectly; expected 8 spaces, found 12

                if (isset($params[1]->header['Sec-Websocket-Accept'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    // Successful handshake
                    parent::triggerWebSocketEvent('onOpen', [$this->swoole, $params[0]]);
                }

Line indented incorrectly; expected 12 spaces, found 16

                $this->afterWebSocketOpen($params[0]);
                break;
            case 'onOpen':

Line indented incorrectly; expected 8 spaces, found 12

                $this->afterWebSocketOpen($params[1]);
                break;
        }
    }

    protected function triggerPortEvent(Port $port, $handlerClass, $event, array $params)

Missing doc comment for function triggerPortEvent()

    {
        switch ($event) {
            case 'onHandShake':

Line indented incorrectly; expected 8 spaces, found 12

                $this->beforeWebSocketHandShake($params[0]);

Consider adding a comment if this fall-through is intended.

            case 'onRequest':

Line indented incorrectly; expected 8 spaces, found 12

                if (!empty($this->conf['server'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    $params[1]->header('Server', $this->conf['server']);
                }

Line indented incorrectly; expected 12 spaces, found 16

                break;
        }

        parent::triggerPortEvent($port, $handlerClass, $event, $params);

        switch ($event) {
            case 'onHandShake':

Line indented incorrectly; expected 8 spaces, found 12

                if (isset($params[1]->header['Sec-Websocket-Accept'])) {

Line indented incorrectly; expected 12 spaces, found 16

                    // Successful handshake
                    parent::triggerPortEvent($port, $handlerClass, 'onOpen', [$this->swoole, $params[0]]);
                }

Line indented incorrectly; expected 12 spaces, found 16

                $this->afterWebSocketOpen($params[0]);
                break;
            case 'onOpen':

Line indented incorrectly; expected 8 spaces, found 12

                $this->afterWebSocketOpen($params[1]);
                break;
        }
    }

    public function onShutdown(HttpServer $server)

Missing doc comment for function onShutdown()

    {
        parent::onShutdown($server);

        // Fire ServerStop event
        if (isset($this->conf['event_handlers']['ServerStop'])) {
            $this->laravel = $this->initLaravel($this->laravelConf, $this->swoole);
            $this->fireEvent('ServerStop', ServerStopInterface::class, [$server]);
        }
    }

    public function onWorkerStart(HttpServer $server, $workerId)

Missing doc comment for function onWorkerStart()

    {
        parent::onWorkerStart($server, $workerId);

        // To implement gracefully reload
        // Delay to create Laravel
        // Delay to include Laravel's autoload.php
        $this->laravel = $this->initLaravel($this->laravelConf, $this->swoole);

        // Fire WorkerStart event
        $this->fireEvent('WorkerStart', WorkerStartInterface::class, func_get_args());
    }

    public function onWorkerStop(HttpServer $server, $workerId)

Missing doc comment for function onWorkerStop()

    {
        parent::onWorkerStop($server, $workerId);

        // Fire WorkerStop event
        $this->fireEvent('WorkerStop', WorkerStopInterface::class, func_get_args());
    }

    public function onWorkerError(HttpServer $server, $workerId, $workerPId, $exitCode, $signal)

Missing doc comment for function onWorkerError()

    {
        parent::onWorkerError($server, $workerId, $workerPId, $exitCode, $signal);

        Laravel::autoload($this->laravelConf['root_path']);

        // Fire WorkerError event
        $this->fireEvent('WorkerError', WorkerErrorInterface::class, func_get_args());
    }

    protected function convertRequest(Laravel $laravel, SwooleRequest $request)

Missing doc comment for function convertRequest()

    {
        $rawGlobals = $laravel->getRawGlobals();
        return (new Request($request))->toIlluminateRequest($rawGlobals['_SERVER'], $rawGlobals['_ENV']);
    }

    public function onRequest(SwooleRequest $swooleRequest, SwooleResponse $swooleResponse)

Missing doc comment for function onRequest()

    {
        try {
            $laravelRequest = $this->convertRequest($this->laravel, $swooleRequest);
            $this->laravel->bindRequest($laravelRequest);
            $this->laravel->fireEvent('laravels.received_request', [$laravelRequest]);
            $handleStaticSuccess = false;
            if ($this->conf['handle_static']) {
                // For Swoole < 1.9.17
                $handleStaticSuccess = $this->handleStaticResource($this->laravel, $laravelRequest, $swooleResponse);
            }
            if (!$handleStaticSuccess) {
                $this->handleDynamicResource($this->laravel, $laravelRequest, $swooleResponse);
            }
        } catch (\Exception $e) {
            $this->handleException($e, $swooleResponse);
        }
    }

    /**

Missing short description in doc comment

     * @param \Exception $e

Missing parameter comment

Expected 5 spaces after parameter type; 1 found

     * @param SwooleResponse $response

Missing parameter comment

     */

Missing @return tag in function comment

    protected function handleException($e, SwooleResponse $response)
    {
        $error = sprintf(
            'onRequest: Uncaught exception "%s"([%d]%s) at %s:%s, %s%s',
            get_class($e),
            $e->getCode(),
            $e->getMessage(),
            $e->getFile(),
            $e->getLine(),
            PHP_EOL,
            $e->getTraceAsString()
        );
        $this->error($error);
        try {
            $response->status(500);
            $response->end('Oops! An unexpected error occurred');
        } catch (\Exception $e) {
            $this->logException($e);
        }
    }

    protected function handleStaticResource(Laravel $laravel, IlluminateRequest $laravelRequest, SwooleResponse $swooleResponse)

Missing doc comment for function handleStaticResource()

    {
        $laravelResponse = $laravel->handleStatic($laravelRequest);
        if ($laravelResponse === false) {
            return false;
        }
        if (!empty($this->conf['server'])) {
            $laravelResponse->headers->set('Server', $this->conf['server'], true);
        }
        $laravel->fireEvent('laravels.generated_response', [$laravelRequest, $laravelResponse]);
        $response = new StaticResponse($swooleResponse, $laravelResponse);
        $response->setChunkLimit($this->conf['swoole']['buffer_output_size']);
        $response->send($this->conf['enable_gzip']);
        return true;
    }

    protected function handleDynamicResource(Laravel $laravel, IlluminateRequest $laravelRequest, SwooleResponse $swooleResponse)

Missing doc comment for function handleDynamicResource()

    {
        $laravel->cleanProviders();
        $laravelResponse = $laravel->handleDynamic($laravelRequest);
        if (!empty($this->conf['server'])) {
            $laravelResponse->headers->set('Server', $this->conf['server'], true);
        }
        $laravel->fireEvent('laravels.generated_response', [$laravelRequest, $laravelResponse]);
        if ($laravelResponse instanceof BinaryFileResponse) {
            $response = new StaticResponse($swooleResponse, $laravelResponse);
        } else {
            $response = new DynamicResponse($swooleResponse, $laravelResponse);
        }
        $response->setChunkLimit($this->conf['swoole']['buffer_output_size']);
        $response->send($this->conf['enable_gzip']);
        $laravel->clean();
        return true;
    }

    /**@var OutputStyle */

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

    protected static $outputStyle;

    public static function setOutputStyle(OutputStyle $outputStyle)

Missing doc comment for function setOutputStyle()

    {
        static::$outputStyle = $outputStyle;
    }

    public static function getOutputStyle()

Missing doc comment for function getOutputStyle()

    {
        return static::$outputStyle;
    }
}