Failed Conditions
Pull Request — master (#1)
by
unknown
02:42
created

Url::filter()   B

Complexity

Conditions 5
Paths 4

Size

Total Lines 16
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
eloc 8
nc 4
nop 2
dl 0
loc 16
rs 8.8571
c 0
b 0
f 0
1
<?php
2
3
namespace TraderInteractive\Filter;
4
5
use TraderInteractive\Exceptions\FilterException;
6
7
/**
8
 * A collection of filters for urls.
9
 */
10
final class Url
11
{
12
    /**
13
     * Filter an url
14
     *
15
     * Filters value as URL (according to » http://www.faqs.org/rfcs/rfc2396)
16
     *
17
     * The return value is the url, as expected by the \TraderInteractive\Filterer class.
18
     * By default, nulls are not allowed.
19
     *
20
     * @param mixed $value The value to filter.
21
     * @param bool $allowNull True to allow nulls through, and false (default) if nulls should not be allowed.
22
     *
23
     * @return string|null The passed in $value.
24
     *
25
     * @throws FilterException if the value did not pass validation.
26
     */
27
    public static function filter($value, bool $allowNull = false)
28
    {
29
        if ($allowNull === true && $value === null) {
30
            return null;
31
        }
32
33
        if (!is_string($value)) {
34
            throw new FilterException("Value '" . var_export($value, true) . "' is not a string");
35
        }
36
37
        $filteredUrl = filter_var($value, FILTER_VALIDATE_URL);
38
        if ($filteredUrl === false) {
39
            throw new FilterException("Value '{$value}' is not a valid url");
40
        }
41
42
        return $filteredUrl;
43
    }
44
}
45