Helldar\Support\Helpers\Http

Complexity

Total Complexity

15

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	9
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	validateUrl()	0	4	2
A	isUrl()	0	3	1
A	validatedUrl()	0	5	1
A	exists()	0	16	2
A	subdomain()	0	7	2
A	host()	0	8	1
A	domain()	0	5	1
A	scheme()	0	5	1
A	image()	0	5	4

<?php

namespace Helldar\Support\Helpers;

use Exception;
use Helldar\Support\Exceptions\NotValidUrlException;
use Helldar\Support\Facades\Helpers\Filesystem\File as FileHelper;
use Helldar\Support\Facades\Helpers\HttpBuilder as HttpBuilderHelper;

final class Http
{
    /**
     * Check if the string is a valid URL.
     *
     * @param  string|null  $url
     *
     * @return bool
     */
    public function isUrl(?string $url): bool
    {
        return filter_var($url, FILTER_VALIDATE_URL) !== false;
    }

    /**
     * Validate if the value is a valid URL or throw an error.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     */
    public function validateUrl(?string $url): void
    {
        if (! $this->isUrl($url)) {
            throw new NotValidUrlException($url);
        }
    }

    /**
     * Returns the URL after validation, or throws an error.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     * @return string
     */
    public function validatedUrl(?string $url): string
    {
        $this->validateUrl($url);

        return $url;

The expression return $url could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Check if the specified URL exists.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     *
     * @return bool
     */
    public function exists(?string $url): bool
    {
        $this->validateUrl($url);

        try {
            $headers = get_headers($url);

It seems like $url can also be of type null; however, parameter $url of get_headers() does only seem to accept string, maybe add an additional type check?

            $key   = array_search('HTTP/', $headers);
            $value = $headers[$key] ?? null;

            preg_match('/HTTP\/\d{1}\.?\d?\s[2-3]\d{2}/i', $value, $matches);

It seems like $value can also be of type null; however, parameter $subject of preg_match() does only seem to accept string, maybe add an additional type check?

            return count($matches) > 0;
        }
        catch (Exception $e) {
            return false;
        }
    }

    /**
     * Get the domain name from the URL.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     *
     * @return string
     */
    public function domain(?string $url): string
    {
        $this->validateUrl($url);

        return HttpBuilderHelper::parse($url)->getHost();

The expression return Helldar\Support\Facades\Helpers\HttpBuilder::parse($url)->getHost() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get the subdomain name from the URL.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     *
     * @return string|null
     */
    public function subdomain(?string $url): ?string
    {
        $this->validateUrl($url);

        $host = explode('.', HttpBuilderHelper::parse($url)->getHost());

It seems like Helldar\Support\Facades\Helpers\HttpBuilder::parse($url)->getHost() can also be of type null; however, parameter $string of explode() does only seem to accept string, maybe add an additional type check?

        return count($host) > 2 ? reset($host) : null;
    }

    /**
     * Get the scheme and host from the URL.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     *
     * @return string
     */
    public function host(?string $url): string
    {
        $this->validateUrl($url);

        return HttpBuilderHelper::same()
            ->parse($url, PHP_URL_SCHEME)

It seems like $url can also be of type null; however, parameter $url of Helldar\Support\Helpers\HttpBuilder::parse() does only seem to accept string, maybe add an additional type check?

            ->parse($url, PHP_URL_HOST)
            ->compile();
    }

    /**
     * Get the scheme name from the URL.
     *
     * @param  string|null  $url
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     *
     * @return string
     */
    public function scheme(?string $url): string
    {
        $this->validateUrl($url);

        return HttpBuilderHelper::parse($url)->getScheme();

The expression return Helldar\Support\Facades\Helpers\HttpBuilder::parse($url)->getScheme() could return the type null which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }

    /**
     * Check the existence of the file and return the default value if it is missing.
     *
     * @param  string  $url
     * @param  string|null  $default
     *
     * @throws \Helldar\Support\Exceptions\NotValidUrlException
     *
     * @return string|null
     */
    public function image(string $url, string $default = null): ?string
    {
        return $this->isUrl($url)
            ? ($this->exists($url) ? $url : $default)
            : (FileHelper::exists($url) ? $url : $default);
    }
}