Merge pull request #7 from inhere/master

add some methods, code formatting

Author: huangzhhui

.php_cs

@@ -0,0 +1,38 @@
+<?php
+
+$header = <<<'EOF'
+This file is part of Swoft.
+
+@link     https://swoft.org
+@document https://doc.swoft.org
+@contact  group@swoft.org
+@license  https://github.com/swoft-cloud/swoft/blob/master/LICENSE
+EOF;
+
+return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR2' => true,
+        'header_comment' => [
+            'commentType' => 'PHPDoc',
+            'header' => $header,
+            'separate' => 'none'
+        ],
+        'array_syntax' => [
+            'syntax' => 'short'
+        ],
+        'single_quote' => true,
+        'class_attributes_separation' => true,
+        'no_unused_imports' => true,
+        'standardize_not_equals' => true,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->exclude('public')
+            ->exclude('resources')
+            ->exclude('config')
+            ->exclude('runtime')
+            ->exclude('vendor')
+            ->in(__DIR__)
+    )
+    ->setUsingCache(false);

README.md

@@ -1,9 +1,25 @@
-# Swoft Http-server
-Swoft Http-server Component
+# Swoft http server
+
+Swoft Http server Component
 
 # Install
 
+- composer command
+
+```bash
+composer require swoft/http-server
+```
+
 # Document
 
+Please see [document site](https://doc.swoft.org)
+
+# Unit testing
+
+```bash
+phpunit
+```
+
 # LICENSE
-Swoft Http-server Component is open-sourced software licensed under the [Apache license](LICENSE).
+
+The Component is open-sourced software licensed under the [Apache license](LICENSE).

src/Bean/Parser/ControllerParser.php

@@ -8,18 +8,12 @@
 use Swoft\Http\Server\Bean\Collector\ControllerCollector;
 
 /**
- * AutoController注解解析器
- *
- * @uses      ControllerParser
- * @version   2017年09月03日
- * @author    stelin <phpcrazy@126.com>
- * @copyright Copyright 2010-2016 swoft software
- * @license   PHP Version 7.x {@link http://www.php.net/license/3_0.txt}
+ * Controller parser
  */
 class ControllerParser extends AbstractParser
 {
     /**
-     * AutoController注解解析
+     * Parse @Controller annotation
      *
      * @param string      $className
      * @param Controller  $objectAnnotation

src/Bootstrap/CoreBean.php

@@ -18,7 +18,7 @@ class CoreBean implements BootBeanInterface
     /**
      * @return array
      */
-    public function beans()
+    public function beans(): array
     {
         return [
             'serverDispatcher' => [
@@ -32,4 +32,4 @@ public function beans()
             ],
         ];
     }
-}
+}

src/Bootstrap/Listener/MasterStartListener.php

@@ -1,10 +1,4 @@
 <?php
-/**
- * Created by PhpStorm.
- * User: inhere
- * Date: 2018/3/19
- * Time: 上午11:32
- */
 
 namespace Swoft\Http\Server\Bootstrap\Listener;
 
@@ -30,7 +24,7 @@ public function onStart(Server $server)
 
         // output a message before start
         if (!App::$server->isDaemonize()) {
-            \output()->writeln('You can use <info>CTRL + C</info> to stop run.');
+            \output()->writeln("You can use <info>CTRL + C</info> to stop run.\n");
         }
     }
 }

src/Command/ServerCommand.php

@@ -22,6 +22,7 @@ class ServerCommand
      * @Example
      *   {fullCommand}
      *   {fullCommand} -d
+     * @throws \InvalidArgumentException
      * @throws \Swoft\Exception\RuntimeException
      * @throws \RuntimeException
      */
@@ -56,7 +57,7 @@ public function start()
         $tcpHost = $tcpStatus['host'];
         $tcpPort = $tcpStatus['port'];
         $tcpType = $tcpStatus['type'];
-        $tcpEnable = $tcpEnable ? '<note>Enabled</note>' : '<warning>Disabled</warning>';
+        $tcpEnable = $tcpEnable ? '<info>Enabled</info>' : '<warning>Disabled</warning>';
 
         // 信息面板
         $lines = [
@@ -104,6 +105,7 @@ public function reload()
      *
      * @Usage {fullCommand}
      * @Example {fullCommand}
+     * @throws \InvalidArgumentException
      * @throws \RuntimeException
      */
     public function stop()
@@ -141,6 +143,7 @@ public function stop()
      * @Example
      *   {fullCommand}
      *   {fullCommand} -d
+     * @throws \Swoft\Exception\RuntimeException
      * @throws \InvalidArgumentException
      * @throws \RuntimeException
      */

src/Exception/UnauthorizedException.php

@@ -3,7 +3,7 @@
 namespace Swoft\Http\Server\Exception;
 
 /**
- * @uses      UnanthenticatedException
+ * @uses      UnauthorizedException
  * @version   2017-11-11
  * @author    huangzhhui <huangzhwork@gmail.com>
  * @copyright Copyright 2010-2017 Swoft software

src/Middleware/AcceptTrait.php

@@ -23,8 +23,9 @@ trait AcceptTrait
 
     /**
      * @param \Psr\Http\Message\ServerRequestInterface $request
-     * @param \Psr\Http\Message\ResponseInterface      $response
+     * @param \Psr\Http\Message\ResponseInterface $response
      * @return \Psr\Http\Message\ResponseInterface
+     * @throws \InvalidArgumentException
      */
     protected function handleAccept(ServerRequestInterface $request, ResponseInterface $response): ResponseInterface
     {

src/Middleware/HandlerAdapterMiddleware.php

@@ -21,10 +21,14 @@ class HandlerAdapterMiddleware implements MiddlewareInterface
     /**
      * execute action
      *
-     * @param \Psr\Http\Message\ServerRequestInterface     $request
+     * @param \Psr\Http\Message\ServerRequestInterface $request
      * @param \Psr\Http\Server\RequestHandlerInterface $handler
      *
      * @return \Psr\Http\Message\ResponseInterface
+     * @throws \Swoft\Http\Server\Exception\RouteNotFoundException
+     * @throws \Swoft\Http\Server\Exception\MethodNotAllowedException
+     * @throws \InvalidArgumentException
+     * @throws \ReflectionException
      */
     public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
     {

src/Middleware/PoweredByMiddleware.php

@@ -9,7 +9,7 @@
 use Swoft\Http\Message\Middleware\MiddlewareInterface;
 
 /**
- * add powere by
+ * add powered by
  *
  * @Bean()
  * @uses      PoweredByMiddleware
@@ -20,7 +20,6 @@
  */
 class PoweredByMiddleware implements MiddlewareInterface
 {
-
     /**
      * Process an incoming server request and return a response, optionally delegating
      * response creation to a handler.