nystudio107\retour\helpers\UrlHelper

Complexity

Total Complexity

3

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Test Coverage

Coverage

55%

Importance

Changes	5
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	combineQueryStringsFromUrls()	0	12	2
A	sanitizeUrl()	0	19	1

<?php
/**
 * Retour plugin for Craft CMS 3.x
 *
 * Retour allows you to intelligently redirect legacy URLs, so that you don't
 * lose SEO value when rebuilding & restructuring a website
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2020 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\retour\helpers;

use craft\helpers\UrlHelper as CraftUrlHelper;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Retour

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     3.1.34

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class UrlHelper extends CraftUrlHelper
{
    // Public Static Methods
    // =========================================================================

    /**
     * Returns a query string that is a combination of al of the query strings from
     * the passed in $urls
     *
     * @param ...$urls

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    public static function combineQueryStringsFromUrls(...$urls): string
    {
        $queryParams = [];
        foreach ($urls as $url) {
            $parsedUrl = parse_url($url);
            $params = [];
            parse_str($parsedUrl['query'] ?? '', $params);
            $queryParams[] = $params;
        }
        $queryParams = array_unique(array_merge([], ...$queryParams));

        return http_build_query($queryParams);
    }

    /**
     * Return a sanitized URL
     *
     * @param string $url

Missing parameter comment

     *
     * @return string
     */
    public static function sanitizeUrl(string $url): string
    {
        // HTML decode the entities, then strip out any tags
        $url = html_entity_decode($url, ENT_NOQUOTES, 'UTF-8');
        $url = urldecode($url);
        $url = strip_tags($url);
        // Remove any Twig tags that somehow are present in the incoming URL
        /** @noinspection CallableParameterUseCaseInTypeContextInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $url = preg_replace('/{.*}/', '', $url);
        // Remove any linebreaks that may be errantly in the URL
        $url = (string)str_replace([

The opening parenthesis of a multi-line function call should be the last content on the line.

                PHP_EOL,
                "\r",
                "\n",
            ]
            , '', $url

Space found before comma in argument list

        );

        return $url;
    }
}