luya\helpers\Url

Complexity

Total Complexity

17

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	ensureHttp()	0	8	3
A	cleanHost()	0	4	1
A	domain()	0	4	1
A	appendQuery()	0	6	2
A	appendQueryToUrl()	0	21	5
A	trailing()	0	4	1
A	toInternal()	0	8	2
A	toAjax()	0	9	2

<?php

namespace luya\helpers;

use Yii;

/**
 * Helper methods when dealing with URLs and Links.
 *
 * Extends the {{yii\helpers\BaseUrl}} class by some usefull functions like:
 *
 * + {{luya\helpers\Url::trailing()}}
 * + {{luya\helpers\Url::toInternal()}}
 * + {{luya\helpers\Url::toAjax()}}
 * + {{luya\helpers\Url::ensureHttp()}}
 *
 * An example of create an URL based on Route in the UrlManager:
 *
 * ```php
 * Url::toRoute(['/module/controller/action']);
 * ```
 *
 * @author Basil Suter <basil@nadar.io>
 * @since 1.0.0
 */
class Url extends \yii\helpers\BaseUrl
{
    /**
     * Add a trailing slash to an url if there is no trailing slash at the end of the url.
     *
     * @param string $url The url which a trailing slash should be appended
     * @param string $slash If you want to trail a file on a windows system it gives you the ability to add forward slashes.
     * @return string The url with added trailing slash, if requred.
     */
    public static function trailing($url, $slash = '/')
    {
        return rtrim($url, $slash) . $slash;
    }
    
    /**
     * This helper method will not concern any context informations
     *
     * @param array $routeParams Example array to route `['/module/controller/action']`.
     * @param boolean $scheme Whether to return the absolute url or not
     * @return string The created url.
     */
    public static function toInternal(array $routeParams, $scheme = false)
    {
        if ($scheme) {
            return Yii::$app->getUrlManager()->internalCreateAbsoluteUrl($routeParams);
        }
        
        return Yii::$app->getUrlManager()->internalCreateUrl($routeParams);
    }

    /**
     * Create a link to use when point to an ajax script.
     *
     * @param string $route  The base routing path defined in yii. module/controller/action
     * @param array $params Optional array containing get parameters with key value pairing
     * @return string The ajax url link.
     */
    public static function toAjax($route, array $params = [])
    {
        $routeParams = ['/'.$route];
        foreach ($params as $key => $value) {
            $routeParams[$key] = $value;
        }
        
        return static::toInternal($routeParams, true);
    }
    
    /**
     * Apply the http protcol to an url to make sure valid clickable links. Commonly used when provide link where user could have added urls
     * in an administration area. For Example:
     *
     * ```php
     * Url::ensureHttp('luya.io'); // return http://luya.io
     * Url::ensureHttp('www.luya.io'); // return https://luya.io
     * Url::ensureHttp('luya.io', true); // return https://luya.io
     * ```
     *
     * @param string $url The url where the http protcol should be applied to if missing
     * @param boolean $https Whether the ensured url should be returned as https or not.
     * @return string
     */
    public static function ensureHttp($url, $https = false)
    {
        if (!preg_match("~^(?:f|ht)tps?://~i", $url)) {
            $url = ($https ? "https://" : "http://") . $url;
        }
        
        return $url;
    }

    /**
     * Removes schema, protocol and www. subdomain from host.
     *
     * For example `https://luya.io/path` would return `luya.io/path`.
     *
     * @param string $url The url to extract
     * @return string returns the url without protocol or www. subdomain
     * @since 1.0.20
     */
    public static function cleanHost($url)
    {
        return str_replace(['www.', 'http://', 'https://'], '', Url::ensureHttp($url));
    }
    /**
     * Return only the domain of a path.
     *
     * For example `https://luya.io/path` would return `luya.io` without path informations.
     *
     * @param string $url The url to extract
     * @return string Returns only the domain from the url.
     * @since 1.0.20
     */
    public static function domain($url)
    {
        return self::cleanHost(parse_url(Url::ensureHttp($url), PHP_URL_HOST));

It seems like parse_url(\luya\helpers\Url::ensureHttp($url), PHP_URL_HOST) targeting parse_url() can also be of type false; however, luya\helpers\Url::cleanHost() does only seem to accept string, did you maybe forget to handle an error condition?

    }

    /**
     * Append a query to the current url.
     *
     * See {{luya\helpers\Url::appendToUrl()}}
     *
     * @param string|array $append A string with url fragments or an array which will be processed by http_build_query.
     * @param boolean $scheme Add full path schema to the url, by default false. Otherwise absolute paths are used (including domain).
     * @return string
     * @since 1.0.25
     */
    public static function appendQuery($append, $scheme = false)
    {
        $url = $scheme ? Yii::$app->request->absoluteUrl : Yii::$app->request->url;

        return self::appendQueryToUrl($url, $append);
    }

    /**
     * Append an url part to an url
     *
     * @param string $url The url where the data should be appended.
     * @param string|array $append The query param to append, if an array is given http_build_query() will taken to build the query string.
     * @return string Returns the url with appended query string
     * @since 1.0.25
     */
    public static function appendQueryToUrl($url, $append)
    {
        if (is_array($append)) {
            $append = http_build_query($append);
        }
        // remove starting & and ? chars
        $append = ltrim($append, '&?');
        // use &: Do we have already a ? in the url
        if (StringHelper::contains('?', $url)) {
            // seperator already existing
            if (StringHelper::endsWith($url, '&') || StringHelper::endsWith($url, '?')) {
                return $url . $append;
            }

            // add seperator
            return $url . '&' . $append;
        }
        
        // use ?
        return $url . '?' . $append;
    }
}