update something. readme

README.md

@@ -26,6 +26,59 @@ git clone https://git.oschina.net/inhere/php-http.git // git@osc
 git clone https://github.com/inhere/php-http.git // github
 ```
 
+## usage
+
+### basic
+
+```php
+use Inhere\Http\Request;
+use Inhere\Http\Response;
+
+$request = new Request($method, $uri);
+$response = new Response($code);
+... ...
+```
+
+### use factory
+
+```php
+use Inhere\Http\HttpFactory;
+
+$request = HttpFactory::createRequest($method, $uri);
+$request = HttpFactory::createRequestFromArray($_SERVER);
+
+$response = HttpFactory::createResponse($code);
+
+```
+
+### Extended
+
+```php
+use Inhere\Http\Request;
+use Inhere\Http\Extra\ExtendedRequestTrait;
+
+class MyRequest extends Request {
+   use ExtendedRequestTrait;
+}
+
+// 
+
+$request = new MyRequest(...);
+
+$age = $request->getInt('age');
+$name = $request->getTrimmed('name');
+
+```
+
+```php
+use Inhere\Http\Response;
+use Inhere\Http\Extra\ExtendedResponseTrait;
+
+class MyResponse extends Response {
+   use ExtendedResponseTrait;
+}
+```
+
 ## license
 
 MIT

src/Extra/Request.php → src/Extra/ExtendedRequestTrait.php

@@ -15,7 +15,16 @@
 use Inhere\Library\Types;
 
 /**
- * Class Request
+ * trait ExtendedRequestTrait
+ *
+ * ```php
+ * use Inhere\Http\Request;
+ *
+ * class MyRequest extends Request {
+ *   use ExtendedRequestTrait;
+ * }
+ * ```
+ *
  * @package Inhere\Http\Extra
  *
  * @method      string   getRaw($name, $default = null)      Get raw data
@@ -31,13 +40,23 @@
  * @method      string   getUrl($name, $default = null)      Get URL
  *
  * @property  Uri $uri;
+ *
+ * // there methods at the class Request.
+ *
+ * @method string getHeaderLine(string $name)
+ * @method boolean isAjax()
+ * @method string getRequestTarget()
+ * @method array getUploadedFiles()
+ * @method array getQueryParams()
+ * @method array getParams()
+ * @method mixed getParam($key, $default = null)
  */
-class Request extends \Inhere\Http\Request
+trait ExtendedRequestTrait
 {
     /**
      * return raw data
      */
-    const FILTER_RAW = 'raw';
+    private static $rawFilter = 'raw';
 
     /**
      * @var array
@@ -56,6 +75,8 @@ class Request extends \Inhere\Http\Request
         'boolean' => 'bool',
         // (string)$var
         'string' => 'string',
+        // (array)$var
+        'array' => 'array',
 
         // trim($var)
         'trimmed' => [FilterList::class, 'trim'],
@@ -200,12 +221,12 @@ public function __call($name, array $arguments)
 
     /**
      * @param $value
-     * @param $filter
+     * @param string|callable $filter
      * @return mixed|null
      */
-    public function filtering($value, $filter = self::FILTER_RAW)
+    public function filtering($value, $filter = null)
     {
-        if ($filter === self::FILTER_RAW) {
+        if (!$filter || $filter === self::$rawFilter) {
             return $value;
         }
 

src/Extra/Response.php → src/Extra/ExtendedResponseTrait.php

@@ -12,10 +12,19 @@
 use Psr\Http\Message\UriInterface;
 
 /**
- * Class Response
+ * trait ExtendedResponseTrait
+ *
+ * ```php
+ * use Inhere\Http\Response;
+ *
+ * class MyResponse extends Response {
+ *   use ExtendedResponseTrait;
+ * }
+ * ```
+ *
  * @package Inhere\Http\Extra
  */
-class Response extends \Inhere\Http\Response
+trait ExtendedResponseTrait
 {
     /*******************************************************************************
      * Response Helpers