Merge pull request #260 from raicabogdan/5.9.x

Update IP filter sanitize and Request documentation

Author: niden

docs/api/phalcon_filter.md

@@ -66,6 +66,7 @@ const FILTER_BOOL = bool;
 const FILTER_EMAIL = email;
 const FILTER_FLOAT = float;
 const FILTER_INT = int;
+const FILTER_IP = 'ip';
 const FILTER_LOWER = lower;
 const FILTER_LOWERFIRST = lowerfirst;
 const FILTER_REGEX = regex;
@@ -447,6 +448,38 @@ public function __invoke( mixed $input );
 
 
 
+## Filter\Sanitize\Ip
+
+[Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Ip.zep)
+
+
+-   __Namespace__
+
+    - `Phalcon\Filter\Sanitize`
+
+-   __Uses__
+
+
+-   __Extends__
+
+
+-   __Implements__
+
+
+Phalcon\Filter\Sanitize\Ip
+
+Sanitizes a value to an IP address or CIDR IP range
+
+
+### Methods
+
+```php
+public function __invoke(string input, int filter = 0);
+```
+
+
+
+
 ## Filter\Sanitize\Lower 
 
 [Source on GitHub](https://github.com/phalcon/cphalcon/blob/5.0.x/phalcon/Filter/Sanitize/Lower.zep)

docs/api/phalcon_http.md

@@ -717,6 +717,11 @@ private $rawBody = ;
  */
 private $strictHostCheck = false;
 
+/**
+ * @var array
+ */
+private $trustedProxies = [];
+
 ```
 
 ### Methods
@@ -1253,6 +1258,18 @@ final protected function getBestQuality( array $qualityParts, string $name ): st
 Process a request header and return the one with best quality
 
 
+```php
+protected function setTrustedProxies(array $trustedProxies): RequestInterface;
+```
+Set trusted proxy list.
+
+
+```php
+protected function isIpAddressInCIDR(string $ip, string $cidr): bool;
+```
+Check if an IP address exists in CIDR range.
+
+
 ```php
 final protected function getHelper( array $source, string $name = null, mixed $filters = null, mixed $defaultValue = null, bool $notAllowEmpty = bool, bool $noRecursive = bool ): mixed;
 ```

docs/filter-filter.md

@@ -117,6 +117,21 @@ IntVal( mixed $input ): int
 ```
 Remove all characters except digits, plus and minus sign, and casts the value as an integer. Internally it uses [filter_var][filter_var] and `(int)`.
 
+#### `ip`
+```php
+Ip( string input, int filter = 0 ): int
+```
+Sanitize the IP address or CIDR IP range. Internally it uses [filter_var][filter_var]. You can pass specific filters to sanitize your input:
+
+```
+FILTER_FLAG_IPV4
+FILTER_FLAG_IPV6
+FILTER_FLAG_NO_RES_RANGE
+FILTER_FLAG_NO_PRIV_RANGE
+```
+By default, it will detect the IPv4 or IPv6 protocol if you do not use a predefined filter and sanitize the input.
+It will return `false` for invalid IP address or CIDR IP range.
+
 #### `lower`
 ```php
 Lower( mixed $input ): string
@@ -220,6 +235,7 @@ const FILTER_BOOL          = 'bool';
 const FILTER_EMAIL         = 'email';
 const FILTER_FLOAT         = 'float';
 const FILTER_INT           = 'int';
+const FILTER_IP            = 'ip';
 const FILTER_LOWER         = 'lower';
 const FILTER_LOWERFIRST    = 'lowerfirst';
 const FILTER_REGEX         = 'regex';
@@ -262,6 +278,7 @@ $filter->bool(mixed $input): bool
 $filter->email(string $input): string
 $filter->float(mixed $input): float
 $filter->int(string $input): int
+$filter->ip(string $input, int $filter = FILTER_FLAG_NONE): string|false
 $filter->lower(string $input): string
 $filter->lowerfirst(string $input): string
 $filter->regex(mixed $input, mixed $pattern, mixed $replace): mixed
@@ -583,6 +600,7 @@ $filteredIp = $locator->sanitize('127.0.0.1', 'ipv4');
 [filter-sanitize-email]: api/phalcon_filter.md#filtersanitizeemail
 [filter-sanitize-floatval]: api/phalcon_filter.md#filtersanitizefloatval
 [filter-sanitize-intval]: api/phalcon_filter.md#filtersanitizeintval
+[filter-sanitize-ip]: api/phalcon_filter.md#filtersanitizeip
 [filter-sanitize-lower]: api/phalcon_filter.md#filtersanitizelower
 [filter-sanitize-lowerfirst]: api/phalcon_filter.md#filtersanitizelowerfirst
 [filter-sanitize-regex]: api/phalcon_filter.md#filtersanitizeregex